com.box.sdkgen.managers.metadatataxonomies

Class MetadataTaxonomiesManager

Object

MetadataTaxonomiesManager

public class MetadataTaxonomiesManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetadataTaxonomiesManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
MetadataTaxonomyLevels	addMetadataTaxonomyLevel(String namespace, String taxonomyKey, AddMetadataTaxonomyLevelRequestBody requestBody) Creates a new metadata taxonomy level and appends it to the existing levels.
MetadataTaxonomyLevels	addMetadataTaxonomyLevel(String namespace, String taxonomyKey, AddMetadataTaxonomyLevelRequestBody requestBody, AddMetadataTaxonomyLevelHeaders headers) Creates a new metadata taxonomy level and appends it to the existing levels.
MetadataTaxonomy	createMetadataTaxonomy(CreateMetadataTaxonomyRequestBody requestBody) Creates a new metadata taxonomy that can be used in metadata templates.
MetadataTaxonomy	createMetadataTaxonomy(CreateMetadataTaxonomyRequestBody requestBody, CreateMetadataTaxonomyHeaders headers) Creates a new metadata taxonomy that can be used in metadata templates.
MetadataTaxonomyLevels	createMetadataTaxonomyLevel(String namespace, String taxonomyKey, List<MetadataTaxonomyLevel> requestBody) Creates new metadata taxonomy levels.
MetadataTaxonomyLevels	createMetadataTaxonomyLevel(String namespace, String taxonomyKey, List<MetadataTaxonomyLevel> requestBody, CreateMetadataTaxonomyLevelHeaders headers) Creates new metadata taxonomy levels.
MetadataTaxonomyNode	createMetadataTaxonomyNode(String namespace, String taxonomyKey, CreateMetadataTaxonomyNodeRequestBody requestBody) Creates a new metadata taxonomy node.
MetadataTaxonomyNode	createMetadataTaxonomyNode(String namespace, String taxonomyKey, CreateMetadataTaxonomyNodeRequestBody requestBody, CreateMetadataTaxonomyNodeHeaders headers) Creates a new metadata taxonomy node.
void	deleteMetadataTaxonomy(String namespace, String taxonomyKey) Delete a metadata taxonomy.
void	deleteMetadataTaxonomy(String namespace, String taxonomyKey, DeleteMetadataTaxonomyHeaders headers) Delete a metadata taxonomy.
MetadataTaxonomyLevels	deleteMetadataTaxonomyLevel(String namespace, String taxonomyKey) Deletes the last level of the metadata taxonomy.
MetadataTaxonomyLevels	deleteMetadataTaxonomyLevel(String namespace, String taxonomyKey, DeleteMetadataTaxonomyLevelHeaders headers) Deletes the last level of the metadata taxonomy.
void	deleteMetadataTaxonomyNode(String namespace, String taxonomyKey, String nodeId) Delete a metadata taxonomy node.
void	deleteMetadataTaxonomyNode(String namespace, String taxonomyKey, String nodeId, DeleteMetadataTaxonomyNodeHeaders headers) Delete a metadata taxonomy node.
Authentication	getAuth()
MetadataTaxonomies	getMetadataTaxonomies(String namespace) Used to retrieve all metadata taxonomies in a namespace.
MetadataTaxonomies	getMetadataTaxonomies(String namespace, GetMetadataTaxonomiesHeaders headers) Used to retrieve all metadata taxonomies in a namespace.
MetadataTaxonomies	getMetadataTaxonomies(String namespace, GetMetadataTaxonomiesQueryParams queryParams) Used to retrieve all metadata taxonomies in a namespace.
MetadataTaxonomies	getMetadataTaxonomies(String namespace, GetMetadataTaxonomiesQueryParams queryParams, GetMetadataTaxonomiesHeaders headers) Used to retrieve all metadata taxonomies in a namespace.
MetadataTaxonomy	getMetadataTaxonomyByKey(String namespace, String taxonomyKey) Used to retrieve a metadata taxonomy by taxonomy key.
MetadataTaxonomy	getMetadataTaxonomyByKey(String namespace, String taxonomyKey, GetMetadataTaxonomyByKeyHeaders headers) Used to retrieve a metadata taxonomy by taxonomy key.
MetadataTaxonomyNode	getMetadataTaxonomyNodeById(String namespace, String taxonomyKey, String nodeId) Retrieves a metadata taxonomy node by its identifier.
MetadataTaxonomyNode	getMetadataTaxonomyNodeById(String namespace, String taxonomyKey, String nodeId, GetMetadataTaxonomyNodeByIdHeaders headers) Retrieves a metadata taxonomy node by its identifier.
MetadataTaxonomyNodes	getMetadataTaxonomyNodes(String namespace, String taxonomyKey) Used to retrieve metadata taxonomy nodes based on the parameters specified.
MetadataTaxonomyNodes	getMetadataTaxonomyNodes(String namespace, String taxonomyKey, GetMetadataTaxonomyNodesHeaders headers) Used to retrieve metadata taxonomy nodes based on the parameters specified.
MetadataTaxonomyNodes	getMetadataTaxonomyNodes(String namespace, String taxonomyKey, GetMetadataTaxonomyNodesQueryParams queryParams) Used to retrieve metadata taxonomy nodes based on the parameters specified.
MetadataTaxonomyNodes	getMetadataTaxonomyNodes(String namespace, String taxonomyKey, GetMetadataTaxonomyNodesQueryParams queryParams, GetMetadataTaxonomyNodesHeaders headers) Used to retrieve metadata taxonomy nodes based on the parameters specified.
MetadataTaxonomyNodes	getMetadataTemplateFieldOptions(String namespace, String templateKey, String fieldKey) Used to retrieve metadata taxonomy nodes which are available for the taxonomy field based on its configuration and the parameters specified.
MetadataTaxonomyNodes	getMetadataTemplateFieldOptions(String namespace, String templateKey, String fieldKey, GetMetadataTemplateFieldOptionsHeaders headers) Used to retrieve metadata taxonomy nodes which are available for the taxonomy field based on its configuration and the parameters specified.
MetadataTaxonomyNodes	getMetadataTemplateFieldOptions(String namespace, String templateKey, String fieldKey, GetMetadataTemplateFieldOptionsQueryParams queryParams) Used to retrieve metadata taxonomy nodes which are available for the taxonomy field based on its configuration and the parameters specified.
MetadataTaxonomyNodes	getMetadataTemplateFieldOptions(String namespace, String templateKey, String fieldKey, GetMetadataTemplateFieldOptionsQueryParams queryParams, GetMetadataTemplateFieldOptionsHeaders headers) Used to retrieve metadata taxonomy nodes which are available for the taxonomy field based on its configuration and the parameters specified.
NetworkSession	getNetworkSession()
MetadataTaxonomy	updateMetadataTaxonomy(String namespace, String taxonomyKey, UpdateMetadataTaxonomyRequestBody requestBody) Updates an existing metadata taxonomy.
MetadataTaxonomy	updateMetadataTaxonomy(String namespace, String taxonomyKey, UpdateMetadataTaxonomyRequestBody requestBody, UpdateMetadataTaxonomyHeaders headers) Updates an existing metadata taxonomy.
MetadataTaxonomyLevel	updateMetadataTaxonomyLevelById(String namespace, String taxonomyKey, long levelIndex, UpdateMetadataTaxonomyLevelByIdRequestBody requestBody) Updates an existing metadata taxonomy level.
MetadataTaxonomyLevel	updateMetadataTaxonomyLevelById(String namespace, String taxonomyKey, long levelIndex, UpdateMetadataTaxonomyLevelByIdRequestBody requestBody, UpdateMetadataTaxonomyLevelByIdHeaders headers) Updates an existing metadata taxonomy level.
MetadataTaxonomyNode	updateMetadataTaxonomyNode(String namespace, String taxonomyKey, String nodeId) Updates an existing metadata taxonomy node.
MetadataTaxonomyNode	updateMetadataTaxonomyNode(String namespace, String taxonomyKey, String nodeId, UpdateMetadataTaxonomyNodeHeaders headers) Updates an existing metadata taxonomy node.
MetadataTaxonomyNode	updateMetadataTaxonomyNode(String namespace, String taxonomyKey, String nodeId, UpdateMetadataTaxonomyNodeRequestBody requestBody) Updates an existing metadata taxonomy node.
MetadataTaxonomyNode	updateMetadataTaxonomyNode(String namespace, String taxonomyKey, String nodeId, UpdateMetadataTaxonomyNodeRequestBody requestBody, UpdateMetadataTaxonomyNodeHeaders headers) Updates an existing metadata taxonomy node.

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

