com.vmware.cis.tagging

Interface Tag

All Superinterfaces:

Service, TagTypes

All Known Implementing Classes:

TagStub

public interface Tag
extends Service, TagTypes

The Tag interface provides methods to create, read, update, delete, and enumerate tags.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.cis.tagging.TagTypes

TagTypes.CreateSpec, TagTypes.UpdateSpec

Field Summary

Fields inherited from interface com.vmware.cis.tagging.TagTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	addToUsedBy(java.lang.String tagId, java.lang.String usedByEntity) Adds the usedByEntity to the TagModel.getUsedBy() subscribers Set.
void	addToUsedBy(java.lang.String tagId, java.lang.String usedByEntity, AsyncCallback<java.lang.Void> asyncCallback) Adds the usedByEntity to the TagModel.getUsedBy() subscribers Set.
void	addToUsedBy(java.lang.String tagId, java.lang.String usedByEntity, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Adds the usedByEntity to the TagModel.getUsedBy() subscribers Set.
void	addToUsedBy(java.lang.String tagId, java.lang.String usedByEntity, InvocationConfig invocationConfig) Adds the usedByEntity to the TagModel.getUsedBy() subscribers Set.
java.lang.String	create(TagTypes.CreateSpec createSpec) Creates a tag.
void	create(TagTypes.CreateSpec createSpec, AsyncCallback<java.lang.String> asyncCallback) Creates a tag.
void	create(TagTypes.CreateSpec createSpec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a tag.
java.lang.String	create(TagTypes.CreateSpec createSpec, InvocationConfig invocationConfig) Creates a tag.
void	delete(java.lang.String tagId) Deletes an existing tag.
void	delete(java.lang.String tagId, AsyncCallback<java.lang.Void> asyncCallback) Deletes an existing tag.
void	delete(java.lang.String tagId, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes an existing tag.
void	delete(java.lang.String tagId, InvocationConfig invocationConfig) Deletes an existing tag.
TagModel	get(java.lang.String tagId) Fetches the tag information for the given tag identifier.
void	get(java.lang.String tagId, AsyncCallback<TagModel> asyncCallback) Fetches the tag information for the given tag identifier.
void	get(java.lang.String tagId, AsyncCallback<TagModel> asyncCallback, InvocationConfig invocationConfig) Fetches the tag information for the given tag identifier.
TagModel	get(java.lang.String tagId, InvocationConfig invocationConfig) Fetches the tag information for the given tag identifier.
java.util.List<java.lang.String>	list() Enumerates the tags in the system.
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Enumerates the tags in the system.
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Enumerates the tags in the system.
java.util.List<java.lang.String>	list(InvocationConfig invocationConfig) Enumerates the tags in the system.
java.util.List<java.lang.String>	listTagsForCategory(java.lang.String categoryId) Enumerates all tags for the given category.
void	listTagsForCategory(java.lang.String categoryId, AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Enumerates all tags for the given category.
void	listTagsForCategory(java.lang.String categoryId, AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Enumerates all tags for the given category.
java.util.List<java.lang.String>	listTagsForCategory(java.lang.String categoryId, InvocationConfig invocationConfig) Enumerates all tags for the given category.
java.util.List<java.lang.String>	listUsedTags(java.lang.String usedByEntity) Enumerates all tags for which the usedByEntity is part of the TagModel.getUsedBy() subscribers Set.
void	listUsedTags(java.lang.String usedByEntity, AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Enumerates all tags for which the usedByEntity is part of the TagModel.getUsedBy() subscribers Set.
void	listUsedTags(java.lang.String usedByEntity, AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Enumerates all tags for which the usedByEntity is part of the TagModel.getUsedBy() subscribers Set.
java.util.List<java.lang.String>	listUsedTags(java.lang.String usedByEntity, InvocationConfig invocationConfig) Enumerates all tags for which the usedByEntity is part of the TagModel.getUsedBy() subscribers Set.
void	removeFromUsedBy(java.lang.String tagId, java.lang.String usedByEntity) Removes the usedByEntity from the TagModel.getUsedBy() subscribers set.
void	removeFromUsedBy(java.lang.String tagId, java.lang.String usedByEntity, AsyncCallback<java.lang.Void> asyncCallback) Removes the usedByEntity from the TagModel.getUsedBy() subscribers set.
void	removeFromUsedBy(java.lang.String tagId, java.lang.String usedByEntity, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Removes the usedByEntity from the TagModel.getUsedBy() subscribers set.
void	removeFromUsedBy(java.lang.String tagId, java.lang.String usedByEntity, InvocationConfig invocationConfig) Removes the usedByEntity from the TagModel.getUsedBy() subscribers set.
void	revokePropagatingPermissions(java.lang.String tagId) Revokes all propagating permissions on the given tag.
void	revokePropagatingPermissions(java.lang.String tagId, AsyncCallback<java.lang.Void> asyncCallback) Revokes all propagating permissions on the given tag.
void	revokePropagatingPermissions(java.lang.String tagId, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Revokes all propagating permissions on the given tag.
void	revokePropagatingPermissions(java.lang.String tagId, InvocationConfig invocationConfig) Revokes all propagating permissions on the given tag.
void	update(java.lang.String tagId, TagTypes.UpdateSpec updateSpec) Updates an existing tag.
void	update(java.lang.String tagId, TagTypes.UpdateSpec updateSpec, AsyncCallback<java.lang.Void> asyncCallback) Updates an existing tag.
void	update(java.lang.String tagId, TagTypes.UpdateSpec updateSpec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Updates an existing tag.
void	update(java.lang.String tagId, TagTypes.UpdateSpec updateSpec, InvocationConfig invocationConfig) Updates an existing tag.

Method Detail

create

java.lang.String create(TagTypes.CreateSpec createSpec)

Creates a tag. To invoke this method, you need the create tag privilege on the input category.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

createSpec - Specification for the new tag to be created.

Returns:

The identifier of the created tag. The return value will be an identifier for the resource type: com.vmware.cis.tagging.Tag.

Throws:

AlreadyExists - if the TagTypes.CreateSpec.getName() provided in the createSpec is the name of an already existing tag in the input category.

InvalidArgument - if any of the input information in the createSpec is invalid.

NotFound - if the category for in the given createSpec does not exist in the system.

Unauthorized - if you do not have the privilege to create tag.

create

java.lang.String create(TagTypes.CreateSpec createSpec,
                        InvocationConfig invocationConfig)

Creates a tag. To invoke this method, you need the create tag privilege on the input category.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

createSpec - Specification for the new tag to be created.

invocationConfig - Configuration for the method invocation.

Returns:

The identifier of the created tag. The return value will be an identifier for the resource type: com.vmware.cis.tagging.Tag.

Throws:

AlreadyExists - if the TagTypes.CreateSpec.getName() provided in the createSpec is the name of an already existing tag in the input category.

InvalidArgument - if any of the input information in the createSpec is invalid.

NotFound - if the category for in the given createSpec does not exist in the system.

Unauthorized - if you do not have the privilege to create tag.

create

void create(TagTypes.CreateSpec createSpec,
            AsyncCallback<java.lang.String> asyncCallback)

Creates a tag. To invoke this method, you need the create tag privilege on the input category.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The identifier of the created tag. The return value will be an identifier for the resource type: com.vmware.cis.tagging.Tag.

Operation Errors:
AlreadyExists - if the TagTypes.CreateSpec.getName() provided in the createSpec is the name of an already existing tag in the input category.
InvalidArgument - if any of the input information in the createSpec is invalid.
NotFound - if the category for in the given createSpec does not exist in the system.
Unauthorized - if you do not have the privilege to create tag.

Parameters:

createSpec - Specification for the new tag to be created.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

create

void create(TagTypes.CreateSpec createSpec,
            AsyncCallback<java.lang.String> asyncCallback,
            InvocationConfig invocationConfig)

Creates a tag. To invoke this method, you need the create tag privilege on the input category.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The identifier of the created tag. The return value will be an identifier for the resource type: com.vmware.cis.tagging.Tag.

Operation Errors:
AlreadyExists - if the TagTypes.CreateSpec.getName() provided in the createSpec is the name of an already existing tag in the input category.
InvalidArgument - if any of the input information in the createSpec is invalid.
NotFound - if the category for in the given createSpec does not exist in the system.
Unauthorized - if you do not have the privilege to create tag.

Parameters:

createSpec - Specification for the new tag to be created.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

TagModel get(java.lang.String tagId)

Fetches the tag information for the given tag identifier. To invoke this method, you need the read privilege on the tag in order to view the tag info.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

Returns:

The TagModel that corresponds to tagId.

Throws:

NotFound - if the tag for the given tagId does not exist in the system.

Unauthorized - if the user does not have the privilege to read the tag.

get

TagModel get(java.lang.String tagId,
             InvocationConfig invocationConfig)

Fetches the tag information for the given tag identifier. To invoke this method, you need the read privilege on the tag in order to view the tag info.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

invocationConfig - Configuration for the method invocation.

Returns:

The TagModel that corresponds to tagId.

Throws:

NotFound - if the tag for the given tagId does not exist in the system.

Unauthorized - if the user does not have the privilege to read the tag.

get

void get(java.lang.String tagId,
         AsyncCallback<TagModel> asyncCallback)

Fetches the tag information for the given tag identifier. To invoke this method, you need the read privilege on the tag in order to view the tag info.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The TagModel that corresponds to tagId.

Operation Errors:
NotFound - if the tag for the given tagId does not exist in the system.
Unauthorized - if the user does not have the privilege to read the tag.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String tagId,
         AsyncCallback<TagModel> asyncCallback,
         InvocationConfig invocationConfig)

Fetches the tag information for the given tag identifier. To invoke this method, you need the read privilege on the tag in order to view the tag info.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The TagModel that corresponds to tagId.

Operation Errors:
NotFound - if the tag for the given tagId does not exist in the system.
Unauthorized - if the user does not have the privilege to read the tag.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String tagId,
            TagTypes.UpdateSpec updateSpec)

Updates an existing tag. To invoke this method, you need the edit privilege on the tag.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

updateSpec - Specification to update the tag.

Throws:

AlreadyExists - if the TagTypes.UpdateSpec.getName() provided in the updateSpec is the name of an already existing tag in the same category.

InvalidArgument - if any of the input information in the updateSpec is invalid.

NotFound - if the tag for the given tagId does not exist in the system.

Unauthorized - if you do not have the privilege to update the tag.

update

void update(java.lang.String tagId,
            TagTypes.UpdateSpec updateSpec,
            InvocationConfig invocationConfig)

Updates an existing tag. To invoke this method, you need the edit privilege on the tag.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

updateSpec - Specification to update the tag.

invocationConfig - Configuration for the method invocation.

Throws:

AlreadyExists - if the TagTypes.UpdateSpec.getName() provided in the updateSpec is the name of an already existing tag in the same category.

InvalidArgument - if any of the input information in the updateSpec is invalid.

NotFound - if the tag for the given tagId does not exist in the system.

Unauthorized - if you do not have the privilege to update the tag.

update

void update(java.lang.String tagId,
            TagTypes.UpdateSpec updateSpec,
            AsyncCallback<java.lang.Void> asyncCallback)

Updates an existing tag. To invoke this method, you need the edit privilege on the tag.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
AlreadyExists - if the TagTypes.UpdateSpec.getName() provided in the updateSpec is the name of an already existing tag in the same category.
InvalidArgument - if any of the input information in the updateSpec is invalid.
NotFound - if the tag for the given tagId does not exist in the system.
Unauthorized - if you do not have the privilege to update the tag.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

updateSpec - Specification to update the tag.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

update

void update(java.lang.String tagId,
            TagTypes.UpdateSpec updateSpec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Updates an existing tag. To invoke this method, you need the edit privilege on the tag.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
AlreadyExists - if the TagTypes.UpdateSpec.getName() provided in the updateSpec is the name of an already existing tag in the same category.
InvalidArgument - if any of the input information in the updateSpec is invalid.
NotFound - if the tag for the given tagId does not exist in the system.
Unauthorized - if you do not have the privilege to update the tag.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

updateSpec - Specification to update the tag.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String tagId)

Deletes an existing tag. To invoke this method, you need the delete privilege on the tag.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

Throws:

NotFound - if the tag for the given tagId does not exist in the system.

Unauthorized - if you do not have the privilege to delete the tag.

Unauthenticated - if the user can not be authenticated.

delete

void delete(java.lang.String tagId,
            InvocationConfig invocationConfig)

Deletes an existing tag. To invoke this method, you need the delete privilege on the tag.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the tag for the given tagId does not exist in the system.

Unauthorized - if you do not have the privilege to delete the tag.

Unauthenticated - if the user can not be authenticated.

delete

void delete(java.lang.String tagId,
            AsyncCallback<java.lang.Void> asyncCallback)

Deletes an existing tag. To invoke this method, you need the delete privilege on the tag.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
NotFound - if the tag for the given tagId does not exist in the system.
Unauthorized - if you do not have the privilege to delete the tag.
Unauthenticated - if the user can not be authenticated.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

delete

void delete(java.lang.String tagId,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Deletes an existing tag. To invoke this method, you need the delete privilege on the tag.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
NotFound - if the tag for the given tagId does not exist in the system.
Unauthorized - if you do not have the privilege to delete the tag.
Unauthenticated - if the user can not be authenticated.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

java.util.List<java.lang.String> list()

Enumerates the tags in the system. To invoke this method, you need read privilege on the individual tags. The List will only contain tags for which you have read privileges.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Returns:

The List of resource identifiers for the tags in the system. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

list

java.util.List<java.lang.String> list(InvocationConfig invocationConfig)

Enumerates the tags in the system. To invoke this method, you need read privilege on the individual tags. The List will only contain tags for which you have read privileges.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

The List of resource identifiers for the tags in the system. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

list

void list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback)

Enumerates the tags in the system. To invoke this method, you need read privilege on the individual tags. The List will only contain tags for which you have read privileges.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The List of resource identifiers for the tags in the system. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback,
          InvocationConfig invocationConfig)

Enumerates the tags in the system. To invoke this method, you need read privilege on the individual tags. The List will only contain tags for which you have read privileges.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The List of resource identifiers for the tags in the system. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

listUsedTags

java.util.List<java.lang.String> listUsedTags(java.lang.String usedByEntity)

Enumerates all tags for which the usedByEntity is part of the TagModel.getUsedBy() subscribers Set. To invoke this method, you need the read privilege on the individual tags.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

usedByEntity - The field on which the results will be filtered.

Returns:

The List of resource identifiers for the tags in the system that are used by usedByEntity. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

listUsedTags

java.util.List<java.lang.String> listUsedTags(java.lang.String usedByEntity,
                                              InvocationConfig invocationConfig)

Enumerates all tags for which the usedByEntity is part of the TagModel.getUsedBy() subscribers Set. To invoke this method, you need the read privilege on the individual tags.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

usedByEntity - The field on which the results will be filtered.

invocationConfig - Configuration for the method invocation.

Returns:

The List of resource identifiers for the tags in the system that are used by usedByEntity. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

listUsedTags

void listUsedTags(java.lang.String usedByEntity,
                  AsyncCallback<java.util.List<java.lang.String>> asyncCallback)

Enumerates all tags for which the usedByEntity is part of the TagModel.getUsedBy() subscribers Set. To invoke this method, you need the read privilege on the individual tags.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The List of resource identifiers for the tags in the system that are used by usedByEntity. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Parameters:

usedByEntity - The field on which the results will be filtered.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

listUsedTags

void listUsedTags(java.lang.String usedByEntity,
                  AsyncCallback<java.util.List<java.lang.String>> asyncCallback,
                  InvocationConfig invocationConfig)

Enumerates all tags for which the usedByEntity is part of the TagModel.getUsedBy() subscribers Set. To invoke this method, you need the read privilege on the individual tags.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The List of resource identifiers for the tags in the system that are used by usedByEntity. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Parameters:

usedByEntity - The field on which the results will be filtered.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

listTagsForCategory

java.util.List<java.lang.String> listTagsForCategory(java.lang.String categoryId)

Enumerates all tags for the given category. To invoke this method, you need the read privilege on the given category and the individual tags in that category.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

Returns:

The List of resource identifiers for the tags in the given input category. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Throws:

NotFound - if the category for the given categoryId does not exist in the system.

Unauthorized - if you do not have the privilege to read the category.

listTagsForCategory

java.util.List<java.lang.String> listTagsForCategory(java.lang.String categoryId,
                                                     InvocationConfig invocationConfig)

Enumerates all tags for the given category. To invoke this method, you need the read privilege on the given category and the individual tags in that category.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

invocationConfig - Configuration for the method invocation.

Returns:

The List of resource identifiers for the tags in the given input category. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Throws:

NotFound - if the category for the given categoryId does not exist in the system.

Unauthorized - if you do not have the privilege to read the category.

listTagsForCategory

void listTagsForCategory(java.lang.String categoryId,
                         AsyncCallback<java.util.List<java.lang.String>> asyncCallback)

Enumerates all tags for the given category. To invoke this method, you need the read privilege on the given category and the individual tags in that category.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The List of resource identifiers for the tags in the given input category. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Operation Errors:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to read the category.

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

listTagsForCategory

void listTagsForCategory(java.lang.String categoryId,
                         AsyncCallback<java.util.List<java.lang.String>> asyncCallback,
                         InvocationConfig invocationConfig)

Enumerates all tags for the given category. To invoke this method, you need the read privilege on the given category and the individual tags in that category.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The List of resource identifiers for the tags in the given input category. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Operation Errors:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to read the category.

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

addToUsedBy

void addToUsedBy(java.lang.String tagId,
                 java.lang.String usedByEntity)

Adds the usedByEntity to the TagModel.getUsedBy() subscribers Set. If the usedByEntity is already in the Set, then this becomes a no-op. To invoke this method, you need the modify TagModel.getUsedBy() privilege on the tag.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

usedByEntity - The name of the user to be added to the TagModel.getUsedBy() Set.

Throws:

NotFound - if the tag for the given tagId does not exist in the system.

Unauthorized - if you do not have the privilege to add an entity to the TagModel.getUsedBy() field.

addToUsedBy

void addToUsedBy(java.lang.String tagId,
                 java.lang.String usedByEntity,
                 InvocationConfig invocationConfig)

Adds the usedByEntity to the TagModel.getUsedBy() subscribers Set. If the usedByEntity is already in the Set, then this becomes a no-op. To invoke this method, you need the modify TagModel.getUsedBy() privilege on the tag.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

usedByEntity - The name of the user to be added to the TagModel.getUsedBy() Set.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the tag for the given tagId does not exist in the system.

Unauthorized - if you do not have the privilege to add an entity to the TagModel.getUsedBy() field.

addToUsedBy

void addToUsedBy(java.lang.String tagId,
                 java.lang.String usedByEntity,
                 AsyncCallback<java.lang.Void> asyncCallback)

Adds the usedByEntity to the TagModel.getUsedBy() subscribers Set. If the usedByEntity is already in the Set, then this becomes a no-op. To invoke this method, you need the modify TagModel.getUsedBy() privilege on the tag.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
NotFound - if the tag for the given tagId does not exist in the system.
Unauthorized - if you do not have the privilege to add an entity to the TagModel.getUsedBy() field.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

usedByEntity - The name of the user to be added to the TagModel.getUsedBy() Set.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

addToUsedBy

void addToUsedBy(java.lang.String tagId,
                 java.lang.String usedByEntity,
                 AsyncCallback<java.lang.Void> asyncCallback,
                 InvocationConfig invocationConfig)

Adds the usedByEntity to the TagModel.getUsedBy() subscribers Set. If the usedByEntity is already in the Set, then this becomes a no-op. To invoke this method, you need the modify TagModel.getUsedBy() privilege on the tag.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
NotFound - if the tag for the given tagId does not exist in the system.
Unauthorized - if you do not have the privilege to add an entity to the TagModel.getUsedBy() field.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

usedByEntity - The name of the user to be added to the TagModel.getUsedBy() Set.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

removeFromUsedBy

void removeFromUsedBy(java.lang.String tagId,
                      java.lang.String usedByEntity)

Removes the usedByEntity from the TagModel.getUsedBy() subscribers set. If the usedByEntity is not using this tag, then this becomes a no-op. To invoke this method, you need modify TagModel.getUsedBy() privilege on the tag.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

usedByEntity - The name of the user to be removed from the TagModel.getUsedBy() Set.

Throws:

NotFound - if the tag for the given tagId does not exist in the system.

Unauthorized - if you do not have the privilege to remove an entity from the TagModel.getUsedBy() field.

removeFromUsedBy

void removeFromUsedBy(java.lang.String tagId,
                      java.lang.String usedByEntity,
                      InvocationConfig invocationConfig)

Removes the usedByEntity from the TagModel.getUsedBy() subscribers set. If the usedByEntity is not using this tag, then this becomes a no-op. To invoke this method, you need modify TagModel.getUsedBy() privilege on the tag.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

usedByEntity - The name of the user to be removed from the TagModel.getUsedBy() Set.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the tag for the given tagId does not exist in the system.

Unauthorized - if you do not have the privilege to remove an entity from the TagModel.getUsedBy() field.

removeFromUsedBy

void removeFromUsedBy(java.lang.String tagId,
                      java.lang.String usedByEntity,
                      AsyncCallback<java.lang.Void> asyncCallback)

Removes the usedByEntity from the TagModel.getUsedBy() subscribers set. If the usedByEntity is not using this tag, then this becomes a no-op. To invoke this method, you need modify TagModel.getUsedBy() privilege on the tag.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
NotFound - if the tag for the given tagId does not exist in the system.
Unauthorized - if you do not have the privilege to remove an entity from the TagModel.getUsedBy() field.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

usedByEntity - The name of the user to be removed from the TagModel.getUsedBy() Set.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

removeFromUsedBy

void removeFromUsedBy(java.lang.String tagId,
                      java.lang.String usedByEntity,
                      AsyncCallback<java.lang.Void> asyncCallback,
                      InvocationConfig invocationConfig)

Removes the usedByEntity from the TagModel.getUsedBy() subscribers set. If the usedByEntity is not using this tag, then this becomes a no-op. To invoke this method, you need modify TagModel.getUsedBy() privilege on the tag.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
NotFound - if the tag for the given tagId does not exist in the system.
Unauthorized - if you do not have the privilege to remove an entity from the TagModel.getUsedBy() field.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

usedByEntity - The name of the user to be removed from the TagModel.getUsedBy() Set.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

revokePropagatingPermissions

void revokePropagatingPermissions(java.lang.String tagId)

Revokes all propagating permissions on the given tag. You should then attach a direct permission with tagging privileges on the given tag. To invoke this method, you need tag related privileges (direct or propagating) on the concerned tag.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

Throws:

NotFound - if the tag for the given tagId does not exist in the system.

Unauthorized - if you do not have the privilege to revoke propagating permissions on the tag.

revokePropagatingPermissions

void revokePropagatingPermissions(java.lang.String tagId,
                                  InvocationConfig invocationConfig)

Revokes all propagating permissions on the given tag. You should then attach a direct permission with tagging privileges on the given tag. To invoke this method, you need tag related privileges (direct or propagating) on the concerned tag.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the tag for the given tagId does not exist in the system.

Unauthorized - if you do not have the privilege to revoke propagating permissions on the tag.

revokePropagatingPermissions

void revokePropagatingPermissions(java.lang.String tagId,
                                  AsyncCallback<java.lang.Void> asyncCallback)

Revokes all propagating permissions on the given tag. You should then attach a direct permission with tagging privileges on the given tag. To invoke this method, you need tag related privileges (direct or propagating) on the concerned tag.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
NotFound - if the tag for the given tagId does not exist in the system.
Unauthorized - if you do not have the privilege to revoke propagating permissions on the tag.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

revokePropagatingPermissions

void revokePropagatingPermissions(java.lang.String tagId,
                                  AsyncCallback<java.lang.Void> asyncCallback,
                                  InvocationConfig invocationConfig)

Revokes all propagating permissions on the given tag. You should then attach a direct permission with tagging privileges on the given tag. To invoke this method, you need tag related privileges (direct or propagating) on the concerned tag.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
NotFound - if the tag for the given tagId does not exist in the system.
Unauthorized - if you do not have the privilege to revoke propagating permissions on the tag.

Parameters:

tagId - The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.