SqlParameter (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.rdsdata.model.SqlParameter

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SqlParameter
extends Object
implements Serializable, Cloneable, StructuredPojo

A parameter used in a SQL statement.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SqlParameter()

Constructors
Constructor and Description
`SqlParameter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SqlParameter`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getName()` The name of the parameter.
`String`	`getTypeHint()` A hint that specifies the correct object type for data type mapping.
`Field`	`getValue()` The value of the parameter.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setName(String name)` The name of the parameter.
`void`	`setTypeHint(String typeHint)` A hint that specifies the correct object type for data type mapping.
`void`	`setValue(Field value)` The value of the parameter.
`String`	`toString()` Returns a string representation of this object.
`SqlParameter`	`withName(String name)` The name of the parameter.
`SqlParameter`	`withTypeHint(String typeHint)` A hint that specifies the correct object type for data type mapping.
`SqlParameter`	`withTypeHint(TypeHint typeHint)` A hint that specifies the correct object type for data type mapping.
`SqlParameter`	`withValue(Field value)` The value of the parameter.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SqlParameter
```
public SqlParameter()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the parameter.
    
    Parameters:
    
    name - The name of the parameter.
  - getName
```
public String getName()
```
    The name of the parameter.
    
    Returns:
    
    The name of the parameter.
  - withName
```
public SqlParameter withName(String name)
```
    The name of the parameter.
    
    Parameters:
    
    name - The name of the parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTypeHint
```
public void setTypeHint(String typeHint)
```
    A hint that specifies the correct object type for data type mapping. Possible values are as follows:
    - DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.
    - DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.
    - JSON - The corresponding String parameter value is sent as an object of JSON type to the database.
    - TIME - The corresponding String parameter value is sent as an object of TIME type to the database. The accepted format is HH:MM:SS[.FFF].
    - TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF].
    - UUID - The corresponding String parameter value is sent as an object of UUID type to the database.
    Parameters:
    typeHint - A hint that specifies the correct object type for data type mapping. Possible values are as follows:
    
    DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.
    
    DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.
    
    JSON - The corresponding String parameter value is sent as an object of JSON type to the database.
    
    TIME - The corresponding String parameter value is sent as an object of TIME type to the database. The accepted format is HH:MM:SS[.FFF].
    
    TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF] .
    
    UUID - The corresponding String parameter value is sent as an object of UUID type to the database.
    See Also:
    
    TypeHint
  - getTypeHint
```
public String getTypeHint()
```
    A hint that specifies the correct object type for data type mapping. Possible values are as follows:
    - DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.
    - DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.
    - JSON - The corresponding String parameter value is sent as an object of JSON type to the database.
    - TIME - The corresponding String parameter value is sent as an object of TIME type to the database. The accepted format is HH:MM:SS[.FFF].
    - TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF].
    - UUID - The corresponding String parameter value is sent as an object of UUID type to the database.
    Returns:
    A hint that specifies the correct object type for data type mapping. Possible values are as follows:
    
    DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.
    
    DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.
    
    JSON - The corresponding String parameter value is sent as an object of JSON type to the database.
    
    TIME - The corresponding String parameter value is sent as an object of TIME type to the database. The accepted format is HH:MM:SS[.FFF].
    
    TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF].
    
    UUID - The corresponding String parameter value is sent as an object of UUID type to the database.
    See Also:
    
    TypeHint
  - withTypeHint
```
public SqlParameter withTypeHint(String typeHint)
```
    A hint that specifies the correct object type for data type mapping. Possible values are as follows:
    - DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.
    - DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.
    - JSON - The corresponding String parameter value is sent as an object of JSON type to the database.
    - TIME - The corresponding String parameter value is sent as an object of TIME type to the database. The accepted format is HH:MM:SS[.FFF].
    - TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF].
    - UUID - The corresponding String parameter value is sent as an object of UUID type to the database.
    Parameters:
    typeHint - A hint that specifies the correct object type for data type mapping. Possible values are as follows:
    
    DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.
    
    DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.
    
    JSON - The corresponding String parameter value is sent as an object of JSON type to the database.
    
    TIME - The corresponding String parameter value is sent as an object of TIME type to the database. The accepted format is HH:MM:SS[.FFF].
    
    TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF] .
    
    UUID - The corresponding String parameter value is sent as an object of UUID type to the database.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TypeHint
  - withTypeHint
```
public SqlParameter withTypeHint(TypeHint typeHint)
```
    A hint that specifies the correct object type for data type mapping. Possible values are as follows:
    - DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.
    - DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.
    - JSON - The corresponding String parameter value is sent as an object of JSON type to the database.
    - TIME - The corresponding String parameter value is sent as an object of TIME type to the database. The accepted format is HH:MM:SS[.FFF].
    - TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF].
    - UUID - The corresponding String parameter value is sent as an object of UUID type to the database.
    Parameters:
    typeHint - A hint that specifies the correct object type for data type mapping. Possible values are as follows:
    
    DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.
    
    DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.
    
    JSON - The corresponding String parameter value is sent as an object of JSON type to the database.
    
    TIME - The corresponding String parameter value is sent as an object of TIME type to the database. The accepted format is HH:MM:SS[.FFF].
    
    TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF] .
    
    UUID - The corresponding String parameter value is sent as an object of UUID type to the database.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TypeHint
  - setValue
```
public void setValue(Field value)
```
    The value of the parameter.
    
    Parameters:
    
    value - The value of the parameter.
  - getValue
```
public Field getValue()
```
    The value of the parameter.
    
    Returns:
    
    The value of the parameter.
  - withValue
```
public SqlParameter withValue(Field value)
```
    The value of the parameter.
    
    Parameters:
    
    value - The value of the parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SqlParameter clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class SqlParameter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SqlParameter

Method Detail

setName

getName

withName

setTypeHint

getTypeHint

withTypeHint

withTypeHint

setValue

getValue

withValue

toString

equals

hashCode

clone

marshall