com.box.sdkgen.schemas.metadatacascadepolicy

Class MetadataCascadePolicy

Object

NullableFieldTracker

SerializableObject

MetadataCascadePolicy

All Implemented Interfaces:

Serializable

public class MetadataCascadePolicy
extends SerializableObject

A metadata cascade policy automatically applies a metadata template instance to all the files and folders within the targeted folder.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetadataCascadePolicy.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected String	id The ID of the metadata cascade policy object.
protected MetadataCascadePolicyOwnerEnterpriseField	ownerEnterprise The enterprise that owns this policy.
protected MetadataCascadePolicyParentField	parent Represent the folder the policy is applied to.
protected String	scope The scope of the metadata cascade policy can either be `global` or `enterprise_*`.
protected String	templateKey The key of the template that is cascaded down to the folder's children.
protected EnumWrapper<MetadataCascadePolicyTypeField>	type The value will always be `metadata_cascade_policy`.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetadataCascadePolicy(MetadataCascadePolicy.Builder builder)
	MetadataCascadePolicy(String id)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getId()
MetadataCascadePolicyOwnerEnterpriseField	getOwnerEnterprise()
MetadataCascadePolicyParentField	getParent()
String	getScope()
String	getTemplateKey()
EnumWrapper<MetadataCascadePolicyTypeField>	getType()
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

id

protected final String id

The ID of the metadata cascade policy object.

type

protected EnumWrapper<MetadataCascadePolicyTypeField> type

The value will always be `metadata_cascade_policy`.

ownerEnterprise

protected MetadataCascadePolicyOwnerEnterpriseField ownerEnterprise

The enterprise that owns this policy.

parent

protected MetadataCascadePolicyParentField parent

Represent the folder the policy is applied to.

scope

protected String scope

The scope of the metadata cascade policy can either be `global` or `enterprise_*`. The `global` scope is used for policies that are available to any Box enterprise. The `enterprise_*` scope represents policies that have been created within a specific enterprise, where `*` will be the ID of that enterprise.

templateKey

protected String templateKey

The key of the template that is cascaded down to the folder's children.

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

Constructor Detail

MetadataCascadePolicy

public MetadataCascadePolicy(String id)

MetadataCascadePolicy

protected MetadataCascadePolicy(MetadataCascadePolicy.Builder builder)

Method Detail

getId

public String getId()

getType

public EnumWrapper<MetadataCascadePolicyTypeField> getType()

getOwnerEnterprise

public MetadataCascadePolicyOwnerEnterpriseField getOwnerEnterprise()

getParent

public MetadataCascadePolicyParentField getParent()

getScope

public String getScope()

getTemplateKey

public String getTemplateKey()

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