com.amazonaws.services.forecastquery.model

Class QueryForecastRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.forecastquery.model.QueryForecastRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class QueryForecastRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
QueryForecastRequest()

Method Summary

Modifier and Type	Method and Description
QueryForecastRequest	addFiltersEntry(String key, String value) Add a single Filters entry
QueryForecastRequest	clearFiltersEntries() Removes all the entries added into Filters.
QueryForecastRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getEndDate() The end date for the forecast.
Map<String,String>	getFilters() The filtering criteria to apply when retrieving the forecast.
String	getForecastArn() The Amazon Resource Name (ARN) of the forecast to query.
String	getNextToken() If the result of the previous request was truncated, the response includes a NextToken.
String	getStartDate() The start date for the forecast.
int	hashCode()
void	setEndDate(String endDate) The end date for the forecast.
void	setFilters(Map<String,String> filters) The filtering criteria to apply when retrieving the forecast.
void	setForecastArn(String forecastArn) The Amazon Resource Name (ARN) of the forecast to query.
void	setNextToken(String nextToken) If the result of the previous request was truncated, the response includes a NextToken.
void	setStartDate(String startDate) The start date for the forecast.
String	toString() Returns a string representation of this object.
QueryForecastRequest	withEndDate(String endDate) The end date for the forecast.
QueryForecastRequest	withFilters(Map<String,String> filters) The filtering criteria to apply when retrieving the forecast.
QueryForecastRequest	withForecastArn(String forecastArn) The Amazon Resource Name (ARN) of the forecast to query.
QueryForecastRequest	withNextToken(String nextToken) If the result of the previous request was truncated, the response includes a NextToken.
QueryForecastRequest	withStartDate(String startDate) The start date for the forecast.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryForecastRequest

public QueryForecastRequest()

Method Detail

setForecastArn

public void setForecastArn(String forecastArn)

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

Parameters:

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

getForecastArn

public String getForecastArn()

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

Returns:

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

withForecastArn

public QueryForecastRequest withForecastArn(String forecastArn)

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

Parameters:

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

Returns:

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

setStartDate

public void setStartDate(String startDate)

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.

Parameters:

startDate - 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.

getStartDate

public String getStartDate()

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.

Returns:

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.

withStartDate

public QueryForecastRequest withStartDate(String startDate)

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.

Parameters:

startDate - 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.

Returns:

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

setEndDate

public void setEndDate(String endDate)

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.

Parameters:

endDate - 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.

getEndDate

public String getEndDate()

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.

Returns:

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.

withEndDate

public QueryForecastRequest withEndDate(String endDate)

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.

Parameters:

endDate - 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.

Returns:

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

getFilters

public Map<String,String> getFilters()

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.

Returns:

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.

setFilters

public void setFilters(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 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 forecast, use the CreateForecastExportJob operation.

withFilters

public QueryForecastRequest withFilters(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 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 forecast, use the CreateForecastExportJob operation.

Returns:

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

addFiltersEntry

public QueryForecastRequest addFiltersEntry(String key,
                                            String value)

Add a single Filters entry

See Also:

withFilters(java.util.Map<java.lang.String, java.lang.String>)

clearFiltersEntries

public QueryForecastRequest clearFiltersEntries()

Removes all the entries added into Filters.

Returns:

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

setNextToken

public void setNextToken(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.

getNextToken

public String getNextToken()

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:

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.

withNextToken

public QueryForecastRequest withNextToken(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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public QueryForecastRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()