vmware::cis::tagging::TagAssociationStub Class Reference

Remote stub implementation of the TagAssociation API service. More...

Inherits vmware::cis::tagging::TagAssociation.

List of all members.

Public Member Functions
	TagAssociationStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.IStubConfiguration config)
void	Attach (string tagId, vmware.vapi.std.DynamicID objectId)
	Attaches the given tag to the input object.
void	Attach (string tagId, vmware.vapi.std.DynamicID objectId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Attaches the given tag to the input object.
global::System.Threading.Tasks.Task	AttachAsync (string tagId, vmware.vapi.std.DynamicID objectId)
	Attaches the given tag to the input object.
global::System.Threading.Tasks.Task	AttachAsync (string tagId, vmware.vapi.std.DynamicID objectId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Attaches the given tag to the input object.
void	Detach (string tagId, vmware.vapi.std.DynamicID objectId)
	Detaches the tag from the given object.
void	Detach (string tagId, vmware.vapi.std.DynamicID objectId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Detaches the tag from the given object.
global::System.Threading.Tasks.Task	DetachAsync (string tagId, vmware.vapi.std.DynamicID objectId)
	Detaches the tag from the given object.
global::System.Threading.Tasks.Task	DetachAsync (string tagId, vmware.vapi.std.DynamicID objectId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Detaches the tag from the given object.
global::System.Collections.Generic.List < vmware.vapi.std.DynamicID >	ListAttachedObjects (string tagId)
	Fetches the list of attached objects for the given tag.
global::System.Collections.Generic.List < vmware.vapi.std.DynamicID >	ListAttachedObjects (string tagId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Fetches the list of attached objects for the given tag.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.vapi.std.DynamicID > >	ListAttachedObjectsAsync (string tagId)
	Fetches the list of attached objects for the given tag.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.vapi.std.DynamicID > >	ListAttachedObjectsAsync (string tagId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Fetches the list of attached objects for the given tag.
global::System.Collections.Generic.List < string >	ListAttachedTags (vmware.vapi.std.DynamicID objectId)
	Fetches the list of tags attached to the given object.
global::System.Collections.Generic.List < string >	ListAttachedTags (vmware.vapi.std.DynamicID objectId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Fetches the list of tags attached to the given object.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < string > >	ListAttachedTagsAsync (vmware.vapi.std.DynamicID objectId)
	Fetches the list of tags attached to the given object.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < string > >	ListAttachedTagsAsync (vmware.vapi.std.DynamicID objectId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Fetches the list of tags attached to the given object.
global::System.Collections.Generic.List < string >	ListAttachableTags (vmware.vapi.std.DynamicID objectId)
	Fetches the list of attachable tags for the given object, omitting the tags that have already been attached.
global::System.Collections.Generic.List < string >	ListAttachableTags (vmware.vapi.std.DynamicID objectId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Fetches the list of attachable tags for the given object, omitting the tags that have already been attached.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < string > >	ListAttachableTagsAsync (vmware.vapi.std.DynamicID objectId)
	Fetches the list of attachable tags for the given object, omitting the tags that have already been attached.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < string > >	ListAttachableTagsAsync (vmware.vapi.std.DynamicID objectId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Fetches the list of attachable tags for the given object, omitting the tags that have already been attached.

---

Detailed Description

Remote stub implementation of the TagAssociation API service.

---

Constructor & Destructor Documentation

vmware::cis::tagging::TagAssociationStub::TagAssociationStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.IStubConfiguration	config
	)		[inline]

---

Member Function Documentation

void vmware::cis::tagging::TagAssociationStub::Attach	(	string	tagId,
		vmware.vapi.std.DynamicID	objectId
	)		[inline]

Attaches the given tag to the input object.

To invoke this method, you need the attach tag privilege on the tag and the read privilege on the object.

Exceptions:

vmware.vapi.std.errors.NotFound	if the tag for the given tagId does not exist in the system.
vmware.vapi.std.errors.InvalidArgument	if the input tag is not eligible to be attached to this object or if the objectId is not valid.
vmware.vapi.std.errors.Unauthorized	if you do not have the privilege to attach the tag or do not have the privilege to read the concerned object. The tag needs to pass the cardinality and associability test in order to be eligible for attachment.

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.

Implements vmware::cis::tagging::TagAssociation.

void vmware::cis::tagging::TagAssociationStub::Attach	(	string	tagId,
		vmware.vapi.std.DynamicID	objectId,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Attaches the given tag to the input object.

To invoke this method, you need the attach tag privilege on the tag and the read privilege on the object.

Exceptions:

vmware.vapi.std.errors.NotFound	if the tag for the given tagId does not exist in the system.
vmware.vapi.std.errors.InvalidArgument	if the input tag is not eligible to be attached to this object or if the objectId is not valid.
vmware.vapi.std.errors.Unauthorized	if you do not have the privilege to attach the tag or do not have the privilege to read the concerned object. The tag needs to pass the cardinality and associability test in order to be eligible for attachment.

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.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::cis::tagging::TagAssociation.

global::System.Threading.Tasks.Task vmware::cis::tagging::TagAssociationStub::AttachAsync	(	string	tagId,
		vmware.vapi.std.DynamicID	objectId,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Attaches the given tag to the input object.

To invoke this method, you need the attach tag privilege on the tag and the read privilege on the object.

Exceptions:

vmware.vapi.std.errors.NotFound	if the tag for the given tagId does not exist in the system.
vmware.vapi.std.errors.InvalidArgument	if the input tag is not eligible to be attached to this object or if the objectId is not valid.
vmware.vapi.std.errors.Unauthorized	if you do not have the privilege to attach the tag or do not have the privilege to read the concerned object. The tag needs to pass the cardinality and associability test in order to be eligible for attachment.

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.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::cis::tagging::TagAssociation.

global::System.Threading.Tasks.Task vmware::cis::tagging::TagAssociationStub::AttachAsync	(	string	tagId,
		vmware.vapi.std.DynamicID	objectId
	)		[inline]

Attaches the given tag to the input object.

To invoke this method, you need the attach tag privilege on the tag and the read privilege on the object.

Exceptions:

vmware.vapi.std.errors.NotFound	if the tag for the given tagId does not exist in the system.
vmware.vapi.std.errors.InvalidArgument	if the input tag is not eligible to be attached to this object or if the objectId is not valid.
vmware.vapi.std.errors.Unauthorized	if you do not have the privilege to attach the tag or do not have the privilege to read the concerned object. The tag needs to pass the cardinality and associability test in order to be eligible for attachment.

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.

Implements vmware::cis::tagging::TagAssociation.

void vmware::cis::tagging::TagAssociationStub::Detach	(	string	tagId,
		vmware.vapi.std.DynamicID	objectId
	)		[inline]

Detaches the tag from the given object.

To invoke this method, you need the attach tag privilege on the tag and the read privilege on the object.

Exceptions:

vmware.vapi.std.errors.NotFound	if the tag for the given tagId does not exist in the system.
vmware.vapi.std.errors.Unauthorized	if you do not have the privilege to detach the tag or do not have the privilege to read the concerned object.

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.

Implements vmware::cis::tagging::TagAssociation.

void vmware::cis::tagging::TagAssociationStub::Detach	(	string	tagId,
		vmware.vapi.std.DynamicID	objectId,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Detaches the tag from the given object.

To invoke this method, you need the attach tag privilege on the tag and the read privilege on the object.

Exceptions:

vmware.vapi.std.errors.NotFound	if the tag for the given tagId does not exist in the system.
vmware.vapi.std.errors.Unauthorized	if you do not have the privilege to detach the tag or do not have the privilege to read the concerned object.

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.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::cis::tagging::TagAssociation.

global::System.Threading.Tasks.Task vmware::cis::tagging::TagAssociationStub::DetachAsync	(	string	tagId,
		vmware.vapi.std.DynamicID	objectId,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Detaches the tag from the given object.

To invoke this method, you need the attach tag privilege on the tag and the read privilege on the object.

Exceptions:

vmware.vapi.std.errors.NotFound	if the tag for the given tagId does not exist in the system.
vmware.vapi.std.errors.Unauthorized	if you do not have the privilege to detach the tag or do not have the privilege to read the concerned object.

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.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::cis::tagging::TagAssociation.

global::System.Threading.Tasks.Task vmware::cis::tagging::TagAssociationStub::DetachAsync	(	string	tagId,
		vmware.vapi.std.DynamicID	objectId
	)		[inline]

Detaches the tag from the given object.

To invoke this method, you need the attach tag privilege on the tag and the read privilege on the object.

Exceptions:

vmware.vapi.std.errors.NotFound	if the tag for the given tagId does not exist in the system.
vmware.vapi.std.errors.Unauthorized	if you do not have the privilege to detach the tag or do not have the privilege to read the concerned object.

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.

Implements vmware::cis::tagging::TagAssociation.

global::System.Collections.Generic.List<string> vmware::cis::tagging::TagAssociationStub::ListAttachableTags

(

vmware.vapi.std.DynamicID

objectId

)

[inline]

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.cardinality ) and associability ( CategoryModel.associableTypes ) 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.

Exceptions:

vmware.vapi.std.errors.Unauthorized

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

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 result will contain identifiers for the resource type: com.vmware.cis.tagging.Tag .

Implements vmware::cis::tagging::TagAssociation.

global::System.Collections.Generic.List<string> vmware::cis::tagging::TagAssociationStub::ListAttachableTags	(	vmware.vapi.std.DynamicID	objectId,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

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.cardinality ) and associability ( CategoryModel.associableTypes ) 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.

Exceptions:

vmware.vapi.std.errors.Unauthorized

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

Parameters:

objectId	The identifier of the input object.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

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

Implements vmware::cis::tagging::TagAssociation.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<string> > vmware::cis::tagging::TagAssociationStub::ListAttachableTagsAsync

(

vmware.vapi.std.DynamicID

objectId

)

[inline]

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.cardinality ) and associability ( CategoryModel.associableTypes ) 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.

Exceptions:

vmware.vapi.std.errors.Unauthorized

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

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 result will contain identifiers for the resource type: com.vmware.cis.tagging.Tag .

Implements vmware::cis::tagging::TagAssociation.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<string> > vmware::cis::tagging::TagAssociationStub::ListAttachableTagsAsync	(	vmware.vapi.std.DynamicID	objectId,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

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.cardinality ) and associability ( CategoryModel.associableTypes ) 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.

Exceptions:

vmware.vapi.std.errors.Unauthorized

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

Parameters:

objectId	The identifier of the input object.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

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

Implements vmware::cis::tagging::TagAssociation.

global::System.Collections.Generic.List<vmware.vapi.std.DynamicID> vmware::cis::tagging::TagAssociationStub::ListAttachedObjects	(	string	tagId,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

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 read privileges will be returned.

Exceptions:

vmware.vapi.std.errors.NotFound	if the tag for the given tagId does not exist in the system.
vmware.vapi.std.errors.Unauthorized	if you do 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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

The list of attached object identifiers.

Implements vmware::cis::tagging::TagAssociation.

global::System.Collections.Generic.List<vmware.vapi.std.DynamicID> vmware::cis::tagging::TagAssociationStub::ListAttachedObjects

(

string

tagId

)

[inline]

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 read privileges will be returned.

Exceptions:

vmware.vapi.std.errors.NotFound	if the tag for the given tagId does not exist in the system.
vmware.vapi.std.errors.Unauthorized	if you do 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 .

Returns:

The list of attached object identifiers.

Implements vmware::cis::tagging::TagAssociation.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vapi.std.DynamicID> > vmware::cis::tagging::TagAssociationStub::ListAttachedObjectsAsync

(

string

tagId

)

[inline]

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 read privileges will be returned.

Exceptions:

vmware.vapi.std.errors.NotFound	if the tag for the given tagId does not exist in the system.
vmware.vapi.std.errors.Unauthorized	if you do 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 .

Returns:

The list of attached object identifiers.

Implements vmware::cis::tagging::TagAssociation.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vapi.std.DynamicID> > vmware::cis::tagging::TagAssociationStub::ListAttachedObjectsAsync	(	string	tagId,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

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 read privileges will be returned.

Exceptions:

vmware.vapi.std.errors.NotFound	if the tag for the given tagId does not exist in the system.
vmware.vapi.std.errors.Unauthorized	if you do 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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

The list of attached object identifiers.

Implements vmware::cis::tagging::TagAssociation.

global::System.Collections.Generic.List<string> vmware::cis::tagging::TagAssociationStub::ListAttachedTags	(	vmware.vapi.std.DynamicID	objectId,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

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

Exceptions:

vmware.vapi.std.errors.Unauthorized

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

Parameters:

objectId	The identifier of the input object.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

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

Implements vmware::cis::tagging::TagAssociation.

global::System.Collections.Generic.List<string> vmware::cis::tagging::TagAssociationStub::ListAttachedTags

(

vmware.vapi.std.DynamicID

objectId

)

[inline]

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

Exceptions:

vmware.vapi.std.errors.Unauthorized

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

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 result will contain identifiers for the resource type: com.vmware.cis.tagging.Tag .

Implements vmware::cis::tagging::TagAssociation.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<string> > vmware::cis::tagging::TagAssociationStub::ListAttachedTagsAsync	(	vmware.vapi.std.DynamicID	objectId,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

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

Exceptions:

vmware.vapi.std.errors.Unauthorized

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

Parameters:

objectId	The identifier of the input object.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

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

Implements vmware::cis::tagging::TagAssociation.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<string> > vmware::cis::tagging::TagAssociationStub::ListAttachedTagsAsync

(

vmware.vapi.std.DynamicID

objectId

)

[inline]

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

Exceptions:

vmware.vapi.std.errors.Unauthorized

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

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 result will contain identifiers for the resource type: com.vmware.cis.tagging.Tag .

Implements vmware::cis::tagging::TagAssociation.

---

The documentation for this class was generated from the following file:

• TagAssociationStub.cs