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

Class QueryStagePlanNode

java.lang.Object

software.amazon.awssdk.services.athena.model.QueryStagePlanNode

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<QueryStagePlanNode.Builder,QueryStagePlanNode>

@Generated("software.amazon.awssdk:codegen")
public final class QueryStagePlanNode
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<QueryStagePlanNode.Builder,QueryStagePlanNode>

Stage plan information such as name, identifier, sub plans, and remote sources.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QueryStagePlanNode.Builder

Method Summary

Modifier and Type	Method	Description
static QueryStagePlanNode.Builder	builder()
List<QueryStagePlanNode>	children()	Stage plan information such as name, identifier, sub plans, and remote sources of child plan nodes/
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasChildren()	For responses, this returns true if the service returned a value for the Children property.
int	hashCode()
boolean	hasRemoteSources()	For responses, this returns true if the service returned a value for the RemoteSources property.
String	identifier()	Information about the operation this query stage plan node is performing.
String	name()	Name of the query stage plan that describes the operation this stage is performing as part of query execution.
List<String>	remoteSources()	Source plan node IDs.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends QueryStagePlanNode.Builder>	serializableBuilderClass()
QueryStagePlanNode.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

name

public final String name()

Name of the query stage plan that describes the operation this stage is performing as part of query execution.

Returns:

Name of the query stage plan that describes the operation this stage is performing as part of query execution.

identifier

public final String identifier()

Information about the operation this query stage plan node is performing.

Returns:

Information about the operation this query stage plan node is performing.

hasChildren

public final boolean hasChildren()

For responses, this returns true if the service returned a value for the Children 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.

children

public final List<QueryStagePlanNode> children()

Stage plan information such as name, identifier, sub plans, and remote sources of child plan nodes/

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

Returns:

Stage plan information such as name, identifier, sub plans, and remote sources of child plan nodes/

hasRemoteSources

public final boolean hasRemoteSources()

For responses, this returns true if the service returned a value for the RemoteSources 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.

remoteSources

public final List<String> remoteSources()

Source plan node IDs.

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

Returns:

Source plan node IDs.

toBuilder

public QueryStagePlanNode.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryStagePlanNode.Builder,QueryStagePlanNode>

builder

public static QueryStagePlanNode.Builder builder()

serializableBuilderClass

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