com.vmware.vcenter.vcha.cluster

Class WitnessStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.vcha.cluster.WitnessStub

All Implemented Interfaces:

Service, Witness, WitnessTypes

public class WitnessStub
extends com.vmware.vapi.internal.bindings.Stub
implements Witness

Remote stub implementation of the Witness 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.WitnessTypes

WitnessTypes._VAPI_OPERATIONS, WitnessTypes.CheckResult, WitnessTypes.CheckSpec, WitnessTypes.RedeploySpec

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

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

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
WitnessTypes.CheckResult	check(WitnessTypes.CheckSpec spec) Validates the specified witness node's placement configuration.
void	check(WitnessTypes.CheckSpec spec, AsyncCallback<WitnessTypes.CheckResult> asyncCallback) Validates the specified witness node's placement configuration.
void	check(WitnessTypes.CheckSpec spec, AsyncCallback<WitnessTypes.CheckResult> asyncCallback, InvocationConfig invocationConfig) Validates the specified witness node's placement configuration.
WitnessTypes.CheckResult	check(WitnessTypes.CheckSpec spec, InvocationConfig invocationConfig) Validates the specified witness node's placement configuration.
java.lang.String	redeploy_Task(WitnessTypes.RedeploySpec spec) Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node.
void	redeploy_Task(WitnessTypes.RedeploySpec spec, AsyncCallback<java.lang.String> asyncCallback) Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node.
void	redeploy_Task(WitnessTypes.RedeploySpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node.
java.lang.String	redeploy_Task(WitnessTypes.RedeploySpec spec, InvocationConfig invocationConfig) Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node.

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

WitnessStub

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

WitnessStub

public WitnessStub(ApiProvider apiProvider,
                   StubConfigurationBase config)

Method Detail

check

public WitnessTypes.CheckResult check(WitnessTypes.CheckSpec spec)

Description copied from interface: Witness

Validates the specified witness node's placement configuration. 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:

check in interface Witness

Parameters:

spec - Contains the witness node's placement specification.

Returns:

CheckResult structure containing errors and warnings.

check

public WitnessTypes.CheckResult check(WitnessTypes.CheckSpec spec,
                                      InvocationConfig invocationConfig)

Description copied from interface: Witness

Validates the specified witness node's placement configuration. 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:

check in interface Witness

Parameters:

spec - Contains the witness node's placement specification.

invocationConfig - Configuration for the method invocation.

Returns:

CheckResult structure containing errors and warnings.

check

public void check(WitnessTypes.CheckSpec spec,
                  AsyncCallback<WitnessTypes.CheckResult> asyncCallback)

Description copied from interface: Witness

Validates the specified witness node's placement configuration. 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:
CheckResult structure containing errors and warnings.

Operation Errors:
InvalidArgument - If the credentials provided for authentincating with the active node's management vCenter server are invalid.
InvalidArgument - If the specified resource spec is deemed invalid for the clone operation.
UnverifiedPeer - If the SSL certificate of the management vCenter server cannot be validated.
The value of the data property of Error will be a class that contains all the properties defined in CertificateInfo.
NotFound - If the active virtual machine is not managed by the specified vCenter server for the active node.
InvalidElementConfiguration - If the active node is on more than one datastore.
NotAllowedInCurrentState - If the clone operation is not allowed in the current state of the system.
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:

check in interface Witness

Parameters:

spec - Contains the witness node's placement specification.

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

check

public void check(WitnessTypes.CheckSpec spec,
                  AsyncCallback<WitnessTypes.CheckResult> asyncCallback,
                  InvocationConfig invocationConfig)

Description copied from interface: Witness

Validates the specified witness node's placement configuration. 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:
CheckResult structure containing errors and warnings.

Operation Errors:
InvalidArgument - If the credentials provided for authentincating with the active node's management vCenter server are invalid.
InvalidArgument - If the specified resource spec is deemed invalid for the clone operation.
UnverifiedPeer - If the SSL certificate of the management vCenter server cannot be validated.
The value of the data property of Error will be a class that contains all the properties defined in CertificateInfo.
NotFound - If the active virtual machine is not managed by the specified vCenter server for the active node.
InvalidElementConfiguration - If the active node is on more than one datastore.
NotAllowedInCurrentState - If the clone operation is not allowed in the current state of the system.
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:

check in interface Witness

Parameters:

spec - Contains the witness node's placement specification.

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

invocationConfig - Configuration for the method invocation.

redeploy_Task

public java.lang.String redeploy_Task(WitnessTypes.RedeploySpec spec)

Description copied from interface: Witness

Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node. 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:

redeploy_Task in interface Witness

Parameters:

spec - Contains the witness node's redeploy specification.

Returns:

identifier for the task created by this API invocation

redeploy_Task

public java.lang.String redeploy_Task(WitnessTypes.RedeploySpec spec,
                                      InvocationConfig invocationConfig)

Description copied from interface: Witness

Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node. 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:

redeploy_Task in interface Witness

Parameters:

spec - Contains the witness node's redeploy specification.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

redeploy_Task

public void redeploy_Task(WitnessTypes.RedeploySpec spec,
                          AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Witness

Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node. 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:
InvalidArgument - If the credentials provided for authentincating with the active node's management vCenter server are invalid.
Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
UnverifiedPeer - If the SSL certificate of the management vCenter server cannot be validated.
The value of the data property of Error will be a class that contains all the properties defined in CertificateInfo.
Error - If any other error occurs.

Specified by:

redeploy_Task in interface Witness

Parameters:

spec - Contains the witness node's redeploy specification.

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

redeploy_Task

public void redeploy_Task(WitnessTypes.RedeploySpec spec,
                          AsyncCallback<java.lang.String> asyncCallback,
                          InvocationConfig invocationConfig)

Description copied from interface: Witness

Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node. 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:
InvalidArgument - If the credentials provided for authentincating with the active node's management vCenter server are invalid.
Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
UnverifiedPeer - If the SSL certificate of the management vCenter server cannot be validated.
The value of the data property of Error will be a class that contains all the properties defined in CertificateInfo.
Error - If any other error occurs.

Specified by:

redeploy_Task in interface Witness

Parameters:

spec - Contains the witness node's redeploy specification.

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

invocationConfig - Configuration for the method invocation.