software.amazon.awssdk.services.redshiftdata.model

Class BatchExecuteStatementRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchExecuteStatementRequest.Builder,BatchExecuteStatementRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchExecuteStatementRequest.Builder

Method Summary

Modifier and Type	Method and Description
static BatchExecuteStatementRequest.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	hasSqls() For responses, this returns true if the service returned a value for the Sqls property.
List<SdkField<?>>	sdkFields()
String	secretArn() The name or ARN of the secret that enables access to the database.
static Class<? extends BatchExecuteStatementRequest.Builder>	serializableBuilderClass()
List<String>	sqls() One or more SQL statements to run.
String	statementName() The name of the SQL statements.
BatchExecuteStatementRequest.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 statements run.

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 connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

Returns:

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

database

public final String database()

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

Returns:

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

dbUser

public final String dbUser()

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

Returns:

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

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

Returns:

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

hasSqls

public final boolean hasSqls()

For responses, this returns true if the service returned a value for the Sqls 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.

sqls

public final List<String> sqls()

One or more SQL statements to run.

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 hasSqls() method.

Returns:

One or more SQL statements to run.

statementName

public final String statementName()

The name of the SQL statements. You can name the SQL statements when you create them to identify the query.

Returns:

The name of the SQL statements. You can name the SQL statements when you create them 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 statements run.

Returns:

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

toBuilder

public BatchExecuteStatementRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchExecuteStatementRequest.Builder,BatchExecuteStatementRequest>

Specified by:

toBuilder in class RedshiftDataRequest

builder

public static BatchExecuteStatementRequest.Builder builder()

serializableBuilderClass

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