Class ExecuteStatementRequest

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

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

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

      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.

    • resultFormat

      public final ResultFormatString resultFormat()

      The data format of the result of the SQL statement. If no format is specified, the default is JSON.

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

      Returns:
      The data format of the result of the SQL statement. If no format is specified, the default is JSON.
      See Also:

    • resultFormatAsString

      public final String resultFormatAsString()

      The data format of the result of the SQL statement. If no format is specified, the default is JSON.

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

      Returns:
      The data format of the result of the SQL statement. If no format is specified, the default is JSON.
      See Also:

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

    • sessionId

      public final String sessionId()

      The session identifier of the query.

      Returns:
      The session identifier of the query.

    • sessionKeepAliveSeconds

      public final Integer sessionKeepAliveSeconds()

      The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.

      Returns:
      The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.

    • sql

      public final String sql()

      The SQL statement text to run.

      Returns:
      The SQL statement text to run.

    • statementName

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

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

      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

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