Struct aws_sdk_forecastquery::operation::query_forecast::builders::QueryForecastInputBuilder

#[non_exhaustive]
pub struct QueryForecastInputBuilder { /* private fields */ }

A builder for QueryForecastInput.

Implementations

impl QueryForecastInputBuilder

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

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

This field is required.

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

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

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

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

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

The start date for the 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 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 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 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 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 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 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 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 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.

pub fn build(self) -> Result<QueryForecastInput, BuildError>

Consumes the builder and constructs a QueryForecastInput.

impl QueryForecastInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<QueryForecastOutput, SdkError<QueryForecastError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for QueryForecastInputBuilder

fn clone(&self) -> QueryForecastInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryForecastInputBuilder

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

Formats the value using the given formatter.

impl Default for QueryForecastInputBuilder

fn default() -> QueryForecastInputBuilder

Returns the “default value” for a type.

impl PartialEq for QueryForecastInputBuilder

fn eq(&self, other: &QueryForecastInputBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for QueryForecastInputBuilder