public class PowerStub extends com.vmware.vapi.internal.bindings.Stub implements Power
Power
API service.
WARNING: Internal class, subject to change in future versions.
PowerTypes.Info, PowerTypes.State
apiProvider, converter, ifaceId, retryPolicy, securityContext
_VAPI_SERVICE_ID
Constructor and Description |
---|
PowerStub(ApiProvider apiProvider,
StubConfigurationBase config) |
PowerStub(ApiProvider apiProvider,
com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
StubConfigurationBase config) |
Modifier and Type | Method and Description |
---|---|
PowerTypes.Info |
get(java.lang.String vm)
Returns the power state information of a virtual machine.
|
void |
get(java.lang.String vm,
AsyncCallback<PowerTypes.Info> asyncCallback)
Returns the power state information of a virtual machine.
|
void |
get(java.lang.String vm,
AsyncCallback<PowerTypes.Info> asyncCallback,
InvocationConfig invocationConfig)
Returns the power state information of a virtual machine.
|
PowerTypes.Info |
get(java.lang.String vm,
InvocationConfig invocationConfig)
Returns the power state information of a virtual machine.
|
void |
reset(java.lang.String vm)
Resets a powered-on virtual machine.
|
void |
reset(java.lang.String vm,
AsyncCallback<java.lang.Void> asyncCallback)
Resets a powered-on virtual machine.
|
void |
reset(java.lang.String vm,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Resets a powered-on virtual machine.
|
void |
reset(java.lang.String vm,
InvocationConfig invocationConfig)
Resets a powered-on virtual machine.
|
void |
start(java.lang.String vm)
Powers on a powered-off or suspended virtual machine.
|
void |
start(java.lang.String vm,
AsyncCallback<java.lang.Void> asyncCallback)
Powers on a powered-off or suspended virtual machine.
|
void |
start(java.lang.String vm,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Powers on a powered-off or suspended virtual machine.
|
void |
start(java.lang.String vm,
InvocationConfig invocationConfig)
Powers on a powered-off or suspended virtual machine.
|
void |
stop(java.lang.String vm)
Powers off a powered-on or suspended virtual machine.
|
void |
stop(java.lang.String vm,
AsyncCallback<java.lang.Void> asyncCallback)
Powers off a powered-on or suspended virtual machine.
|
void |
stop(java.lang.String vm,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Powers off a powered-on or suspended virtual machine.
|
void |
stop(java.lang.String vm,
InvocationConfig invocationConfig)
Powers off a powered-on or suspended virtual machine.
|
void |
suspend(java.lang.String vm)
Suspends a powered-on virtual machine.
|
void |
suspend(java.lang.String vm,
AsyncCallback<java.lang.Void> asyncCallback)
Suspends a powered-on virtual machine.
|
void |
suspend(java.lang.String vm,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Suspends a powered-on virtual machine.
|
void |
suspend(java.lang.String vm,
InvocationConfig invocationConfig)
Suspends a powered-on virtual machine.
|
public PowerStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)
public PowerStub(ApiProvider apiProvider, StubConfigurationBase config)
public PowerTypes.Info get(java.lang.String vm)
Power
Synchronous method overload. Result of the invocation will be reported as a method return value.
public PowerTypes.Info get(java.lang.String vm, InvocationConfig invocationConfig)
Power
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
public void get(java.lang.String vm, AsyncCallback<PowerTypes.Info> asyncCallback)
Power
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Power state information for the specified virtual machine.
Operation Errors:
Error
- if the system reports an error while responding to the request.
NotFound
- if the virtual machine is not found.
ResourceInaccessible
- if the virtual machine's configuration or execution state cannot be accessed.
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
System.Read
. public void get(java.lang.String vm, AsyncCallback<PowerTypes.Info> asyncCallback, InvocationConfig invocationConfig)
Power
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:
Power state information for the specified virtual machine.
Operation Errors:
Error
- if the system reports an error while responding to the request.
NotFound
- if the virtual machine is not found.
ResourceInaccessible
- if the virtual machine's configuration or execution state cannot be accessed.
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
System.Read
. get
in interface Power
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public void start(java.lang.String vm)
Power
Synchronous method overload. Result of the invocation will be reported as a method return value.
public void start(java.lang.String vm, InvocationConfig invocationConfig)
Power
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
public void start(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback)
Power
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
Error
- if the system reports an error while responding to the request.
NotFound
- if the virtual machine is not found.
AlreadyInDesiredState
- if the virtual machine is already powered on.
Unsupported
- if the virtual machine does not support being powered on (e.g. marked as a
template, serving as a fault-tolerance secondary virtual machine).
UnableToAllocateResource
- if resources cannot be allocated for the virtual machine (e.g. physical resource
allocation policy cannot be satisfied, insufficient licenses are available to
run the virtual machine).
ResourceInaccessible
- if resources required by the virtual machine are not accessible (e.g. virtual
machine configuration files or virtual disks are on inaccessible storage, no
hosts are available to run the virtual machine).
ResourceInUse
- if resources required by the virtual machine are in use (e.g. virtual machine
configuration files or virtual disks are locked, host containing the virtual
machine is an HA failover host).
ResourceBusy
- if the virtual machine is performing another operation.
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.Interact.PowerOn
. public void start(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Power
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Operation Errors:
Error
- if the system reports an error while responding to the request.
NotFound
- if the virtual machine is not found.
AlreadyInDesiredState
- if the virtual machine is already powered on.
Unsupported
- if the virtual machine does not support being powered on (e.g. marked as a
template, serving as a fault-tolerance secondary virtual machine).
UnableToAllocateResource
- if resources cannot be allocated for the virtual machine (e.g. physical resource
allocation policy cannot be satisfied, insufficient licenses are available to
run the virtual machine).
ResourceInaccessible
- if resources required by the virtual machine are not accessible (e.g. virtual
machine configuration files or virtual disks are on inaccessible storage, no
hosts are available to run the virtual machine).
ResourceInUse
- if resources required by the virtual machine are in use (e.g. virtual machine
configuration files or virtual disks are locked, host containing the virtual
machine is an HA failover host).
ResourceBusy
- if the virtual machine is performing another operation.
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.Interact.PowerOn
. start
in interface Power
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public void stop(java.lang.String vm)
Power
Synchronous method overload. Result of the invocation will be reported as a method return value.
public void stop(java.lang.String vm, InvocationConfig invocationConfig)
Power
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
public void stop(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback)
Power
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
Error
- if the system reports an error while responding to the request.
NotFound
- if the virtual machine is not found.
AlreadyInDesiredState
- if the virtual machine is already powered off.
ResourceBusy
- if the virtual machine is performing another operation.
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.Interact.PowerOff
. public void stop(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Power
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Operation Errors:
Error
- if the system reports an error while responding to the request.
NotFound
- if the virtual machine is not found.
AlreadyInDesiredState
- if the virtual machine is already powered off.
ResourceBusy
- if the virtual machine is performing another operation.
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.Interact.PowerOff
. stop
in interface Power
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public void suspend(java.lang.String vm)
Power
Synchronous method overload. Result of the invocation will be reported as a method return value.
public void suspend(java.lang.String vm, InvocationConfig invocationConfig)
Power
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
public void suspend(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback)
Power
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
Error
- if the system reports an error while responding to the request.
NotFound
- if the virtual machine is not found.
AlreadyInDesiredState
- if the virtual machine is already suspended.
NotAllowedInCurrentState
- if the virtual machine is powered off.
ResourceBusy
- if the virtual machine is performing another operation.
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.Interact.Suspend
. public void suspend(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Power
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Operation Errors:
Error
- if the system reports an error while responding to the request.
NotFound
- if the virtual machine is not found.
AlreadyInDesiredState
- if the virtual machine is already suspended.
NotAllowedInCurrentState
- if the virtual machine is powered off.
ResourceBusy
- if the virtual machine is performing another operation.
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.Interact.Suspend
. suspend
in interface Power
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public void reset(java.lang.String vm)
Power
Synchronous method overload. Result of the invocation will be reported as a method return value.
public void reset(java.lang.String vm, InvocationConfig invocationConfig)
Power
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
public void reset(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback)
Power
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
Error
- if the system reports an error while responding to the request.
NotFound
- if the virtual machine is not found.
NotAllowedInCurrentState
- if the virtual machine is powered off or suspended.
ResourceBusy
- if the virtual machine is performing another operation
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.Interact.Reset
. public void reset(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Power
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Operation Errors:
Error
- if the system reports an error while responding to the request.
NotFound
- if the virtual machine is not found.
NotAllowedInCurrentState
- if the virtual machine is powered off or suspended.
ResourceBusy
- if the virtual machine is performing another operation
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.Interact.Reset
. reset
in interface Power
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.