Filter (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pricing.model.Filter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Filter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The constraints that you want all returned products to match.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Filter()

Constructors
Constructor and Description
`Filter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Filter`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getField()` The product metadata field that you want to filter on.
`String`	`getType()` The type of filter that you want to use.
`String`	`getValue()` The service code or attribute value that you want to filter by.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setField(String field)` The product metadata field that you want to filter on.
`void`	`setType(String type)` The type of filter that you want to use.
`void`	`setValue(String value)` The service code or attribute value that you want to filter by.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Filter`	`withField(String field)` The product metadata field that you want to filter on.
`Filter`	`withType(FilterType type)` The type of filter that you want to use.
`Filter`	`withType(String type)` The type of filter that you want to use.
`Filter`	`withValue(String value)` The service code or attribute value that you want to filter by.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Filter
```
public Filter()
```
- Method Detail
  - setType
```
public void setType(String type)
```
    The type of filter that you want to use.
    
    Valid values are: TERM_MATCH. TERM_MATCH returns only products that match both the given filter field and the given value.
    
    Parameters:
    
    type - The type of filter that you want to use.
    
    Valid values are: TERM_MATCH. TERM_MATCH returns only products that match both the given filter field and the given value.
    
    See Also:
    
    FilterType
  - getType
```
public String getType()
```
    The type of filter that you want to use.
    
    Valid values are: TERM_MATCH. TERM_MATCH returns only products that match both the given filter field and the given value.
    
    Returns:
    
    The type of filter that you want to use.
    
    Valid values are: TERM_MATCH. TERM_MATCH returns only products that match both the given filter field and the given value.
    
    See Also:
    
    FilterType
  - withType
```
public Filter withType(String type)
```
    The type of filter that you want to use.
    
    Valid values are: TERM_MATCH. TERM_MATCH returns only products that match both the given filter field and the given value.
    
    Parameters:
    
    type - The type of filter that you want to use.
    
    Valid values are: TERM_MATCH. TERM_MATCH returns only products that match both the given filter field and the given value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FilterType
  - withType
```
public Filter withType(FilterType type)
```
    The type of filter that you want to use.
    
    Valid values are: TERM_MATCH. TERM_MATCH returns only products that match both the given filter field and the given value.
    
    Parameters:
    
    type - The type of filter that you want to use.
    
    Valid values are: TERM_MATCH. TERM_MATCH returns only products that match both the given filter field and the given value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FilterType
  - setField
```
public void setField(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 names
    
    For example, you can filter by the AmazonEC2 service code and the volumeType attribute name to get the prices for only Amazon EC2 volumes.
    
    Parameters:
    
    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 names
    
    For example, you can filter by the AmazonEC2 service code and the volumeType attribute name to get the prices for only Amazon EC2 volumes.
  - getField
```
public String getField()
```
    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 names
    
    For example, you can filter by the AmazonEC2 service code and the volumeType attribute 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 names
    
    For example, you can filter by the AmazonEC2 service code and the volumeType attribute name to get the prices for only Amazon EC2 volumes.
  - withField
```
public Filter withField(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 names
    
    For example, you can filter by the AmazonEC2 service code and the volumeType attribute name to get the prices for only Amazon EC2 volumes.
    
    Parameters:
    
    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 names
    
    For example, you can filter by the AmazonEC2 service code and the volumeType attribute name to get the prices for only Amazon EC2 volumes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValue
```
public void setValue(String value)
```
    The service code or attribute value that you want to filter by. If you are filtering by service code this is the actual service code, such as AmazonEC2. If you are filtering by attribute name, this is the attribute value that you want the returned products to match, such as a Provisioned IOPS volume.
    
    Parameters:
    
    value - The service code or attribute value that you want to filter by. If you are filtering by service code this is the actual service code, such as AmazonEC2. If you are filtering by attribute name, this is the attribute value that you want the returned products to match, such as a Provisioned IOPS volume.
  - getValue
```
public String getValue()
```
    The service code or attribute value that you want to filter by. If you are filtering by service code this is the actual service code, such as AmazonEC2. If you are filtering by attribute name, this is the attribute value that you want the returned products to match, such as a Provisioned IOPS volume.
    
    Returns:
    
    The service code or attribute value that you want to filter by. If you are filtering by service code this is the actual service code, such as AmazonEC2. If you are filtering by attribute name, this is the attribute value that you want the returned products to match, such as a Provisioned IOPS volume.
  - withValue
```
public Filter withValue(String value)
```
    The service code or attribute value that you want to filter by. If you are filtering by service code this is the actual service code, such as AmazonEC2. If you are filtering by attribute name, this is the attribute value that you want the returned products to match, such as a Provisioned IOPS volume.
    
    Parameters:
    
    value - The service code or attribute value that you want to filter by. If you are filtering by service code this is the actual service code, such as AmazonEC2. If you are filtering by attribute name, this is the attribute value that you want the returned products to match, such as a Provisioned IOPS volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Filter clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Filter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Filter

Method Detail

setType

getType

withType

withType

setField

getField

withField

setValue

getValue

withValue

toString

equals

hashCode

clone

marshall