Filters (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.workdocs.model.Filters

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Filters
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Filters results based on entity metadata.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Filters()

Constructors
Constructor and Description
`Filters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Filters`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getAncestorIds()` Filter based on resource’s path.
`List<String>`	`getContentCategories()` Filters by content category.
`DateRangeType`	`getCreatedRange()` Filter based on resource’s creation timestamp.
`List<String>`	`getLabels()` Filter by labels using exact match.
`DateRangeType`	`getModifiedRange()` Filter based on resource’s modified timestamp.
`List<SearchPrincipalType>`	`getPrincipals()` Filter based on UserIds or GroupIds.
`List<String>`	`getResourceTypes()` Filters based on entity type.
`List<String>`	`getSearchCollectionTypes()` Filter based on file groupings.
`LongRangeType`	`getSizeRange()` Filter based on size (in bytes).
`List<String>`	`getTextLocales()` Filters by the locale of the content or comment.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAncestorIds(Collection<String> ancestorIds)` Filter based on resource’s path.
`void`	`setContentCategories(Collection<String> contentCategories)` Filters by content category.
`void`	`setCreatedRange(DateRangeType createdRange)` Filter based on resource’s creation timestamp.
`void`	`setLabels(Collection<String> labels)` Filter by labels using exact match.
`void`	`setModifiedRange(DateRangeType modifiedRange)` Filter based on resource’s modified timestamp.
`void`	`setPrincipals(Collection<SearchPrincipalType> principals)` Filter based on UserIds or GroupIds.
`void`	`setResourceTypes(Collection<String> resourceTypes)` Filters based on entity type.
`void`	`setSearchCollectionTypes(Collection<String> searchCollectionTypes)` Filter based on file groupings.
`void`	`setSizeRange(LongRangeType sizeRange)` Filter based on size (in bytes).
`void`	`setTextLocales(Collection<String> textLocales)` Filters by the locale of the content or comment.
`String`	`toString()` Returns a string representation of this object.
`Filters`	`withAncestorIds(Collection<String> ancestorIds)` Filter based on resource’s path.
`Filters`	`withAncestorIds(String... ancestorIds)` Filter based on resource’s path.
`Filters`	`withContentCategories(Collection<String> contentCategories)` Filters by content category.
`Filters`	`withContentCategories(ContentCategoryType... contentCategories)` Filters by content category.
`Filters`	`withContentCategories(String... contentCategories)` Filters by content category.
`Filters`	`withCreatedRange(DateRangeType createdRange)` Filter based on resource’s creation timestamp.
`Filters`	`withLabels(Collection<String> labels)` Filter by labels using exact match.
`Filters`	`withLabels(String... labels)` Filter by labels using exact match.
`Filters`	`withModifiedRange(DateRangeType modifiedRange)` Filter based on resource’s modified timestamp.
`Filters`	`withPrincipals(Collection<SearchPrincipalType> principals)` Filter based on UserIds or GroupIds.
`Filters`	`withPrincipals(SearchPrincipalType... principals)` Filter based on UserIds or GroupIds.
`Filters`	`withResourceTypes(Collection<String> resourceTypes)` Filters based on entity type.
`Filters`	`withResourceTypes(SearchResourceType... resourceTypes)` Filters based on entity type.
`Filters`	`withResourceTypes(String... resourceTypes)` Filters based on entity type.
`Filters`	`withSearchCollectionTypes(Collection<String> searchCollectionTypes)` Filter based on file groupings.
`Filters`	`withSearchCollectionTypes(SearchCollectionType... searchCollectionTypes)` Filter based on file groupings.
`Filters`	`withSearchCollectionTypes(String... searchCollectionTypes)` Filter based on file groupings.
`Filters`	`withSizeRange(LongRangeType sizeRange)` Filter based on size (in bytes).
`Filters`	`withTextLocales(Collection<String> textLocales)` Filters by the locale of the content or comment.
`Filters`	`withTextLocales(LanguageCodeType... textLocales)` Filters by the locale of the content or comment.
`Filters`	`withTextLocales(String... textLocales)` Filters by the locale of the content or comment.

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

- Constructor Detail
  - Filters
```
public Filters()
```
- Method Detail
  - getTextLocales
```
public List<String> getTextLocales()
```
    Filters by the locale of the content or comment.
    
    Returns:
    
    Filters by the locale of the content or comment.
    
    See Also:
    
    LanguageCodeType
  - setTextLocales
```
public void setTextLocales(Collection<String> textLocales)
```
    Filters by the locale of the content or comment.
    
    Parameters:
    
    textLocales - Filters by the locale of the content or comment.
    
    See Also:
    
    LanguageCodeType
  - withTextLocales
```
public Filters withTextLocales(String... textLocales)
```
    Filters by the locale of the content or comment.
    
    NOTE: This method appends the values to the existing list (if any). Use setTextLocales(java.util.Collection) or withTextLocales(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    textLocales - Filters by the locale of the content or comment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCodeType
  - withTextLocales
```
public Filters withTextLocales(Collection<String> textLocales)
```
    Filters by the locale of the content or comment.
    
    Parameters:
    
    textLocales - Filters by the locale of the content or comment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCodeType
  - withTextLocales
```
public Filters withTextLocales(LanguageCodeType... textLocales)
```
    Filters by the locale of the content or comment.
    
    Parameters:
    
    textLocales - Filters by the locale of the content or comment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCodeType
  - getContentCategories
```
public List<String> getContentCategories()
```
    Filters by content category.
    
    Returns:
    
    Filters by content category.
    
    See Also:
    
    ContentCategoryType
  - setContentCategories
```
public void setContentCategories(Collection<String> contentCategories)
```
    Filters by content category.
    
    Parameters:
    
    contentCategories - Filters by content category.
    
    See Also:
    
    ContentCategoryType
  - withContentCategories
```
public Filters withContentCategories(String... contentCategories)
```
    Filters by content category.
    
    NOTE: This method appends the values to the existing list (if any). Use setContentCategories(java.util.Collection) or withContentCategories(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    contentCategories - Filters by content category.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ContentCategoryType
  - withContentCategories
```
public Filters withContentCategories(Collection<String> contentCategories)
```
    Filters by content category.
    
    Parameters:
    
    contentCategories - Filters by content category.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ContentCategoryType
  - withContentCategories
```
public Filters withContentCategories(ContentCategoryType... contentCategories)
```
    Filters by content category.
    
    Parameters:
    
    contentCategories - Filters by content category.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ContentCategoryType
  - getResourceTypes
```
public List<String> getResourceTypes()
```
    Filters based on entity type.
    
    Returns:
    
    Filters based on entity type.
    
    See Also:
    
    SearchResourceType
  - setResourceTypes
```
public void setResourceTypes(Collection<String> resourceTypes)
```
    Filters based on entity type.
    
    Parameters:
    
    resourceTypes - Filters based on entity type.
    
    See Also:
    
    SearchResourceType
  - withResourceTypes
```
public Filters withResourceTypes(String... resourceTypes)
```
    Filters based on entity type.
    
    NOTE: This method appends the values to the existing list (if any). Use setResourceTypes(java.util.Collection) or withResourceTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    resourceTypes - Filters based on entity type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SearchResourceType
  - withResourceTypes
```
public Filters withResourceTypes(Collection<String> resourceTypes)
```
    Filters based on entity type.
    
    Parameters:
    
    resourceTypes - Filters based on entity type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SearchResourceType
  - withResourceTypes
```
public Filters withResourceTypes(SearchResourceType... resourceTypes)
```
    Filters based on entity type.
    
    Parameters:
    
    resourceTypes - Filters based on entity type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SearchResourceType
  - getLabels
```
public List<String> getLabels()
```
    Filter by labels using exact match.
    
    Returns:
    
    Filter by labels using exact match.
  - setLabels
```
public void setLabels(Collection<String> labels)
```
    Filter by labels using exact match.
    
    Parameters:
    
    labels - Filter by labels using exact match.
  - withLabels
```
public Filters withLabels(String... labels)
```
    Filter by labels using exact match.
    
    NOTE: This method appends the values to the existing list (if any). Use setLabels(java.util.Collection) or withLabels(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    labels - Filter by labels using exact match.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withLabels
```
public Filters withLabels(Collection<String> labels)
```
    Filter by labels using exact match.
    
    Parameters:
    
    labels - Filter by labels using exact match.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPrincipals
```
public List<SearchPrincipalType> getPrincipals()
```
    Filter based on UserIds or GroupIds.
    
    Returns:
    
    Filter based on UserIds or GroupIds.
  - setPrincipals
```
public void setPrincipals(Collection<SearchPrincipalType> principals)
```
    Filter based on UserIds or GroupIds.
    
    Parameters:
    
    principals - Filter based on UserIds or GroupIds.
  - withPrincipals
```
public Filters withPrincipals(SearchPrincipalType... principals)
```
    Filter based on UserIds or GroupIds.
    
    NOTE: This method appends the values to the existing list (if any). Use setPrincipals(java.util.Collection) or withPrincipals(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    principals - Filter based on UserIds or GroupIds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPrincipals
```
public Filters withPrincipals(Collection<SearchPrincipalType> principals)
```
    Filter based on UserIds or GroupIds.
    
    Parameters:
    
    principals - Filter based on UserIds or GroupIds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAncestorIds
```
public List<String> getAncestorIds()
```
    Filter based on resource’s path.
    
    Returns:
    
    Filter based on resource’s path.
  - setAncestorIds
```
public void setAncestorIds(Collection<String> ancestorIds)
```
    Filter based on resource’s path.
    
    Parameters:
    
    ancestorIds - Filter based on resource’s path.
  - withAncestorIds
```
public Filters withAncestorIds(String... ancestorIds)
```
    Filter based on resource’s path.
    
    NOTE: This method appends the values to the existing list (if any). Use setAncestorIds(java.util.Collection) or withAncestorIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    ancestorIds - Filter based on resource’s path.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAncestorIds
```
public Filters withAncestorIds(Collection<String> ancestorIds)
```
    Filter based on resource’s path.
    
    Parameters:
    
    ancestorIds - Filter based on resource’s path.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSearchCollectionTypes
```
public List<String> getSearchCollectionTypes()
```
    Filter based on file groupings.
    
    Returns:
    
    Filter based on file groupings.
    
    See Also:
    
    SearchCollectionType
  - setSearchCollectionTypes
```
public void setSearchCollectionTypes(Collection<String> searchCollectionTypes)
```
    Filter based on file groupings.
    
    Parameters:
    
    searchCollectionTypes - Filter based on file groupings.
    
    See Also:
    
    SearchCollectionType
  - withSearchCollectionTypes
```
public Filters withSearchCollectionTypes(String... searchCollectionTypes)
```
    Filter based on file groupings.
    
    NOTE: This method appends the values to the existing list (if any). Use setSearchCollectionTypes(java.util.Collection) or withSearchCollectionTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    searchCollectionTypes - Filter based on file groupings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SearchCollectionType
  - withSearchCollectionTypes
```
public Filters withSearchCollectionTypes(Collection<String> searchCollectionTypes)
```
    Filter based on file groupings.
    
    Parameters:
    
    searchCollectionTypes - Filter based on file groupings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SearchCollectionType
  - withSearchCollectionTypes
```
public Filters withSearchCollectionTypes(SearchCollectionType... searchCollectionTypes)
```
    Filter based on file groupings.
    
    Parameters:
    
    searchCollectionTypes - Filter based on file groupings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SearchCollectionType
  - setSizeRange
```
public void setSizeRange(LongRangeType sizeRange)
```
    Filter based on size (in bytes).
    
    Parameters:
    
    sizeRange - Filter based on size (in bytes).
  - getSizeRange
```
public LongRangeType getSizeRange()
```
    Filter based on size (in bytes).
    
    Returns:
    
    Filter based on size (in bytes).
  - withSizeRange
```
public Filters withSizeRange(LongRangeType sizeRange)
```
    Filter based on size (in bytes).
    
    Parameters:
    
    sizeRange - Filter based on size (in bytes).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedRange
```
public void setCreatedRange(DateRangeType createdRange)
```
    Filter based on resource’s creation timestamp.
    
    Parameters:
    
    createdRange - Filter based on resource’s creation timestamp.
  - getCreatedRange
```
public DateRangeType getCreatedRange()
```
    Filter based on resource’s creation timestamp.
    
    Returns:
    
    Filter based on resource’s creation timestamp.
  - withCreatedRange
```
public Filters withCreatedRange(DateRangeType createdRange)
```
    Filter based on resource’s creation timestamp.
    
    Parameters:
    
    createdRange - Filter based on resource’s creation timestamp.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModifiedRange
```
public void setModifiedRange(DateRangeType modifiedRange)
```
    Filter based on resource’s modified timestamp.
    
    Parameters:
    
    modifiedRange - Filter based on resource’s modified timestamp.
  - getModifiedRange
```
public DateRangeType getModifiedRange()
```
    Filter based on resource’s modified timestamp.
    
    Returns:
    
    Filter based on resource’s modified timestamp.
  - withModifiedRange
```
public Filters withModifiedRange(DateRangeType modifiedRange)
```
    Filter based on resource’s modified timestamp.
    
    Parameters:
    
    modifiedRange - Filter based on resource’s modified timestamp.
    
    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. 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 Filters 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.

AWS SDK for Java 1.x API Reference - 1.12.779

Class Filters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Filters

Method Detail

getTextLocales

setTextLocales

withTextLocales

withTextLocales

withTextLocales

getContentCategories

setContentCategories

withContentCategories

withContentCategories

withContentCategories

getResourceTypes

setResourceTypes

withResourceTypes

withResourceTypes

withResourceTypes

getLabels

setLabels

withLabels

withLabels

getPrincipals

setPrincipals

withPrincipals

withPrincipals

getAncestorIds

setAncestorIds

withAncestorIds

withAncestorIds

getSearchCollectionTypes

setSearchCollectionTypes

withSearchCollectionTypes

withSearchCollectionTypes

withSearchCollectionTypes

setSizeRange

getSizeRange

withSizeRange

setCreatedRange

getCreatedRange

withCreatedRange

setModifiedRange

getModifiedRange

withModifiedRange

toString

equals

hashCode

clone

marshall