LocationFilter (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.datasync.model.LocationFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class LocationFilter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
You can use API filters to narrow down the list of resources returned by ListLocations. For example, to retrieve all your Amazon S3 locations, you can use ListLocations with filter name LocationType S3 and Operator Equals.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

LocationFilter()

Constructors
Constructor and Description
`LocationFilter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LocationFilter`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getName()` The name of the filter being used.
`String`	`getOperator()` The operator that is used to compare filter values (for example, `Equals` or `Contains`).
`List<String>`	`getValues()` The values that you want to filter for.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setName(String name)` The name of the filter being used.
`void`	`setOperator(String operator)` The operator that is used to compare filter values (for example, `Equals` or `Contains`).
`void`	`setValues(Collection<String> values)` The values that you want to filter for.
`String`	`toString()` Returns a string representation of this object.
`LocationFilter`	`withName(LocationFilterName name)` The name of the filter being used.
`LocationFilter`	`withName(String name)` The name of the filter being used.
`LocationFilter`	`withOperator(Operator operator)` The operator that is used to compare filter values (for example, `Equals` or `Contains`).
`LocationFilter`	`withOperator(String operator)` The operator that is used to compare filter values (for example, `Equals` or `Contains`).
`LocationFilter`	`withValues(Collection<String> values)` The values that you want to filter for.
`LocationFilter`	`withValues(String... values)` The values that you want to filter for.

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

- Constructor Detail
  - LocationFilter
```
public LocationFilter()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the filter being used. Each API call supports a list of filters that are available for it (for example, LocationType for ListLocations).
    
    Parameters:
    
    name - The name of the filter being used. Each API call supports a list of filters that are available for it (for example, LocationType for ListLocations).
    
    See Also:
    
    LocationFilterName
  - getName
```
public String getName()
```
    The name of the filter being used. Each API call supports a list of filters that are available for it (for example, LocationType for ListLocations).
    
    Returns:
    
    The name of the filter being used. Each API call supports a list of filters that are available for it (for example, LocationType for ListLocations).
    
    See Also:
    
    LocationFilterName
  - withName
```
public LocationFilter withName(String name)
```
    The name of the filter being used. Each API call supports a list of filters that are available for it (for example, LocationType for ListLocations).
    
    Parameters:
    
    name - The name of the filter being used. Each API call supports a list of filters that are available for it (for example, LocationType for ListLocations).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LocationFilterName
  - withName
```
public LocationFilter withName(LocationFilterName name)
```
    The name of the filter being used. Each API call supports a list of filters that are available for it (for example, LocationType for ListLocations).
    
    Parameters:
    
    name - The name of the filter being used. Each API call supports a list of filters that are available for it (for example, LocationType for ListLocations).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LocationFilterName
  - getValues
```
public List<String> getValues()
```
    The values that you want to filter for. For example, you might want to display only Amazon S3 locations.
    
    Returns:
    
    The values that you want to filter for. For example, you might want to display only Amazon S3 locations.
  - setValues
```
public void setValues(Collection<String> values)
```
    The values that you want to filter for. For example, you might want to display only Amazon S3 locations.
    
    Parameters:
    
    values - The values that you want to filter for. For example, you might want to display only Amazon S3 locations.
  - withValues
```
public LocationFilter withValues(String... values)
```
    The values that you want to filter for. For example, you might want to display only Amazon S3 locations.
    
    NOTE: This method appends the values to the existing list (if any). Use setValues(java.util.Collection) or withValues(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    values - The values that you want to filter for. For example, you might want to display only Amazon S3 locations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withValues
```
public LocationFilter withValues(Collection<String> values)
```
    The values that you want to filter for. For example, you might want to display only Amazon S3 locations.
    
    Parameters:
    
    values - The values that you want to filter for. For example, you might want to display only Amazon S3 locations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOperator
```
public void setOperator(String operator)
```
    The operator that is used to compare filter values (for example, Equals or Contains). For more about API filtering operators, see query-resources.
    
    Parameters:
    
    operator - The operator that is used to compare filter values (for example, Equals or Contains). For more about API filtering operators, see query-resources.
    
    See Also:
    
    Operator
  - getOperator
```
public String getOperator()
```
    The operator that is used to compare filter values (for example, Equals or Contains). For more about API filtering operators, see query-resources.
    
    Returns:
    
    The operator that is used to compare filter values (for example, Equals or Contains). For more about API filtering operators, see query-resources.
    
    See Also:
    
    Operator
  - withOperator
```
public LocationFilter withOperator(String operator)
```
    The operator that is used to compare filter values (for example, Equals or Contains). For more about API filtering operators, see query-resources.
    
    Parameters:
    
    operator - The operator that is used to compare filter values (for example, Equals or Contains). For more about API filtering operators, see query-resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Operator
  - withOperator
```
public LocationFilter withOperator(Operator operator)
```
    The operator that is used to compare filter values (for example, Equals or Contains). For more about API filtering operators, see query-resources.
    
    Parameters:
    
    operator - The operator that is used to compare filter values (for example, Equals or Contains). For more about API filtering operators, see query-resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Operator
  - toString
```
public 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
    
    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 LocationFilter 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 LocationFilter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LocationFilter

Method Detail

setName

getName

withName

withName

getValues

setValues

withValues

withValues

setOperator

getOperator

withOperator

withOperator

toString

equals

hashCode

clone

marshall