Class ExecuteStatementRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ExecuteStatementRequest.Builder,
ExecuteStatementRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.final String
The cluster identifier.final String
database()
The name of the database.final String
dbUser()
The database user name.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Parameters property.final List
<SqlParameter> The parameters for the SQL statement.final String
The name or ARN of the secret that enables access to the database.static Class
<? extends ExecuteStatementRequest.Builder> final String
sql()
The SQL statement text to run.final String
The name of the SQL statement.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Boolean
A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.final String
The serverless workgroup name or Amazon Resource Name (ARN).Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
clientToken
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.
-
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
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
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.
-
hasParameters
public final boolean hasParameters()For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
parameters
The parameters for the 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
hasParameters()
method.- Returns:
- The parameters for the SQL statement.
-
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.
-
sql
The SQL statement text to run.
- Returns:
- The SQL statement text to run.
-
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
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.
-
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:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ExecuteStatementRequest.Builder,
ExecuteStatementRequest> - Specified by:
toBuilder
in classRedshiftDataRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-