com.amazonaws.services.forecast.model

Class CreateWhatIfForecastExportRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.forecast.model.CreateWhatIfForecastExportRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateWhatIfForecastExportRequest
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
CreateWhatIfForecastExportRequest()

Method Summary

Modifier and Type	Method and Description
CreateWhatIfForecastExportRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
DataDestination	getDestination() The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location.
String	getFormat() The format of the exported data, CSV or PARQUET.
List<Tag>	getTags() A list of tags to apply to the what if forecast.
List<String>	getWhatIfForecastArns() The list of what-if forecast Amazon Resource Names (ARNs) to export.
String	getWhatIfForecastExportName() The name of the what-if forecast to export.
int	hashCode()
void	setDestination(DataDestination destination) The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location.
void	setFormat(String format) The format of the exported data, CSV or PARQUET.
void	setTags(Collection<Tag> tags) A list of tags to apply to the what if forecast.
void	setWhatIfForecastArns(Collection<String> whatIfForecastArns) The list of what-if forecast Amazon Resource Names (ARNs) to export.
void	setWhatIfForecastExportName(String whatIfForecastExportName) The name of the what-if forecast to export.
String	toString() Returns a string representation of this object.
CreateWhatIfForecastExportRequest	withDestination(DataDestination destination) The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location.
CreateWhatIfForecastExportRequest	withFormat(String format) The format of the exported data, CSV or PARQUET.
CreateWhatIfForecastExportRequest	withTags(Collection<Tag> tags) A list of tags to apply to the what if forecast.
CreateWhatIfForecastExportRequest	withTags(Tag... tags) A list of tags to apply to the what if forecast.
CreateWhatIfForecastExportRequest	withWhatIfForecastArns(Collection<String> whatIfForecastArns) The list of what-if forecast Amazon Resource Names (ARNs) to export.
CreateWhatIfForecastExportRequest	withWhatIfForecastArns(String... whatIfForecastArns) The list of what-if forecast Amazon Resource Names (ARNs) to export.
CreateWhatIfForecastExportRequest	withWhatIfForecastExportName(String whatIfForecastExportName) The name of the what-if forecast to export.

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

CreateWhatIfForecastExportRequest

public CreateWhatIfForecastExportRequest()

Method Detail

setWhatIfForecastExportName

public void setWhatIfForecastExportName(String whatIfForecastExportName)

The name of the what-if forecast to export.

Parameters:

whatIfForecastExportName - The name of the what-if forecast to export.

getWhatIfForecastExportName

public String getWhatIfForecastExportName()

The name of the what-if forecast to export.

Returns:

The name of the what-if forecast to export.

withWhatIfForecastExportName

public CreateWhatIfForecastExportRequest withWhatIfForecastExportName(String whatIfForecastExportName)

The name of the what-if forecast to export.

Parameters:

whatIfForecastExportName - The name of the what-if forecast to export.

Returns:

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

getWhatIfForecastArns

public List<String> getWhatIfForecastArns()

The list of what-if forecast Amazon Resource Names (ARNs) to export.

Returns:

The list of what-if forecast Amazon Resource Names (ARNs) to export.

setWhatIfForecastArns

public void setWhatIfForecastArns(Collection<String> whatIfForecastArns)

The list of what-if forecast Amazon Resource Names (ARNs) to export.

Parameters:

whatIfForecastArns - The list of what-if forecast Amazon Resource Names (ARNs) to export.

withWhatIfForecastArns

public CreateWhatIfForecastExportRequest withWhatIfForecastArns(String... whatIfForecastArns)

The list of what-if forecast Amazon Resource Names (ARNs) to export.

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

Parameters:

whatIfForecastArns - The list of what-if forecast Amazon Resource Names (ARNs) to export.

Returns:

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

withWhatIfForecastArns

public CreateWhatIfForecastExportRequest withWhatIfForecastArns(Collection<String> whatIfForecastArns)

The list of what-if forecast Amazon Resource Names (ARNs) to export.

Parameters:

whatIfForecastArns - The list of what-if forecast Amazon Resource Names (ARNs) to export.

Returns:

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

setDestination

public void setDestination(DataDestination destination)

The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, Destination must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

Parameters:

destination - The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, Destination must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

getDestination

public DataDestination getDestination()

The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, Destination must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

Returns:

The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, Destination must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

withDestination

public CreateWhatIfForecastExportRequest withDestination(DataDestination destination)

The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, Destination must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

Parameters:

destination - The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, Destination must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

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

setFormat

public void setFormat(String format)

The format of the exported data, CSV or PARQUET.

Parameters:

format - The format of the exported data, CSV or PARQUET.

getFormat

public String getFormat()

The format of the exported data, CSV or PARQUET.

Returns:

The format of the exported data, CSV or PARQUET.

withFormat

public CreateWhatIfForecastExportRequest withFormat(String format)

The format of the exported data, CSV or PARQUET.

Parameters:

format - The format of the exported data, CSV or PARQUET.

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 CreateWhatIfForecastExportRequest 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()