Class ProductAttributeValues

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

The product attribute values used for filtering the costs by key and value pairs. Product attributes are supported for Amazon Bedrock only.

See Also:

  • Method Details

    • key

      public final String key()

      The name of the product attribute to filter on. Valid values are the following:

      • feature – The feature that was used, such as On-demand Inference.

      • inferenceType – The type of inference usage, such as Input tokens or Output tokens.

      • model – The model, such as Claude Sonnet 5 or Claude Haiku 4.5.

      • provider – The model provider, such as Anthropic, Cohere, or Amazon.

      Keys are case-sensitive.

      Returns:
      The name of the product attribute to filter on. Valid values are the following:

      • feature – The feature that was used, such as On-demand Inference.

      • inferenceType – The type of inference usage, such as Input tokens or Output tokens.

      • model – The model, such as Claude Sonnet 5 or Claude Haiku 4.5.

      • provider – The model provider, such as Anthropic, Cohere, or Amazon.

      Keys are case-sensitive.

    • 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 specific values of the product attribute, such as Claude Sonnet 5 for the model key. Values are matched exactly.

      Values is required unless MatchOptions is ABSENT. To match costs that have no value for the key, set MatchOptions to ABSENT and omit 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 specific values of the product attribute, such as Claude Sonnet 5 for the model key. Values are matched exactly.

      Values is required unless MatchOptions is ABSENT. To match costs that have no value for the key, set MatchOptions to ABSENT and omit Values.

    • matchOptions

      public final List<MatchOption> matchOptions()

      The match options for the ProductAttributes filter. Valid values:

      • ABSENT – Matches costs that have no value for the attribute.

      • CASE_SENSITIVE – Requires an exact case match.

      • EQUALS – Matches costs where the attribute equals the specified value.

      Specify either EQUALS or ABSENT. You can add CASE_SENSITIVE to EQUALS, but you can't use it by itself or with ABSENT.

      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 for the ProductAttributes filter. Valid values:

      • ABSENT – Matches costs that have no value for the attribute.

      • CASE_SENSITIVE – Requires an exact case match.

      • EQUALS – Matches costs where the attribute equals the specified value.

      Specify either EQUALS or ABSENT. You can add CASE_SENSITIVE to EQUALS, but you can't use it by itself or with ABSENT.

    • 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 for the ProductAttributes filter. Valid values:

      • ABSENT – Matches costs that have no value for the attribute.

      • CASE_SENSITIVE – Requires an exact case match.

      • EQUALS – Matches costs where the attribute equals the specified value.

      Specify either EQUALS or ABSENT. You can add CASE_SENSITIVE to EQUALS, but you can't use it by itself or with ABSENT.

      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 for the ProductAttributes filter. Valid values:

      • ABSENT – Matches costs that have no value for the attribute.

      • CASE_SENSITIVE – Requires an exact case match.

      • EQUALS – Matches costs where the attribute equals the specified value.

      Specify either EQUALS or ABSENT. You can add CASE_SENSITIVE to EQUALS, but you can't use it by itself or with ABSENT.

    • toBuilder

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

    • builder

      public static ProductAttributeValues.Builder builder()

    • serializableBuilderClass

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