Class Filter
- java.lang.Object
-
- software.amazon.awssdk.services.pricing.model.Filter
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Filter.Builder,Filter>
@Generated("software.amazon.awssdk:codegen") public final class Filter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Filter.Builder,Filter>
The constraints that you want all returned products to match.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFilter.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Filter.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)Stringfield()The product metadata field that you want to filter on.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()List<SdkField<?>>sdkFields()static Class<? extends Filter.Builder>serializableBuilderClass()Filter.BuildertoBuilder()StringtoString()Returns a string representation of this object.FilterTypetype()The type of filter that you want to use.StringtypeAsString()The type of filter that you want to use.Stringvalue()The service code or attribute value that you want to filter by.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
type
public final FilterType type()
The type of filter that you want to use.
Valid values are:
TERM_MATCH.TERM_MATCHreturns only products that match both the given filter field and the given value.If the service returns an enum value that is not available in the current SDK version,
typewill returnFilterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of filter that you want to use.
Valid values are:
TERM_MATCH.TERM_MATCHreturns only products that match both the given filter field and the given value. - See Also:
FilterType
-
typeAsString
public final String typeAsString()
The type of filter that you want to use.
Valid values are:
TERM_MATCH.TERM_MATCHreturns only products that match both the given filter field and the given value.If the service returns an enum value that is not available in the current SDK version,
typewill returnFilterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of filter that you want to use.
Valid values are:
TERM_MATCH.TERM_MATCHreturns only products that match both the given filter field and the given value. - See Also:
FilterType
-
field
public final String field()
The product metadata field that you want to filter on. You can filter by just the service code to see all products for a specific service, filter by just the attribute name to see a specific attribute for multiple services, or use both a service code and an attribute name to retrieve only products that match both fields.
Valid values include:
ServiceCode, and all attribute namesFor example, you can filter by the
AmazonEC2service code and thevolumeTypeattribute name to get the prices for only Amazon EC2 volumes.- Returns:
- The product metadata field that you want to filter on. You can filter by just the service code to see all
products for a specific service, filter by just the attribute name to see a specific attribute for
multiple services, or use both a service code and an attribute name to retrieve only products that match
both fields.
Valid values include:
ServiceCode, and all attribute namesFor example, you can filter by the
AmazonEC2service code and thevolumeTypeattribute name to get the prices for only Amazon EC2 volumes.
-
value
public final String value()
The service code or attribute value that you want to filter by. If you're filtering by service code this is the actual service code, such as
AmazonEC2. If you're filtering by attribute name, this is the attribute value that you want the returned products to match, such as aProvisioned IOPSvolume.- Returns:
- The service code or attribute value that you want to filter by. If you're filtering by service code this
is the actual service code, such as
AmazonEC2. If you're filtering by attribute name, this is the attribute value that you want the returned products to match, such as aProvisioned IOPSvolume.
-
toBuilder
public Filter.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Filter.Builder,Filter>
-
builder
public static Filter.Builder builder()
-
serializableBuilderClass
public static Class<? extends Filter.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-