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 in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This interface is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Nested Class Summary

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

TagUsageTypes.FilterSpec, TagUsageTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.compute.policies.TagUsageTypes

_VAPI_SERVICE_ID

Method Summary

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 in VMware Cloud on AWS.
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 in VMware Cloud on AWS.
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 in VMware Cloud on AWS.
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 in VMware Cloud on AWS.

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 in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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 in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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 in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Invocation 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 in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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