com.vmware.nsx.upgrade

Class NodesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.upgrade.NodesStub

All Implemented Interfaces:

Nodes, NodesTypes, com.vmware.vapi.bindings.Service

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.

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.nsx.upgrade.NodesTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
NodeInfoListResult	list(java.lang.String componentType, java.lang.String componentVersion, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Get list of nodes.
void	list(java.lang.String componentType, java.lang.String componentVersion, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<NodeInfoListResult> asyncCallback) Get list of nodes.
void	list(java.lang.String componentType, java.lang.String componentVersion, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<NodeInfoListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get list of nodes.
NodeInfoListResult	list(java.lang.String componentType, java.lang.String componentVersion, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get list of nodes.

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

NodesStub

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

NodesStub

public NodesStub(com.vmware.vapi.core.ApiProvider apiProvider,
                 com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

list

public NodeInfoListResult list(java.lang.String componentType,
                               java.lang.String componentVersion,
                               java.lang.String cursor,
                               java.lang.String includedFields,
                               java.lang.Long pageSize,
                               java.lang.Boolean sortAscending,
                               java.lang.String sortBy)

Description copied from interface: Nodes

Get list of nodes. If request parameter component type is specified, then all nodes for that component will be returned. If request parameter component version is specified, then all nodes at that version will be returned.

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

Specified by:

list in interface Nodes

Parameters:

componentType - Component type based on which nodes will be filtered (optional)

componentVersion - Component version based on which nodes will be filtered (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx.model.NodeInfoListResult

list

public NodeInfoListResult list(java.lang.String componentType,
                               java.lang.String componentVersion,
                               java.lang.String cursor,
                               java.lang.String includedFields,
                               java.lang.Long pageSize,
                               java.lang.Boolean sortAscending,
                               java.lang.String sortBy,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Nodes

Get list of nodes. If request parameter component type is specified, then all nodes for that component will be returned. If request parameter component version is specified, then all nodes at that version will be returned.

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:

componentType - Component type based on which nodes will be filtered (optional)

componentVersion - Component version based on which nodes will be filtered (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeInfoListResult

list

public void list(java.lang.String componentType,
                 java.lang.String componentVersion,
                 java.lang.String cursor,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<NodeInfoListResult> asyncCallback)

Description copied from interface: Nodes

Get list of nodes. If request parameter component type is specified, then all nodes for that component will be returned. If request parameter component version is specified, then all nodes at that version will be returned.

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

Invocation Result:
com.vmware.nsx.model.NodeInfoListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

list in interface Nodes

Parameters:

componentType - Component type based on which nodes will be filtered (optional)

componentVersion - Component version based on which nodes will be filtered (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

list

public void list(java.lang.String componentType,
                 java.lang.String componentVersion,
                 java.lang.String cursor,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<NodeInfoListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Nodes

Get list of nodes. If request parameter component type is specified, then all nodes for that component will be returned. If request parameter component version is specified, then all nodes at that version will be returned.

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:
com.vmware.nsx.model.NodeInfoListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

list in interface Nodes

Parameters:

componentType - Component type based on which nodes will be filtered (optional)

componentVersion - Component version based on which nodes will be filtered (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

invocationConfig - Configuration for the method invocation.