com.amazonaws.services.forecast.model

Class CreateWhatIfAnalysisRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.forecast.model.CreateWhatIfAnalysisRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateWhatIfAnalysisRequest()

Method Summary

Modifier and Type	Method and Description
CreateWhatIfAnalysisRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getForecastArn() The Amazon Resource Name (ARN) of the baseline forecast.
List<Tag>	getTags() A list of tags to apply to the what if forecast.
TimeSeriesSelector	getTimeSeriesSelector() Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object.
String	getWhatIfAnalysisName() The name of the what-if analysis.
int	hashCode()
void	setForecastArn(String forecastArn) The Amazon Resource Name (ARN) of the baseline forecast.
void	setTags(Collection<Tag> tags) A list of tags to apply to the what if forecast.
void	setTimeSeriesSelector(TimeSeriesSelector timeSeriesSelector) Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object.
void	setWhatIfAnalysisName(String whatIfAnalysisName) The name of the what-if analysis.
String	toString() Returns a string representation of this object.
CreateWhatIfAnalysisRequest	withForecastArn(String forecastArn) The Amazon Resource Name (ARN) of the baseline forecast.
CreateWhatIfAnalysisRequest	withTags(Collection<Tag> tags) A list of tags to apply to the what if forecast.
CreateWhatIfAnalysisRequest	withTags(Tag... tags) A list of tags to apply to the what if forecast.
CreateWhatIfAnalysisRequest	withTimeSeriesSelector(TimeSeriesSelector timeSeriesSelector) Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object.
CreateWhatIfAnalysisRequest	withWhatIfAnalysisName(String whatIfAnalysisName) The name of the what-if analysis.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateWhatIfAnalysisRequest

public CreateWhatIfAnalysisRequest()

Method Detail

setWhatIfAnalysisName

public void setWhatIfAnalysisName(String whatIfAnalysisName)

The name of the what-if analysis. Each name must be unique.

Parameters:

whatIfAnalysisName - The name of the what-if analysis. Each name must be unique.

getWhatIfAnalysisName

public String getWhatIfAnalysisName()

The name of the what-if analysis. Each name must be unique.

Returns:

The name of the what-if analysis. Each name must be unique.

withWhatIfAnalysisName

public CreateWhatIfAnalysisRequest withWhatIfAnalysisName(String whatIfAnalysisName)

The name of the what-if analysis. Each name must be unique.

Parameters:

whatIfAnalysisName - The name of the what-if analysis. Each name must be unique.

Returns:

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

setForecastArn

public void setForecastArn(String forecastArn)

The Amazon Resource Name (ARN) of the baseline forecast.

Parameters:

forecastArn - The Amazon Resource Name (ARN) of the baseline forecast.

getForecastArn

public String getForecastArn()

The Amazon Resource Name (ARN) of the baseline forecast.

Returns:

The Amazon Resource Name (ARN) of the baseline forecast.

withForecastArn

public CreateWhatIfAnalysisRequest withForecastArn(String forecastArn)

The Amazon Resource Name (ARN) of the baseline forecast.

Parameters:

forecastArn - The Amazon Resource Name (ARN) of the baseline forecast.

Returns:

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

setTimeSeriesSelector

public void setTimeSeriesSelector(TimeSeriesSelector timeSeriesSelector)

Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.

The TimeSeriesIdentifiers object needs the following information:

• DataSource

• Format

• Schema

Parameters:

timeSeriesSelector - Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.

The TimeSeriesIdentifiers object needs the following information:

• DataSource

• Format

• Schema

getTimeSeriesSelector

public TimeSeriesSelector getTimeSeriesSelector()

Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.

The TimeSeriesIdentifiers object needs the following information:

• DataSource

• Format

• Schema

Returns:

Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.

The TimeSeriesIdentifiers object needs the following information:

• DataSource

• Format

• Schema

withTimeSeriesSelector

public CreateWhatIfAnalysisRequest withTimeSeriesSelector(TimeSeriesSelector timeSeriesSelector)

Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.

The TimeSeriesIdentifiers object needs the following information:

• DataSource

• Format

• Schema

Parameters:

timeSeriesSelector - Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.

The TimeSeriesIdentifiers object needs the following information:

• DataSource

• Format

• Schema

Returns:

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

getTags

public List<Tag> getTags()

A list of tags to apply to the what if forecast.

Returns:

A list of tags to apply to the what if forecast.

setTags

public void setTags(Collection<Tag> tags)

A list of tags to apply to the what if forecast.

Parameters:

tags - A list of tags to apply to the what if forecast.

withTags

public CreateWhatIfAnalysisRequest withTags(Tag... tags)

A list of tags to apply to the what if forecast.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - A list of tags to apply to the what if forecast.

Returns:

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

withTags

public CreateWhatIfAnalysisRequest withTags(Collection<Tag> tags)

A list of tags to apply to the what if forecast.

Parameters:

tags - A list of tags to apply to the what if forecast.

Returns:

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

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 CreateWhatIfAnalysisRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()