Class ExecuteSqlRequest

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.ExecuteSqlRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ExecuteSqlRequest.Builder,ExecuteSqlRequest>
@Generated("software.amazon.awssdk:codegen") public final class ExecuteSqlRequest extends RdsDataRequest implements ToCopyableBuilder<ExecuteSqlRequest.Builder,ExecuteSqlRequest>

The request parameters represent the input of a request to run one or more SQL statements.

  • Method Details

    • dbClusterOrInstanceArn

      public final String dbClusterOrInstanceArn()

      The ARN of the Aurora Serverless DB cluster.

      Returns:
      The ARN of the Aurora Serverless DB cluster.

    • awsSecretStoreArn

      public final String awsSecretStoreArn()

      The Amazon Resource Name (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 Amazon Resource Name (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.

    • sqlStatements

      public final String sqlStatements()

      One or more SQL statements to run on the DB cluster.

      You can separate SQL statements from each other with a semicolon (;). Any valid SQL statement is permitted, including data definition, data manipulation, and commit statements.

      Returns:
      One or more SQL statements to run on the DB cluster.

      You can separate SQL statements from each other with a semicolon (;). Any valid SQL statement is permitted, including data definition, data manipulation, and commit statements.

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

      Returns:
      The name of the database schema.

    • toBuilder

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

    • builder

      public static ExecuteSqlRequest.Builder builder()

    • serializableBuilderClass

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