MetadataTaxonomiesManager

public MetadataTaxonomiesManager()

MetadataTaxonomiesManager

protected MetadataTaxonomiesManager(MetadataTaxonomiesManager.Builder builder)

Method Detail

createMetadataTaxonomy

public MetadataTaxonomy createMetadataTaxonomy(CreateMetadataTaxonomyRequestBody requestBody)

Creates a new metadata taxonomy that can be used in metadata templates.

Parameters:

requestBody - Request body of createMetadataTaxonomy method

createMetadataTaxonomy

public MetadataTaxonomy createMetadataTaxonomy(CreateMetadataTaxonomyRequestBody requestBody,
                                               CreateMetadataTaxonomyHeaders headers)

Creates a new metadata taxonomy that can be used in metadata templates.

Parameters:

requestBody - Request body of createMetadataTaxonomy method

headers - Headers of createMetadataTaxonomy method

getMetadataTaxonomies

public MetadataTaxonomies getMetadataTaxonomies(String namespace)

Used to retrieve all metadata taxonomies in a namespace.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

getMetadataTaxonomies

public MetadataTaxonomies getMetadataTaxonomies(String namespace,
                                                GetMetadataTaxonomiesQueryParams queryParams)

Used to retrieve all metadata taxonomies in a namespace.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

queryParams - Query parameters of getMetadataTaxonomies method

getMetadataTaxonomies

public MetadataTaxonomies getMetadataTaxonomies(String namespace,
                                                GetMetadataTaxonomiesHeaders headers)

Used to retrieve all metadata taxonomies in a namespace.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

headers - Headers of getMetadataTaxonomies method

getMetadataTaxonomies

public MetadataTaxonomies getMetadataTaxonomies(String namespace,
                                                GetMetadataTaxonomiesQueryParams queryParams,
                                                GetMetadataTaxonomiesHeaders headers)

Used to retrieve all metadata taxonomies in a namespace.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

queryParams - Query parameters of getMetadataTaxonomies method

headers - Headers of getMetadataTaxonomies method

getMetadataTaxonomyByKey

public MetadataTaxonomy getMetadataTaxonomyByKey(String namespace,
                                                 String taxonomyKey)

Used to retrieve a metadata taxonomy by taxonomy key.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

getMetadataTaxonomyByKey

public MetadataTaxonomy getMetadataTaxonomyByKey(String namespace,
                                                 String taxonomyKey,
                                                 GetMetadataTaxonomyByKeyHeaders headers)

Used to retrieve a metadata taxonomy by taxonomy key.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

headers - Headers of getMetadataTaxonomyByKey method

updateMetadataTaxonomy

public MetadataTaxonomy updateMetadataTaxonomy(String namespace,
                                               String taxonomyKey,
                                               UpdateMetadataTaxonomyRequestBody requestBody)

Updates an existing metadata taxonomy.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

requestBody - Request body of updateMetadataTaxonomy method

updateMetadataTaxonomy

public MetadataTaxonomy updateMetadataTaxonomy(String namespace,
                                               String taxonomyKey,
                                               UpdateMetadataTaxonomyRequestBody requestBody,
                                               UpdateMetadataTaxonomyHeaders headers)

Updates an existing metadata taxonomy.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

requestBody - Request body of updateMetadataTaxonomy method

headers - Headers of updateMetadataTaxonomy method

deleteMetadataTaxonomy

public void deleteMetadataTaxonomy(String namespace,
                                   String taxonomyKey)

Delete a metadata taxonomy. This deletion is permanent and cannot be reverted.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

deleteMetadataTaxonomy

public void deleteMetadataTaxonomy(String namespace,
                                   String taxonomyKey,
                                   DeleteMetadataTaxonomyHeaders headers)

Delete a metadata taxonomy. This deletion is permanent and cannot be reverted.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

headers - Headers of deleteMetadataTaxonomy method

createMetadataTaxonomyLevel

