Interface CreateForecastRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateForecastRequest.Builder,
,CreateForecastRequest> ForecastRequest.Builder
,SdkBuilder<CreateForecastRequest.Builder,
,CreateForecastRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateForecastRequest
-
Method Summary
Modifier and TypeMethodDescriptionforecastName
(String forecastName) A name for the forecast.forecastTypes
(String... forecastTypes) The quantiles at which probabilistic forecasts are generated.forecastTypes
(Collection<String> forecastTypes) The quantiles at which probabilistic forecasts are generated.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.predictorArn
(String predictorArn) The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.tags
(Collection<Tag> tags) The optional metadata that you apply to the forecast to help you categorize and organize them.tags
(Consumer<Tag.Builder>... tags) The optional metadata that you apply to the forecast to help you categorize and organize them.The optional metadata that you apply to the forecast to help you categorize and organize them.default CreateForecastRequest.Builder
timeSeriesSelector
(Consumer<TimeSeriesSelector.Builder> timeSeriesSelector) Defines the set of time series that are used to create the forecasts in aTimeSeriesIdentifiers
object.timeSeriesSelector
(TimeSeriesSelector timeSeriesSelector) Defines the set of time series that are used to create the forecasts in aTimeSeriesIdentifiers
object.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.forecast.model.ForecastRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
forecastName
A name for the forecast.
- Parameters:
forecastName
- A name for the forecast.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
predictorArn
The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
- Parameters:
predictorArn
- The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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) andmean
. 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"]
.- Parameters:
forecastTypes
- The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per forecast. Accepted values include0.01 to 0.99
(increments of .01 only) andmean
. 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"]
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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) andmean
. 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"]
.- Parameters:
forecastTypes
- The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per forecast. Accepted values include0.01 to 0.99
(increments of .01 only) andmean
. 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"]
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 hasaws
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 ofaws
do not count against your tags per resource limit.
- Parameters:
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 hasaws
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 ofaws
do not count against your tags per resource limit.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 hasaws
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 ofaws
do not count against your tags per resource limit.
- Parameters:
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 hasaws
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 ofaws
do not count against your tags per resource limit.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 hasaws
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 ofaws
do not count against your tags per resource limit.
Tag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
- Parameters:
timeSeriesSelector
- Defines the set of time series that are used to create the forecasts in aTimeSeriesIdentifiers
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.
-
-
timeSeriesSelector
default CreateForecastRequest.Builder timeSeriesSelector(Consumer<TimeSeriesSelector.Builder> 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.Builder
avoiding the need to create one manually viaTimeSeriesSelector.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totimeSeriesSelector(TimeSeriesSelector)
.- Parameters:
timeSeriesSelector
- a consumer that will call methods onTimeSeriesSelector.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
overrideConfiguration
CreateForecastRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateForecastRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-