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 interface	SqlParameter.Builder

Method Summary

Modifier and Type	Method	Description
static SqlParameter.Builder	builder()
final boolean	equals(Object obj)
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.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends SqlParameter.Builder>	serializableBuilderClass()
SqlParameter.Builder	toBuilder()	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	typeHintAsString()	A hint that specifies the correct object type for data type mapping.
final Field	value()	The value of the parameter.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

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 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.

If the service returns an enum value that is not available in the current SDK version, typeHint will return TypeHint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeHintAsString().

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

typeHintAsString

public final String typeHintAsString()

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.

If the service returns an enum value that is not available in the current SDK version, typeHint will return TypeHint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeHintAsString().

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

toBuilder

public SqlParameter.Builder 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 interface ToCopyableBuilder<SqlParameter.Builder,SqlParameter>

Returns:

a builder for type T

builder

public static SqlParameter.Builder builder()

serializableBuilderClass

public static Class<? extends SqlParameter.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
 Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.