software.amazon.awssdk.services.redshiftdata.model

Class StatementData

java.lang.Object

software.amazon.awssdk.services.redshiftdata.model.StatementData

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class StatementData
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StatementData.Builder,StatementData>

The SQL statement to run.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StatementData.Builder

Method Summary

Modifier and Type	Method and Description
static StatementData.Builder	builder()
Instant	createdAt() The date and time (UTC) the statement was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasQueryParameters() For responses, this returns true if the service returned a value for the QueryParameters property.
boolean	hasQueryStrings() For responses, this returns true if the service returned a value for the QueryStrings property.
String	id() The SQL statement identifier.
Boolean	isBatchStatement() A value that indicates whether the statement is a batch query request.
List<SqlParameter>	queryParameters() The parameters used in a SQL statement.
String	queryString() The SQL statement.
List<String>	queryStrings() One or more SQL statements.
List<SdkField<?>>	sdkFields()
String	secretArn() The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
static Class<? extends StatementData.Builder>	serializableBuilderClass()
String	statementName() The name of the SQL statement.
StatusString	status() The status of the SQL statement.
String	statusAsString() The status of the SQL statement.
StatementData.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updatedAt() The date and time (UTC) that the statement metadata was last updated.

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

createdAt

public final Instant createdAt()

The date and time (UTC) the statement was created.

Returns:

The date and time (UTC) the statement was created.

id

public final String id()

The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

Returns:

The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

isBatchStatement

public final Boolean isBatchStatement()

A value that indicates whether the statement is a batch query request.

Returns:

A value that indicates whether the statement is a batch query request.

hasQueryParameters

public final boolean hasQueryParameters()

For responses, this returns true if the service returned a value for the QueryParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

queryParameters

public final List<SqlParameter> queryParameters()

The parameters used in a SQL statement.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasQueryParameters() method.

Returns:

The parameters used in a SQL statement.

queryString

public final String queryString()

The SQL statement.

Returns:

The SQL statement.

hasQueryStrings

public final boolean hasQueryStrings()

For responses, this returns true if the service returned a value for the QueryStrings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

queryStrings

public final List<String> queryStrings()

One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasQueryStrings() method.

Returns:

One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.

secretArn

public final String secretArn()

The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

Returns:

The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

statementName

public final String statementName()

The name of the SQL statement.

Returns:

The name of the SQL statement.

status

public final StatusString status()

The status of the SQL statement. An example is the that the SQL statement finished.

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

Returns:

The status of the SQL statement. An example is the that the SQL statement finished.

See Also:

StatusString

statusAsString

public final String statusAsString()

The status of the SQL statement. An example is the that the SQL statement finished.

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

Returns:

The status of the SQL statement. An example is the that the SQL statement finished.

See Also:

StatusString

updatedAt

public final Instant updatedAt()

The date and time (UTC) that the statement metadata was last updated.

Returns:

The date and time (UTC) that the statement metadata was last updated.

toBuilder

public StatementData.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StatementData.Builder,StatementData>

builder

public static StatementData.Builder builder()

serializableBuilderClass

public static Class<? extends StatementData.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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