Package software.amazon.awssdk.services.athena.model

Class QueryStage

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

Stage statistics such as input and output rows and bytes, execution time and stage state. This information also includes substages and the query stage plan.

See Also:

  • Method Details

    • stageId

      public final Long stageId()

      The identifier for a stage.

      Returns:
      The identifier for a stage.

    • state

      public final String state()

      State of the stage after query execution.

      Returns:
      State of the stage after query execution.

    • outputBytes

      public final Long outputBytes()

      The number of bytes output from the stage after execution.

      Returns:
      The number of bytes output from the stage after execution.

    • outputRows

      public final Long outputRows()

      The number of rows output from the stage after execution.

      Returns:
      The number of rows output from the stage after execution.

    • inputBytes

      public final Long inputBytes()

      The number of bytes input into the stage for execution.

      Returns:
      The number of bytes input into the stage for execution.

    • inputRows

      public final Long inputRows()

      The number of rows input into the stage for execution.

      Returns:
      The number of rows input into the stage for execution.

    • executionTime

      public final Long executionTime()

      Time taken to execute this stage.

      Returns:
      Time taken to execute this stage.

    • queryStagePlan

      public final QueryStagePlanNode queryStagePlan()

      Stage plan information such as name, identifier, sub plans, and source stages.

      Returns:
      Stage plan information such as name, identifier, sub plans, and source stages.

    • hasSubStages

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

    • subStages

      public final List<QueryStage> subStages()

      List of sub query stages that form this stage execution plan.

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

      Returns:
      List of sub query stages that form this stage execution plan.

    • toBuilder

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

    • builder

      public static QueryStage.Builder builder()

    • serializableBuilderClass

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