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

Class GetSavingsPlansUtilizationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.costexplorer.model.CostExplorerRequest
software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansUtilizationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetSavingsPlansUtilizationRequest.Builder,GetSavingsPlansUtilizationRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetSavingsPlansUtilizationRequest extends CostExplorerRequest implements ToCopyableBuilder<GetSavingsPlansUtilizationRequest.Builder,GetSavingsPlansUtilizationRequest>

  • Method Details

    • timePeriod

      public final DateInterval timePeriod()

      The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

      Returns:
      The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

    • granularity

      public final Granularity granularity()

      The granularity of the Amazon Web Services utillization data for your Savings Plans.

      The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.

      If the service returns an enum value that is not available in the current SDK version, granularity will return Granularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granularityAsString().

      Returns:
      The granularity of the Amazon Web Services utillization data for your Savings Plans.

      The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.

      See Also:

    • granularityAsString

      public final String granularityAsString()

      The granularity of the Amazon Web Services utillization data for your Savings Plans.

      The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.

      If the service returns an enum value that is not available in the current SDK version, granularity will return Granularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granularityAsString().

      Returns:
      The granularity of the Amazon Web Services utillization data for your Savings Plans.

      The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.

      See Also:

    • filter

      public final Expression filter()

      Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

      • LINKED_ACCOUNT

      • SAVINGS_PLAN_ARN

      • SAVINGS_PLANS_TYPE

      • REGION

      • PAYMENT_OPTION

      • INSTANCE_TYPE_FAMILY

      GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension.

      Returns:
      Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

      • LINKED_ACCOUNT

      • SAVINGS_PLAN_ARN

      • SAVINGS_PLANS_TYPE

      • REGION

      • PAYMENT_OPTION

      • INSTANCE_TYPE_FAMILY

      GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension.

    • sortBy

      public final SortDefinition sortBy()

      The value that you want to sort the data by.

      The following values are supported for Key:

      • UtilizationPercentage

      • TotalCommitment

      • UsedCommitment

      • UnusedCommitment

      • NetSavings

      The supported values for SortOrder are ASCENDING and DESCENDING.

      Returns:
      The value that you want to sort the data by.

      The following values are supported for Key:

      • UtilizationPercentage

      • TotalCommitment

      • UsedCommitment

      • UnusedCommitment

      • NetSavings

      The supported values for SortOrder are ASCENDING and DESCENDING.

    • toBuilder

      public GetSavingsPlansUtilizationRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetSavingsPlansUtilizationRequest.Builder,GetSavingsPlansUtilizationRequest>
      Specified by:
      toBuilder in class CostExplorerRequest
      Returns:
      a builder for type T

    • builder

      public static GetSavingsPlansUtilizationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetSavingsPlansUtilizationRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.