com.amazonaws.services.redshiftdataapi.model

Class BatchExecuteStatementRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.redshiftdataapi.model.BatchExecuteStatementRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchExecuteStatementRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
BatchExecuteStatementRequest()

Method Summary

Modifier and Type	Method and Description
BatchExecuteStatementRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	getClusterIdentifier() The cluster identifier.
String	getDatabase() The name of the database.
String	getDbUser() The database user name.
String	getSecretArn() The name or ARN of the secret that enables access to the database.
List<String>	getSqls() One or more SQL statements to run.
String	getStatementName() The name of the SQL statements.
Boolean	getWithEvent() A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.
String	getWorkgroupName() The serverless workgroup name or Amazon Resource Name (ARN).
int	hashCode()
Boolean	isWithEvent() A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.
void	setClientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setClusterIdentifier(String clusterIdentifier) The cluster identifier.
void	setDatabase(String database) The name of the database.
void	setDbUser(String dbUser) The database user name.
void	setSecretArn(String secretArn) The name or ARN of the secret that enables access to the database.
void	setSqls(Collection<String> sqls) One or more SQL statements to run.
void	setStatementName(String statementName) The name of the SQL statements.
void	setWithEvent(Boolean withEvent) A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.
void	setWorkgroupName(String workgroupName) The serverless workgroup name or Amazon Resource Name (ARN).
String	toString() Returns a string representation of this object.
BatchExecuteStatementRequest	withClientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
BatchExecuteStatementRequest	withClusterIdentifier(String clusterIdentifier) The cluster identifier.
BatchExecuteStatementRequest	withDatabase(String database) The name of the database.
BatchExecuteStatementRequest	withDbUser(String dbUser) The database user name.
BatchExecuteStatementRequest	withSecretArn(String secretArn) The name or ARN of the secret that enables access to the database.
BatchExecuteStatementRequest	withSqls(Collection<String> sqls) One or more SQL statements to run.
BatchExecuteStatementRequest	withSqls(String... sqls) One or more SQL statements to run.
BatchExecuteStatementRequest	withStatementName(String statementName) The name of the SQL statements.
BatchExecuteStatementRequest	withWithEvent(Boolean withEvent) A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.
BatchExecuteStatementRequest	withWorkgroupName(String workgroupName) The serverless workgroup name or Amazon Resource Name (ARN).

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BatchExecuteStatementRequest

public BatchExecuteStatementRequest()

Method Detail

setClientToken

public void setClientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

getClientToken

public String getClientToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

withClientToken

public BatchExecuteStatementRequest withClientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClusterIdentifier

public void setClusterIdentifier(String clusterIdentifier)

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

Parameters:

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

getClusterIdentifier

public String getClusterIdentifier()

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.

withClusterIdentifier

public BatchExecuteStatementRequest withClusterIdentifier(String clusterIdentifier)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDatabase

public void setDatabase(String database)

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

Parameters:

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

getDatabase

public String getDatabase()

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.

withDatabase

public BatchExecuteStatementRequest withDatabase(String database)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDbUser

public void setDbUser(String dbUser)

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

Parameters:

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

getDbUser

public String getDbUser()

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

Returns:

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

withDbUser

public BatchExecuteStatementRequest withDbUser(String dbUser)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setSecretArn

public void setSecretArn(String secretArn)

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

Parameters:

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

getSecretArn

public String getSecretArn()

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.

withSecretArn

public BatchExecuteStatementRequest withSecretArn(String secretArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getSqls

public List<String> getSqls()

One or more SQL statements to run.

  The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p> 
 

Returns:

One or more SQL statements to run.

 
          The SQL statements are run as a single transaction. They run serially in the order of the array.
         Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL
         statement fails, then because they are run as one transaction, all work is rolled back.</p> 

setSqls

public void setSqls(Collection<String> sqls)

One or more SQL statements to run.

  The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p> 
 

Parameters:

sqls - One or more SQL statements to run.

 
         The SQL statements are run as a single transaction. They run serially in the order of the array.
        Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL
        statement fails, then because they are run as one transaction, all work is rolled back.</p> 

withSqls

public BatchExecuteStatementRequest withSqls(String... sqls)

One or more SQL statements to run.

  The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p> 
 

NOTE: This method appends the values to the existing list (if any). Use setSqls(java.util.Collection) or withSqls(java.util.Collection) if you want to override the existing values.

Parameters:

sqls - One or more SQL statements to run.

  The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p> 

Returns:

Returns a reference to this object so that method calls can be chained together.

withSqls

public BatchExecuteStatementRequest withSqls(Collection<String> sqls)

One or more SQL statements to run.

  The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p> 
 

Parameters:

sqls - One or more SQL statements to run.

 
         The SQL statements are run as a single transaction. They run serially in the order of the array.
        Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL
        statement fails, then because they are run as one transaction, all work is rolled back.</p> 

Returns:

Returns a reference to this object so that method calls can be chained together.

setStatementName

public void setStatementName(String statementName)

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

Parameters:

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

getStatementName

public String getStatementName()

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.

withStatementName

public BatchExecuteStatementRequest withStatementName(String statementName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setWithEvent

public void setWithEvent(Boolean withEvent)

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

Parameters:

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

getWithEvent

public Boolean getWithEvent()

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.

withWithEvent

public BatchExecuteStatementRequest withWithEvent(Boolean withEvent)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isWithEvent

public Boolean isWithEvent()

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.

setWorkgroupName

public void setWorkgroupName(String workgroupName)

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Parameters:

workgroupName - The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

getWorkgroupName

public String getWorkgroupName()

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Returns:

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

withWorkgroupName

public BatchExecuteStatementRequest withWorkgroupName(String workgroupName)

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Parameters:

workgroupName - The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public BatchExecuteStatementRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()