com.vmware.appliance

Class ShutdownStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.appliance.ShutdownStub

All Implemented Interfaces:

Shutdown, ShutdownTypes, Service

public class ShutdownStub
extends com.vmware.vapi.internal.bindings.Stub
implements Shutdown

Remote stub implementation of the Shutdown API service.

WARNING: Internal class, subject to change in future versions.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.ShutdownTypes

ShutdownTypes.ShutdownConfig

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.appliance.ShutdownTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
ShutdownStub(ApiProvider apiProvider, StubConfigurationBase config)
ShutdownStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel pending shutdown action.
void	cancel(AsyncCallback<java.lang.Void> asyncCallback) Cancel pending shutdown action.
void	cancel(AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Cancel pending shutdown action.
void	cancel(InvocationConfig invocationConfig) Cancel pending shutdown action.
ShutdownTypes.ShutdownConfig	get() Get details about the pending shutdown action.
void	get(AsyncCallback<ShutdownTypes.ShutdownConfig> asyncCallback) Get details about the pending shutdown action.
void	get(AsyncCallback<ShutdownTypes.ShutdownConfig> asyncCallback, InvocationConfig invocationConfig) Get details about the pending shutdown action.
ShutdownTypes.ShutdownConfig	get(InvocationConfig invocationConfig) Get details about the pending shutdown action.
void	poweroff(long delay, java.lang.String reason) Power off the appliance.
void	poweroff(long delay, java.lang.String reason, AsyncCallback<java.lang.Void> asyncCallback) Power off the appliance.
void	poweroff(long delay, java.lang.String reason, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Power off the appliance.
void	poweroff(long delay, java.lang.String reason, InvocationConfig invocationConfig) Power off the appliance.
void	reboot(long delay, java.lang.String reason) Reboot the appliance.
void	reboot(long delay, java.lang.String reason, AsyncCallback<java.lang.Void> asyncCallback) Reboot the appliance.
void	reboot(long delay, java.lang.String reason, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Reboot the appliance.
void	reboot(long delay, java.lang.String reason, InvocationConfig invocationConfig) Reboot the appliance.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ShutdownStub

public ShutdownStub(ApiProvider apiProvider,
                    com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                    StubConfigurationBase config)

ShutdownStub

public ShutdownStub(ApiProvider apiProvider,
                    StubConfigurationBase config)

Method Detail

cancel

public void cancel()

Description copied from interface: Shutdown

Cancel pending shutdown action. This method was added in vSphere API 6.7.

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

Specified by:

cancel in interface Shutdown

cancel

public void cancel(InvocationConfig invocationConfig)

Description copied from interface: Shutdown

Cancel pending shutdown action. This method was added in vSphere API 6.7.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

cancel in interface Shutdown

Parameters:

invocationConfig - Configuration for the method invocation.

cancel

public void cancel(AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Shutdown

Cancel pending shutdown action. This method was added in vSphere API 6.7.

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

Operation Errors:
Error - Generic error

Specified by:

cancel in interface Shutdown

Parameters:

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

cancel

public void cancel(AsyncCallback<java.lang.Void> asyncCallback,
                   InvocationConfig invocationConfig)

Description copied from interface: Shutdown

Cancel pending shutdown action. This method was added in vSphere API 6.7.

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 - Generic error

Specified by:

cancel in interface Shutdown

Parameters:

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

invocationConfig - Configuration for the method invocation.

poweroff

public void poweroff(long delay,
                     java.lang.String reason)

Description copied from interface: Shutdown

Power off the appliance. This method was added in vSphere API 6.7.

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

Specified by:

poweroff in interface Shutdown

Parameters:

delay - Minutes after which poweroff should start. If 0 is specified, poweroff will start immediately.

reason - Reason for peforming poweroff.

poweroff

public void poweroff(long delay,
                     java.lang.String reason,
                     InvocationConfig invocationConfig)

Description copied from interface: Shutdown

Power off the appliance. This method was added in vSphere API 6.7.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

poweroff in interface Shutdown

Parameters:

delay - Minutes after which poweroff should start. If 0 is specified, poweroff will start immediately.

reason - Reason for peforming poweroff.

invocationConfig - Configuration for the method invocation.

poweroff

public void poweroff(long delay,
                     java.lang.String reason,
                     AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Shutdown

Power off the appliance. This method was added in vSphere API 6.7.

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

Operation Errors:
Error - Generic error

Specified by:

poweroff in interface Shutdown

Parameters:

delay - Minutes after which poweroff should start. If 0 is specified, poweroff will start immediately.

reason - Reason for peforming poweroff.

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

poweroff

public void poweroff(long delay,
                     java.lang.String reason,
                     AsyncCallback<java.lang.Void> asyncCallback,
                     InvocationConfig invocationConfig)

Description copied from interface: Shutdown

Power off the appliance. This method was added in vSphere API 6.7.

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 - Generic error

Specified by:

poweroff in interface Shutdown

Parameters:

delay - Minutes after which poweroff should start. If 0 is specified, poweroff will start immediately.

reason - Reason for peforming poweroff.

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

invocationConfig - Configuration for the method invocation.

reboot

public void reboot(long delay,
                   java.lang.String reason)

Description copied from interface: Shutdown

Reboot the appliance. This method was added in vSphere API 6.7.

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

Specified by:

reboot in interface Shutdown

Parameters:

delay - Minutes after which reboot should start. If 0 is specified, reboot will start immediately.

reason - Reason for peforming reboot.

reboot

public void reboot(long delay,
                   java.lang.String reason,
                   InvocationConfig invocationConfig)

Description copied from interface: Shutdown

Reboot the appliance. This method was added in vSphere API 6.7.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

reboot in interface Shutdown

Parameters:

delay - Minutes after which reboot should start. If 0 is specified, reboot will start immediately.

reason - Reason for peforming reboot.

invocationConfig - Configuration for the method invocation.

reboot

public void reboot(long delay,
                   java.lang.String reason,
                   AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Shutdown

Reboot the appliance. This method was added in vSphere API 6.7.

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

Operation Errors:
Error - Generic error

Specified by:

reboot in interface Shutdown

Parameters:

delay - Minutes after which reboot should start. If 0 is specified, reboot will start immediately.

reason - Reason for peforming reboot.

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

reboot

public void reboot(long delay,
                   java.lang.String reason,
                   AsyncCallback<java.lang.Void> asyncCallback,
                   InvocationConfig invocationConfig)

Description copied from interface: Shutdown

Reboot the appliance. This method was added in vSphere API 6.7.

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 - Generic error

Specified by:

reboot in interface Shutdown

Parameters:

delay - Minutes after which reboot should start. If 0 is specified, reboot will start immediately.

reason - Reason for peforming reboot.

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

invocationConfig - Configuration for the method invocation.

get

public ShutdownTypes.ShutdownConfig get()

Description copied from interface: Shutdown

Get details about the pending shutdown action. This method was added in vSphere API 6.7.

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

Specified by:

get in interface Shutdown

Returns:

Configuration of pending shutdown action.

get

public ShutdownTypes.ShutdownConfig get(InvocationConfig invocationConfig)

Description copied from interface: Shutdown

Get details about the pending shutdown action. This method was added in vSphere API 6.7.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

get in interface Shutdown

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

Configuration of pending shutdown action.

get

public void get(AsyncCallback<ShutdownTypes.ShutdownConfig> asyncCallback)

Description copied from interface: Shutdown

Get details about the pending shutdown action. This method was added in vSphere API 6.7.

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

Invocation Result:
Configuration of pending shutdown action.

Operation Errors:
Error - Generic error

Specified by:

get in interface Shutdown

Parameters:

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

get

public void get(AsyncCallback<ShutdownTypes.ShutdownConfig> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Shutdown

Get details about the pending shutdown action. This method was added in vSphere API 6.7.

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:
Configuration of pending shutdown action.

Operation Errors:
Error - Generic error

Specified by:

get in interface Shutdown

Parameters:

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

invocationConfig - Configuration for the method invocation.