Package software.amazon.awssdk.services.redshiftdata.model

Class StatementData

java.lang.Object
software.amazon.awssdk.services.redshiftdata.model.StatementData
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<StatementData.Builder,StatementData>
@Generated("software.amazon.awssdk:codegen") public final class StatementData extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StatementData.Builder,StatementData>

The SQL statement to run.

See Also:

  • Method Details

    • createdAt

      public final Instant createdAt()

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

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

    • id

      public final String id()

      The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

      Returns:
      The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

    • isBatchStatement

      public final Boolean isBatchStatement()

      A value that indicates whether the statement is a batch query request.

      Returns:
      A value that indicates whether the statement is a batch query request.

    • hasQueryParameters

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

    • queryParameters

      public final List<SqlParameter> queryParameters()

      The parameters used in a 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 hasQueryParameters() method.

      Returns:
      The parameters used in a SQL statement.

    • queryString

      public final String queryString()

      The SQL statement.

      Returns:
      The SQL statement.

    • hasQueryStrings

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

    • queryStrings

      public final List<String> queryStrings()

      One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.

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

      Returns:
      One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.

    • secretArn

      public final String secretArn()

      The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

      Returns:
      The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

    • statementName

      public final String statementName()

      The name of the SQL statement.

      Returns:
      The name of the SQL statement.

    • status

      public final StatusString status()

      The status of the SQL statement. An example is the that the SQL statement finished.

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

      Returns:
      The status of the SQL statement. An example is the that the SQL statement finished.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the SQL statement. An example is the that the SQL statement finished.

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

      Returns:
      The status of the SQL statement. An example is the that the SQL statement finished.
      See Also:

    • updatedAt

      public final Instant updatedAt()

      The date and time (UTC) that the statement metadata was last updated.

      Returns:
      The date and time (UTC) that the statement metadata was last updated.

    • toBuilder

      public StatementData.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<StatementData.Builder,StatementData>
      Returns:
      a builder for type T

    • builder

      public static StatementData.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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