com.vmware.cis.tagging

Interface TagAssociation

All Superinterfaces:

Service, TagAssociationTypes

All Known Implementing Classes:

TagAssociationStub

public interface TagAssociation
extends Service, TagAssociationTypes

The TagAssociation interface provides methods to attach, detach, and query tags.

Nested Class Summary

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

TagAssociationTypes.BatchResult, TagAssociationTypes.ObjectToTags, TagAssociationTypes.TagToObjects

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	attach(java.lang.String tagId, DynamicID objectId) Attaches the given tag to the input object.
void	attach(java.lang.String tagId, DynamicID objectId, AsyncCallback<java.lang.Void> asyncCallback) Attaches the given tag to the input object.
void	attach(java.lang.String tagId, DynamicID objectId, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Attaches the given tag to the input object.
void	attach(java.lang.String tagId, DynamicID objectId, InvocationConfig invocationConfig) Attaches the given tag to the input object.
TagAssociationTypes.BatchResult	attachMultipleTagsToObject(DynamicID objectId, java.util.List<java.lang.String> tagIds) Attaches the given tags to the input object.
void	attachMultipleTagsToObject(DynamicID objectId, java.util.List<java.lang.String> tagIds, AsyncCallback<TagAssociationTypes.BatchResult> asyncCallback) Attaches the given tags to the input object.
void	attachMultipleTagsToObject(DynamicID objectId, java.util.List<java.lang.String> tagIds, AsyncCallback<TagAssociationTypes.BatchResult> asyncCallback, InvocationConfig invocationConfig) Attaches the given tags to the input object.
TagAssociationTypes.BatchResult	attachMultipleTagsToObject(DynamicID objectId, java.util.List<java.lang.String> tagIds, InvocationConfig invocationConfig) Attaches the given tags to the input object.
TagAssociationTypes.BatchResult	attachTagToMultipleObjects(java.lang.String tagId, java.util.List<DynamicID> objectIds) Attaches the given tag to the input objects.
void	attachTagToMultipleObjects(java.lang.String tagId, java.util.List<DynamicID> objectIds, AsyncCallback<TagAssociationTypes.BatchResult> asyncCallback) Attaches the given tag to the input objects.
void	attachTagToMultipleObjects(java.lang.String tagId, java.util.List<DynamicID> objectIds, AsyncCallback<TagAssociationTypes.BatchResult> asyncCallback, InvocationConfig invocationConfig) Attaches the given tag to the input objects.
TagAssociationTypes.BatchResult	attachTagToMultipleObjects(java.lang.String tagId, java.util.List<DynamicID> objectIds, InvocationConfig invocationConfig) Attaches the given tag to the input objects.
void	detach(java.lang.String tagId, DynamicID objectId) Detaches the tag from the given object.
void	detach(java.lang.String tagId, DynamicID objectId, AsyncCallback<java.lang.Void> asyncCallback) Detaches the tag from the given object.
void	detach(java.lang.String tagId, DynamicID objectId, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Detaches the tag from the given object.
void	detach(java.lang.String tagId, DynamicID objectId, InvocationConfig invocationConfig) Detaches the tag from the given object.
TagAssociationTypes.BatchResult	detachMultipleTagsFromObject(DynamicID objectId, java.util.List<java.lang.String> tagIds) Detaches the given tags from the input object.
void	detachMultipleTagsFromObject(DynamicID objectId, java.util.List<java.lang.String> tagIds, AsyncCallback<TagAssociationTypes.BatchResult> asyncCallback) Detaches the given tags from the input object.
void	detachMultipleTagsFromObject(DynamicID objectId, java.util.List<java.lang.String> tagIds, AsyncCallback<TagAssociationTypes.BatchResult> asyncCallback, InvocationConfig invocationConfig) Detaches the given tags from the input object.
TagAssociationTypes.BatchResult	detachMultipleTagsFromObject(DynamicID objectId, java.util.List<java.lang.String> tagIds, InvocationConfig invocationConfig) Detaches the given tags from the input object.
TagAssociationTypes.BatchResult	detachTagFromMultipleObjects(java.lang.String tagId, java.util.List<DynamicID> objectIds) Detaches the given tag from the input objects.
void	detachTagFromMultipleObjects(java.lang.String tagId, java.util.List<DynamicID> objectIds, AsyncCallback<TagAssociationTypes.BatchResult> asyncCallback) Detaches the given tag from the input objects.
void	detachTagFromMultipleObjects(java.lang.String tagId, java.util.List<DynamicID> objectIds, AsyncCallback<TagAssociationTypes.BatchResult> asyncCallback, InvocationConfig invocationConfig) Detaches the given tag from the input objects.
TagAssociationTypes.BatchResult	detachTagFromMultipleObjects(java.lang.String tagId, java.util.List<DynamicID> objectIds, InvocationConfig invocationConfig) Detaches the given tag from the input objects.
java.util.List<java.lang.String>	listAttachableTags(DynamicID objectId) Fetches the List of attachable tags for the given object, omitting the tags that have already been attached.
void	listAttachableTags(DynamicID objectId, AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Fetches the List of attachable tags for the given object, omitting the tags that have already been attached.
void	listAttachableTags(DynamicID objectId, AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Fetches the List of attachable tags for the given object, omitting the tags that have already been attached.
java.util.List<java.lang.String>	listAttachableTags(DynamicID objectId, InvocationConfig invocationConfig) Fetches the List of attachable tags for the given object, omitting the tags that have already been attached.
java.util.List<DynamicID>	listAttachedObjects(java.lang.String tagId) Fetches the List of attached objects for the given tag.
void	listAttachedObjects(java.lang.String tagId, AsyncCallback<java.util.List<DynamicID>> asyncCallback) Fetches the List of attached objects for the given tag.
void	listAttachedObjects(java.lang.String tagId, AsyncCallback<java.util.List<DynamicID>> asyncCallback, InvocationConfig invocationConfig) Fetches the List of attached objects for the given tag.
java.util.List<DynamicID>	listAttachedObjects(java.lang.String tagId, InvocationConfig invocationConfig) Fetches the List of attached objects for the given tag.
java.util.List<TagAssociationTypes.TagToObjects>	listAttachedObjectsOnTags(java.util.List<java.lang.String> tagIds) Fetches the List of TagAssociationTypes.TagToObjects describing the input tag identifiers and the objects they are attached to.
void	listAttachedObjectsOnTags(java.util.List<java.lang.String> tagIds, AsyncCallback<java.util.List<TagAssociationTypes.TagToObjects>> asyncCallback) Fetches the List of TagAssociationTypes.TagToObjects describing the input tag identifiers and the objects they are attached to.
void	listAttachedObjectsOnTags(java.util.List<java.lang.String> tagIds, AsyncCallback<java.util.List<TagAssociationTypes.TagToObjects>> asyncCallback, InvocationConfig invocationConfig) Fetches the List of TagAssociationTypes.TagToObjects describing the input tag identifiers and the objects they are attached to.
java.util.List<TagAssociationTypes.TagToObjects>	listAttachedObjectsOnTags(java.util.List<java.lang.String> tagIds, InvocationConfig invocationConfig) Fetches the List of TagAssociationTypes.TagToObjects describing the input tag identifiers and the objects they are attached to.
java.util.List<java.lang.String>	listAttachedTags(DynamicID objectId) Fetches the List of tags attached to the given object.
void	listAttachedTags(DynamicID objectId, AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Fetches the List of tags attached to the given object.
void	listAttachedTags(DynamicID objectId, AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Fetches the List of tags attached to the given object.
java.util.List<java.lang.String>	listAttachedTags(DynamicID objectId, InvocationConfig invocationConfig) Fetches the List of tags attached to the given object.
java.util.List<TagAssociationTypes.ObjectToTags>	listAttachedTagsOnObjects(java.util.List<DynamicID> objectIds) Fetches the List of TagAssociationTypes.ObjectToTags describing the input object identifiers and the tags attached to each object.
void	listAttachedTagsOnObjects(java.util.List<DynamicID> objectIds, AsyncCallback<java.util.List<TagAssociationTypes.ObjectToTags>> asyncCallback) Fetches the List of TagAssociationTypes.ObjectToTags describing the input object identifiers and the tags attached to each object.
void	listAttachedTagsOnObjects(java.util.List<DynamicID> objectIds, AsyncCallback<java.util.List<TagAssociationTypes.ObjectToTags>> asyncCallback, InvocationConfig invocationConfig) Fetches the List of TagAssociationTypes.ObjectToTags describing the input object identifiers and the tags attached to each object.
java.util.List<TagAssociationTypes.ObjectToTags>	listAttachedTagsOnObjects(java.util.List<DynamicID> objectIds, InvocationConfig invocationConfig) Fetches the List of TagAssociationTypes.ObjectToTags describing the input object identifiers and the tags attached to each object.

Method Detail

attach

void attach(java.lang.String tagId,
            DynamicID objectId)

Attaches the given tag to the input object. The tag needs to meet the cardinality (CategoryModel.getCardinality()) and associability (CategoryModel.getAssociableTypes()) criteria in order to be eligible for attachment. If the tag is already attached to the object, then this method is a no-op and an error will not be thrown. To invoke this method, you need the attach tag privilege on the tag and the read privilege on the object.

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.

objectId - The identifier of the input object.

Throws:

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

InvalidArgument - if the input tag is not eligible to be attached to this object or if the objectId is not valid.

Unauthorized - if you do not have the privilege to attach the tag or do not have the privilege to read the object.

Unauthenticated - if the user can not be authenticated.

attach

void attach(java.lang.String tagId,
            DynamicID objectId,
            InvocationConfig invocationConfig)

Attaches the given tag to the input object. The tag needs to meet the cardinality (CategoryModel.getCardinality()) and associability (CategoryModel.getAssociableTypes()) criteria in order to be eligible for attachment. If the tag is already attached to the object, then this method is a no-op and an error will not be thrown. To invoke this method, you need the attach tag privilege on the tag and the read privilege on the object.

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.

objectId - The identifier of the input object.

invocationConfig - Configuration for the method invocation.

Throws:

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

InvalidArgument - if the input tag is not eligible to be attached to this object or if the objectId is not valid.

Unauthorized - if you do not have the privilege to attach the tag or do not have the privilege to read the object.

Unauthenticated - if the user can not be authenticated.

attach

void attach(java.lang.String tagId,
            DynamicID objectId,
            AsyncCallback<java.lang.Void> asyncCallback)

Attaches the given tag to the input object. The tag needs to meet the cardinality (CategoryModel.getCardinality()) and associability (CategoryModel.getAssociableTypes()) criteria in order to be eligible for attachment. If the tag is already attached to the object, then this method is a no-op and an error will not be thrown. To invoke this method, you need the attach tag privilege on the tag and the read privilege on the object.

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.
InvalidArgument - if the input tag is not eligible to be attached to this object or if the objectId is not valid.
Unauthorized - if you do not have the privilege to attach the tag or do not have the privilege to read the object.
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.

objectId - The identifier of the input object.

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

attach

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

Attaches the given tag to the input object. The tag needs to meet the cardinality (CategoryModel.getCardinality()) and associability (CategoryModel.getAssociableTypes()) criteria in order to be eligible for attachment. If the tag is already attached to the object, then this method is a no-op and an error will not be thrown. To invoke this method, you need the attach tag privilege on the tag and the read privilege on the object.

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.
InvalidArgument - if the input tag is not eligible to be attached to this object or if the objectId is not valid.
Unauthorized - if you do not have the privilege to attach the tag or do not have the privilege to read the object.
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.

objectId - The identifier of the input object.

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

invocationConfig - Configuration for the method invocation.

attachMultipleTagsToObject

TagAssociationTypes.BatchResult attachMultipleTagsToObject(DynamicID objectId,
                                                           java.util.List<java.lang.String> tagIds)

Attaches the given tags to the input object. If a tag is already attached to the object, then the individual method is a no-op and an error will not be added to TagAssociationTypes.BatchResult.getErrorMessages(). To invoke this method, you need the read privilege on the object and the attach tag privilege on each tag. This method was added in vSphere API 6.5.

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

Parameters:

objectId - The identifier of the input object.

tagIds - The identifiers of the input tags. The parameter must contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Returns:

The outcome of the batch method and the List of error messages (TagAssociationTypes.BatchResult.getErrorMessages()) describing attachment failures.

Throws:

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

Unauthenticated - if the user can not be authenticated.

attachMultipleTagsToObject

TagAssociationTypes.BatchResult attachMultipleTagsToObject(DynamicID objectId,
                                                           java.util.List<java.lang.String> tagIds,
                                                           InvocationConfig invocationConfig)

Attaches the given tags to the input object. If a tag is already attached to the object, then the individual method is a no-op and an error will not be added to TagAssociationTypes.BatchResult.getErrorMessages(). To invoke this method, you need the read privilege on the object and the attach tag privilege on each tag. This method was added in vSphere API 6.5.

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:

objectId - The identifier of the input object.

tagIds - The identifiers of the input tags. The parameter must contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

invocationConfig - Configuration for the method invocation.

Returns:

The outcome of the batch method and the List of error messages (TagAssociationTypes.BatchResult.getErrorMessages()) describing attachment failures.

Throws:

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

Unauthenticated - if the user can not be authenticated.

attachMultipleTagsToObject

void attachMultipleTagsToObject(DynamicID objectId,
                                java.util.List<java.lang.String> tagIds,
                                AsyncCallback<TagAssociationTypes.BatchResult> asyncCallback)

Attaches the given tags to the input object. If a tag is already attached to the object, then the individual method is a no-op and an error will not be added to TagAssociationTypes.BatchResult.getErrorMessages(). To invoke this method, you need the read privilege on the object and the attach tag privilege on each tag. This method was added in vSphere API 6.5.

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

Invocation Result:
The outcome of the batch method and the List of error messages (TagAssociationTypes.BatchResult.getErrorMessages()) describing attachment failures.

Operation Errors:
Unauthorized - if you do not have the privilege to read the object.
Unauthenticated - if the user can not be authenticated.

Parameters:

objectId - The identifier of the input object.

tagIds - The identifiers of the input tags. The parameter must contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

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

attachMultipleTagsToObject

void attachMultipleTagsToObject(DynamicID objectId,
                                java.util.List<java.lang.String> tagIds,
                                AsyncCallback<TagAssociationTypes.BatchResult> asyncCallback,
                                InvocationConfig invocationConfig)

Attaches the given tags to the input object. If a tag is already attached to the object, then the individual method is a no-op and an error will not be added to TagAssociationTypes.BatchResult.getErrorMessages(). To invoke this method, you need the read privilege on the object and the attach tag privilege on each tag. This method was added in vSphere API 6.5.

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 outcome of the batch method and the List of error messages (TagAssociationTypes.BatchResult.getErrorMessages()) describing attachment failures.

Operation Errors:
Unauthorized - if you do not have the privilege to read the object.
Unauthenticated - if the user can not be authenticated.

Parameters:

objectId - The identifier of the input object.

tagIds - The identifiers of the input tags. The parameter must contain identifiers 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.

attachTagToMultipleObjects

TagAssociationTypes.BatchResult attachTagToMultipleObjects(java.lang.String tagId,
                                                           java.util.List<DynamicID> objectIds)

Attaches the given tag to the input objects. If a tag is already attached to the object, then the individual method is a no-op and an error will not be added to TagAssociationTypes.BatchResult.getErrorMessages(). To invoke this method, you need the attach tag privilege on the tag and the read privilege on each object. This method was added in vSphere API 6.5.

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.

objectIds - The identifiers of the input objects.

Returns:

The outcome of the batch method and the List of error messages (TagAssociationTypes.BatchResult.getErrorMessages()) describing attachment failures.

Throws:

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

Unauthorized - if you do not have the attach tag privilege on the tag.

Unauthenticated - if the user can not be authenticated.

attachTagToMultipleObjects

TagAssociationTypes.BatchResult attachTagToMultipleObjects(java.lang.String tagId,
                                                           java.util.List<DynamicID> objectIds,
                                                           InvocationConfig invocationConfig)

Attaches the given tag to the input objects. If a tag is already attached to the object, then the individual method is a no-op and an error will not be added to TagAssociationTypes.BatchResult.getErrorMessages(). To invoke this method, you need the attach tag privilege on the tag and the read privilege on each object. This method was added in vSphere API 6.5.

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.

objectIds - The identifiers of the input objects.

invocationConfig - Configuration for the method invocation.

Returns:

The outcome of the batch method and the List of error messages (TagAssociationTypes.BatchResult.getErrorMessages()) describing attachment failures.

Throws:

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

Unauthorized - if you do not have the attach tag privilege on the tag.

Unauthenticated - if the user can not be authenticated.

attachTagToMultipleObjects

void attachTagToMultipleObjects(java.lang.String tagId,
                                java.util.List<DynamicID> objectIds,
                                AsyncCallback<TagAssociationTypes.BatchResult> asyncCallback)

Attaches the given tag to the input objects. If a tag is already attached to the object, then the individual method is a no-op and an error will not be added to TagAssociationTypes.BatchResult.getErrorMessages(). To invoke this method, you need the attach tag privilege on the tag and the read privilege on each object. This method was added in vSphere API 6.5.

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

Invocation Result:
The outcome of the batch method and the List of error messages (TagAssociationTypes.BatchResult.getErrorMessages()) describing attachment failures.

Operation Errors:
NotFound - if the tag for the given tagId does not exist in the system.
Unauthorized - if you do not have the attach tag privilege on 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.

objectIds - The identifiers of the input objects.

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

attachTagToMultipleObjects

void attachTagToMultipleObjects(java.lang.String tagId,
                                java.util.List<DynamicID> objectIds,
                                AsyncCallback<TagAssociationTypes.BatchResult> asyncCallback,
                                InvocationConfig invocationConfig)

Attaches the given tag to the input objects. If a tag is already attached to the object, then the individual method is a no-op and an error will not be added to TagAssociationTypes.BatchResult.getErrorMessages(). To invoke this method, you need the attach tag privilege on the tag and the read privilege on each object. This method was added in vSphere API 6.5.

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 outcome of the batch method and the List of error messages (TagAssociationTypes.BatchResult.getErrorMessages()) describing attachment failures.

Operation Errors:
NotFound - if the tag for the given tagId does not exist in the system.
Unauthorized - if you do not have the attach tag privilege on 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.

objectIds - The identifiers of the input objects.

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

invocationConfig - Configuration for the method invocation.

detach

void detach(java.lang.String tagId,
            DynamicID objectId)

Detaches the tag from the given object. If the tag is already removed from the object, then this method is a no-op and an error will not be thrown. To invoke this method, you need the attach tag privilege on the tag and the read privilege on the object.

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.

objectId - The identifier of the input object.

Throws:

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

Unauthorized - if you do not have the privilege to detach the tag or do not have the privilege to read the given object.

Unauthenticated - if the user can not be authenticated.

detach

void detach(java.lang.String tagId,
            DynamicID objectId,
            InvocationConfig invocationConfig)

Detaches the tag from the given object. If the tag is already removed from the object, then this method is a no-op and an error will not be thrown. To invoke this method, you need the attach tag privilege on the tag and the read privilege on the object.

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.

objectId - The identifier of the input object.

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 detach the tag or do not have the privilege to read the given object.

Unauthenticated - if the user can not be authenticated.

detach

void detach(java.lang.String tagId,
            DynamicID objectId,
            AsyncCallback<java.lang.Void> asyncCallback)

Detaches the tag from the given object. If the tag is already removed from the object, then this method is a no-op and an error will not be thrown. To invoke this method, you need the attach tag privilege on the tag and the read privilege on the object.

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 detach the tag or do not have the privilege to read the given object.
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.

objectId - The identifier of the input object.

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

detach

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

Detaches the tag from the given object. If the tag is already removed from the object, then this method is a no-op and an error will not be thrown. To invoke this method, you need the attach tag privilege on the tag and the read privilege on the object.

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 detach the tag or do not have the privilege to read the given object.
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.

objectId - The identifier of the input object.

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

invocationConfig - Configuration for the method invocation.

detachMultipleTagsFromObject

TagAssociationTypes.BatchResult detachMultipleTagsFromObject(DynamicID objectId,
                                                             java.util.List<java.lang.String> tagIds)

Detaches the given tags from the input object. If a tag is already removed from the object, then the individual method is a no-op and an error will not be added to TagAssociationTypes.BatchResult.getErrorMessages(). To invoke this method, you need the read privilege on the object and the attach tag privilege each tag. This method was added in vSphere API 6.5.

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

Parameters:

objectId - The identifier of the input object.

tagIds - The identifiers of the input tags. The parameter must contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Returns:

The outcome of the batch method and the List of error messages (TagAssociationTypes.BatchResult.getErrorMessages()) describing detachment failures.

Throws:

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

Unauthenticated - if the user can not be authenticated.

detachMultipleTagsFromObject

TagAssociationTypes.BatchResult detachMultipleTagsFromObject(DynamicID objectId,
                                                             java.util.List<java.lang.String> tagIds,
                                                             InvocationConfig invocationConfig)

Detaches the given tags from the input object. If a tag is already removed from the object, then the individual method is a no-op and an error will not be added to TagAssociationTypes.BatchResult.getErrorMessages(). To invoke this method, you need the read privilege on the object and the attach tag privilege each tag. This method was added in vSphere API 6.5.

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:

objectId - The identifier of the input object.

tagIds - The identifiers of the input tags. The parameter must contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

invocationConfig - Configuration for the method invocation.

Returns:

The outcome of the batch method and the List of error messages (TagAssociationTypes.BatchResult.getErrorMessages()) describing detachment failures.

Throws:

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

Unauthenticated - if the user can not be authenticated.

detachMultipleTagsFromObject

void detachMultipleTagsFromObject(DynamicID objectId,
                                  java.util.List<java.lang.String> tagIds,
                                  AsyncCallback<TagAssociationTypes.BatchResult> asyncCallback)

Detaches the given tags from the input object. If a tag is already removed from the object, then the individual method is a no-op and an error will not be added to TagAssociationTypes.BatchResult.getErrorMessages(). To invoke this method, you need the read privilege on the object and the attach tag privilege each tag. This method was added in vSphere API 6.5.

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

Invocation Result:
The outcome of the batch method and the List of error messages (TagAssociationTypes.BatchResult.getErrorMessages()) describing detachment failures.

Operation Errors:
Unauthorized - if you do not have the privilege to read the object.
Unauthenticated - if the user can not be authenticated.

Parameters:

objectId - The identifier of the input object.

tagIds - The identifiers of the input tags. The parameter must contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

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

detachMultipleTagsFromObject

void detachMultipleTagsFromObject(DynamicID objectId,
                                  java.util.List<java.lang.String> tagIds,
                                  AsyncCallback<TagAssociationTypes.BatchResult> asyncCallback,
                                  InvocationConfig invocationConfig)

Detaches the given tags from the input object. If a tag is already removed from the object, then the individual method is a no-op and an error will not be added to TagAssociationTypes.BatchResult.getErrorMessages(). To invoke this method, you need the read privilege on the object and the attach tag privilege each tag. This method was added in vSphere API 6.5.

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 outcome of the batch method and the List of error messages (TagAssociationTypes.BatchResult.getErrorMessages()) describing detachment failures.

Operation Errors:
Unauthorized - if you do not have the privilege to read the object.
Unauthenticated - if the user can not be authenticated.

Parameters:

objectId - The identifier of the input object.

tagIds - The identifiers of the input tags. The parameter must contain identifiers 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.

detachTagFromMultipleObjects

TagAssociationTypes.BatchResult detachTagFromMultipleObjects(java.lang.String tagId,
                                                             java.util.List<DynamicID> objectIds)

Detaches the given tag from the input objects. If a tag is already removed from the object, then the individual method is a no-op and an error will not be added to TagAssociationTypes.BatchResult.getErrorMessages(). To invoke this method, you need the attach tag privilege on the tag and the read privilege on each object. This method was added in vSphere API 6.5.

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.

objectIds - The identifiers of the input objects.

Returns:

The outcome of the batch method and the List of error messages (TagAssociationTypes.BatchResult.getErrorMessages()) describing detachment failures.

Throws:

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

Unauthorized - if you do not have the attach tag privilege on the tag.

Unauthenticated - if the user can not be authenticated.

detachTagFromMultipleObjects

TagAssociationTypes.BatchResult detachTagFromMultipleObjects(java.lang.String tagId,
                                                             java.util.List<DynamicID> objectIds,
                                                             InvocationConfig invocationConfig)

Detaches the given tag from the input objects. If a tag is already removed from the object, then the individual method is a no-op and an error will not be added to TagAssociationTypes.BatchResult.getErrorMessages(). To invoke this method, you need the attach tag privilege on the tag and the read privilege on each object. This method was added in vSphere API 6.5.

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.

objectIds - The identifiers of the input objects.

invocationConfig - Configuration for the method invocation.

Returns:

The outcome of the batch method and the List of error messages (TagAssociationTypes.BatchResult.getErrorMessages()) describing detachment failures.

Throws:

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

Unauthorized - if you do not have the attach tag privilege on the tag.

Unauthenticated - if the user can not be authenticated.

detachTagFromMultipleObjects

void detachTagFromMultipleObjects(java.lang.String tagId,
                                  java.util.List<DynamicID> objectIds,
                                  AsyncCallback<TagAssociationTypes.BatchResult> asyncCallback)

Detaches the given tag from the input objects. If a tag is already removed from the object, then the individual method is a no-op and an error will not be added to TagAssociationTypes.BatchResult.getErrorMessages(). To invoke this method, you need the attach tag privilege on the tag and the read privilege on each object. This method was added in vSphere API 6.5.

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

Invocation Result:
The outcome of the batch method and the List of error messages (TagAssociationTypes.BatchResult.getErrorMessages()) describing detachment failures.

Operation Errors:
NotFound - if the tag for the given tag does not exist in the system.
Unauthorized - if you do not have the attach tag privilege on 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.

objectIds - The identifiers of the input objects.

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

detachTagFromMultipleObjects

void detachTagFromMultipleObjects(java.lang.String tagId,
                                  java.util.List<DynamicID> objectIds,
                                  AsyncCallback<TagAssociationTypes.BatchResult> asyncCallback,
                                  InvocationConfig invocationConfig)

Detaches the given tag from the input objects. If a tag is already removed from the object, then the individual method is a no-op and an error will not be added to TagAssociationTypes.BatchResult.getErrorMessages(). To invoke this method, you need the attach tag privilege on the tag and the read privilege on each object. This method was added in vSphere API 6.5.

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 outcome of the batch method and the List of error messages (TagAssociationTypes.BatchResult.getErrorMessages()) describing detachment failures.

Operation Errors:
NotFound - if the tag for the given tag does not exist in the system.
Unauthorized - if you do not have the attach tag privilege on 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.

objectIds - The identifiers of the input objects.

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

invocationConfig - Configuration for the method invocation.

listAttachedObjects

java.util.List<DynamicID> listAttachedObjects(java.lang.String tagId)

Fetches the List of attached objects for the given tag. To invoke this method, you need the read privilege on the input tag. Only those objects for which you have the read privilege will be returned.

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 List of attached object identifiers.

Throws:

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

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

Unauthenticated - if the user can not be authenticated.

listAttachedObjects

java.util.List<DynamicID> listAttachedObjects(java.lang.String tagId,
                                              InvocationConfig invocationConfig)

Fetches the List of attached objects for the given tag. To invoke this method, you need the read privilege on the input tag. Only those objects for which you have the read privilege will be returned.

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 List of attached object identifiers.

Throws:

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

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

Unauthenticated - if the user can not be authenticated.

listAttachedObjects

void listAttachedObjects(java.lang.String tagId,
                         AsyncCallback<java.util.List<DynamicID>> asyncCallback)

Fetches the List of attached objects for the given tag. To invoke this method, you need the read privilege on the input tag. Only those objects for which you have the read privilege will be returned.

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

Invocation Result:
The List of attached object identifiers.

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 read 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.

listAttachedObjects

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

Fetches the List of attached objects for the given tag. To invoke this method, you need the read privilege on the input tag. Only those objects for which you have the read privilege will be returned.

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 attached object identifiers.

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 read 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.

listAttachedObjectsOnTags

java.util.List<TagAssociationTypes.TagToObjects> listAttachedObjectsOnTags(java.util.List<java.lang.String> tagIds)

Fetches the List of TagAssociationTypes.TagToObjects describing the input tag identifiers and the objects they are attached to. To invoke this method, you need the read privilege on each input tag. The TagAssociationTypes.TagToObjects.getObjectIds() will only contain those objects for which you have the read privilege. This method was added in vSphere API 6.5.

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

Parameters:

tagIds - The identifiers of the input tags. The parameter must contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Returns:

The List of the tag identifiers to all object identifiers that each tag is attached to.

Throws:

Unauthenticated - if the user can not be authenticated.

listAttachedObjectsOnTags

java.util.List<TagAssociationTypes.TagToObjects> listAttachedObjectsOnTags(java.util.List<java.lang.String> tagIds,
                                                                           InvocationConfig invocationConfig)

Fetches the List of TagAssociationTypes.TagToObjects describing the input tag identifiers and the objects they are attached to. To invoke this method, you need the read privilege on each input tag. The TagAssociationTypes.TagToObjects.getObjectIds() will only contain those objects for which you have the read privilege. This method was added in vSphere API 6.5.

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:

tagIds - The identifiers of the input tags. The parameter must contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

invocationConfig - Configuration for the method invocation.

Returns:

The List of the tag identifiers to all object identifiers that each tag is attached to.

Throws:

Unauthenticated - if the user can not be authenticated.

listAttachedObjectsOnTags

void listAttachedObjectsOnTags(java.util.List<java.lang.String> tagIds,
                               AsyncCallback<java.util.List<TagAssociationTypes.TagToObjects>> asyncCallback)

Fetches the List of TagAssociationTypes.TagToObjects describing the input tag identifiers and the objects they are attached to. To invoke this method, you need the read privilege on each input tag. The TagAssociationTypes.TagToObjects.getObjectIds() will only contain those objects for which you have the read privilege. This method was added in vSphere API 6.5.

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

Invocation Result:
The List of the tag identifiers to all object identifiers that each tag is attached to.

Operation Errors:
Unauthenticated - if the user can not be authenticated.

Parameters:

tagIds - The identifiers of the input tags. The parameter must contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

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

listAttachedObjectsOnTags

void listAttachedObjectsOnTags(java.util.List<java.lang.String> tagIds,
                               AsyncCallback<java.util.List<TagAssociationTypes.TagToObjects>> asyncCallback,
                               InvocationConfig invocationConfig)

Fetches the List of TagAssociationTypes.TagToObjects describing the input tag identifiers and the objects they are attached to. To invoke this method, you need the read privilege on each input tag. The TagAssociationTypes.TagToObjects.getObjectIds() will only contain those objects for which you have the read privilege. This method was added in vSphere API 6.5.

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 the tag identifiers to all object identifiers that each tag is attached to.

Operation Errors:
Unauthenticated - if the user can not be authenticated.

Parameters:

tagIds - The identifiers of the input tags. The parameter must contain identifiers 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.

listAttachedTags

java.util.List<java.lang.String> listAttachedTags(DynamicID objectId)

Fetches the List of tags attached to the given object. To invoke this method, you need the read privilege on the input object. The List will only contain those tags for which you have the read privileges.

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

Parameters:

objectId - The identifier of the input object.

Returns:

The List of all tag identifiers that correspond to the tags attached to the given object. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Throws:

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

Unauthenticated - if the user can not be authenticated.

listAttachedTags

java.util.List<java.lang.String> listAttachedTags(DynamicID objectId,
                                                  InvocationConfig invocationConfig)

Fetches the List of tags attached to the given object. To invoke this method, you need the read privilege on the input object. The List will only contain those tags for which you have the 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:

objectId - The identifier of the input object.

invocationConfig - Configuration for the method invocation.

Returns:

The List of all tag identifiers that correspond to the tags attached to the given object. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Throws:

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

Unauthenticated - if the user can not be authenticated.

listAttachedTags

void listAttachedTags(DynamicID objectId,
                      AsyncCallback<java.util.List<java.lang.String>> asyncCallback)

Fetches the List of tags attached to the given object. To invoke this method, you need the read privilege on the input object. The List will only contain those tags for which you have the read privileges.

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

Invocation Result:
The List of all tag identifiers that correspond to the tags attached to the given object. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Operation Errors:
Unauthorized - if you do not have the privilege to read the object.
Unauthenticated - if the user can not be authenticated.

Parameters:

objectId - The identifier of the input object.

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

listAttachedTags

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

Fetches the List of tags attached to the given object. To invoke this method, you need the read privilege on the input object. The List will only contain those tags for which you have the 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 all tag identifiers that correspond to the tags attached to the given object. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Operation Errors:
Unauthorized - if you do not have the privilege to read the object.
Unauthenticated - if the user can not be authenticated.

Parameters:

objectId - The identifier of the input object.

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

invocationConfig - Configuration for the method invocation.

listAttachedTagsOnObjects

java.util.List<TagAssociationTypes.ObjectToTags> listAttachedTagsOnObjects(java.util.List<DynamicID> objectIds)

Fetches the List of TagAssociationTypes.ObjectToTags describing the input object identifiers and the tags attached to each object. To invoke this method, you need the read privilege on each input object. The TagAssociationTypes.ObjectToTags.getTagIds() will only contain those tags for which you have the read privilege. This method was added in vSphere API 6.5.

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

Parameters:

objectIds - The identifiers of the input objects.

Returns:

The List of the object identifiers to all tag identifiers that are attached to that object.

Throws:

Unauthenticated - if the user can not be authenticated.

listAttachedTagsOnObjects

java.util.List<TagAssociationTypes.ObjectToTags> listAttachedTagsOnObjects(java.util.List<DynamicID> objectIds,
                                                                           InvocationConfig invocationConfig)

Fetches the List of TagAssociationTypes.ObjectToTags describing the input object identifiers and the tags attached to each object. To invoke this method, you need the read privilege on each input object. The TagAssociationTypes.ObjectToTags.getTagIds() will only contain those tags for which you have the read privilege. This method was added in vSphere API 6.5.

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:

objectIds - The identifiers of the input objects.

invocationConfig - Configuration for the method invocation.

Returns:

The List of the object identifiers to all tag identifiers that are attached to that object.

Throws:

Unauthenticated - if the user can not be authenticated.

listAttachedTagsOnObjects

void listAttachedTagsOnObjects(java.util.List<DynamicID> objectIds,
                               AsyncCallback<java.util.List<TagAssociationTypes.ObjectToTags>> asyncCallback)

Fetches the List of TagAssociationTypes.ObjectToTags describing the input object identifiers and the tags attached to each object. To invoke this method, you need the read privilege on each input object. The TagAssociationTypes.ObjectToTags.getTagIds() will only contain those tags for which you have the read privilege. This method was added in vSphere API 6.5.

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

Invocation Result:
The List of the object identifiers to all tag identifiers that are attached to that object.

Operation Errors:
Unauthenticated - if the user can not be authenticated.

Parameters:

objectIds - The identifiers of the input objects.

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

listAttachedTagsOnObjects

void listAttachedTagsOnObjects(java.util.List<DynamicID> objectIds,
                               AsyncCallback<java.util.List<TagAssociationTypes.ObjectToTags>> asyncCallback,
                               InvocationConfig invocationConfig)

Fetches the List of TagAssociationTypes.ObjectToTags describing the input object identifiers and the tags attached to each object. To invoke this method, you need the read privilege on each input object. The TagAssociationTypes.ObjectToTags.getTagIds() will only contain those tags for which you have the read privilege. This method was added in vSphere API 6.5.

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 the object identifiers to all tag identifiers that are attached to that object.

Operation Errors:
Unauthenticated - if the user can not be authenticated.

Parameters:

objectIds - The identifiers of the input objects.

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

invocationConfig - Configuration for the method invocation.

listAttachableTags

java.util.List<java.lang.String> listAttachableTags(DynamicID objectId)

Fetches the List of attachable tags for the given object, omitting the tags that have already been attached. Criteria for attachability is calculated based on tagging cardinality (CategoryModel.getCardinality()) and associability (CategoryModel.getAssociableTypes()) constructs. To invoke this method, you need the read privilege on the input object. The List will only contain those tags for which you have read privileges.

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

Parameters:

objectId - The identifier of the input object.

Returns:

The List of tag identifiers that are eligible to be attached to the given object. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Throws:

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

Unauthenticated - if the user can not be authenticated.

listAttachableTags

java.util.List<java.lang.String> listAttachableTags(DynamicID objectId,
                                                    InvocationConfig invocationConfig)

Fetches the List of attachable tags for the given object, omitting the tags that have already been attached. Criteria for attachability is calculated based on tagging cardinality (CategoryModel.getCardinality()) and associability (CategoryModel.getAssociableTypes()) constructs. To invoke this method, you need the read privilege on the input object. The List will only contain those 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:

objectId - The identifier of the input object.

invocationConfig - Configuration for the method invocation.

Returns:

The List of tag identifiers that are eligible to be attached to the given object. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Throws:

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

Unauthenticated - if the user can not be authenticated.

listAttachableTags

void listAttachableTags(DynamicID objectId,
                        AsyncCallback<java.util.List<java.lang.String>> asyncCallback)

Fetches the List of attachable tags for the given object, omitting the tags that have already been attached. Criteria for attachability is calculated based on tagging cardinality (CategoryModel.getCardinality()) and associability (CategoryModel.getAssociableTypes()) constructs. To invoke this method, you need the read privilege on the input object. The List will only contain those 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 tag identifiers that are eligible to be attached to the given object. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Operation Errors:
Unauthorized - if you do not have the privilege to read the object.
Unauthenticated - if the user can not be authenticated.

Parameters:

objectId - The identifier of the input object.

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

listAttachableTags

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

Fetches the List of attachable tags for the given object, omitting the tags that have already been attached. Criteria for attachability is calculated based on tagging cardinality (CategoryModel.getCardinality()) and associability (CategoryModel.getAssociableTypes()) constructs. To invoke this method, you need the read privilege on the input object. The List will only contain those 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 tag identifiers that are eligible to be attached to the given object. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.

Operation Errors:
Unauthorized - if you do not have the privilege to read the object.
Unauthenticated - if the user can not be authenticated.

Parameters:

objectId - The identifier of the input object.

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

invocationConfig - Configuration for the method invocation.