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>

  • Method Details

    • 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()
      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 interface ToCopyableBuilder<DescribeExplainabilityResponse.Builder,DescribeExplainabilityResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.