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

Interface GetReservationCoverageRequest.Builder

    • Method Detail

      • timePeriod

        GetReservationCoverageRequest.Builder timePeriod​(DateInterval timePeriod)

        The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. 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 - The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. 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 GetReservationCoverageRequest.Builder timePeriod​(Consumer<DateInterval.Builder> timePeriod)

        The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. 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:
        timePeriod(DateInterval)

      • groupBy

        GetReservationCoverageRequest.Builder groupBy​(Collection<GroupDefinition> groupBy)

        You can group the data by the following attributes:

        • AZ

        • CACHE_ENGINE

        • DATABASE_ENGINE

        • DEPLOYMENT_OPTION

        • INSTANCE_TYPE

        • INVOICING_ENTITY

        • LINKED_ACCOUNT

        • OPERATING_SYSTEM

        • PLATFORM

        • REGION

        • TENANCY

        Parameters:
        groupBy - You can group the data by the following attributes:

        • AZ

        • CACHE_ENGINE

        • DATABASE_ENGINE

        • DEPLOYMENT_OPTION

        • INSTANCE_TYPE

        • INVOICING_ENTITY

        • LINKED_ACCOUNT

        • OPERATING_SYSTEM

        • PLATFORM

        • REGION

        • TENANCY

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

      • groupBy

        GetReservationCoverageRequest.Builder groupBy​(GroupDefinition... groupBy)

        You can group the data by the following attributes:

        • AZ

        • CACHE_ENGINE

        • DATABASE_ENGINE

        • DEPLOYMENT_OPTION

        • INSTANCE_TYPE

        • INVOICING_ENTITY

        • LINKED_ACCOUNT

        • OPERATING_SYSTEM

        • PLATFORM

        • REGION

        • TENANCY

        Parameters:
        groupBy - You can group the data by the following attributes:

        • AZ

        • CACHE_ENGINE

        • DATABASE_ENGINE

        • DEPLOYMENT_OPTION

        • INSTANCE_TYPE

        • INVOICING_ENTITY

        • LINKED_ACCOUNT

        • OPERATING_SYSTEM

        • PLATFORM

        • REGION

        • TENANCY

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

      • granularity

        GetReservationCoverageRequest.Builder granularity​(String granularity)

        The granularity of the Amazon Web Services cost data for the reservation. Valid values are MONTHLY and DAILY.

        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.

        The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

        Parameters:
        granularity - The granularity of the Amazon Web Services cost data for the reservation. Valid values are MONTHLY and DAILY.

        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.

        The GetReservationCoverage 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, Granularity

      • granularity

        GetReservationCoverageRequest.Builder granularity​(Granularity granularity)

        The granularity of the Amazon Web Services cost data for the reservation. Valid values are MONTHLY and DAILY.

        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.

        The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

        Parameters:
        granularity - The granularity of the Amazon Web Services cost data for the reservation. Valid values are MONTHLY and DAILY.

        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.

        The GetReservationCoverage 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, Granularity

      • filter

        GetReservationCoverageRequest.Builder filter​(Expression filter)

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

        • AZ

        • CACHE_ENGINE

        • DATABASE_ENGINE

        • DEPLOYMENT_OPTION

        • INSTANCE_TYPE

        • LINKED_ACCOUNT

        • OPERATING_SYSTEM

        • PLATFORM

        • REGION

        • SERVICE

        • TAG

        • TENANCY

        GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

        If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

        Cost category is also supported.

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

        • AZ

        • CACHE_ENGINE

        • DATABASE_ENGINE

        • DEPLOYMENT_OPTION

        • INSTANCE_TYPE

        • LINKED_ACCOUNT

        • OPERATING_SYSTEM

        • PLATFORM

        • REGION

        • SERVICE

        • TAG

        • TENANCY

        GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

        If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

        Cost category is also supported.

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

      • filter

        default GetReservationCoverageRequest.Builder filter​(Consumer<Expression.Builder> filter)

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

        • AZ

        • CACHE_ENGINE

        • DATABASE_ENGINE

        • DEPLOYMENT_OPTION

        • INSTANCE_TYPE

        • LINKED_ACCOUNT

        • OPERATING_SYSTEM

        • PLATFORM

        • REGION

        • SERVICE

        • TAG

        • TENANCY

        GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

        If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

        Cost category is also supported.

        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:
        filter(Expression)

      • metrics

        GetReservationCoverageRequest.Builder metrics​(Collection<String> metrics)

        The measurement that you want your reservation coverage reported in.

        Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

        Parameters:
        metrics - The measurement that you want your reservation coverage reported in.

        Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

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

      • metrics

        GetReservationCoverageRequest.Builder metrics​(String... metrics)

        The measurement that you want your reservation coverage reported in.

        Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

        Parameters:
        metrics - The measurement that you want your reservation coverage reported in.

        Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

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

      • nextPageToken

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

      • sortBy

        GetReservationCoverageRequest.Builder sortBy​(SortDefinition sortBy)

        The value by which you want to sort the data.

        The following values are supported for Key:

        • OnDemandCost

        • CoverageHoursPercentage

        • OnDemandHours

        • ReservedHours

        • TotalRunningHours

        • CoverageNormalizedUnitsPercentage

        • OnDemandNormalizedUnits

        • ReservedNormalizedUnits

        • TotalRunningNormalizedUnits

        • Time

        Supported values for SortOrder are ASCENDING or DESCENDING.

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

        The following values are supported for Key:

        • OnDemandCost

        • CoverageHoursPercentage

        • OnDemandHours

        • ReservedHours

        • TotalRunningHours

        • CoverageNormalizedUnitsPercentage

        • OnDemandNormalizedUnits

        • ReservedNormalizedUnits

        • TotalRunningNormalizedUnits

        • Time

        Supported values for SortOrder are ASCENDING or DESCENDING.

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

      • maxResults

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