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

Class CalculationStatus

java.lang.Object

software.amazon.awssdk.services.athena.model.CalculationStatus

All Implemented Interfaces:

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

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

Contains information about the status of a notebook calculation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CalculationStatus.Builder

Method Summary

Modifier and Type	Method	Description
static CalculationStatus.Builder	builder()
Instant	completionDateTime()	The date and time the calculation completed processing.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CalculationStatus.Builder>	serializableBuilderClass()
CalculationExecutionState	state()	The state of the calculation execution.
String	stateAsString()	The state of the calculation execution.
String	stateChangeReason()	The reason for the calculation state change (for example, the calculation was canceled because the session was terminated).
Instant	submissionDateTime()	The date and time the calculation was submitted for processing.
CalculationStatus.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

submissionDateTime

public final Instant submissionDateTime()

The date and time the calculation was submitted for processing.

Returns:

The date and time the calculation was submitted for processing.

completionDateTime

public final Instant completionDateTime()

The date and time the calculation completed processing.

Returns:

The date and time the calculation completed processing.

state

public final CalculationExecutionState state()

The state of the calculation execution. 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, state will return CalculationExecutionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the calculation execution. 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

stateAsString

public final String stateAsString()

The state of the calculation execution. 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, state will return CalculationExecutionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the calculation execution. 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

stateChangeReason

public final String stateChangeReason()

The reason for the calculation state change (for example, the calculation was canceled because the session was terminated).

Returns:

The reason for the calculation state change (for example, the calculation was canceled because the session was terminated).

toBuilder

public CalculationStatus.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CalculationStatus.Builder,CalculationStatus>

builder

public static CalculationStatus.Builder builder()

serializableBuilderClass

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