software.amazon.awssdk.services.redshiftdata.model

Class ExecuteStatementRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.redshiftdata.model.RedshiftDataRequest

software.amazon.awssdk.services.redshiftdata.model.ExecuteStatementRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ExecuteStatementRequest
extends RedshiftDataRequest
implements ToCopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExecuteStatementRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ExecuteStatementRequest.Builder	builder()
String	clusterIdentifier() The cluster identifier.
String	database() The name of the database.
String	dbUser() The database user name.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParameters() Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<SqlParameter>	parameters() The parameters for the SQL statement.
List<SdkField<?>>	sdkFields()
String	secretArn() The name or ARN of the secret that enables access to the database.
static Class<? extends ExecuteStatementRequest.Builder>	serializableBuilderClass()
String	sql() The SQL statement text to run.
String	statementName() The name of the SQL statement.
ExecuteStatementRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Boolean	withEvent() A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

clusterIdentifier

public final String clusterIdentifier()

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Returns:

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

database

public final String database()

The name of the database. This parameter is required when authenticating using temporary credentials.

Returns:

The name of the database. This parameter is required when authenticating using temporary credentials.

dbUser

public final String dbUser()

The database user name. This parameter is required when authenticating using temporary credentials.

Returns:

The database user name. This parameter is required when authenticating using temporary credentials.

hasParameters

public final boolean hasParameters()

Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

parameters

public final List<SqlParameter> parameters()

The parameters for the SQL statement.

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

You can use hasParameters() to see if a value was sent in this field.

Returns:

The parameters for the SQL statement.

secretArn

public final String secretArn()

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Returns:

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

sql

public final String sql()

The SQL statement text to run.

Returns:

The SQL statement text to run.

statementName

public final String statementName()

The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

Returns:

The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

withEvent

public final Boolean withEvent()

A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.

Returns:

A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.

toBuilder

public ExecuteStatementRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>

Specified by:

toBuilder in class RedshiftDataRequest

builder

public static ExecuteStatementRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo