Class SqlParameter
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SqlParameter.Builder,
SqlParameter>
A parameter used in a SQL statement.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SqlParameter.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
name()
The name of the parameter.static Class
<? extends SqlParameter.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TypeHint
typeHint()
A hint that specifies the correct object type for data type mapping.final String
A hint that specifies the correct object type for data type mapping.final Field
value()
The value of the parameter.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the parameter.
- Returns:
- The name of the parameter.
-
value
The value of the parameter.
- Returns:
- The value of the parameter.
-
typeHint
A hint that specifies the correct object type for data type mapping. Possible values are as follows:
-
DATE
- The correspondingString
parameter value is sent as an object ofDATE
type to the database. The accepted format isYYYY-MM-DD
. -
DECIMAL
- The correspondingString
parameter value is sent as an object ofDECIMAL
type to the database. -
JSON
- The correspondingString
parameter value is sent as an object ofJSON
type to the database. -
TIME
- The correspondingString
parameter value is sent as an object ofTIME
type to the database. The accepted format isHH:MM:SS[.FFF]
. -
TIMESTAMP
- The correspondingString
parameter value is sent as an object ofTIMESTAMP
type to the database. The accepted format isYYYY-MM-DD HH:MM:SS[.FFF]
. -
UUID
- The correspondingString
parameter value is sent as an object ofUUID
type to the database.
If the service returns an enum value that is not available in the current SDK version,
typeHint
will returnTypeHint.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeHintAsString()
.- Returns:
- A hint that specifies the correct object type for data type mapping. Possible values are as follows:
-
DATE
- The correspondingString
parameter value is sent as an object ofDATE
type to the database. The accepted format isYYYY-MM-DD
. -
DECIMAL
- The correspondingString
parameter value is sent as an object ofDECIMAL
type to the database. -
JSON
- The correspondingString
parameter value is sent as an object ofJSON
type to the database. -
TIME
- The correspondingString
parameter value is sent as an object ofTIME
type to the database. The accepted format isHH:MM:SS[.FFF]
. -
TIMESTAMP
- The correspondingString
parameter value is sent as an object ofTIMESTAMP
type to the database. The accepted format isYYYY-MM-DD HH:MM:SS[.FFF]
. -
UUID
- The correspondingString
parameter value is sent as an object ofUUID
type to the database.
-
- See Also:
-
-
typeHintAsString
A hint that specifies the correct object type for data type mapping. Possible values are as follows:
-
DATE
- The correspondingString
parameter value is sent as an object ofDATE
type to the database. The accepted format isYYYY-MM-DD
. -
DECIMAL
- The correspondingString
parameter value is sent as an object ofDECIMAL
type to the database. -
JSON
- The correspondingString
parameter value is sent as an object ofJSON
type to the database. -
TIME
- The correspondingString
parameter value is sent as an object ofTIME
type to the database. The accepted format isHH:MM:SS[.FFF]
. -
TIMESTAMP
- The correspondingString
parameter value is sent as an object ofTIMESTAMP
type to the database. The accepted format isYYYY-MM-DD HH:MM:SS[.FFF]
. -
UUID
- The correspondingString
parameter value is sent as an object ofUUID
type to the database.
If the service returns an enum value that is not available in the current SDK version,
typeHint
will returnTypeHint.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeHintAsString()
.- Returns:
- A hint that specifies the correct object type for data type mapping. Possible values are as follows:
-
DATE
- The correspondingString
parameter value is sent as an object ofDATE
type to the database. The accepted format isYYYY-MM-DD
. -
DECIMAL
- The correspondingString
parameter value is sent as an object ofDECIMAL
type to the database. -
JSON
- The correspondingString
parameter value is sent as an object ofJSON
type to the database. -
TIME
- The correspondingString
parameter value is sent as an object ofTIME
type to the database. The accepted format isHH:MM:SS[.FFF]
. -
TIMESTAMP
- The correspondingString
parameter value is sent as an object ofTIMESTAMP
type to the database. The accepted format isYYYY-MM-DD HH:MM:SS[.FFF]
. -
UUID
- The correspondingString
parameter value is sent as an object ofUUID
type to the database.
-
- See Also:
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SqlParameter.Builder,
SqlParameter> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-