com.box.sdkgen.managers.metadatatemplates

Class MetadataTemplatesManager

Object

MetadataTemplatesManager

public class MetadataTemplatesManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetadataTemplatesManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
MetadataTemplate	createMetadataTemplate(CreateMetadataTemplateRequestBody requestBody) Creates a new metadata template that can be applied to files and folders.
MetadataTemplate	createMetadataTemplate(CreateMetadataTemplateRequestBody requestBody, CreateMetadataTemplateHeaders headers) Creates a new metadata template that can be applied to files and folders.
void	deleteMetadataTemplate(DeleteMetadataTemplateScope scope, String templateKey) Delete a metadata template and its instances.
void	deleteMetadataTemplate(DeleteMetadataTemplateScope scope, String templateKey, DeleteMetadataTemplateHeaders headers) Delete a metadata template and its instances.
Authentication	getAuth()
MetadataTemplates	getEnterpriseMetadataTemplates() Used to retrieve all metadata templates created to be used specifically within the user's enterprise.
MetadataTemplates	getEnterpriseMetadataTemplates(GetEnterpriseMetadataTemplatesHeaders headers) Used to retrieve all metadata templates created to be used specifically within the user's enterprise.
MetadataTemplates	getEnterpriseMetadataTemplates(GetEnterpriseMetadataTemplatesQueryParams queryParams) Used to retrieve all metadata templates created to be used specifically within the user's enterprise.
MetadataTemplates	getEnterpriseMetadataTemplates(GetEnterpriseMetadataTemplatesQueryParams queryParams, GetEnterpriseMetadataTemplatesHeaders headers) Used to retrieve all metadata templates created to be used specifically within the user's enterprise.
MetadataTemplates	getGlobalMetadataTemplates() Used to retrieve all generic, global metadata templates available to all enterprises using Box.
MetadataTemplates	getGlobalMetadataTemplates(GetGlobalMetadataTemplatesHeaders headers) Used to retrieve all generic, global metadata templates available to all enterprises using Box.
MetadataTemplates	getGlobalMetadataTemplates(GetGlobalMetadataTemplatesQueryParams queryParams) Used to retrieve all generic, global metadata templates available to all enterprises using Box.
MetadataTemplates	getGlobalMetadataTemplates(GetGlobalMetadataTemplatesQueryParams queryParams, GetGlobalMetadataTemplatesHeaders headers) Used to retrieve all generic, global metadata templates available to all enterprises using Box.
MetadataTemplate	getMetadataTemplate(GetMetadataTemplateScope scope, String templateKey) Retrieves a metadata template by its `scope` and `templateKey` values.
MetadataTemplate	getMetadataTemplate(GetMetadataTemplateScope scope, String templateKey, GetMetadataTemplateHeaders headers) Retrieves a metadata template by its `scope` and `templateKey` values.
MetadataTemplate	getMetadataTemplateById(String templateId) Retrieves a metadata template by its ID.
MetadataTemplate	getMetadataTemplateById(String templateId, GetMetadataTemplateByIdHeaders headers) Retrieves a metadata template by its ID.
MetadataTemplates	getMetadataTemplatesByInstanceId(GetMetadataTemplatesByInstanceIdQueryParams queryParams) Finds a metadata template by searching for the ID of an instance of the template.
MetadataTemplates	getMetadataTemplatesByInstanceId(GetMetadataTemplatesByInstanceIdQueryParams queryParams, GetMetadataTemplatesByInstanceIdHeaders headers) Finds a metadata template by searching for the ID of an instance of the template.
NetworkSession	getNetworkSession()
MetadataTemplate	updateMetadataTemplate(UpdateMetadataTemplateScope scope, String templateKey, List<UpdateMetadataTemplateRequestBody> requestBody) Updates a metadata template.
MetadataTemplate	updateMetadataTemplate(UpdateMetadataTemplateScope scope, String templateKey, List<UpdateMetadataTemplateRequestBody> requestBody, UpdateMetadataTemplateHeaders headers) Updates a metadata template.

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

