Package software.amazon.awssdk.services.forecast.model

Interface ListForecastsRequest.Builder

    • Method Detail

      • nextToken

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

      • maxResults

        ListForecastsRequest.Builder maxResults​(Integer maxResults)

        The number of items to return in the response.

        Parameters:
        maxResults - The number of items to return in the response.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filters

        ListForecastsRequest.Builder filters​(Collection<Filter> filters)

        An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the forecasts that match the statement from the list, respectively. The match statement consists of a key and a value.

        Filter properties

        • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the forecasts that match the statement, specify IS. To exclude matching forecasts, specify IS_NOT.

        • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn, PredictorArn, and Status.

        • Value - The value to match.

        For example, to list all forecasts whose status is not ACTIVE, you would specify:

        "Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]

        Parameters:
        filters - An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the forecasts that match the statement from the list, respectively. The match statement consists of a key and a value.

        Filter properties

        • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the forecasts that match the statement, specify IS. To exclude matching forecasts, specify IS_NOT.

        • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn, PredictorArn, and Status.

        • Value - The value to match.

        For example, to list all forecasts whose status is not ACTIVE, you would specify:

        "Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]

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

      • filters

        ListForecastsRequest.Builder filters​(Filter... filters)

        An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the forecasts that match the statement from the list, respectively. The match statement consists of a key and a value.

        Filter properties

        • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the forecasts that match the statement, specify IS. To exclude matching forecasts, specify IS_NOT.

        • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn, PredictorArn, and Status.

        • Value - The value to match.

        For example, to list all forecasts whose status is not ACTIVE, you would specify:

        "Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]

        Parameters:
        filters - An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the forecasts that match the statement from the list, respectively. The match statement consists of a key and a value.

        Filter properties

        • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the forecasts that match the statement, specify IS. To exclude matching forecasts, specify IS_NOT.

        • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn, PredictorArn, and Status.

        • Value - The value to match.

        For example, to list all forecasts whose status is not ACTIVE, you would specify:

        "Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]

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

      • filters

        ListForecastsRequest.Builder filters​(Consumer<Filter.Builder>... filters)

        An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the forecasts that match the statement from the list, respectively. The match statement consists of a key and a value.

        Filter properties

        • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the forecasts that match the statement, specify IS. To exclude matching forecasts, specify IS_NOT.

        • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn, PredictorArn, and Status.

        • Value - The value to match.

        For example, to list all forecasts whose status is not ACTIVE, you would specify:

        "Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]

        This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #filters(List).

        Parameters:
        filters - a consumer that will call methods on Filter.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #filters(java.util.Collection)