Class DescribeExplainabilityResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeExplainabilityResponse.Builder,
DescribeExplainabilityResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
When the Explainability resource was created.final DataSource
Returns the value of the DataSource property for this object.final Boolean
Whether the visualization was enabled for the Explainability resource.final String
IfTimePointGranularity
is set toSPECIFIC
, the last time point in the Explainability.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Long
The estimated time remaining in minutes for the CreateExplainability job to complete.final String
The Amazon Resource Name (ARN) of the Explainability.final ExplainabilityConfig
The configuration settings that define the granularity of time series and time points for the Explainability.final String
The name of the Explainability.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final Instant
The last time the resource was modified.final String
message()
If an error occurred, a message about the error.final String
The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.final Schema
schema()
Returns the value of the Schema property for this object.static Class
<? extends DescribeExplainabilityResponse.Builder> final String
IfTimePointGranularity
is set toSPECIFIC
, the first time point in the Explainability.final String
status()
The status of the Explainability resource.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 class software.amazon.awssdk.services.forecast.model.ForecastResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
explainabilityArn
The Amazon Resource Name (ARN) of the Explainability.
- Returns:
- The Amazon Resource Name (ARN) of the Explainability.
-
explainabilityName
The name of the Explainability.
- Returns:
- The name of the Explainability.
-
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
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
Whether the visualization was enabled for the Explainability resource.
- Returns:
- Whether the visualization was enabled for the Explainability resource.
-
dataSource
Returns the value of the DataSource property for this object.- Returns:
- The value of the DataSource property for this object.
-
schema
Returns the value of the Schema property for this object.- Returns:
- The value of the Schema property for this object.
-
startDateTime
If
TimePointGranularity
is set toSPECIFIC
, the first time point in the Explainability.- Returns:
- If
TimePointGranularity
is set toSPECIFIC
, the first time point in the Explainability.
-
endDateTime
If
TimePointGranularity
is set toSPECIFIC
, the last time point in the Explainability.- Returns:
- If
TimePointGranularity
is set toSPECIFIC
, the last time point in the Explainability.
-
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
If an error occurred, a message about the error.
- Returns:
- If an error occurred, a message about the error.
-
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
When the Explainability resource was created.
- Returns:
- When the Explainability resource was created.
-
lastModificationTime
The last time the resource was modified. The timestamp depends on the status of the job:
-
CREATE_PENDING
- TheCreationTime
. -
CREATE_IN_PROGRESS
- The current timestamp. -
CREATE_STOPPING
- The current timestamp. -
CREATE_STOPPED
- When the job stopped. -
ACTIVE
orCREATE_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
- TheCreationTime
. -
CREATE_IN_PROGRESS
- The current timestamp. -
CREATE_STOPPING
- The current timestamp. -
CREATE_STOPPED
- When the job stopped. -
ACTIVE
orCREATE_FAILED
- When the job finished or failed.
-
-
-
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<DescribeExplainabilityResponse.Builder,
DescribeExplainabilityResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-