public MetadataTaxonomyLevels createMetadataTaxonomyLevel(String namespace,
                                                          String taxonomyKey,
                                                          List<MetadataTaxonomyLevel> requestBody)

Creates new metadata taxonomy levels.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

requestBody - Request body of createMetadataTaxonomyLevel method

createMetadataTaxonomyLevel

public MetadataTaxonomyLevels createMetadataTaxonomyLevel(String namespace,
                                                          String taxonomyKey,
                                                          List<MetadataTaxonomyLevel> requestBody,
                                                          CreateMetadataTaxonomyLevelHeaders headers)

Creates new metadata taxonomy levels.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

requestBody - Request body of createMetadataTaxonomyLevel method

headers - Headers of createMetadataTaxonomyLevel method

updateMetadataTaxonomyLevelById

public MetadataTaxonomyLevel updateMetadataTaxonomyLevelById(String namespace,
                                                             String taxonomyKey,
                                                             long levelIndex,
                                                             UpdateMetadataTaxonomyLevelByIdRequestBody requestBody)

Updates an existing metadata taxonomy level.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

levelIndex - The index of the metadata taxonomy level. Example: 1

requestBody - Request body of updateMetadataTaxonomyLevelById method

updateMetadataTaxonomyLevelById

public MetadataTaxonomyLevel updateMetadataTaxonomyLevelById(String namespace,
                                                             String taxonomyKey,
                                                             long levelIndex,
                                                             UpdateMetadataTaxonomyLevelByIdRequestBody requestBody,
                                                             UpdateMetadataTaxonomyLevelByIdHeaders headers)

Updates an existing metadata taxonomy level.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

levelIndex - The index of the metadata taxonomy level. Example: 1

requestBody - Request body of updateMetadataTaxonomyLevelById method

headers - Headers of updateMetadataTaxonomyLevelById method

addMetadataTaxonomyLevel

public MetadataTaxonomyLevels addMetadataTaxonomyLevel(String namespace,
                                                       String taxonomyKey,
                                                       AddMetadataTaxonomyLevelRequestBody requestBody)

Creates a new metadata taxonomy level and appends it to the existing levels. If there are no levels defined yet, this will create the first level.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

requestBody - Request body of addMetadataTaxonomyLevel method

addMetadataTaxonomyLevel

public MetadataTaxonomyLevels addMetadataTaxonomyLevel(String namespace,
                                                       String taxonomyKey,
                                                       AddMetadataTaxonomyLevelRequestBody requestBody,
                                                       AddMetadataTaxonomyLevelHeaders headers)

Creates a new metadata taxonomy level and appends it to the existing levels. If there are no levels defined yet, this will create the first level.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

requestBody - Request body of addMetadataTaxonomyLevel method

headers - Headers of addMetadataTaxonomyLevel method

deleteMetadataTaxonomyLevel

public MetadataTaxonomyLevels deleteMetadataTaxonomyLevel(String namespace,
                                                          String taxonomyKey)

Deletes the last level of the metadata taxonomy.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

deleteMetadataTaxonomyLevel

public MetadataTaxonomyLevels deleteMetadataTaxonomyLevel(String namespace,
                                                          String taxonomyKey,
                                                          DeleteMetadataTaxonomyLevelHeaders headers)

Deletes the last level of the metadata taxonomy.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

headers - Headers of deleteMetadataTaxonomyLevel method

getMetadataTaxonomyNodes

public MetadataTaxonomyNodes getMetadataTaxonomyNodes(String namespace,
                                                      String taxonomyKey)

Used to retrieve metadata taxonomy nodes based on the parameters specified. Results are sorted in lexicographic order unless a `query` parameter is passed. With a `query` parameter specified, results are sorted in order of relevance.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

getMetadataTaxonomyNodes

public MetadataTaxonomyNodes getMetadataTaxonomyNodes(String namespace,
                                                      String taxonomyKey,
                                                      GetMetadataTaxonomyNodesQueryParams queryParams)

Used to retrieve metadata taxonomy nodes based on the parameters specified. Results are sorted in lexicographic order unless a `query` parameter is passed. With a `query` parameter specified, results are sorted in order of relevance.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

queryParams - Query parameters of getMetadataTaxonomyNodes method

getMetadataTaxonomyNodes

