com.amazonaws.services.forecastquery

Class AbstractAmazonForecastQuery

java.lang.Object

com.amazonaws.services.forecastquery.AbstractAmazonForecastQuery

All Implemented Interfaces:

AmazonForecastQuery

Direct Known Subclasses:

AbstractAmazonForecastQueryAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonForecastQuery
extends Object
implements AmazonForecastQuery

Abstract implementation of AmazonForecastQuery. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.forecastquery.AmazonForecastQuery

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
QueryForecastResult	queryForecast(QueryForecastRequest request) Retrieves a forecast for a single item, filtered by the supplied criteria.
QueryWhatIfForecastResult	queryWhatIfForecast(QueryWhatIfForecastRequest request) Retrieves a what-if forecast.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

queryForecast

public QueryForecastResult queryForecast(QueryForecastRequest request)

Description copied from interface: AmazonForecastQuery

Retrieves a forecast for a single item, filtered by the supplied criteria.

The criteria is a key-value pair. The key is either item_id (or the equivalent non-timestamp, non-target field) from the TARGET_TIME_SERIES dataset, or one of the forecast dimensions specified as part of the FeaturizationConfig object.

By default, QueryForecast returns the complete date range for the filtered forecast. You can request a specific date range.

To get the full forecast, use the CreateForecastExportJob operation.

The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.

Specified by:

queryForecast in interface AmazonForecastQuery

Returns:

Result of the QueryForecast operation returned by the service.

See Also:

AWS API Documentation

queryWhatIfForecast

public QueryWhatIfForecastResult queryWhatIfForecast(QueryWhatIfForecastRequest request)

Description copied from interface: AmazonForecastQuery

Retrieves a what-if forecast.

Specified by:

queryWhatIfForecast in interface AmazonForecastQuery

Returns:

Result of the QueryWhatIfForecast operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonForecastQuery

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonForecastQuery

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonForecastQuery

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Specified by:

getCachedResponseMetadata in interface AmazonForecastQuery

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.