Package software.amazon.awssdk.services.forecastquery.model

Interface QueryForecastRequest.Builder

    • Method Detail

      • forecastArn

        QueryForecastRequest.Builder forecastArn​(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.

      • startDate

        QueryForecastRequest.Builder startDate​(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.

      • endDate

        QueryForecastRequest.Builder endDate​(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.

      • filters

        QueryForecastRequest.Builder filters​(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.

      • nextToken

        QueryForecastRequest.Builder nextToken​(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.