software.amazon.awssdk.services.rdsdata.model

Class SqlParameter

java.lang.Object

software.amazon.awssdk.services.rdsdata.model.SqlParameter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SqlParameter.Builder,SqlParameter>

@Generated(value="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 and Description
static interface	SqlParameter.Builder

Method Summary

Modifier and Type	Method and Description
static SqlParameter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name of the parameter.
List<SdkField<?>>	sdkFields()
static Class<? extends SqlParameter.Builder>	serializableBuilderClass()
SqlParameter.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TypeHint	typeHint() A hint that specifies the correct object type for data type mapping.
String	typeHintAsString() A hint that specifies the correct object type for data type mapping.
Field	value() 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 String name()

The name of the parameter.

Returns:

The name of the parameter.

typeHint

public TypeHint typeHint()

A hint that specifies the correct object type for data type mapping.

Values:

• DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.

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

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

• DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.

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.

Values:

• DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.

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

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

• DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.

See Also:

TypeHint

typeHintAsString

public String typeHintAsString()

A hint that specifies the correct object type for data type mapping.

Values:

• DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.

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

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

• DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.

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.

Values:

• DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.

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

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

• DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.

See Also:

TypeHint

value

public Field value()

The value of the parameter.

Returns:

The value of the parameter.

toBuilder

public SqlParameter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SqlParameter.Builder,SqlParameter>

builder

public static SqlParameter.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo