software.amazon.awssdk.services.workdocs.model

Class Filters

java.lang.Object

software.amazon.awssdk.services.workdocs.model.Filters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Filters.Builder,Filters>

@Generated(value="software.amazon.awssdk:codegen")
public final class Filters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Filters.Builder,Filters>

Filters results based on entity metadata.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Filters.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	ancestorIds() Filter based on resource’s path.
static Filters.Builder	builder()
List<ContentCategoryType>	contentCategories() Filters by content category.
List<String>	contentCategoriesAsStrings() Filters by content category.
DateRangeType	createdRange() Filter based on resource’s creation timestamp.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAncestorIds() For responses, this returns true if the service returned a value for the AncestorIds property.
boolean	hasContentCategories() For responses, this returns true if the service returned a value for the ContentCategories property.
int	hashCode()
boolean	hasLabels() For responses, this returns true if the service returned a value for the Labels property.
boolean	hasPrincipals() For responses, this returns true if the service returned a value for the Principals property.
boolean	hasResourceTypes() For responses, this returns true if the service returned a value for the ResourceTypes property.
boolean	hasSearchCollectionTypes() For responses, this returns true if the service returned a value for the SearchCollectionTypes property.
boolean	hasTextLocales() For responses, this returns true if the service returned a value for the TextLocales property.
List<String>	labels() Filter by labels using exact match.
DateRangeType	modifiedRange() Filter based on resource’s modified timestamp.
List<SearchPrincipalType>	principals() Filter based on UserIds or GroupIds.
List<SearchResourceType>	resourceTypes() Filters based on entity type.
List<String>	resourceTypesAsStrings() Filters based on entity type.
List<SdkField<?>>	sdkFields()
List<SearchCollectionType>	searchCollectionTypes() Filter based on file groupings.
List<String>	searchCollectionTypesAsStrings() Filter based on file groupings.
static Class<? extends Filters.Builder>	serializableBuilderClass()
LongRangeType	sizeRange() Filter based on size (in bytes).
List<LanguageCodeType>	textLocales() Filters by the locale of the content or comment.
List<String>	textLocalesAsStrings() Filters by the locale of the content or comment.
Filters.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

textLocales

public final List<LanguageCodeType> textLocales()

Filters by the locale of the content or comment.

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 hasTextLocales() method.

Returns:

Filters by the locale of the content or comment.

hasTextLocales

public final boolean hasTextLocales()

For responses, this returns true if the service returned a value for the TextLocales 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.

textLocalesAsStrings

public final List<String> textLocalesAsStrings()

Filters by the locale of the content or comment.

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 hasTextLocales() method.

Returns:

Filters by the locale of the content or comment.

contentCategories

public final List<ContentCategoryType> contentCategories()

Filters by content category.

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 hasContentCategories() method.

Returns:

Filters by content category.

hasContentCategories

public final boolean hasContentCategories()

For responses, this returns true if the service returned a value for the ContentCategories 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.

contentCategoriesAsStrings

public final List<String> contentCategoriesAsStrings()

Filters by content category.

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 hasContentCategories() method.

Returns:

Filters by content category.

resourceTypes

public final List<SearchResourceType> resourceTypes()

Filters based on entity type.

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 hasResourceTypes() method.

Returns:

Filters based on entity type.

hasResourceTypes

public final boolean hasResourceTypes()

For responses, this returns true if the service returned a value for the ResourceTypes 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.

resourceTypesAsStrings

public final List<String> resourceTypesAsStrings()

Filters based on entity type.

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 hasResourceTypes() method.

Returns:

Filters based on entity type.

hasLabels

public final boolean hasLabels()

For responses, this returns true if the service returned a value for the Labels 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.

labels

public final List<String> labels()

Filter by labels using exact match.

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 hasLabels() method.

Returns:

Filter by labels using exact match.

hasPrincipals

public final boolean hasPrincipals()

For responses, this returns true if the service returned a value for the Principals 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.

principals

public final List<SearchPrincipalType> principals()

Filter based on UserIds or GroupIds.

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 hasPrincipals() method.

Returns:

Filter based on UserIds or GroupIds.

hasAncestorIds

public final boolean hasAncestorIds()

For responses, this returns true if the service returned a value for the AncestorIds 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.

ancestorIds

public final List<String> ancestorIds()

Filter based on resource’s path.

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 hasAncestorIds() method.

Returns:

Filter based on resource’s path.

searchCollectionTypes

public final List<SearchCollectionType> searchCollectionTypes()

Filter based on file groupings.

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 hasSearchCollectionTypes() method.

Returns:

Filter based on file groupings.

hasSearchCollectionTypes

public final boolean hasSearchCollectionTypes()

For responses, this returns true if the service returned a value for the SearchCollectionTypes 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.

searchCollectionTypesAsStrings

public final List<String> searchCollectionTypesAsStrings()

Filter based on file groupings.

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 hasSearchCollectionTypes() method.

Returns:

Filter based on file groupings.

sizeRange

public final LongRangeType sizeRange()

Filter based on size (in bytes).

Returns:

Filter based on size (in bytes).

createdRange

public final DateRangeType createdRange()

Filter based on resource’s creation timestamp.

Returns:

Filter based on resource’s creation timestamp.

modifiedRange

public final DateRangeType modifiedRange()

Filter based on resource’s modified timestamp.

Returns:

Filter based on resource’s modified timestamp.

toBuilder

public Filters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Filters.Builder,Filters>

builder

public static Filters.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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