Class CalculationStatus
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CalculationStatus.Builder,
CalculationStatus>
Contains information about the status of a notebook calculation.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CalculationStatus.Builder
builder()
final Instant
The date and time the calculation completed processing.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends CalculationStatus.Builder> state()
The state of the calculation execution.final String
The state of the calculation execution.final String
The reason for the calculation state change (for example, the calculation was canceled because the session was terminated).final Instant
The date and time the calculation was submitted for processing.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
submissionDateTime
The date and time the calculation was submitted for processing.
- Returns:
- The date and time the calculation was submitted for processing.
-
completionDateTime
The date and time the calculation completed processing.
- Returns:
- The date and time the calculation completed processing.
-
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 returnCalculationExecutionState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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:
-
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 returnCalculationExecutionState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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:
-
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
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 interfaceToCopyableBuilder<CalculationStatus.Builder,
CalculationStatus> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-