public MetadataTaxonomyNodes getMetadataTaxonomyNodes(String namespace,
                                                      String taxonomyKey,
                                                      GetMetadataTaxonomyNodesHeaders headers)

Used to retrieve metadata taxonomy nodes based on the parameters specified. Results are sorted in lexicographic order unless a `query` parameter is passed. With a `query` parameter specified, results are sorted in order of relevance.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

headers - Headers of getMetadataTaxonomyNodes method

getMetadataTaxonomyNodes

public MetadataTaxonomyNodes getMetadataTaxonomyNodes(String namespace,
                                                      String taxonomyKey,
                                                      GetMetadataTaxonomyNodesQueryParams queryParams,
                                                      GetMetadataTaxonomyNodesHeaders headers)

Used to retrieve metadata taxonomy nodes based on the parameters specified. Results are sorted in lexicographic order unless a `query` parameter is passed. With a `query` parameter specified, results are sorted in order of relevance.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

queryParams - Query parameters of getMetadataTaxonomyNodes method

headers - Headers of getMetadataTaxonomyNodes method

createMetadataTaxonomyNode

public MetadataTaxonomyNode createMetadataTaxonomyNode(String namespace,
                                                       String taxonomyKey,
                                                       CreateMetadataTaxonomyNodeRequestBody requestBody)

Creates a new metadata taxonomy node.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

requestBody - Request body of createMetadataTaxonomyNode method

createMetadataTaxonomyNode

public MetadataTaxonomyNode createMetadataTaxonomyNode(String namespace,
                                                       String taxonomyKey,
                                                       CreateMetadataTaxonomyNodeRequestBody requestBody,
                                                       CreateMetadataTaxonomyNodeHeaders headers)

Creates a new metadata taxonomy node.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

requestBody - Request body of createMetadataTaxonomyNode method

headers - Headers of createMetadataTaxonomyNode method

getMetadataTaxonomyNodeById

public MetadataTaxonomyNode getMetadataTaxonomyNodeById(String namespace,
                                                        String taxonomyKey,
                                                        String nodeId)

Retrieves a metadata taxonomy node by its identifier.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

nodeId - The identifier of the metadata taxonomy node. Example: "14d3d433-c77f-49c5-b146-9dea370f6e32"

getMetadataTaxonomyNodeById

public MetadataTaxonomyNode getMetadataTaxonomyNodeById(String namespace,
                                                        String taxonomyKey,
                                                        String nodeId,
                                                        GetMetadataTaxonomyNodeByIdHeaders headers)

Retrieves a metadata taxonomy node by its identifier.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

nodeId - The identifier of the metadata taxonomy node. Example: "14d3d433-c77f-49c5-b146-9dea370f6e32"

headers - Headers of getMetadataTaxonomyNodeById method

updateMetadataTaxonomyNode

public MetadataTaxonomyNode updateMetadataTaxonomyNode(String namespace,
                                                       String taxonomyKey,
                                                       String nodeId)

Updates an existing metadata taxonomy node.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

nodeId - The identifier of the metadata taxonomy node. Example: "14d3d433-c77f-49c5-b146-9dea370f6e32"

updateMetadataTaxonomyNode

public MetadataTaxonomyNode updateMetadataTaxonomyNode(String namespace,
                                                       String taxonomyKey,
                                                       String nodeId,
                                                       UpdateMetadataTaxonomyNodeRequestBody requestBody)

Updates an existing metadata taxonomy node.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

nodeId - The identifier of the metadata taxonomy node. Example: "14d3d433-c77f-49c5-b146-9dea370f6e32"

requestBody - Request body of updateMetadataTaxonomyNode method

updateMetadataTaxonomyNode

public MetadataTaxonomyNode updateMetadataTaxonomyNode(String namespace,
                                                       String taxonomyKey,
                                                       String nodeId,
                                                       UpdateMetadataTaxonomyNodeHeaders headers)

Updates an existing metadata taxonomy node.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

nodeId - The identifier of the metadata taxonomy node. Example: "14d3d433-c77f-49c5-b146-9dea370f6e32"

headers - Headers of updateMetadataTaxonomyNode method

updateMetadataTaxonomyNode

