software.amazon.awssdk.services.athena.model

Class ListCalculationExecutionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.athena.model.AthenaRequest

software.amazon.awssdk.services.athena.model.ListCalculationExecutionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListCalculationExecutionsRequest.Builder,ListCalculationExecutionsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListCalculationExecutionsRequest
extends AthenaRequest
implements ToCopyableBuilder<ListCalculationExecutionsRequest.Builder,ListCalculationExecutionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListCalculationExecutionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListCalculationExecutionsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults() The maximum number of calculation executions to return.
String	nextToken() A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.
List<SdkField<?>>	sdkFields()
static Class<? extends ListCalculationExecutionsRequest.Builder>	serializableBuilderClass()
String	sessionId() The session ID.
CalculationExecutionState	stateFilter() A filter for a specific calculation execution state.
String	stateFilterAsString() A filter for a specific calculation execution state.
ListCalculationExecutionsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

sessionId

public final String sessionId()

The session ID.

Returns:

The session ID.

stateFilter

public final CalculationExecutionState stateFilter()

A filter for a specific calculation execution state. A description of each state follows.

CREATING - The calculation is in the process of being created.

CREATED - The calculation has been created and is ready to run.

QUEUED - The calculation has been queued for processing.

RUNNING - The calculation is running.

CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

CANCELED - The calculation is no longer running as the result of a cancel request.

COMPLETED - The calculation has completed without error.

FAILED - The calculation failed and is no longer running.

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

Returns:

A filter for a specific calculation execution state. A description of each state follows.

CREATING - The calculation is in the process of being created.

CREATED - The calculation has been created and is ready to run.

QUEUED - The calculation has been queued for processing.

RUNNING - The calculation is running.

CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

CANCELED - The calculation is no longer running as the result of a cancel request.

COMPLETED - The calculation has completed without error.

FAILED - The calculation failed and is no longer running.

See Also:

CalculationExecutionState

stateFilterAsString

public final String stateFilterAsString()

A filter for a specific calculation execution state. A description of each state follows.

CREATING - The calculation is in the process of being created.

CREATED - The calculation has been created and is ready to run.

QUEUED - The calculation has been queued for processing.

RUNNING - The calculation is running.

CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

CANCELED - The calculation is no longer running as the result of a cancel request.

COMPLETED - The calculation has completed without error.

FAILED - The calculation failed and is no longer running.

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

Returns:

A filter for a specific calculation execution state. A description of each state follows.

CREATING - The calculation is in the process of being created.

CREATED - The calculation has been created and is ready to run.

QUEUED - The calculation has been queued for processing.

RUNNING - The calculation is running.

CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

CANCELED - The calculation is no longer running as the result of a cancel request.

COMPLETED - The calculation has completed without error.

FAILED - The calculation failed and is no longer running.

See Also:

CalculationExecutionState

maxResults

public final Integer maxResults()

The maximum number of calculation executions to return.

Returns:

The maximum number of calculation executions to return.

nextToken

public final String nextToken()

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Returns:

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

toBuilder

public ListCalculationExecutionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListCalculationExecutionsRequest.Builder,ListCalculationExecutionsRequest>

Specified by:

toBuilder in class AthenaRequest

builder

public static ListCalculationExecutionsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo