com.vmware.vcenter.vcha.cluster

Class ActiveStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.vcha.cluster.ActiveStub

All Implemented Interfaces:

Service, Active, ActiveTypes

public class ActiveStub
extends com.vmware.vapi.internal.bindings.Stub
implements Active

Remote stub implementation of the Active 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.ActiveTypes

ActiveTypes.Info

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.ActiveTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ActiveTypes.Info	get(CredentialsSpec vcSpec, java.lang.Boolean partial) Retrieves information about the active node of a VCHA cluster.
void	get(CredentialsSpec vcSpec, java.lang.Boolean partial, AsyncCallback<ActiveTypes.Info> asyncCallback) Retrieves information about the active node of a VCHA cluster.
void	get(CredentialsSpec vcSpec, java.lang.Boolean partial, AsyncCallback<ActiveTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieves information about the active node of a VCHA cluster.
ActiveTypes.Info	get(CredentialsSpec vcSpec, java.lang.Boolean partial, InvocationConfig invocationConfig) Retrieves information about the active node of a VCHA cluster.

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

ActiveStub

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

ActiveStub

public ActiveStub(ApiProvider apiProvider,
                  StubConfigurationBase config)

Method Detail

get

public ActiveTypes.Info get(CredentialsSpec vcSpec,
                            java.lang.Boolean partial)

Description copied from interface: Active

Retrieves information about the active node 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 Active

Parameters:

vcSpec - Contains active node's management vCenter server credentials. If null, then the active vCenter Server instance is assumed to be either self-managed or else in enhanced linked mode and managed by a linked vCenter Server instance.

partial - If true, then return only the information that does not require connecting to the Active vCenter Server.
If false or unset, then return all the information. If null, then return all the information.

Returns:

Info Information about the VCHA network and placement of the active node.

get

public ActiveTypes.Info get(CredentialsSpec vcSpec,
                            java.lang.Boolean partial,
                            InvocationConfig invocationConfig)

Description copied from interface: Active

Retrieves information about the active node 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 Active

Parameters:

vcSpec - Contains active node's management vCenter server credentials. If null, then the active vCenter Server instance is assumed to be either self-managed or else in enhanced linked mode and managed by a linked vCenter Server instance.

partial - If true, then return only the information that does not require connecting to the Active vCenter Server.
If false or unset, then return all the information. If null, then return all the information.

invocationConfig - Configuration for the method invocation.

Returns:

Info Information about the VCHA network and placement of the active node.

get

public void get(CredentialsSpec vcSpec,
                java.lang.Boolean partial,
                AsyncCallback<ActiveTypes.Info> asyncCallback)

Description copied from interface: Active

Retrieves information about the active node 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 Information about the VCHA network and placement of the active node.

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.

• If partial is false or unset, then the operation execution requires the Global.VCServer privilege.
• If partial is true, then the operation execution requires the System.Read 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.
InvalidElementConfiguration - If the active node is on more than one datastore.
NotFound - If the active virtual machine is not managed by the specified vCenter server for the active node.
Error - If the management interface IP address assignment is not static.
Error - If any other error occurs.

Specified by:

get in interface Active

Parameters:

vcSpec - Contains active node's management vCenter server credentials. If null, then the active vCenter Server instance is assumed to be either self-managed or else in enhanced linked mode and managed by a linked vCenter Server instance.

partial - If true, then return only the information that does not require connecting to the Active vCenter Server.
If false or unset, then return all the information. If null, then return all the information.

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

get

public void get(CredentialsSpec vcSpec,
                java.lang.Boolean partial,
                AsyncCallback<ActiveTypes.Info> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Active

Retrieves information about the active node 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 Information about the VCHA network and placement of the active node.

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.

• If partial is false or unset, then the operation execution requires the Global.VCServer privilege.
• If partial is true, then the operation execution requires the System.Read 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.
InvalidElementConfiguration - If the active node is on more than one datastore.
NotFound - If the active virtual machine is not managed by the specified vCenter server for the active node.
Error - If the management interface IP address assignment is not static.
Error - If any other error occurs.

Specified by:

get in interface Active

Parameters:

vcSpec - Contains active node's management vCenter server credentials. If null, then the active vCenter Server instance is assumed to be either self-managed or else in enhanced linked mode and managed by a linked vCenter Server instance.

partial - If true, then return only the information that does not require connecting to the Active vCenter Server.
If false or unset, then return all the information. If null, then return all the information.

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

invocationConfig - Configuration for the method invocation.