Struct aws_sdk_forecastquery::operation::query_what_if_forecast::builders::QueryWhatIfForecastFluentBuilder

pub struct QueryWhatIfForecastFluentBuilder { /* private fields */ }

Fluent builder constructing a request to QueryWhatIfForecast.

Retrieves a what-if forecast.

Implementations

impl QueryWhatIfForecastFluentBuilder

pub fn as_input(&self) -> &QueryWhatIfForecastInputBuilder

Access the QueryWhatIfForecast as a reference.

pub async fn send( self ) -> Result<QueryWhatIfForecastOutput, SdkError<QueryWhatIfForecastError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<QueryWhatIfForecastOutput, QueryWhatIfForecastError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn what_if_forecast_arn(self, input: impl Into<String>) -> Self

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

pub fn set_what_if_forecast_arn(self, input: Option<String>) -> Self

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

pub fn get_what_if_forecast_arn(&self) -> &Option<String>

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

pub fn start_date(self, input: impl Into<String>) -> Self

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.

pub fn set_start_date(self, input: Option<String>) -> Self

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.

pub fn get_start_date(&self) -> &Option<String>

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.

pub fn end_date(self, input: impl Into<String>) -> Self

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.

pub fn set_end_date(self, input: Option<String>) -> Self

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.

pub fn get_end_date(&self) -> &Option<String>

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.

pub fn filters(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Filters.

To override the contents of this collection use set_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.

pub fn set_filters(self, input: Option<HashMap<String, String>>) -> Self

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.

pub fn get_filters(&self) -> &Option<HashMap<String, String>>

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.

pub fn next_token(self, input: impl Into<String>) -> Self

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.

pub fn set_next_token(self, input: Option<String>) -> Self

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.

pub fn get_next_token(&self) -> &Option<String>

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.

Trait Implementations

impl Clone for QueryWhatIfForecastFluentBuilder

fn clone(&self) -> QueryWhatIfForecastFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QueryWhatIfForecastFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.