com.vmware.vcenter.compute.policies

Interface Capabilities

All Superinterfaces:

CapabilitiesTypes, Service

All Known Implementing Classes:

CapabilitiesStub

public interface Capabilities
extends Service, CapabilitiesTypes

The Capabilities interface provides methods to manage compute policy capabilities in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. The description of the capability provides information about the intent of a policy based on this capability. A capability provides a type to create a policy (see Policies.create(com.vmware.vapi.bindings.Structure)). A capability also provides a type that describes the information returned when retrieving information about a policy (see Policies.get(java.lang.String)). 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.CapabilitiesTypes

CapabilitiesTypes.Info, CapabilitiesTypes.Summary

Field Summary

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

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
CapabilitiesTypes.Info	get(java.lang.String capability) Returns information about a specific compute policy capability in VMware Cloud on AWS.
void	get(java.lang.String capability, AsyncCallback<CapabilitiesTypes.Info> asyncCallback) Returns information about a specific compute policy capability in VMware Cloud on AWS.
void	get(java.lang.String capability, AsyncCallback<CapabilitiesTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a specific compute policy capability in VMware Cloud on AWS.
CapabilitiesTypes.Info	get(java.lang.String capability, InvocationConfig invocationConfig) Returns information about a specific compute policy capability in VMware Cloud on AWS.
java.util.List<CapabilitiesTypes.Summary>	list() Returns information about the compute policy capabilities available in this vCenter server in VMware Cloud on AWS.
void	list(AsyncCallback<java.util.List<CapabilitiesTypes.Summary>> asyncCallback) Returns information about the compute policy capabilities available in this vCenter server in VMware Cloud on AWS.
void	list(AsyncCallback<java.util.List<CapabilitiesTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about the compute policy capabilities available in this vCenter server in VMware Cloud on AWS.
java.util.List<CapabilitiesTypes.Summary>	list(InvocationConfig invocationConfig) Returns information about the compute policy capabilities available in this vCenter server in VMware Cloud on AWS.

Method Detail

list

java.util.List<CapabilitiesTypes.Summary> list()

Returns information about the compute policy capabilities available in this vCenter server 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.

Returns:

The list of compute policy capabilities available on this vCenter server.

Throws:

Unauthorized - if the user doesn't have the required privileges, or when used beyond VMware Cloud on AWS.

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

• Method execution requires System.Read.

list

java.util.List<CapabilitiesTypes.Summary> list(InvocationConfig invocationConfig)

Returns information about the compute policy capabilities available in this vCenter server 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:

invocationConfig - Configuration for the method invocation.

Returns:

The list of compute policy capabilities available on this vCenter server.

Throws:

Unauthorized - if the user doesn't have the required privileges, or when used beyond VMware Cloud on AWS.

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

• Method execution requires System.Read.

list

void list(AsyncCallback<java.util.List<CapabilitiesTypes.Summary>> asyncCallback)

Returns information about the compute policy capabilities available in this vCenter server 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 compute policy capabilities available on this vCenter server.

Operation Errors:
Unauthorized - if the user doesn't have the required privileges, or when used beyond VMware Cloud on AWS.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

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

list

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

Returns information about the compute policy capabilities available in this vCenter server 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 compute policy capabilities available on this vCenter server.

Operation Errors:
Unauthorized - if the user doesn't have the required privileges, or when used beyond VMware Cloud on AWS.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

CapabilitiesTypes.Info get(java.lang.String capability)

Returns information about a specific compute policy capability 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:

capability - Identifier of the capability for which information should be retrieved. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability.

Returns:

Detailed information about the capability.

Throws:

NotFound - if a capability with this identifier does not exist.

Unauthorized - if the user doesn't have the required privileges, or when used beyond VMware Cloud on AWS.

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

• Method execution requires System.Read.

get

CapabilitiesTypes.Info get(java.lang.String capability,
                           InvocationConfig invocationConfig)

Returns information about a specific compute policy capability 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:

capability - Identifier of the capability for which information should be retrieved. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability.

invocationConfig - Configuration for the method invocation.

Returns:

Detailed information about the capability.

Throws:

NotFound - if a capability with this identifier does not exist.

Unauthorized - if the user doesn't have the required privileges, or when used beyond VMware Cloud on AWS.

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

• Method execution requires System.Read.

get

void get(java.lang.String capability,
         AsyncCallback<CapabilitiesTypes.Info> asyncCallback)

Returns information about a specific compute policy capability 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:
Detailed information about the capability.

Operation Errors:
NotFound - if a capability with this identifier does not exist.
Unauthorized - if the user doesn't have the required privileges, or when used beyond VMware Cloud on AWS.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

capability - Identifier of the capability for which information should be retrieved. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability.

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

get

void get(java.lang.String capability,
         AsyncCallback<CapabilitiesTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns information about a specific compute policy capability 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:
Detailed information about the capability.

Operation Errors:
NotFound - if a capability with this identifier does not exist.
Unauthorized - if the user doesn't have the required privileges, or when used beyond VMware Cloud on AWS.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

capability - Identifier of the capability for which information should be retrieved. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability.

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

invocationConfig - Configuration for the method invocation.