Package software.amazon.awssdk.services.forecast.model

Class ExplainabilitySummary

java.lang.Object

software.amazon.awssdk.services.forecast.model.ExplainabilitySummary

All Implemented Interfaces:

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

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

Provides a summary of the Explainability properties used in the ListExplainabilities operation. To get a complete set of properties, call the DescribeExplainability operation, and provide the listed ExplainabilityArn.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExplainabilitySummary.Builder

Method Summary

Modifier and Type	Method	Description
static ExplainabilitySummary.Builder	builder()
Instant	creationTime()	When the Explainability was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	explainabilityArn()	The Amazon Resource Name (ARN) of the Explainability.
ExplainabilityConfig	explainabilityConfig()	The configuration settings that define the granularity of time series and time points for the Explainability.
String	explainabilityName()	The name of the Explainability.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModificationTime()	The last time the resource was modified.
String	message()	Information about any errors that may have occurred during the Explainability creation process.
String	resourceArn()	The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
List<SdkField<?>>	sdkFields()
static Class<? extends ExplainabilitySummary.Builder>	serializableBuilderClass()
String	status()	The status of the Explainability.
ExplainabilitySummary.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

explainabilityArn

public final String explainabilityArn()

The Amazon Resource Name (ARN) of the Explainability.

Returns:

The Amazon Resource Name (ARN) of the Explainability.

explainabilityName

public final String explainabilityName()

The name of the Explainability.

Returns:

The name of the Explainability.

resourceArn

public final String resourceArn()

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.

Returns:

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.

explainabilityConfig

public final ExplainabilityConfig explainabilityConfig()

The configuration settings that define the granularity of time series and time points for the Explainability.

Returns:

The configuration settings that define the granularity of time series and time points for the Explainability.

status

public final String status()

The status of the Explainability. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• CREATE_STOPPING, CREATE_STOPPED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Returns:

The status of the Explainability. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• CREATE_STOPPING, CREATE_STOPPED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

message

public final String message()

Information about any errors that may have occurred during the Explainability creation process.

Returns:

Information about any errors that may have occurred during the Explainability creation process.

creationTime

public final Instant creationTime()

When the Explainability was created.

Returns:

When the Explainability was created.

lastModificationTime

public final Instant lastModificationTime()

The last time the resource was modified. The timestamp depends on the status of the job:

• CREATE_PENDING - The CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• CREATE_STOPPING - The current timestamp.

• CREATE_STOPPED - When the job stopped.

• ACTIVE or CREATE_FAILED - When the job finished or failed.

Returns:

The last time the resource was modified. The timestamp depends on the status of the job:

• CREATE_PENDING - The CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• CREATE_STOPPING - The current timestamp.

• CREATE_STOPPED - When the job stopped.

• ACTIVE or CREATE_FAILED - When the job finished or failed.

toBuilder

public ExplainabilitySummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExplainabilitySummary.Builder,ExplainabilitySummary>

builder

public static ExplainabilitySummary.Builder builder()

serializableBuilderClass

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