com.amazonaws.services.redshiftdataapi.model

Class ExecuteStatementRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.redshiftdataapi.model.ExecuteStatementRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ExecuteStatementRequest
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
ExecuteStatementRequest()

Method Summary

Modifier and Type	Method and Description
ExecuteStatementRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
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.
String	getSql() The SQL statement text to run.
String	getStatementName() The name of the SQL statement.
Boolean	getWithEvent() A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.
int	hashCode()
Boolean	isWithEvent() A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.
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	setSql(String sql) The SQL statement text to run.
void	setStatementName(String statementName) The name of the SQL statement.
void	setWithEvent(Boolean withEvent) A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.
String	toString() Returns a string representation of this object.
ExecuteStatementRequest	withClusterIdentifier(String clusterIdentifier) The cluster identifier.
ExecuteStatementRequest	withDatabase(String database) The name of the database.
ExecuteStatementRequest	withDbUser(String dbUser) The database user name.
ExecuteStatementRequest	withSecretArn(String secretArn) The name or ARN of the secret that enables access to the database.
ExecuteStatementRequest	withSql(String sql) The SQL statement text to run.
ExecuteStatementRequest	withStatementName(String statementName) The name of the SQL statement.
ExecuteStatementRequest	withWithEvent(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 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

ExecuteStatementRequest

public ExecuteStatementRequest()

Method Detail

setClusterIdentifier

public void setClusterIdentifier(String clusterIdentifier)

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

Parameters:

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

getClusterIdentifier

public String getClusterIdentifier()

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.

withClusterIdentifier

public ExecuteStatementRequest withClusterIdentifier(String clusterIdentifier)

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

Parameters:

clusterIdentifier - The cluster identifier. This parameter is required when authenticating using either AWS 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 temporary credentials.

Parameters:

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

getDatabase

public String getDatabase()

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.

withDatabase

public ExecuteStatementRequest withDatabase(String database)

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

Parameters:

database - The name of the database. This parameter is required when authenticating using 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 authenticating using temporary credentials.

Parameters:

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

getDbUser

public String getDbUser()

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.

withDbUser

public ExecuteStatementRequest withDbUser(String dbUser)

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

Parameters:

dbUser - The database user name. This parameter is required when 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 AWS Secrets Manager.

Parameters:

secretArn - The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS 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 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.

withSecretArn

public ExecuteStatementRequest withSecretArn(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.

Parameters:

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:

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

setSql

public void setSql(String sql)

The SQL statement text to run.

Parameters:

sql - The SQL statement text to run.

getSql

public String getSql()

The SQL statement text to run.

Returns:

The SQL statement text to run.

withSql

public ExecuteStatementRequest withSql(String sql)

The SQL statement text to run.

Parameters:

sql - The SQL statement text to run.

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 statement. You can name the SQL statement when you create it to identify the query.

Parameters:

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

getStatementName

public String getStatementName()

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.

withStatementName

public ExecuteStatementRequest withStatementName(String statementName)

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

Parameters:

statementName - The name of the SQL statement. You can name the SQL statement when you create it 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 statement runs.

Parameters:

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

getWithEvent

public Boolean getWithEvent()

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.

withWithEvent

public ExecuteStatementRequest withWithEvent(Boolean withEvent)

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

Parameters:

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

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 statement runs.

Returns:

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

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 ExecuteStatementRequest 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()