com.vmware.vcenter.topology

Class NodesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.topology.NodesStub

All Implemented Interfaces:

Service, Nodes, NodesTypes

public class NodesStub
extends com.vmware.vapi.internal.bindings.Stub
implements Nodes

Remote stub implementation of the Nodes API service.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.topology.NodesTypes

NodesTypes.ApplianceType, NodesTypes.FilterSpec, NodesTypes.Info, NodesTypes.Summary

Field Summary

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

apiProvider, converter, ifaceId, securityContext

Fields inherited from interface com.vmware.vcenter.topology.NodesTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
NodesTypes.Info	get(java.lang.String node) Retrieve details for a given identifier of the vCenter or Platform Services Controller node.
void	get(java.lang.String node, AsyncCallback<NodesTypes.Info> asyncCallback) Retrieve details for a given identifier of the vCenter or Platform Services Controller node.
void	get(java.lang.String node, AsyncCallback<NodesTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieve details for a given identifier of the vCenter or Platform Services Controller node.
NodesTypes.Info	get(java.lang.String node, InvocationConfig invocationConfig) Retrieve details for a given identifier of the vCenter or Platform Services Controller node.
java.util.List<NodesTypes.Summary>	list(NodesTypes.FilterSpec filter) Returns information about all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec.
void	list(NodesTypes.FilterSpec filter, AsyncCallback<java.util.List<NodesTypes.Summary>> asyncCallback) Returns information about all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec.
void	list(NodesTypes.FilterSpec filter, AsyncCallback<java.util.List<NodesTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec.
java.util.List<NodesTypes.Summary>	list(NodesTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns information about all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec.

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

NodesStub

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

NodesStub

public NodesStub(ApiProvider apiProvider,
                 StubConfigurationBase config)

Method Detail

list

public java.util.List<NodesTypes.Summary> list(NodesTypes.FilterSpec filter)

Description copied from interface: Nodes

Returns information about all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec. This method was added in vSphere API 6.7.2.

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

Specified by:

list in interface Nodes

Parameters:

filter - Specification of matching vCenter and Platform Services Controller nodes for which information should be returned. If null, the behavior is equivalent to a NodesTypes.FilterSpec with all properties null which means all nodes match the filter.

Returns:

commonly used information for all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec.

list

public java.util.List<NodesTypes.Summary> list(NodesTypes.FilterSpec filter,
                                               InvocationConfig invocationConfig)

Description copied from interface: Nodes

Returns information about all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec. This method was added in vSphere API 6.7.2.

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:

list in interface Nodes

Parameters:

filter - Specification of matching vCenter and Platform Services Controller nodes for which information should be returned. If null, the behavior is equivalent to a NodesTypes.FilterSpec with all properties null which means all nodes match the filter.

invocationConfig - Configuration for the method invocation.

Returns:

commonly used information for all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec.

list

public void list(NodesTypes.FilterSpec filter,
                 AsyncCallback<java.util.List<NodesTypes.Summary>> asyncCallback)

Description copied from interface: Nodes

Returns information about all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec. This method was added in vSphere API 6.7.2.

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

Invocation Result:
commonly used information for all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
InvalidArgument - if the NodesTypes.FilterSpec.getTypes() property contains a value that is not supported.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Specified by:

list in interface Nodes

Parameters:

filter - Specification of matching vCenter and Platform Services Controller nodes for which information should be returned. If null, the behavior is equivalent to a NodesTypes.FilterSpec with all properties null which means all nodes match the filter.

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

list

public void list(NodesTypes.FilterSpec filter,
                 AsyncCallback<java.util.List<NodesTypes.Summary>> asyncCallback,
                 InvocationConfig invocationConfig)

Description copied from interface: Nodes

Returns information about all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec. This method was added in vSphere API 6.7.2.

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:
commonly used information for all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
InvalidArgument - if the NodesTypes.FilterSpec.getTypes() property contains a value that is not supported.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Specified by:

list in interface Nodes

Parameters:

filter - Specification of matching vCenter and Platform Services Controller nodes for which information should be returned. If null, the behavior is equivalent to a NodesTypes.FilterSpec with all properties null which means all nodes match the filter.

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

invocationConfig - Configuration for the method invocation.

get

public NodesTypes.Info get(java.lang.String node)

Description copied from interface: Nodes

Retrieve details for a given identifier of the vCenter or Platform Services Controller node. This method was added in vSphere API 6.7.2.

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

Specified by:

get in interface Nodes

Parameters:

node - Identifier of the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node. The parameter must be an identifier for the resource type: com.vmware.vcenter.VCenter.name.

Returns:

vCenter or Platform Services Controller node details with replication partners and client affinity information as applicable. See NodesTypes.Info.

get

public NodesTypes.Info get(java.lang.String node,
                           InvocationConfig invocationConfig)

Description copied from interface: Nodes

Retrieve details for a given identifier of the vCenter or Platform Services Controller node. This method was added in vSphere API 6.7.2.

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 Nodes

Parameters:

node - Identifier of the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node. The parameter must be an identifier for the resource type: com.vmware.vcenter.VCenter.name.

invocationConfig - Configuration for the method invocation.

Returns:

vCenter or Platform Services Controller node details with replication partners and client affinity information as applicable. See NodesTypes.Info.

get

public void get(java.lang.String node,
                AsyncCallback<NodesTypes.Info> asyncCallback)

Description copied from interface: Nodes

Retrieve details for a given identifier of the vCenter or Platform Services Controller node. This method was added in vSphere API 6.7.2.

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

Invocation Result:
vCenter or Platform Services Controller node details with replication partners and client affinity information as applicable. See NodesTypes.Info.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
NotFound - if a node doesn't exist for given node identifier.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Specified by:

get in interface Nodes

Parameters:

node - Identifier of the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node. The parameter must be an identifier for the resource type: com.vmware.vcenter.VCenter.name.

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

get

public void get(java.lang.String node,
                AsyncCallback<NodesTypes.Info> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Nodes

Retrieve details for a given identifier of the vCenter or Platform Services Controller node. This method was added in vSphere API 6.7.2.

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:
vCenter or Platform Services Controller node details with replication partners and client affinity information as applicable. See NodesTypes.Info.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
NotFound - if a node doesn't exist for given node identifier.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Specified by:

get in interface Nodes

Parameters:

node - Identifier of the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node. The parameter must be an identifier for the resource type: com.vmware.vcenter.VCenter.name.

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

invocationConfig - Configuration for the method invocation.