public MetadataTaxonomyNode updateMetadataTaxonomyNode(String namespace,
                                                       String taxonomyKey,
                                                       String nodeId,
                                                       UpdateMetadataTaxonomyNodeRequestBody requestBody,
                                                       UpdateMetadataTaxonomyNodeHeaders headers)

Updates an existing metadata taxonomy node.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

nodeId - The identifier of the metadata taxonomy node. Example: "14d3d433-c77f-49c5-b146-9dea370f6e32"

requestBody - Request body of updateMetadataTaxonomyNode method

headers - Headers of updateMetadataTaxonomyNode method

deleteMetadataTaxonomyNode

public void deleteMetadataTaxonomyNode(String namespace,
                                       String taxonomyKey,
                                       String nodeId)

Delete a metadata taxonomy node. This deletion is permanent and cannot be reverted. Only metadata taxonomy nodes without any children can be deleted.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

nodeId - The identifier of the metadata taxonomy node. Example: "14d3d433-c77f-49c5-b146-9dea370f6e32"

deleteMetadataTaxonomyNode

public void deleteMetadataTaxonomyNode(String namespace,
                                       String taxonomyKey,
                                       String nodeId,
                                       DeleteMetadataTaxonomyNodeHeaders headers)

Delete a metadata taxonomy node. This deletion is permanent and cannot be reverted. Only metadata taxonomy nodes without any children can be deleted.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

taxonomyKey - The key of the metadata taxonomy. Example: "geography"

nodeId - The identifier of the metadata taxonomy node. Example: "14d3d433-c77f-49c5-b146-9dea370f6e32"

headers - Headers of deleteMetadataTaxonomyNode method

getMetadataTemplateFieldOptions

public MetadataTaxonomyNodes getMetadataTemplateFieldOptions(String namespace,
                                                             String templateKey,
                                                             String fieldKey)

Used to retrieve metadata taxonomy nodes which are available for the taxonomy field based on its configuration and the parameters specified. Results are sorted in lexicographic order unless a `query` parameter is passed. With a `query` parameter specified, results are sorted in order of relevance.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

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

fieldKey - The key of the metadata taxonomy field in the template. Example: "geography"

getMetadataTemplateFieldOptions

public MetadataTaxonomyNodes getMetadataTemplateFieldOptions(String namespace,
                                                             String templateKey,
                                                             String fieldKey,
                                                             GetMetadataTemplateFieldOptionsQueryParams queryParams)

Used to retrieve metadata taxonomy nodes which are available for the taxonomy field based on its configuration and the parameters specified. Results are sorted in lexicographic order unless a `query` parameter is passed. With a `query` parameter specified, results are sorted in order of relevance.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

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

fieldKey - The key of the metadata taxonomy field in the template. Example: "geography"

queryParams - Query parameters of getMetadataTemplateFieldOptions method

getMetadataTemplateFieldOptions

public MetadataTaxonomyNodes getMetadataTemplateFieldOptions(String namespace,
                                                             String templateKey,
                                                             String fieldKey,
                                                             GetMetadataTemplateFieldOptionsHeaders headers)

Used to retrieve metadata taxonomy nodes which are available for the taxonomy field based on its configuration and the parameters specified. Results are sorted in lexicographic order unless a `query` parameter is passed. With a `query` parameter specified, results are sorted in order of relevance.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

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

fieldKey - The key of the metadata taxonomy field in the template. Example: "geography"

headers - Headers of getMetadataTemplateFieldOptions method

getMetadataTemplateFieldOptions

public MetadataTaxonomyNodes getMetadataTemplateFieldOptions(String namespace,
                                                             String templateKey,
                                                             String fieldKey,
                                                             GetMetadataTemplateFieldOptionsQueryParams queryParams,
                                                             GetMetadataTemplateFieldOptionsHeaders headers)

Used to retrieve metadata taxonomy nodes which are available for the taxonomy field based on its configuration and the parameters specified. Results are sorted in lexicographic order unless a `query` parameter is passed. With a `query` parameter specified, results are sorted in order of relevance.

Parameters:

namespace - The namespace of the metadata taxonomy. Example: "enterprise_123456"

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

fieldKey - The key of the metadata taxonomy field in the template. Example: "geography"

queryParams - Query parameters of getMetadataTemplateFieldOptions method

headers - Headers of getMetadataTemplateFieldOptions method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()