Package software.amazon.awssdk.services.costexplorer.model

Interface GetReservationUtilizationRequest.Builder

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

  • Method Details

    • timePeriod

      GetReservationUtilizationRequest.Builder timePeriod(DateInterval timePeriod)

      Sets the start and end dates for retrieving Reserved Instance (RI) utilization. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01 .

      Parameters:
      timePeriod - Sets the start and end dates for retrieving Reserved Instance (RI) utilization. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timePeriod

      default GetReservationUtilizationRequest.Builder timePeriod(Consumer<DateInterval.Builder> timePeriod)

      Sets the start and end dates for retrieving Reserved Instance (RI) utilization. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01 .

      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 timePeriod(DateInterval).

      Parameters:
      timePeriod - 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:

    • groupBy

      GetReservationUtilizationRequest.Builder groupBy(Collection<GroupDefinition> groupBy)

      Groups only by SUBSCRIPTION_ID. Metadata is included.

      Parameters:
      groupBy - Groups only by SUBSCRIPTION_ID. Metadata is included.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupBy

      GetReservationUtilizationRequest.Builder groupBy(GroupDefinition... groupBy)

      Groups only by SUBSCRIPTION_ID. Metadata is included.

      Parameters:
      groupBy - Groups only by SUBSCRIPTION_ID. Metadata is included.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupBy

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

      Groups only by SUBSCRIPTION_ID. Metadata is included.

      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:

    • granularity

      GetReservationUtilizationRequest.Builder granularity(String granularity)

      If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

      The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

      Parameters:
      granularity - If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

      The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

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

    • granularity

      GetReservationUtilizationRequest.Builder granularity(Granularity granularity)

      If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

      The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

      Parameters:
      granularity - If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

      The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

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

    • filter

      GetReservationUtilizationRequest.Builder filter(Expression filter)

      Filters utilization data by dimensions. You can filter by the following dimensions:

      • AZ

      • CACHE_ENGINE

      • DEPLOYMENT_OPTION

      • INSTANCE_TYPE

      • LINKED_ACCOUNT

      • OPERATING_SYSTEM

      • PLATFORM

      • REGION

      • SERVICE

      • SCOPE

      • TENANCY

      GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

      Parameters:
      filter - Filters utilization data by dimensions. You can filter by the following dimensions:

      • AZ

      • CACHE_ENGINE

      • DEPLOYMENT_OPTION

      • INSTANCE_TYPE

      • LINKED_ACCOUNT

      • OPERATING_SYSTEM

      • PLATFORM

      • REGION

      • SERVICE

      • SCOPE

      • TENANCY

      GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

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

    • filter

      default GetReservationUtilizationRequest.Builder filter(Consumer<Expression.Builder> filter)

      Filters utilization data by dimensions. You can filter by the following dimensions:

      • AZ

      • CACHE_ENGINE

      • DEPLOYMENT_OPTION

      • INSTANCE_TYPE

      • LINKED_ACCOUNT

      • OPERATING_SYSTEM

      • PLATFORM

      • REGION

      • SERVICE

      • SCOPE

      • TENANCY

      GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

      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:

    • sortBy

      GetReservationUtilizationRequest.Builder sortBy(SortDefinition sortBy)

      The value that you want to sort the data by.

      The following values are supported for Key:

      • UtilizationPercentage

      • UtilizationPercentageInUnits

      • PurchasedHours

      • PurchasedUnits

      • TotalActualHours

      • TotalActualUnits

      • UnusedHours

      • UnusedUnits

      • OnDemandCostOfRIHoursUsed

      • NetRISavings

      • TotalPotentialRISavings

      • AmortizedUpfrontFee

      • AmortizedRecurringFee

      • TotalAmortizedFee

      • RICostForUnusedHours

      • RealizedSavings

      • UnrealizedSavings

      The supported values for SortOrder are ASCENDING and DESCENDING.

      Parameters:
      sortBy - The value that you want to sort the data by.

      The following values are supported for Key:

      • UtilizationPercentage

      • UtilizationPercentageInUnits

      • PurchasedHours

      • PurchasedUnits

      • TotalActualHours

      • TotalActualUnits

      • UnusedHours

      • UnusedUnits

      • OnDemandCostOfRIHoursUsed

      • NetRISavings

      • TotalPotentialRISavings

      • AmortizedUpfrontFee

      • AmortizedRecurringFee

      • TotalAmortizedFee

      • RICostForUnusedHours

      • RealizedSavings

      • UnrealizedSavings

      The supported values for SortOrder are ASCENDING and DESCENDING.

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

    • sortBy

      default GetReservationUtilizationRequest.Builder sortBy(Consumer<SortDefinition.Builder> sortBy)

      The value that you want to sort the data by.

      The following values are supported for Key:

      • UtilizationPercentage

      • UtilizationPercentageInUnits

      • PurchasedHours

      • PurchasedUnits

      • TotalActualHours

      • TotalActualUnits

      • UnusedHours

      • UnusedUnits

      • OnDemandCostOfRIHoursUsed

      • NetRISavings

      • TotalPotentialRISavings

      • AmortizedUpfrontFee

      • AmortizedRecurringFee

      • TotalAmortizedFee

      • RICostForUnusedHours

      • RealizedSavings

      • UnrealizedSavings

      The supported values for SortOrder are ASCENDING and DESCENDING.

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

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

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

    • nextPageToken

      GetReservationUtilizationRequest.Builder nextPageToken(String nextPageToken)

      The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

      Parameters:
      nextPageToken - The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      GetReservationUtilizationRequest.Builder maxResults(Integer maxResults)

      The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

      Parameters:
      maxResults - The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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