com.box.sdkgen.managers.metadatacascadepolicies

Class MetadataCascadePoliciesManager

Object

MetadataCascadePoliciesManager

public class MetadataCascadePoliciesManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetadataCascadePoliciesManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	applyMetadataCascadePolicy(String metadataCascadePolicyId, ApplyMetadataCascadePolicyRequestBody requestBody) Force the metadata on a folder with a metadata cascade policy to be applied to all of its children.
void	applyMetadataCascadePolicy(String metadataCascadePolicyId, ApplyMetadataCascadePolicyRequestBody requestBody, ApplyMetadataCascadePolicyHeaders headers) Force the metadata on a folder with a metadata cascade policy to be applied to all of its children.
MetadataCascadePolicy	createMetadataCascadePolicy(CreateMetadataCascadePolicyRequestBody requestBody) Creates a new metadata cascade policy that applies a given metadata template to a given folder and automatically cascades it down to any files within that folder.
MetadataCascadePolicy	createMetadataCascadePolicy(CreateMetadataCascadePolicyRequestBody requestBody, CreateMetadataCascadePolicyHeaders headers) Creates a new metadata cascade policy that applies a given metadata template to a given folder and automatically cascades it down to any files within that folder.
void	deleteMetadataCascadePolicyById(String metadataCascadePolicyId) Deletes a metadata cascade policy.
void	deleteMetadataCascadePolicyById(String metadataCascadePolicyId, DeleteMetadataCascadePolicyByIdHeaders headers) Deletes a metadata cascade policy.
Authentication	getAuth()
MetadataCascadePolicies	getMetadataCascadePolicies(GetMetadataCascadePoliciesQueryParams queryParams) Retrieves a list of all the metadata cascade policies that are applied to a given folder.
MetadataCascadePolicies	getMetadataCascadePolicies(GetMetadataCascadePoliciesQueryParams queryParams, GetMetadataCascadePoliciesHeaders headers) Retrieves a list of all the metadata cascade policies that are applied to a given folder.
MetadataCascadePolicy	getMetadataCascadePolicyById(String metadataCascadePolicyId) Retrieve a specific metadata cascade policy assigned to a folder.
MetadataCascadePolicy	getMetadataCascadePolicyById(String metadataCascadePolicyId, GetMetadataCascadePolicyByIdHeaders headers) Retrieve a specific metadata cascade policy assigned to a folder.
NetworkSession	getNetworkSession()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

MetadataCascadePoliciesManager

public MetadataCascadePoliciesManager()

MetadataCascadePoliciesManager

protected MetadataCascadePoliciesManager(MetadataCascadePoliciesManager.Builder builder)

Method Detail

getMetadataCascadePolicies

public MetadataCascadePolicies getMetadataCascadePolicies(GetMetadataCascadePoliciesQueryParams queryParams)

Retrieves a list of all the metadata cascade policies that are applied to a given folder. This can not be used on the root folder with ID `0`.

Parameters:

queryParams - Query parameters of getMetadataCascadePolicies method

getMetadataCascadePolicies

public MetadataCascadePolicies getMetadataCascadePolicies(GetMetadataCascadePoliciesQueryParams queryParams,
                                                          GetMetadataCascadePoliciesHeaders headers)

Retrieves a list of all the metadata cascade policies that are applied to a given folder. This can not be used on the root folder with ID `0`.

Parameters:

queryParams - Query parameters of getMetadataCascadePolicies method

headers - Headers of getMetadataCascadePolicies method

createMetadataCascadePolicy

public MetadataCascadePolicy createMetadataCascadePolicy(CreateMetadataCascadePolicyRequestBody requestBody)

Creates a new metadata cascade policy that applies a given metadata template to a given folder and automatically cascades it down to any files within that folder.

In order for the policy to be applied a metadata instance must first be applied to the folder the policy is to be applied to.

Parameters:

requestBody - Request body of createMetadataCascadePolicy method

createMetadataCascadePolicy

public MetadataCascadePolicy createMetadataCascadePolicy(CreateMetadataCascadePolicyRequestBody requestBody,
                                                         CreateMetadataCascadePolicyHeaders headers)

Creates a new metadata cascade policy that applies a given metadata template to a given folder and automatically cascades it down to any files within that folder.

In order for the policy to be applied a metadata instance must first be applied to the folder the policy is to be applied to.

Parameters:

requestBody - Request body of createMetadataCascadePolicy method

headers - Headers of createMetadataCascadePolicy method

getMetadataCascadePolicyById

public MetadataCascadePolicy getMetadataCascadePolicyById(String metadataCascadePolicyId)

Retrieve a specific metadata cascade policy assigned to a folder.

Parameters:

metadataCascadePolicyId - The ID of the metadata cascade policy. Example: "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7"

getMetadataCascadePolicyById

public MetadataCascadePolicy getMetadataCascadePolicyById(String metadataCascadePolicyId,
                                                          GetMetadataCascadePolicyByIdHeaders headers)

Retrieve a specific metadata cascade policy assigned to a folder.

Parameters:

metadataCascadePolicyId - The ID of the metadata cascade policy. Example: "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7"

headers - Headers of getMetadataCascadePolicyById method

deleteMetadataCascadePolicyById

public void deleteMetadataCascadePolicyById(String metadataCascadePolicyId)

Deletes a metadata cascade policy.

Parameters:

metadataCascadePolicyId - The ID of the metadata cascade policy. Example: "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7"

deleteMetadataCascadePolicyById

public void deleteMetadataCascadePolicyById(String metadataCascadePolicyId,
                                            DeleteMetadataCascadePolicyByIdHeaders headers)

Deletes a metadata cascade policy.

Parameters:

metadataCascadePolicyId - The ID of the metadata cascade policy. Example: "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7"

headers - Headers of deleteMetadataCascadePolicyById method

applyMetadataCascadePolicy

public void applyMetadataCascadePolicy(String metadataCascadePolicyId,
                                       ApplyMetadataCascadePolicyRequestBody requestBody)

Force the metadata on a folder with a metadata cascade policy to be applied to all of its children. This can be used after creating a new cascade policy to enforce the metadata to be cascaded down to all existing files within that folder.

Parameters:

metadataCascadePolicyId - The ID of the cascade policy to force-apply. Example: "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7"

requestBody - Request body of applyMetadataCascadePolicy method

applyMetadataCascadePolicy

public void applyMetadataCascadePolicy(String metadataCascadePolicyId,
                                       ApplyMetadataCascadePolicyRequestBody requestBody,
                                       ApplyMetadataCascadePolicyHeaders headers)

Force the metadata on a folder with a metadata cascade policy to be applied to all of its children. This can be used after creating a new cascade policy to enforce the metadata to be cascaded down to all existing files within that folder.

Parameters:

metadataCascadePolicyId - The ID of the cascade policy to force-apply. Example: "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7"

requestBody - Request body of applyMetadataCascadePolicy method

headers - Headers of applyMetadataCascadePolicy method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()