Class SqlParameter
- java.lang.Object
-
- software.amazon.awssdk.services.rdsdata.model.SqlParameter
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<SqlParameter.Builder,SqlParameter>
@Generated("software.amazon.awssdk:codegen") public final class SqlParameter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SqlParameter.Builder,SqlParameter>
A parameter used in a SQL statement.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSqlParameter.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SqlParameter.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringname()The name of the parameter.List<SdkField<?>>sdkFields()static Class<? extends SqlParameter.Builder>serializableBuilderClass()SqlParameter.BuildertoBuilder()StringtoString()Returns a string representation of this object.TypeHinttypeHint()A hint that specifies the correct object type for data type mapping.StringtypeHintAsString()A hint that specifies the correct object type for data type mapping.Fieldvalue()The value of the parameter.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final String name()
The name of the parameter.
- Returns:
- The name of the parameter.
-
value
public final Field value()
The value of the parameter.
- Returns:
- The value of the parameter.
-
typeHint
public final TypeHint typeHint()
A hint that specifies the correct object type for data type mapping. Possible values are as follows:
-
DATE- The correspondingStringparameter value is sent as an object ofDATEtype to the database. The accepted format isYYYY-MM-DD. -
DECIMAL- The correspondingStringparameter value is sent as an object ofDECIMALtype to the database. -
JSON- The correspondingStringparameter value is sent as an object ofJSONtype to the database. -
TIME- The correspondingStringparameter value is sent as an object ofTIMEtype to the database. The accepted format isHH:MM:SS[.FFF]. -
TIMESTAMP- The correspondingStringparameter value is sent as an object ofTIMESTAMPtype to the database. The accepted format isYYYY-MM-DD HH:MM:SS[.FFF]. -
UUID- The correspondingStringparameter value is sent as an object ofUUIDtype to the database.
If the service returns an enum value that is not available in the current SDK version,
typeHintwill 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 correspondingStringparameter value is sent as an object ofDATEtype to the database. The accepted format isYYYY-MM-DD. -
DECIMAL- The correspondingStringparameter value is sent as an object ofDECIMALtype to the database. -
JSON- The correspondingStringparameter value is sent as an object ofJSONtype to the database. -
TIME- The correspondingStringparameter value is sent as an object ofTIMEtype to the database. The accepted format isHH:MM:SS[.FFF]. -
TIMESTAMP- The correspondingStringparameter value is sent as an object ofTIMESTAMPtype to the database. The accepted format isYYYY-MM-DD HH:MM:SS[.FFF]. -
UUID- The correspondingStringparameter value is sent as an object ofUUIDtype to the database.
-
- See Also:
TypeHint
-
-
typeHintAsString
public final String typeHintAsString()
A hint that specifies the correct object type for data type mapping. Possible values are as follows:
-
DATE- The correspondingStringparameter value is sent as an object ofDATEtype to the database. The accepted format isYYYY-MM-DD. -
DECIMAL- The correspondingStringparameter value is sent as an object ofDECIMALtype to the database. -
JSON- The correspondingStringparameter value is sent as an object ofJSONtype to the database. -
TIME- The correspondingStringparameter value is sent as an object ofTIMEtype to the database. The accepted format isHH:MM:SS[.FFF]. -
TIMESTAMP- The correspondingStringparameter value is sent as an object ofTIMESTAMPtype to the database. The accepted format isYYYY-MM-DD HH:MM:SS[.FFF]. -
UUID- The correspondingStringparameter value is sent as an object ofUUIDtype to the database.
If the service returns an enum value that is not available in the current SDK version,
typeHintwill 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 correspondingStringparameter value is sent as an object ofDATEtype to the database. The accepted format isYYYY-MM-DD. -
DECIMAL- The correspondingStringparameter value is sent as an object ofDECIMALtype to the database. -
JSON- The correspondingStringparameter value is sent as an object ofJSONtype to the database. -
TIME- The correspondingStringparameter value is sent as an object ofTIMEtype to the database. The accepted format isHH:MM:SS[.FFF]. -
TIMESTAMP- The correspondingStringparameter value is sent as an object ofTIMESTAMPtype to the database. The accepted format isYYYY-MM-DD HH:MM:SS[.FFF]. -
UUID- The correspondingStringparameter value is sent as an object ofUUIDtype to the database.
-
- See Also:
TypeHint
-
-
toBuilder
public SqlParameter.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SqlParameter.Builder,SqlParameter>
-
builder
public static SqlParameter.Builder builder()
-
serializableBuilderClass
public static Class<? extends SqlParameter.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final 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.
-
-