com.amazonaws.services.forecast.model

Class ExplainabilityConfig

java.lang.Object

com.amazonaws.services.forecast.model.ExplainabilityConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ExplainabilityConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExplainabilityConfig()

Method Summary

Modifier and Type	Method and Description
ExplainabilityConfig	clone()
boolean	equals(Object obj)
String	getTimePointGranularity() To create an Explainability for all time points in your forecast horizon, use ALL.
String	getTimeSeriesGranularity() To create an Explainability for all time series in your datasets, use ALL.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setTimePointGranularity(String timePointGranularity) To create an Explainability for all time points in your forecast horizon, use ALL.
void	setTimeSeriesGranularity(String timeSeriesGranularity) To create an Explainability for all time series in your datasets, use ALL.
String	toString() Returns a string representation of this object.
ExplainabilityConfig	withTimePointGranularity(String timePointGranularity) To create an Explainability for all time points in your forecast horizon, use ALL.
ExplainabilityConfig	withTimePointGranularity(TimePointGranularity timePointGranularity) To create an Explainability for all time points in your forecast horizon, use ALL.
ExplainabilityConfig	withTimeSeriesGranularity(String timeSeriesGranularity) To create an Explainability for all time series in your datasets, use ALL.
ExplainabilityConfig	withTimeSeriesGranularity(TimeSeriesGranularity timeSeriesGranularity) To create an Explainability for all time series in your datasets, use ALL.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExplainabilityConfig

public ExplainabilityConfig()

Method Detail

setTimeSeriesGranularity

public void setTimeSeriesGranularity(String 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.

Parameters:

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.

See Also:

TimeSeriesGranularity

getTimeSeriesGranularity

public String getTimeSeriesGranularity()

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.

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

withTimeSeriesGranularity

public ExplainabilityConfig withTimeSeriesGranularity(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TimeSeriesGranularity

withTimeSeriesGranularity

public ExplainabilityConfig withTimeSeriesGranularity(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TimeSeriesGranularity

setTimePointGranularity

public void setTimePointGranularity(String 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.

Parameters:

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.

See Also:

TimePointGranularity

getTimePointGranularity

public String getTimePointGranularity()

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.

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

withTimePointGranularity

public ExplainabilityConfig withTimePointGranularity(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TimePointGranularity

withTimePointGranularity

public ExplainabilityConfig withTimePointGranularity(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TimePointGranularity

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ExplainabilityConfig clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.