Interface ListForecastExportJobsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListForecastExportJobsRequest.Builder,
,ListForecastExportJobsRequest> ForecastRequest.Builder
,SdkBuilder<ListForecastExportJobsRequest.Builder,
,ListForecastExportJobsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListForecastExportJobsRequest
-
Method Summary
Modifier and TypeMethodDescriptionfilters
(Collection<Filter> filters) An array of filters.filters
(Consumer<Filter.Builder>... filters) An array of filters.An array of filters.maxResults
(Integer maxResults) The number of items to return in the response.If the result of the previous request was truncated, the response includes aNextToken
.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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
-
nextToken
If the result of the previous request was truncated, the response includes a
NextToken
. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.- Parameters:
nextToken
- If the result of the previous request was truncated, the response includes aNextToken
. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The number of items to return in the response.
- Parameters:
maxResults
- The number of items to return in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
An array of filters. For each filter, you provide a condition and a match statement. The condition is either
IS
orIS_NOT
, which specifies whether to include or exclude the forecast export jobs that match the statement from the list, respectively. The match statement consists of a key and a value.Filter properties
-
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the forecast export jobs that match the statement, specifyIS
. To exclude matching forecast export jobs, specifyIS_NOT
. -
Key
- The name of the parameter to filter on. Valid values areForecastArn
andStatus
. -
Value
- The value to match.
For example, to list all jobs that export a forecast named electricityforecast, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]
- Parameters:
filters
- An array of filters. For each filter, you provide a condition and a match statement. The condition is eitherIS
orIS_NOT
, which specifies whether to include or exclude the forecast export jobs that match the statement from the list, respectively. The match statement consists of a key and a value.Filter properties
-
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the forecast export jobs that match the statement, specifyIS
. To exclude matching forecast export jobs, specifyIS_NOT
. -
Key
- The name of the parameter to filter on. Valid values areForecastArn
andStatus
. -
Value
- The value to match.
For example, to list all jobs that export a forecast named electricityforecast, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
An array of filters. For each filter, you provide a condition and a match statement. The condition is either
IS
orIS_NOT
, which specifies whether to include or exclude the forecast export jobs that match the statement from the list, respectively. The match statement consists of a key and a value.Filter properties
-
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the forecast export jobs that match the statement, specifyIS
. To exclude matching forecast export jobs, specifyIS_NOT
. -
Key
- The name of the parameter to filter on. Valid values areForecastArn
andStatus
. -
Value
- The value to match.
For example, to list all jobs that export a forecast named electricityforecast, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]
- Parameters:
filters
- An array of filters. For each filter, you provide a condition and a match statement. The condition is eitherIS
orIS_NOT
, which specifies whether to include or exclude the forecast export jobs that match the statement from the list, respectively. The match statement consists of a key and a value.Filter properties
-
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the forecast export jobs that match the statement, specifyIS
. To exclude matching forecast export jobs, specifyIS_NOT
. -
Key
- The name of the parameter to filter on. Valid values areForecastArn
andStatus
. -
Value
- The value to match.
For example, to list all jobs that export a forecast named electricityforecast, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
An array of filters. For each filter, you provide a condition and a match statement. The condition is either
IS
orIS_NOT
, which specifies whether to include or exclude the forecast export jobs that match the statement from the list, respectively. The match statement consists of a key and a value.Filter properties
-
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the forecast export jobs that match the statement, specifyIS
. To exclude matching forecast export jobs, specifyIS_NOT
. -
Key
- The name of the parameter to filter on. Valid values areForecastArn
andStatus
. -
Value
- The value to match.
For example, to list all jobs that export a forecast named electricityforecast, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]
Filter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<Filter>)
.- Parameters:
filters
- a consumer that will call methods onFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
overrideConfiguration
ListForecastExportJobsRequest.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
ListForecastExportJobsRequest.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.
-