com.vmware.nsx.upgrade

Interface Nodes

All Superinterfaces:

NodesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

NodesStub

public interface Nodes
extends com.vmware.vapi.bindings.Service, NodesTypes

Field Summary

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

_VAPI_SERVICE_ID

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.

Method Detail

list

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

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

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

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

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

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

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

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

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

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.