software.amazon.awssdk.services.forecastquery.model

Interface QueryWhatIfForecastRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<QueryWhatIfForecastRequest.Builder,QueryWhatIfForecastRequest>, ForecastqueryRequest.Builder, SdkBuilder<QueryWhatIfForecastRequest.Builder,QueryWhatIfForecastRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

QueryWhatIfForecastRequest

public static interface QueryWhatIfForecastRequest.Builder
extends ForecastqueryRequest.Builder, SdkPojo, CopyableBuilder<QueryWhatIfForecastRequest.Builder,QueryWhatIfForecastRequest>

Method Summary

Modifier and Type	Method and Description
QueryWhatIfForecastRequest.Builder	endDate(String endDate) The end date for the what-if forecast.
QueryWhatIfForecastRequest.Builder	filters(Map<String,String> filters) The filtering criteria to apply when retrieving the forecast.
QueryWhatIfForecastRequest.Builder	nextToken(String nextToken) If the result of the previous request was truncated, the response includes a NextToken.
QueryWhatIfForecastRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
QueryWhatIfForecastRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
QueryWhatIfForecastRequest.Builder	startDate(String startDate) The start date for the what-if forecast.
QueryWhatIfForecastRequest.Builder	whatIfForecastArn(String whatIfForecastArn) The Amazon Resource Name (ARN) of the what-if forecast to query.

Methods inherited from interface software.amazon.awssdk.services.forecastquery.model.ForecastqueryRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

whatIfForecastArn

QueryWhatIfForecastRequest.Builder whatIfForecastArn(String whatIfForecastArn)

The Amazon Resource Name (ARN) of the what-if forecast to query.

Parameters:

whatIfForecastArn - The Amazon Resource Name (ARN) of the what-if forecast to query.

Returns:

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

startDate

QueryWhatIfForecastRequest.Builder startDate(String startDate)

The start date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.

Parameters:

startDate - The start date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.

Returns:

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

endDate

QueryWhatIfForecastRequest.Builder endDate(String endDate)

The end date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.

Parameters:

endDate - The end date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.

Returns:

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

filters

QueryWhatIfForecastRequest.Builder filters(Map<String,String> filters)

The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for client_21 in the electricity usage dataset, specify the following:

{"item_id" : "client_21"}

To get the full what-if forecast, use the CreateForecastExportJob operation.

Parameters:

filters - The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for client_21 in the electricity usage dataset, specify the following:

{"item_id" : "client_21"}

To get the full what-if forecast, use the CreateForecastExportJob operation.

Returns:

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

nextToken

QueryWhatIfForecastRequest.Builder nextToken(String 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 a NextToken. 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.

overrideConfiguration

QueryWhatIfForecastRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

QueryWhatIfForecastRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder