com.vmware.vcenter.vcha.cluster

Class ModeStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.vcha.cluster.ModeStub

All Implemented Interfaces:

Service, Mode, ModeTypes

public class ModeStub
extends com.vmware.vapi.internal.bindings.Stub
implements Mode

Remote stub implementation of the Mode API service.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.vcha.cluster.ModeTypes

ModeTypes._VAPI_OPERATIONS, ModeTypes.ClusterMode, ModeTypes.Info

Field Summary

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

apiProvider, converter, ifaceId, securityContext

Fields inherited from interface com.vmware.vcenter.vcha.cluster.ModeTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ModeTypes.Info	get() Retrieves the current mode of a VCHA cluster.
void	get(AsyncCallback<ModeTypes.Info> asyncCallback) Retrieves the current mode of a VCHA cluster.
void	get(AsyncCallback<ModeTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieves the current mode of a VCHA cluster.
ModeTypes.Info	get(InvocationConfig invocationConfig) Retrieves the current mode of a VCHA cluster.
java.lang.String	set_Task(ModeTypes.ClusterMode mode) Manipulates the mode of a VCHA Cluster.
void	set_Task(ModeTypes.ClusterMode mode, AsyncCallback<java.lang.String> asyncCallback) Manipulates the mode of a VCHA Cluster.
void	set_Task(ModeTypes.ClusterMode mode, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Manipulates the mode of a VCHA Cluster.
java.lang.String	set_Task(ModeTypes.ClusterMode mode, InvocationConfig invocationConfig) Manipulates the mode of a VCHA Cluster.

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

invokeMethod, invokeMethodAsync, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ModeStub

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

ModeStub

public ModeStub(ApiProvider apiProvider,
                StubConfigurationBase config)

Method Detail

get

public ModeTypes.Info get()

Description copied from interface: Mode

Retrieves the current mode of a VCHA cluster. This method was added in vSphere API 6.7.1.

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

Specified by:

get in interface Mode

Returns:

Info structure containing the mode of the the VCHA cluster.

get

public ModeTypes.Info get(InvocationConfig invocationConfig)

Description copied from interface: Mode

Retrieves the current mode of a VCHA cluster. This method was added in vSphere API 6.7.1.

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 Mode

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

Info structure containing the mode of the the VCHA cluster.

get

public void get(AsyncCallback<ModeTypes.Info> asyncCallback)

Description copied from interface: Mode

Retrieves the current mode of a VCHA cluster. This method was added in vSphere API 6.7.1.

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

Invocation Result:
Info structure containing the mode of the the VCHA cluster.

Operation Errors:
NotAllowedInCurrentState - If the VCHA cluster is not configured.
Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read privilege.
Error - If any other error occurs.

Specified by:

get in interface Mode

Parameters:

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

get

public void get(AsyncCallback<ModeTypes.Info> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Mode

Retrieves the current mode of a VCHA cluster. This method was added in vSphere API 6.7.1.

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:
Info structure containing the mode of the the VCHA cluster.

Operation Errors:
NotAllowedInCurrentState - If the VCHA cluster is not configured.
Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read privilege.
Error - If any other error occurs.

Specified by:

get in interface Mode

Parameters:

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

invocationConfig - Configuration for the method invocation.

set_Task

public java.lang.String set_Task(ModeTypes.ClusterMode mode)

Description copied from interface: Mode

Manipulates the mode of a VCHA Cluster. Following mode transitions are allowed:
enabled -> disabled - Allowed only in healthy and degraded states.
enabled -> maintenance - Allowed only in healthy state.
disabled -> enabled - Allowed only in healthy state.
maintenance -> enabled - Allowed only in healthy state with all nodes are running the same version.
maintenance -> disabled - Allowed only in healthy state with all nodes are running the same version.
All other transitions are not allowed.

VCHA Cluster configuration remains intact in any of the cluster modes.

. This method was added in vSphere API 6.7.1.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Specified by:

set_Task in interface Mode

Parameters:

mode - Clustermode to change the VCHA cluster mode to.

Returns:

identifier for the task created by this API invocation

set_Task

public java.lang.String set_Task(ModeTypes.ClusterMode mode,
                                 InvocationConfig invocationConfig)

Description copied from interface: Mode

Manipulates the mode of a VCHA Cluster. Following mode transitions are allowed:
enabled -> disabled - Allowed only in healthy and degraded states.
enabled -> maintenance - Allowed only in healthy state.
disabled -> enabled - Allowed only in healthy state.
maintenance -> enabled - Allowed only in healthy state with all nodes are running the same version.
maintenance -> disabled - Allowed only in healthy state with all nodes are running the same version.
All other transitions are not allowed.

VCHA Cluster configuration remains intact in any of the cluster modes.

. This method was added in vSphere API 6.7.1.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

set_Task in interface Mode

Parameters:

mode - Clustermode to change the VCHA cluster mode to.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

set_Task

public void set_Task(ModeTypes.ClusterMode mode,
                     AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Mode

Manipulates the mode of a VCHA Cluster. Following mode transitions are allowed:
enabled -> disabled - Allowed only in healthy and degraded states.
enabled -> maintenance - Allowed only in healthy state.
disabled -> enabled - Allowed only in healthy state.
maintenance -> enabled - Allowed only in healthy state with all nodes are running the same version.
maintenance -> disabled - Allowed only in healthy state with all nodes are running the same version.
All other transitions are not allowed.

VCHA Cluster configuration remains intact in any of the cluster modes.

. This method was added in vSphere API 6.7.1.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
Error - If any other error occurs.

Specified by:

set_Task in interface Mode

Parameters:

mode - Clustermode to change the VCHA cluster mode to.

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

set_Task

public void set_Task(ModeTypes.ClusterMode mode,
                     AsyncCallback<java.lang.String> asyncCallback,
                     InvocationConfig invocationConfig)

Description copied from interface: Mode

Manipulates the mode of a VCHA Cluster. Following mode transitions are allowed:
enabled -> disabled - Allowed only in healthy and degraded states.
enabled -> maintenance - Allowed only in healthy state.
disabled -> enabled - Allowed only in healthy state.
maintenance -> enabled - Allowed only in healthy state with all nodes are running the same version.
maintenance -> disabled - Allowed only in healthy state with all nodes are running the same version.
All other transitions are not allowed.

VCHA Cluster configuration remains intact in any of the cluster modes.

. This method was added in vSphere API 6.7.1.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
Error - If any other error occurs.

Specified by:

set_Task in interface Mode

Parameters:

mode - Clustermode to change the VCHA cluster mode to.

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

invocationConfig - Configuration for the method invocation.