com.box.sdkgen.schemas.metadatafilter

Class MetadataFilter

Object

NullableFieldTracker

SerializableObject

MetadataFilter

All Implemented Interfaces:

Serializable

public class MetadataFilter
extends SerializableObject

A metadata template used to filter the search results.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetadataFilter.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,MetadataFilterValue>	filters Specifies which fields on the template to filter the search results by.
protected EnumWrapper<MetadataFilterScopeField>	scope Specifies the scope of the template to filter search results by.
protected String	templateKey The key of the template used to filter search results.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	MetadataFilter()
protected	MetadataFilter(MetadataFilter.Builder builder)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Map<String,MetadataFilterValue>	getFilters()
EnumWrapper<MetadataFilterScopeField>	getScope()
String	getTemplateKey()
int	hashCode()
String	toString()

Methods inherited from class SerializableObject

getRawData, setRawData

Methods inherited from class NullableFieldTracker

getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

scope

protected EnumWrapper<MetadataFilterScopeField> scope

Specifies the scope of the template to filter search results by.

This will be `enterprise_{enterprise_id}` for templates defined for use in this enterprise, and `global` for general templates that are available to all enterprises using Box.

templateKey

protected String templateKey

The key of the template used to filter search results.

In many cases the template key is automatically derived of its display name, for example `Contract Template` would become `contractTemplate`. In some cases the creator of the template will have provided its own template key.

Please [list the templates for an enterprise][list], or get all instances on a [file][file] or [folder][folder] to inspect a template's key.

[list]: https://developer.box.com/reference/get-metadata-templates-enterprise [file]: https://developer.box.com/reference/get-files-id-metadata [folder]: https://developer.box.com/reference/get-folders-id-metadata

filters

protected Map<String,MetadataFilterValue> filters

Specifies which fields on the template to filter the search results by. When more than one field is specified, the query performs a logical `AND` to ensure that the instance of the template matches each of the fields specified.

Constructor Detail

MetadataFilter

public MetadataFilter()

MetadataFilter

protected MetadataFilter(MetadataFilter.Builder builder)

Method Detail

getScope

public EnumWrapper<MetadataFilterScopeField> getScope()

getTemplateKey

public String getTemplateKey()

getFilters

public Map<String,MetadataFilterValue> getFilters()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object