com.vmware.vcenter.compute.policies

Interface TagUsage

All Superinterfaces:

Service, TagUsageTypes

All Known Implementing Classes:

TagUsageStub

public interface TagUsage
extends Service, TagUsageTypes

The TagUsage interface provides methods to query which tags are used by policies. Warning: This interface is available as technical preview. It may be changed in a future release.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.compute.policies.TagUsageTypes

TagUsageTypes.FilterSpec, TagUsageTypes.Summary

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<TagUsageTypes.Summary>	list(TagUsageTypes.FilterSpec filter) Returns information about the tags used by policies available in this vCenter server matching the TagUsageTypes.FilterSpec.
void	list(TagUsageTypes.FilterSpec filter, AsyncCallback<java.util.List<TagUsageTypes.Summary>> asyncCallback) Returns information about the tags used by policies available in this vCenter server matching the TagUsageTypes.FilterSpec.
void	list(TagUsageTypes.FilterSpec filter, AsyncCallback<java.util.List<TagUsageTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about the tags used by policies available in this vCenter server matching the TagUsageTypes.FilterSpec.
java.util.List<TagUsageTypes.Summary>	list(TagUsageTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns information about the tags used by policies available in this vCenter server matching the TagUsageTypes.FilterSpec.

Method Detail

list

java.util.List<TagUsageTypes.Summary> list(TagUsageTypes.FilterSpec filter)

Returns information about the tags used by policies available in this vCenter server matching the TagUsageTypes.FilterSpec. Warning: This method is available as technical preview. It may be changed in a future release.

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

Parameters:

filter - Specification for matching tags used by policies. If null, the behavior is equivalent to a TagUsageTypes.FilterSpec with all properties null, which means all tags used by policies match the filter.

Returns:

The list of tags used by policies available on this vCenter server matching the TagUsageTypes.FilterSpec.

Throws:

Unauthorized - if the user doesn't have the required privileges.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

list

java.util.List<TagUsageTypes.Summary> list(TagUsageTypes.FilterSpec filter,
                                         InvocationConfig invocationConfig)

Returns information about the tags used by policies available in this vCenter server matching the TagUsageTypes.FilterSpec. Warning: This method is available as technical preview. It may be changed in a future release.

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:

filter - Specification for matching tags used by policies. If null, the behavior is equivalent to a TagUsageTypes.FilterSpec with all properties null, which means all tags used by policies match the filter.

invocationConfig - Configuration for the method invocation.

Returns:

The list of tags used by policies available on this vCenter server matching the TagUsageTypes.FilterSpec.

Throws:

Unauthorized - if the user doesn't have the required privileges.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

list

void list(TagUsageTypes.FilterSpec filter,
        AsyncCallback<java.util.List<TagUsageTypes.Summary>> asyncCallback)

Returns information about the tags used by policies available in this vCenter server matching the TagUsageTypes.FilterSpec. Warning: This method is available as technical preview. It may be changed in a future release.

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

Operation Result:
The list of tags used by policies available on this vCenter server matching the TagUsageTypes.FilterSpec.

Operation Errors:
Unauthorized - if the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

filter - Specification for matching tags used by policies. If null, the behavior is equivalent to a TagUsageTypes.FilterSpec with all properties null, which means all tags used by policies match the filter.

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

list

void list(TagUsageTypes.FilterSpec filter,
        AsyncCallback<java.util.List<TagUsageTypes.Summary>> asyncCallback,
        InvocationConfig invocationConfig)

Returns information about the tags used by policies available in this vCenter server matching the TagUsageTypes.FilterSpec. Warning: This method is available as technical preview. It may be changed in a future release.

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

Operation Result:
The list of tags used by policies available on this vCenter server matching the TagUsageTypes.FilterSpec.

Operation Errors:
Unauthorized - if the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

filter - Specification for matching tags used by policies. If null, the behavior is equivalent to a TagUsageTypes.FilterSpec with all properties null, which means all tags used by policies match the filter.

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

invocationConfig - Configuration for the method invocation.