MetadataTemplatesManager

public MetadataTemplatesManager()

MetadataTemplatesManager

protected MetadataTemplatesManager(MetadataTemplatesManager.Builder builder)

Method Detail

getMetadataTemplatesByInstanceId

public MetadataTemplates getMetadataTemplatesByInstanceId(GetMetadataTemplatesByInstanceIdQueryParams queryParams)

Finds a metadata template by searching for the ID of an instance of the template.

Parameters:

queryParams - Query parameters of getMetadataTemplatesByInstanceId method

getMetadataTemplatesByInstanceId

public MetadataTemplates getMetadataTemplatesByInstanceId(GetMetadataTemplatesByInstanceIdQueryParams queryParams,
                                                          GetMetadataTemplatesByInstanceIdHeaders headers)

Finds a metadata template by searching for the ID of an instance of the template.

Parameters:

queryParams - Query parameters of getMetadataTemplatesByInstanceId method

headers - Headers of getMetadataTemplatesByInstanceId method

getMetadataTemplate

public MetadataTemplate getMetadataTemplate(GetMetadataTemplateScope scope,
                                            String templateKey)

Retrieves a metadata template by its `scope` and `templateKey` values.

To find the `scope` and `templateKey` for a template, list all templates for an enterprise or globally, or list all templates applied to a file or folder.

Parameters:

scope - The scope of the metadata template. Example: "global"

templateKey - The name of the metadata template. Example: "properties"

getMetadataTemplate

public MetadataTemplate getMetadataTemplate(GetMetadataTemplateScope scope,
                                            String templateKey,
                                            GetMetadataTemplateHeaders headers)

Retrieves a metadata template by its `scope` and `templateKey` values.

To find the `scope` and `templateKey` for a template, list all templates for an enterprise or globally, or list all templates applied to a file or folder.

Parameters:

scope - The scope of the metadata template. Example: "global"

templateKey - The name of the metadata template. Example: "properties"

headers - Headers of getMetadataTemplate method

updateMetadataTemplate

public MetadataTemplate updateMetadataTemplate(UpdateMetadataTemplateScope scope,
                                               String templateKey,
                                               List<UpdateMetadataTemplateRequestBody> requestBody)

Updates a metadata template.

The metadata template can only be updated if the template already exists.

The update is applied atomically. If any errors occur during the application of the operations, the metadata template will not be changed.

Parameters:

scope - The scope of the metadata template. Example: "global"

templateKey - The name of the metadata template. Example: "properties"

requestBody - Request body of updateMetadataTemplate method

updateMetadataTemplate

public MetadataTemplate updateMetadataTemplate(UpdateMetadataTemplateScope scope,
                                               String templateKey,
                                               List<UpdateMetadataTemplateRequestBody> requestBody,
                                               UpdateMetadataTemplateHeaders headers)

Updates a metadata template.

The metadata template can only be updated if the template already exists.

The update is applied atomically. If any errors occur during the application of the operations, the metadata template will not be changed.

Parameters:

scope - The scope of the metadata template. Example: "global"

templateKey - The name of the metadata template. Example: "properties"

requestBody - Request body of updateMetadataTemplate method

headers - Headers of updateMetadataTemplate method

deleteMetadataTemplate

public void deleteMetadataTemplate(DeleteMetadataTemplateScope scope,
                                   String templateKey)

Delete a metadata template and its instances. This deletion is permanent and can not be reversed.

Parameters:

scope - The scope of the metadata template. Example: "global"

templateKey - The name of the metadata template. Example: "properties"

deleteMetadataTemplate

public void deleteMetadataTemplate(DeleteMetadataTemplateScope scope,
                                   String templateKey,
                                   DeleteMetadataTemplateHeaders headers)

