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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QueryStage.Builder

Method Summary

Modifier and Type	Method	Description
static QueryStage.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Long	executionTime()	Time taken to execute this stage.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSubStages()	For responses, this returns true if the service returned a value for the SubStages property.
Long	inputBytes()	The number of bytes input into the stage for execution.
Long	inputRows()	The number of rows input into the stage for execution.
Long	outputBytes()	The number of bytes output from the stage after execution.
Long	outputRows()	The number of rows output from the stage after execution.
QueryStagePlanNode	queryStagePlan()	Stage plan information such as name, identifier, sub plans, and source stages.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends QueryStage.Builder>	serializableBuilderClass()
Long	stageId()	The identifier for a stage.
String	state()	State of the stage after query execution.
List<QueryStage>	subStages()	List of sub query stages that form this stage execution plan.
QueryStage.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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

Specified by:

toBuilder in interface ToCopyableBuilder<QueryStage.Builder,QueryStage>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo