Interface GetCostAndUsageComparisonsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetCostAndUsageComparisonsRequest.Builder,GetCostAndUsageComparisonsRequest>, CostExplorerRequest.Builder, SdkBuilder<GetCostAndUsageComparisonsRequest.Builder,GetCostAndUsageComparisonsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetCostAndUsageComparisonsRequest
@Mutable @NotThreadSafe public static interface GetCostAndUsageComparisonsRequest.Builder extends CostExplorerRequest.Builder, SdkPojo, CopyableBuilder<GetCostAndUsageComparisonsRequest.Builder,GetCostAndUsageComparisonsRequest>

  • Method Details

    • billingViewArn

      GetCostAndUsageComparisonsRequest.Builder billingViewArn(String billingViewArn)

      The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API.

      Parameters:
      billingViewArn - The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • baselineTimePeriod

      GetCostAndUsageComparisonsRequest.Builder baselineTimePeriod(DateInterval baselineTimePeriod)

      The reference time period for comparison. This time period serves as the baseline against which other cost and usage data will be compared. The interval must start and end on the first day of a month, with a duration of exactly one month.

      Parameters:
      baselineTimePeriod - The reference time period for comparison. This time period serves as the baseline against which other cost and usage data will be compared. The interval must start and end on the first day of a month, with a duration of exactly one month.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • baselineTimePeriod

      default GetCostAndUsageComparisonsRequest.Builder baselineTimePeriod(Consumer<DateInterval.Builder> baselineTimePeriod)

      The reference time period for comparison. This time period serves as the baseline against which other cost and usage data will be compared. The interval must start and end on the first day of a month, with a duration of exactly one month.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to baselineTimePeriod(DateInterval).

      Parameters:
      baselineTimePeriod - a consumer that will call methods on DateInterval.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • comparisonTimePeriod

      GetCostAndUsageComparisonsRequest.Builder comparisonTimePeriod(DateInterval comparisonTimePeriod)

      The comparison time period for analysis. This time period's cost and usage data will be compared against the baseline time period. The interval must start and end on the first day of a month, with a duration of exactly one month.

      Parameters:
      comparisonTimePeriod - The comparison time period for analysis. This time period's cost and usage data will be compared against the baseline time period. The interval must start and end on the first day of a month, with a duration of exactly one month.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • comparisonTimePeriod

      default GetCostAndUsageComparisonsRequest.Builder comparisonTimePeriod(Consumer<DateInterval.Builder> comparisonTimePeriod)

      The comparison time period for analysis. This time period's cost and usage data will be compared against the baseline time period. The interval must start and end on the first day of a month, with a duration of exactly one month.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to comparisonTimePeriod(DateInterval).

      Parameters:
      comparisonTimePeriod - a consumer that will call methods on DateInterval.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metricForComparison

      GetCostAndUsageComparisonsRequest.Builder metricForComparison(String metricForComparison)

      The cost and usage metric to compare. Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

      Parameters:
      metricForComparison - The cost and usage metric to compare. Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filter

      GetCostAndUsageComparisonsRequest.Builder filter(Expression filter)
      Sets the value of the Filter property for this object.
      Parameters:
      filter - The new value for the Filter property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filter

      default GetCostAndUsageComparisonsRequest.Builder filter(Consumer<Expression.Builder> filter)
      Sets the value of the Filter property for this object. This is a convenience method that creates an instance of the Expression.Builder avoiding the need to create one manually via Expression.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filter(Expression).

      Parameters:
      filter - a consumer that will call methods on Expression.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • groupBy

      GetCostAndUsageComparisonsRequest.Builder groupBy(Collection<GroupDefinition> groupBy)

      You can group results using the attributes DIMENSION, TAG, and COST_CATEGORY.

      Parameters:
      groupBy - You can group results using the attributes DIMENSION, TAG, and COST_CATEGORY.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupBy

      GetCostAndUsageComparisonsRequest.Builder groupBy(GroupDefinition... groupBy)

      You can group results using the attributes DIMENSION, TAG, and COST_CATEGORY.

      Parameters:
      groupBy - You can group results using the attributes DIMENSION, TAG, and COST_CATEGORY.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupBy

      GetCostAndUsageComparisonsRequest.Builder groupBy(Consumer<GroupDefinition.Builder>... groupBy)

      You can group results using the attributes DIMENSION, TAG, and COST_CATEGORY.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to groupBy(List<GroupDefinition>).

      Parameters:
      groupBy - a consumer that will call methods on GroupDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      GetCostAndUsageComparisonsRequest.Builder maxResults(Integer maxResults)

      The maximum number of results that are returned for the request.

      Parameters:
      maxResults - The maximum number of results that are returned for the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextPageToken

      GetCostAndUsageComparisonsRequest.Builder nextPageToken(String nextPageToken)

      The token to retrieve the next set of paginated results.

      Parameters:
      nextPageToken - The token to retrieve the next set of paginated results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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