Delete a metadata template and its instances. This deletion is permanent and can not be reversed.

Parameters:

scope - The scope of the metadata template. Example: "global"

templateKey - The name of the metadata template. Example: "properties"

headers - Headers of deleteMetadataTemplate method

getMetadataTemplateById

public MetadataTemplate getMetadataTemplateById(String templateId)

Retrieves a metadata template by its ID.

Parameters:

templateId - The ID of the template. Example: "f7a9891f"

getMetadataTemplateById

public MetadataTemplate getMetadataTemplateById(String templateId,
                                                GetMetadataTemplateByIdHeaders headers)

Retrieves a metadata template by its ID.

Parameters:

templateId - The ID of the template. Example: "f7a9891f"

headers - Headers of getMetadataTemplateById method

getGlobalMetadataTemplates

public MetadataTemplates getGlobalMetadataTemplates()

Used to retrieve all generic, global metadata templates available to all enterprises using Box.

getGlobalMetadataTemplates

public MetadataTemplates getGlobalMetadataTemplates(GetGlobalMetadataTemplatesQueryParams queryParams)

Used to retrieve all generic, global metadata templates available to all enterprises using Box.

Parameters:

queryParams - Query parameters of getGlobalMetadataTemplates method

getGlobalMetadataTemplates

public MetadataTemplates getGlobalMetadataTemplates(GetGlobalMetadataTemplatesHeaders headers)

Used to retrieve all generic, global metadata templates available to all enterprises using Box.

Parameters:

headers - Headers of getGlobalMetadataTemplates method

getGlobalMetadataTemplates

public MetadataTemplates getGlobalMetadataTemplates(GetGlobalMetadataTemplatesQueryParams queryParams,
                                                    GetGlobalMetadataTemplatesHeaders headers)

Used to retrieve all generic, global metadata templates available to all enterprises using Box.

Parameters:

queryParams - Query parameters of getGlobalMetadataTemplates method

headers - Headers of getGlobalMetadataTemplates method

getEnterpriseMetadataTemplates

public MetadataTemplates getEnterpriseMetadataTemplates()

Used to retrieve all metadata templates created to be used specifically within the user's enterprise.

getEnterpriseMetadataTemplates

public MetadataTemplates getEnterpriseMetadataTemplates(GetEnterpriseMetadataTemplatesQueryParams queryParams)

Used to retrieve all metadata templates created to be used specifically within the user's enterprise.

Parameters:

queryParams - Query parameters of getEnterpriseMetadataTemplates method

getEnterpriseMetadataTemplates

public MetadataTemplates getEnterpriseMetadataTemplates(GetEnterpriseMetadataTemplatesHeaders headers)

Used to retrieve all metadata templates created to be used specifically within the user's enterprise.

Parameters:

headers - Headers of getEnterpriseMetadataTemplates method

getEnterpriseMetadataTemplates

public MetadataTemplates getEnterpriseMetadataTemplates(GetEnterpriseMetadataTemplatesQueryParams queryParams,
                                                        GetEnterpriseMetadataTemplatesHeaders headers)

Used to retrieve all metadata templates created to be used specifically within the user's enterprise.

Parameters:

queryParams - Query parameters of getEnterpriseMetadataTemplates method

headers - Headers of getEnterpriseMetadataTemplates method

createMetadataTemplate

public MetadataTemplate createMetadataTemplate(CreateMetadataTemplateRequestBody requestBody)

Creates a new metadata template that can be applied to files and folders.

Parameters:

requestBody - Request body of createMetadataTemplate method

createMetadataTemplate

public MetadataTemplate createMetadataTemplate(CreateMetadataTemplateRequestBody requestBody,
                                               CreateMetadataTemplateHeaders headers)

Creates a new metadata template that can be applied to files and folders.

Parameters:

requestBody - Request body of createMetadataTemplate method

headers - Headers of createMetadataTemplate method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()