com.vmware.vcenter.vm.compute

Interface Policies

All Superinterfaces:

PoliciesTypes, Service

All Known Implementing Classes:

PoliciesStub

public interface Policies
extends Service, PoliciesTypes

The Policies interface provides methods to query the status of policies on virtual machines 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.vm.compute.PoliciesTypes

PoliciesTypes.Info

Field Summary

Fields inherited from interface com.vmware.vcenter.vm.compute.PoliciesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
PoliciesTypes.Info	get(java.lang.String vm, java.lang.String policy) Returns information about the compliance of a virtual machine with a compute policy in VMware Cloud on AWS.
void	get(java.lang.String vm, java.lang.String policy, AsyncCallback<PoliciesTypes.Info> asyncCallback) Returns information about the compliance of a virtual machine with a compute policy in VMware Cloud on AWS.
void	get(java.lang.String vm, java.lang.String policy, AsyncCallback<PoliciesTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about the compliance of a virtual machine with a compute policy in VMware Cloud on AWS.
PoliciesTypes.Info	get(java.lang.String vm, java.lang.String policy, InvocationConfig invocationConfig) Returns information about the compliance of a virtual machine with a compute policy in VMware Cloud on AWS.

Method Detail

get

PoliciesTypes.Info get(java.lang.String vm,
                       java.lang.String policy)

Returns information about the compliance of a virtual machine with a compute policy 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:

vm - Identifier of the virtual machine to query the status for. The parameter must be an identifier for the resource type: VirtualMachine.

policy - Identifier of the policy to query the status for. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.Resources.COMPUTE_POLICY.

Returns:

Information about the compliance of the specified virtual machine with the specified compute policy.

Throws:

NotFound - if a virtual machine with the given identifier does not exist, or if a policy with the given identifier does not exist.

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

get

PoliciesTypes.Info get(java.lang.String vm,
                       java.lang.String policy,
                       InvocationConfig invocationConfig)

Returns information about the compliance of a virtual machine with a compute policy 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:

vm - Identifier of the virtual machine to query the status for. The parameter must be an identifier for the resource type: VirtualMachine.

policy - Identifier of the policy to query the status for. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.Resources.COMPUTE_POLICY.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the compliance of the specified virtual machine with the specified compute policy.

Throws:

NotFound - if a virtual machine with the given identifier does not exist, or if a policy with the given identifier does not exist.

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

get

void get(java.lang.String vm,
         java.lang.String policy,
         AsyncCallback<PoliciesTypes.Info> asyncCallback)

Returns information about the compliance of a virtual machine with a compute policy 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:
Information about the compliance of the specified virtual machine with the specified compute policy.

Operation Errors:
NotFound - if a virtual machine with the given identifier does not exist, or if a policy with the given identifier does not exist.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

vm - Identifier of the virtual machine to query the status for. The parameter must be an identifier for the resource type: VirtualMachine.

policy - Identifier of the policy to query the status for. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.Resources.COMPUTE_POLICY.

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

get

void get(java.lang.String vm,
         java.lang.String policy,
         AsyncCallback<PoliciesTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns information about the compliance of a virtual machine with a compute policy 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:
Information about the compliance of the specified virtual machine with the specified compute policy.

Operation Errors:
NotFound - if a virtual machine with the given identifier does not exist, or if a policy with the given identifier does not exist.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

vm - Identifier of the virtual machine to query the status for. The parameter must be an identifier for the resource type: VirtualMachine.

policy - Identifier of the policy to query the status for. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.Resources.COMPUTE_POLICY.

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

invocationConfig - Configuration for the method invocation.