com.amazonaws.services.forecastquery.AmazonForecastQueryAsync Maven / Gradle / Ivy

/*
 * Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.forecastquery;

import javax.annotation.Generated;

import com.amazonaws.services.forecastquery.model.*;

/**
 * Interface for accessing Amazon Forecast Query Service asynchronously. Each asynchronous method will return a Java
 * Future object representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to
 * receive notification when an asynchronous operation completes.
 * 
 * Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
 * {@link com.amazonaws.services.forecastquery.AbstractAmazonForecastQueryAsync} instead.
 * 
 * 
 * 

 * Provides APIs for creating and managing Amazon Forecast resources.
 * 
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonForecastQueryAsync extends 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.
     * 
     * 
     * 
     * @param queryForecastRequest
     * @return A Java Future containing the result of the QueryForecast operation returned by the service.
     * @sample AmazonForecastQueryAsync.QueryForecast
     * @see AWS
     *      API Documentation
     */
    java.util.concurrent.Future queryForecastAsync(QueryForecastRequest queryForecastRequest);

    /**
     * 
     * 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.
     * 
     * 
     * 
     * @param queryForecastRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the QueryForecast operation returned by the service.
     * @sample AmazonForecastQueryAsyncHandler.QueryForecast
     * @see AWS
     *      API Documentation
     */
    java.util.concurrent.Future queryForecastAsync(QueryForecastRequest queryForecastRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

}