Class ExecuteStatementRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.rdsdata.model.RdsDataRequest
software.amazon.awssdk.services.rdsdata.model.ExecuteStatementRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>
@Generated("software.amazon.awssdk:codegen") public final class ExecuteStatementRequest extends RdsDataRequest implements ToCopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>

The request parameters represent the input of a request to run a SQL statement against a database.

  • Method Details

    • resourceArn

      public final String resourceArn()

      The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

      Returns:
      The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

    • secretArn

      public final String secretArn()

      The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.

      For information about creating the secret, see Create a database secret.

      Returns:
      The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.

      For information about creating the secret, see Create a database secret.

    • sql

      public final String sql()

      The SQL statement to run.

      Returns:
      The SQL statement to run.

    • database

      public final String database()

      The name of the database.

      Returns:
      The name of the database.

    • schema

      public final String schema()

      The name of the database schema.

      Currently, the schema parameter isn't supported.

      Returns:
      The name of the database schema.

      Currently, the schema parameter isn't supported.

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

    • parameters

      public final List<SqlParameter> parameters()

      The parameters for the SQL statement.

      Array parameters are not supported.

      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.

      Array parameters are not supported.

    • transactionId

      public final String transactionId()

      The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.

      If the SQL statement is not part of a transaction, don't set this parameter.

      Returns:
      The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.

      If the SQL statement is not part of a transaction, don't set this parameter.

    • includeResultMetadata

      public final Boolean includeResultMetadata()

      A value that indicates whether to include metadata in the results.

      Returns:
      A value that indicates whether to include metadata in the results.

    • continueAfterTimeout

      public final Boolean continueAfterTimeout()

      A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out.

      For DDL statements, we recommend continuing to run the statement after the call times out. When a DDL statement terminates before it is finished running, it can result in errors and possibly corrupted data structures.

      Returns:
      A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out.

      For DDL statements, we recommend continuing to run the statement after the call times out. When a DDL statement terminates before it is finished running, it can result in errors and possibly corrupted data structures.

    • resultSetOptions

      public final ResultSetOptions resultSetOptions()

      Options that control how the result set is returned.

      Returns:
      Options that control how the result set is returned.

    • formatRecordsAs

      public final RecordsFormatType formatRecordsAs()

      A value that indicates whether to format the result set as a single JSON string. This parameter only applies to SELECT statements and is ignored for other types of statements. Allowed values are NONE and JSON. The default value is NONE. The result is returned in the formattedRecords field.

      For usage information about the JSON format for result sets, see Using the Data API in the Amazon Aurora User Guide.

      If the service returns an enum value that is not available in the current SDK version, formatRecordsAs will return RecordsFormatType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatRecordsAsAsString().

      Returns:
      A value that indicates whether to format the result set as a single JSON string. This parameter only applies to SELECT statements and is ignored for other types of statements. Allowed values are NONE and JSON. The default value is NONE. The result is returned in the formattedRecords field.

      For usage information about the JSON format for result sets, see Using the Data API in the Amazon Aurora User Guide.

      See Also:

    • formatRecordsAsAsString

      public final String formatRecordsAsAsString()

      A value that indicates whether to format the result set as a single JSON string. This parameter only applies to SELECT statements and is ignored for other types of statements. Allowed values are NONE and JSON. The default value is NONE. The result is returned in the formattedRecords field.

      For usage information about the JSON format for result sets, see Using the Data API in the Amazon Aurora User Guide.

      If the service returns an enum value that is not available in the current SDK version, formatRecordsAs will return RecordsFormatType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatRecordsAsAsString().

      Returns:
      A value that indicates whether to format the result set as a single JSON string. This parameter only applies to SELECT statements and is ignored for other types of statements. Allowed values are NONE and JSON. The default value is NONE. The result is returned in the formattedRecords field.

      For usage information about the JSON format for result sets, see Using the Data API in the Amazon Aurora User Guide.

      See Also:

    • toBuilder

      public ExecuteStatementRequest.Builder 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 interface ToCopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>
      Specified by:
      toBuilder in class RdsDataRequest
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.