Class ExplainabilityConfig

java.lang.Object
software.amazon.awssdk.services.forecast.model.ExplainabilityConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ExplainabilityConfig.Builder,ExplainabilityConfig>
@Generated("software.amazon.awssdk:codegen") public final class ExplainabilityConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ExplainabilityConfig.Builder,ExplainabilityConfig>

The ExplainabilityConfig data type defines the number of time series and time points included in CreateExplainability.

If you provide a predictor ARN for ResourceArn, you must set both TimePointGranularity and TimeSeriesGranularity to “ALL”. When creating Predictor Explainability, Amazon Forecast considers all time series and time points.

If you provide a forecast ARN for ResourceArn, you can set TimePointGranularity and TimeSeriesGranularity to either “ALL” or “Specific”.

See Also:

  • Method Details

    • timeSeriesGranularity

      public final TimeSeriesGranularity timeSeriesGranularity()

      To create an Explainability for all time series in your datasets, use ALL. To create an Explainability for specific time series in your datasets, use SPECIFIC.

      Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the DataDestination data type.

      If the service returns an enum value that is not available in the current SDK version, timeSeriesGranularity will return TimeSeriesGranularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeSeriesGranularityAsString().

      Returns:
      To create an Explainability for all time series in your datasets, use ALL. To create an Explainability for specific time series in your datasets, use SPECIFIC.

      Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the DataDestination data type.

      See Also:

    • timeSeriesGranularityAsString

      public final String timeSeriesGranularityAsString()

      To create an Explainability for all time series in your datasets, use ALL. To create an Explainability for specific time series in your datasets, use SPECIFIC.

      Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the DataDestination data type.

      If the service returns an enum value that is not available in the current SDK version, timeSeriesGranularity will return TimeSeriesGranularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeSeriesGranularityAsString().

      Returns:
      To create an Explainability for all time series in your datasets, use ALL. To create an Explainability for specific time series in your datasets, use SPECIFIC.

      Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the DataDestination data type.

      See Also:

    • timePointGranularity

      public final TimePointGranularity timePointGranularity()

      To create an Explainability for all time points in your forecast horizon, use ALL. To create an Explainability for specific time points in your forecast horizon, use SPECIFIC.

      Specify time points with the StartDateTime and EndDateTime parameters within the CreateExplainability operation.

      If the service returns an enum value that is not available in the current SDK version, timePointGranularity will return TimePointGranularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timePointGranularityAsString().

      Returns:
      To create an Explainability for all time points in your forecast horizon, use ALL. To create an Explainability for specific time points in your forecast horizon, use SPECIFIC.

      Specify time points with the StartDateTime and EndDateTime parameters within the CreateExplainability operation.

      See Also:

    • timePointGranularityAsString

      public final String timePointGranularityAsString()

      To create an Explainability for all time points in your forecast horizon, use ALL. To create an Explainability for specific time points in your forecast horizon, use SPECIFIC.

      Specify time points with the StartDateTime and EndDateTime parameters within the CreateExplainability operation.

      If the service returns an enum value that is not available in the current SDK version, timePointGranularity will return TimePointGranularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timePointGranularityAsString().

      Returns:
      To create an Explainability for all time points in your forecast horizon, use ALL. To create an Explainability for specific time points in your forecast horizon, use SPECIFIC.

      Specify time points with the StartDateTime and EndDateTime parameters within the CreateExplainability operation.

      See Also:

    • toBuilder

      public ExplainabilityConfig.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<ExplainabilityConfig.Builder,ExplainabilityConfig>
      Returns:
      a builder for type T

    • builder

      public static ExplainabilityConfig.Builder builder()

    • serializableBuilderClass

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

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