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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExplainabilityConfig.Builder

Method Summary

Modifier and Type	Method	Description
static ExplainabilityConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ExplainabilityConfig.Builder>	serializableBuilderClass()
TimePointGranularity	timePointGranularity()	To create an Explainability for all time points in your forecast horizon, use ALL.
String	timePointGranularityAsString()	To create an Explainability for all time points in your forecast horizon, use ALL.
TimeSeriesGranularity	timeSeriesGranularity()	To create an Explainability for all time series in your datasets, use ALL.
String	timeSeriesGranularityAsString()	To create an Explainability for all time series in your datasets, use ALL.
ExplainabilityConfig.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

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:

TimeSeriesGranularity

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:

TimeSeriesGranularity

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:

TimePointGranularity

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:

TimePointGranularity

toBuilder

public ExplainabilityConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExplainabilityConfig.Builder,ExplainabilityConfig>

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)

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