Class BatchExecuteStatementRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<BatchExecuteStatementRequest.Builder,BatchExecuteStatementRequest>

@Generated("software.amazon.awssdk:codegen") public final class BatchExecuteStatementRequest extends RedshiftDataRequest implements ToCopyableBuilder<BatchExecuteStatementRequest.Builder,BatchExecuteStatementRequest>
  • Method Details

    • clientToken

      public final String 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

      public final String 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

      public final String 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

      public final String 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.
    • secretArn

      public final String 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.
    • hasSqls

      public final boolean hasSqls()
      For responses, this returns true if the service returned a value for the Sqls 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.
    • sqls

      public final List<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> 
       

      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 hasSqls() method.

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

      public final String statementName()

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

      public final Boolean withEvent()

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

      public final 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.

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

      public static BatchExecuteStatementRequest.Builder builder()
    • serializableBuilderClass

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