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

Class DescribeExplainabilityResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.forecast.model.ForecastResponse

software.amazon.awssdk.services.forecast.model.DescribeExplainabilityResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeExplainabilityResponse.Builder,DescribeExplainabilityResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeExplainabilityResponse
extends ForecastResponse
implements ToCopyableBuilder<DescribeExplainabilityResponse.Builder,DescribeExplainabilityResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeExplainabilityResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeExplainabilityResponse.Builder	builder()
Instant	creationTime()	When the Explainability resource was created.
DataSource	dataSource()	Returns the value of the DataSource property for this object.
Boolean	enableVisualization()	Whether the visualization was enabled for the Explainability resource.
String	endDateTime()	If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Long	estimatedTimeRemainingInMinutes()	The estimated time remaining in minutes for the CreateExplainability job to complete.
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()	If an error occurred, a message about the error.
String	resourceArn()	The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.
Schema	schema()	Returns the value of the Schema property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeExplainabilityResponse.Builder>	serializableBuilderClass()
String	startDateTime()	If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.
String	status()	The status of the Explainability resource.
DescribeExplainabilityResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.forecast.model.ForecastResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 resource.

Returns:

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

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.

enableVisualization

public final Boolean enableVisualization()

Whether the visualization was enabled for the Explainability resource.

Returns:

Whether the visualization was enabled for the Explainability resource.

dataSource

public final DataSource dataSource()

Returns the value of the DataSource property for this object.

Returns:

The value of the DataSource property for this object.

schema

public final Schema schema()

Returns the value of the Schema property for this object.

Returns:

The value of the Schema property for this object.

startDateTime

public final String startDateTime()

If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.

Returns:

If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.

endDateTime

public final String endDateTime()

If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.

Returns:

If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.

estimatedTimeRemainingInMinutes

public final Long estimatedTimeRemainingInMinutes()

The estimated time remaining in minutes for the CreateExplainability job to complete.

Returns:

The estimated time remaining in minutes for the CreateExplainability job to complete.

message

public final String message()

If an error occurred, a message about the error.

Returns:

If an error occurred, a message about the error.

status

public final String status()

The status of the Explainability resource. 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 resource. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• CREATE_STOPPING, CREATE_STOPPED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

creationTime

public final Instant creationTime()

When the Explainability resource was created.

Returns:

When the Explainability resource 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 DescribeExplainabilityResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeExplainabilityResponse.Builder,DescribeExplainabilityResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeExplainabilityResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo