Class BatchExecuteStatementResponse

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

  • Method Details

    • id

      public final String id()

      The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment.

      Returns:
      The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment.

    • createdAt

      public final Instant createdAt()

      The date and time (UTC) the statement was created.

      Returns:
      The date and time (UTC) the statement was created.

    • clusterIdentifier

      public final String clusterIdentifier()

      The cluster identifier. This element is not returned when connecting to a serverless workgroup.

      Returns:
      The cluster identifier. This element is not returned when connecting to a serverless workgroup.

    • dbUser

      public final String dbUser()

      The database user name.

      Returns:
      The database user name.

    • hasDbGroups

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

    • dbGroups

      public final List<String> dbGroups()

      A list of colon (:) separated names of database groups.

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

      Returns:
      A list of colon (:) separated names of database groups.

    • database

      public final String database()

      The name of the database.

      Returns:
      The name of the database.

    • secretArn

      public final String secretArn()

      The name or ARN of the secret that enables access to the database.

      Returns:
      The name or ARN of the secret that enables access to the database.

    • workgroupName

      public final String workgroupName()

      The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.

      Returns:
      The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.

    • sessionId

      public final String sessionId()

      The session identifier of the query.

      Returns:
      The session identifier of the query.

    • status

      public final StatementStatusString status()

      The status of the SQL statement. Status values are defined as follows:

      • ABORTED - The query run was stopped by the user.

      • FAILED - The query run failed.

      • FINISHED - The query has finished running.

      • PICKED - The query has been chosen to be run.

      • STARTED - The query run has started.

      • SUBMITTED - The query was submitted, but not yet processed.

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

      Returns:
      The status of the SQL statement. Status values are defined as follows:

      • ABORTED - The query run was stopped by the user.

      • FAILED - The query run failed.

      • FINISHED - The query has finished running.

      • PICKED - The query has been chosen to be run.

      • STARTED - The query run has started.

      • SUBMITTED - The query was submitted, but not yet processed.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the SQL statement. Status values are defined as follows:

      • ABORTED - The query run was stopped by the user.

      • FAILED - The query run failed.

      • FINISHED - The query has finished running.

      • PICKED - The query has been chosen to be run.

      • STARTED - The query run has started.

      • SUBMITTED - The query was submitted, but not yet processed.

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

      Returns:
      The status of the SQL statement. Status values are defined as follows:

      • ABORTED - The query run was stopped by the user.

      • FAILED - The query run failed.

      • FINISHED - The query has finished running.

      • PICKED - The query has been chosen to be run.

      • STARTED - The query run has started.

      • SUBMITTED - The query was submitted, but not yet processed.

      See Also:

    • redshiftPid

      public final Long redshiftPid()

      The process identifier from Amazon Redshift.

      Returns:
      The process identifier from Amazon Redshift.

    • hasResultSet

      public final Boolean hasResultSet()

      A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. The value is true if any substatement returns a result set.

      Returns:
      A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. The value is true if any substatement returns a result set.

    • toBuilder

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

    • builder

      public static BatchExecuteStatementResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BatchExecuteStatementResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

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