@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateForecastRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
CreateForecastRequest() |
| Modifier and Type | Method and Description |
|---|---|
CreateForecastRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getForecastName()
A name for the forecast.
|
List<String> |
getForecastTypes()
The quantiles at which probabilistic forecasts are generated.
|
String |
getPredictorArn()
The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
|
List<Tag> |
getTags()
The optional metadata that you apply to the forecast to help you categorize and organize them.
|
TimeSeriesSelector |
getTimeSeriesSelector()
Defines the set of time series that are used to create the forecasts in a
TimeSeriesIdentifiers
object. |
int |
hashCode() |
void |
setForecastName(String forecastName)
A name for the forecast.
|
void |
setForecastTypes(Collection<String> forecastTypes)
The quantiles at which probabilistic forecasts are generated.
|
void |
setPredictorArn(String predictorArn)
The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
|
void |
setTags(Collection<Tag> tags)
The optional metadata that you apply to the forecast to help you categorize and organize them.
|
void |
setTimeSeriesSelector(TimeSeriesSelector timeSeriesSelector)
Defines the set of time series that are used to create the forecasts in a
TimeSeriesIdentifiers
object. |
String |
toString()
Returns a string representation of this object.
|
CreateForecastRequest |
withForecastName(String forecastName)
A name for the forecast.
|
CreateForecastRequest |
withForecastTypes(Collection<String> forecastTypes)
The quantiles at which probabilistic forecasts are generated.
|
CreateForecastRequest |
withForecastTypes(String... forecastTypes)
The quantiles at which probabilistic forecasts are generated.
|
CreateForecastRequest |
withPredictorArn(String predictorArn)
The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
|
CreateForecastRequest |
withTags(Collection<Tag> tags)
The optional metadata that you apply to the forecast to help you categorize and organize them.
|
CreateForecastRequest |
withTags(Tag... tags)
The optional metadata that you apply to the forecast to help you categorize and organize them.
|
CreateForecastRequest |
withTimeSeriesSelector(TimeSeriesSelector timeSeriesSelector)
Defines the set of time series that are used to create the forecasts in a
TimeSeriesIdentifiers
object. |
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, withSdkRequestTimeoutpublic void setForecastName(String forecastName)
A name for the forecast.
forecastName - A name for the forecast.public String getForecastName()
A name for the forecast.
public CreateForecastRequest withForecastName(String forecastName)
A name for the forecast.
forecastName - A name for the forecast.public void setPredictorArn(String predictorArn)
The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
predictorArn - The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.public String getPredictorArn()
The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
public CreateForecastRequest withPredictorArn(String predictorArn)
The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
predictorArn - The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.public List<String> getForecastTypes()
The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per
forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean.
The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta
and Negative Binomial).
The default quantiles are the quantiles you specified during predictor creation. If you didn't specify quantiles,
the default values are ["0.1", "0.5", "0.9"].
0.01 to 0.99 (increments of .01 only)
and mean. The mean forecast is different from the median (0.50) when the distribution is not
symmetric (for example, Beta and Negative Binomial).
The default quantiles are the quantiles you specified during predictor creation. If you didn't specify
quantiles, the default values are ["0.1", "0.5", "0.9"].
public void setForecastTypes(Collection<String> forecastTypes)
The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per
forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean.
The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta
and Negative Binomial).
The default quantiles are the quantiles you specified during predictor creation. If you didn't specify quantiles,
the default values are ["0.1", "0.5", "0.9"].
forecastTypes - The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5
quantiles per forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and
mean. The mean forecast is different from the median (0.50) when the distribution is not
symmetric (for example, Beta and Negative Binomial).
The default quantiles are the quantiles you specified during predictor creation. If you didn't specify
quantiles, the default values are ["0.1", "0.5", "0.9"].
public CreateForecastRequest withForecastTypes(String... forecastTypes)
The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per
forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean.
The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta
and Negative Binomial).
The default quantiles are the quantiles you specified during predictor creation. If you didn't specify quantiles,
the default values are ["0.1", "0.5", "0.9"].
NOTE: This method appends the values to the existing list (if any). Use
setForecastTypes(java.util.Collection) or withForecastTypes(java.util.Collection) if you want
to override the existing values.
forecastTypes - The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5
quantiles per forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and
mean. The mean forecast is different from the median (0.50) when the distribution is not
symmetric (for example, Beta and Negative Binomial).
The default quantiles are the quantiles you specified during predictor creation. If you didn't specify
quantiles, the default values are ["0.1", "0.5", "0.9"].
public CreateForecastRequest withForecastTypes(Collection<String> forecastTypes)
The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per
forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean.
The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta
and Negative Binomial).
The default quantiles are the quantiles you specified during predictor creation. If you didn't specify quantiles,
the default values are ["0.1", "0.5", "0.9"].
forecastTypes - The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5
quantiles per forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and
mean. The mean forecast is different from the median (0.50) when the distribution is not
symmetric (for example, Beta and Negative Binomial).
The default quantiles are the quantiles you specified during predictor creation. If you didn't specify
quantiles, the default values are ["0.1", "0.5", "0.9"].
public List<Tag> getTags()
The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values
can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast
considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of
aws do not count against your tags per resource limit.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a
prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with
this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key
does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags
with only the key prefix of aws do not count against your tags per resource limit.
public void setTags(Collection<Tag> tags)
The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values
can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast
considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of
aws do not count against your tags per resource limit.
tags - The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag
consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix
for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this
prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does
not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with
only the key prefix of aws do not count against your tags per resource limit.
public CreateForecastRequest withTags(Tag... tags)
The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values
can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast
considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of
aws do not count against your tags per resource limit.
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.
tags - The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag
consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix
for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this
prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does
not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with
only the key prefix of aws do not count against your tags per resource limit.
public CreateForecastRequest withTags(Collection<Tag> tags)
The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values
can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast
considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of
aws do not count against your tags per resource limit.
tags - The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag
consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix
for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this
prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does
not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with
only the key prefix of aws do not count against your tags per resource limit.
public void setTimeSeriesSelector(TimeSeriesSelector timeSeriesSelector)
Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers
object.
The TimeSeriesIdentifiers object needs the following information:
DataSource
Format
Schema
timeSeriesSelector - Defines the set of time series that are used to create the forecasts in a
TimeSeriesIdentifiers object.
The TimeSeriesIdentifiers object needs the following information:
DataSource
Format
Schema
public TimeSeriesSelector getTimeSeriesSelector()
Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers
object.
The TimeSeriesIdentifiers object needs the following information:
DataSource
Format
Schema
TimeSeriesIdentifiers object.
The TimeSeriesIdentifiers object needs the following information:
DataSource
Format
Schema
public CreateForecastRequest withTimeSeriesSelector(TimeSeriesSelector timeSeriesSelector)
Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers
object.
The TimeSeriesIdentifiers object needs the following information:
DataSource
Format
Schema
timeSeriesSelector - Defines the set of time series that are used to create the forecasts in a
TimeSeriesIdentifiers object.
The TimeSeriesIdentifiers object needs the following information:
DataSource
Format
Schema
public String toString()
toString in class ObjectObject.toString()public CreateForecastRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()