Interface ListWhatIfAnalysesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListWhatIfAnalysesRequest.Builder,ListWhatIfAnalysesRequest>, ForecastRequest.Builder, SdkBuilder<ListWhatIfAnalysesRequest.Builder,ListWhatIfAnalysesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListWhatIfAnalysesRequest
public static interface ListWhatIfAnalysesRequest.Builder extends ForecastRequest.Builder, SdkPojo, CopyableBuilder<ListWhatIfAnalysesRequest.Builder,ListWhatIfAnalysesRequest>

  • Method Details

    • nextToken

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

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

      ListWhatIfAnalysesRequest.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 what-if analysis jobs 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 what-if analysis jobs that match the statement, specify IS. To exclude matching what-if analysis jobs, specify IS_NOT.

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

      • Value - The value to match.

      For example, to list all jobs that export a forecast named electricityWhatIf, specify the following filter:

      "Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf" } ]

      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 what-if analysis jobs 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 what-if analysis jobs that match the statement, specify IS. To exclude matching what-if analysis jobs, specify IS_NOT.

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

      • Value - The value to match.

      For example, to list all jobs that export a forecast named electricityWhatIf, specify the following filter:

      "Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf" } ]

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

    • filters

      ListWhatIfAnalysesRequest.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 what-if analysis jobs 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 what-if analysis jobs that match the statement, specify IS. To exclude matching what-if analysis jobs, specify IS_NOT.

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

      • Value - The value to match.

      For example, to list all jobs that export a forecast named electricityWhatIf, specify the following filter:

      "Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf" } ]

      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 what-if analysis jobs 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 what-if analysis jobs that match the statement, specify IS. To exclude matching what-if analysis jobs, specify IS_NOT.

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

      • Value - The value to match.

      For example, to list all jobs that export a forecast named electricityWhatIf, specify the following filter:

      "Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf" } ]

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

    • filters

      ListWhatIfAnalysesRequest.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 what-if analysis jobs 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 what-if analysis jobs that match the statement, specify IS. To exclude matching what-if analysis jobs, specify IS_NOT.

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

      • Value - The value to match.

      For example, to list all jobs that export a forecast named electricityWhatIf, specify the following filter:

      "Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf" } ]

      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<Filter>).

      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:

    • overrideConfiguration

      ListWhatIfAnalysesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListWhatIfAnalysesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.