Class CostAndUsageQuery

java.lang.Object
software.amazon.awssdk.services.bcmdashboards.model.CostAndUsageQuery
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CostAndUsageQuery.Builder,CostAndUsageQuery>
@Generated("software.amazon.awssdk:codegen") public final class CostAndUsageQuery extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CostAndUsageQuery.Builder,CostAndUsageQuery>

Defines the parameters for retrieving Amazon Web Services cost and usage data. Includes specifications for metrics, time periods, granularity, grouping dimensions, and filtering conditions.

See Also:

  • Method Details

    • metrics

      public final List<MetricName> metrics()

      The specific cost and usage metrics to retrieve.

      Valid values for CostAndUsageQuery metrics are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetrics() method.

      Returns:
      The specific cost and usage metrics to retrieve.

      Valid values for CostAndUsageQuery metrics are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

    • hasMetrics

      public final boolean hasMetrics()
      For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • metricsAsStrings

      public final List<String> metricsAsStrings()

      The specific cost and usage metrics to retrieve.

      Valid values for CostAndUsageQuery metrics are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetrics() method.

      Returns:
      The specific cost and usage metrics to retrieve.

      Valid values for CostAndUsageQuery metrics are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

    • timeRange

      public final DateTimeRange timeRange()

      The time period for which to retrieve data. Can be specified as absolute dates or relative time periods.

      Returns:
      The time period for which to retrieve data. Can be specified as absolute dates or relative time periods.

    • granularity

      public final Granularity granularity()

      The granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.

      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 retrieved data: HOURLY, DAILY, or MONTHLY.
      See Also:

    • granularityAsString

      public final String granularityAsString()

      The granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.

      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 retrieved data: HOURLY, DAILY, or MONTHLY.
      See Also:

    • hasGroupBy

      public final boolean hasGroupBy()
      For responses, this returns true if the service returned a value for the GroupBy property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • groupBy

      public final List<GroupDefinition> groupBy()

      Specifies how to group the retrieved data, such as by SERVICE, ACCOUNT, or TAG.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroupBy() method.

      Returns:
      Specifies how to group the retrieved data, such as by SERVICE, ACCOUNT, or TAG.

    • filter

      public final Expression filter()

      The filter expression to be applied to the cost and usage data.

      Returns:
      The filter expression to be applied to the cost and usage data.

    • toBuilder

      public CostAndUsageQuery.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<CostAndUsageQuery.Builder,CostAndUsageQuery>
      Returns:
      a builder for type T

    • builder

      public static CostAndUsageQuery.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.