Class DimensionValues

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

The metadata that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

See Also:

  • Method Details

    • key

      public final Dimension key()

      The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

      Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

      LINKED_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

      ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

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

      Returns:
      The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

      Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

      LINKED_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

      ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

      See Also:

    • keyAsString

      public final String keyAsString()

      The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

      Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

      LINKED_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

      ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

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

      Returns:
      The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

      Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

      LINKED_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

      ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

      See Also:

    • hasValues

      public final boolean hasValues()
      For responses, this returns true if the service returned a value for the Values 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.

    • values

      public final List<String> values()

      The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

      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 hasValues() method.

      Returns:
      The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

    • matchOptions

      public final List<MatchOption> matchOptions()

      The match options that you can use to filter your results.

      MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

      The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      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 hasMatchOptions() method.

      Returns:
      The match options that you can use to filter your results.

      MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

      The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

    • hasMatchOptions

      public final boolean hasMatchOptions()
      For responses, this returns true if the service returned a value for the MatchOptions 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.

    • matchOptionsAsStrings

      public final List<String> matchOptionsAsStrings()

      The match options that you can use to filter your results.

      MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

      The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      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 hasMatchOptions() method.

      Returns:
      The match options that you can use to filter your results.

      MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

      The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

    • toBuilder

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

    • builder

      public static DimensionValues.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DimensionValues.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.