com.vmware.nsx.transport_nodes

Class StateStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.transport_nodes.StateStub

All Implemented Interfaces:

State, StateTypes, com.vmware.vapi.bindings.Service

public class StateStub
extends com.vmware.vapi.internal.bindings.Stub
implements State

Remote stub implementation of the State 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.transport_nodes.StateTypes

_VAPI_SERVICE_ID, LIST_MM_STATE_DISABLED, LIST_MM_STATE_ENABLED, LIST_MM_STATE_ENTERING, LIST_MM_STATE_EXITING, LIST_STATUS_FAILED, LIST_STATUS_IN_PROGRESS, LIST_STATUS_ORPHANED, LIST_STATUS_PARTIAL_SUCCESS, LIST_STATUS_PENDING, LIST_STATUS_SUCCESS

Constructor Summary

Constructors

Constructor and Description
StateStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
StateStub(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
TransportNodeState	get(java.lang.String transportNodeId) Returns information about the current state of the transport node configuration and information about the associated hostswitch.
void	get(java.lang.String transportNodeId, com.vmware.vapi.bindings.client.AsyncCallback<TransportNodeState> asyncCallback) Returns information about the current state of the transport node configuration and information about the associated hostswitch.
void	get(java.lang.String transportNodeId, com.vmware.vapi.bindings.client.AsyncCallback<TransportNodeState> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the current state of the transport node configuration and information about the associated hostswitch.
TransportNodeState	get(java.lang.String transportNodeId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the current state of the transport node configuration and information about the associated hostswitch.
TransportNodeStateListResult	list(java.lang.String mmState, java.lang.String status, java.lang.String vtepIp) Returns a list of transport node states that have realized state as provided as query parameter.
void	list(java.lang.String mmState, java.lang.String status, java.lang.String vtepIp, com.vmware.vapi.bindings.client.AsyncCallback<TransportNodeStateListResult> asyncCallback) Returns a list of transport node states that have realized state as provided as query parameter.
void	list(java.lang.String mmState, java.lang.String status, java.lang.String vtepIp, com.vmware.vapi.bindings.client.AsyncCallback<TransportNodeStateListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns a list of transport node states that have realized state as provided as query parameter.
TransportNodeStateListResult	list(java.lang.String mmState, java.lang.String status, java.lang.String vtepIp, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns a list of transport node states that have realized state as provided as query parameter.

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

StateStub

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

StateStub

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

Method Detail

get

public TransportNodeState get(java.lang.String transportNodeId)

Description copied from interface: State

Returns information about the current state of the transport node configuration and information about the associated hostswitch. Change introduced in 4.1.2 for ESX Transport node - The vib details will not be retrieved in every state API call. It will be retrieved by periodical polling on the host. Therefore the nsx vib version mismatch or nsx vib absence will be reported by this API only after subsequent polling takes place. Currently, the poll frequency is 10 minutes.

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

Specified by:

get in interface State

Parameters:

transportNodeId - (required)

Returns:

com.vmware.nsx.model.TransportNodeState

get

public TransportNodeState get(java.lang.String transportNodeId,
                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: State

Returns information about the current state of the transport node configuration and information about the associated hostswitch. Change introduced in 4.1.2 for ESX Transport node - The vib details will not be retrieved in every state API call. It will be retrieved by periodical polling on the host. Therefore the nsx vib version mismatch or nsx vib absence will be reported by this API only after subsequent polling takes place. Currently, the poll frequency is 10 minutes.

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 State

Parameters:

transportNodeId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.TransportNodeState

get

public void get(java.lang.String transportNodeId,
                com.vmware.vapi.bindings.client.AsyncCallback<TransportNodeState> asyncCallback)

Description copied from interface: State

Returns information about the current state of the transport node configuration and information about the associated hostswitch. Change introduced in 4.1.2 for ESX Transport node - The vib details will not be retrieved in every state API call. It will be retrieved by periodical polling on the host. Therefore the nsx vib version mismatch or nsx vib absence will be reported by this API only after subsequent polling takes place. Currently, the poll frequency is 10 minutes.

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

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

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

Specified by:

get in interface State

Parameters:

transportNodeId - (required)

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

get

public void get(java.lang.String transportNodeId,
                com.vmware.vapi.bindings.client.AsyncCallback<TransportNodeState> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: State

Returns information about the current state of the transport node configuration and information about the associated hostswitch. Change introduced in 4.1.2 for ESX Transport node - The vib details will not be retrieved in every state API call. It will be retrieved by periodical polling on the host. Therefore the nsx vib version mismatch or nsx vib absence will be reported by this API only after subsequent polling takes place. Currently, the poll frequency is 10 minutes.

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

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

Specified by:

get in interface State

Parameters:

transportNodeId - (required)

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

invocationConfig - Configuration for the method invocation.

list

public TransportNodeStateListResult list(java.lang.String mmState,
                                         java.lang.String status,
                                         java.lang.String vtepIp)

Description copied from interface: State

Returns a list of transport node states that have realized state as provided as query parameter. If this API is called multiple times in parallel then it will fail with error indicating that another request is already in progress. In such case, try the API on another NSX manager instance (if exists) or try again after some time.

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

Specified by:

list in interface State

Parameters:

mmState - maintenance mode state (optional)

status - Realized state of transport nodes (optional)

vtepIp - Virtual tunnel endpoint ip address of transport node (optional)

Returns:

com.vmware.nsx.model.TransportNodeStateListResult

list

public TransportNodeStateListResult list(java.lang.String mmState,
                                         java.lang.String status,
                                         java.lang.String vtepIp,
                                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: State

Returns a list of transport node states that have realized state as provided as query parameter. If this API is called multiple times in parallel then it will fail with error indicating that another request is already in progress. In such case, try the API on another NSX manager instance (if exists) or try again after some time.

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 State

Parameters:

mmState - maintenance mode state (optional)

status - Realized state of transport nodes (optional)

vtepIp - Virtual tunnel endpoint ip address of transport node (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.TransportNodeStateListResult

list

public void list(java.lang.String mmState,
                 java.lang.String status,
                 java.lang.String vtepIp,
                 com.vmware.vapi.bindings.client.AsyncCallback<TransportNodeStateListResult> asyncCallback)

Description copied from interface: State

Returns a list of transport node states that have realized state as provided as query parameter. If this API is called multiple times in parallel then it will fail with error indicating that another request is already in progress. In such case, try the API on another NSX manager instance (if exists) or try again after some time.

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

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

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

Specified by:

list in interface State

Parameters:

mmState - maintenance mode state (optional)

status - Realized state of transport nodes (optional)

vtepIp - Virtual tunnel endpoint ip address of transport node (optional)

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

list

public void list(java.lang.String mmState,
                 java.lang.String status,
                 java.lang.String vtepIp,
                 com.vmware.vapi.bindings.client.AsyncCallback<TransportNodeStateListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: State

Returns a list of transport node states that have realized state as provided as query parameter. If this API is called multiple times in parallel then it will fail with error indicating that another request is already in progress. In such case, try the API on another NSX manager instance (if exists) or try again after some time.

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

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

Specified by:

list in interface State

Parameters:

mmState - maintenance mode state (optional)

status - Realized state of transport nodes (optional)

vtepIp - Virtual tunnel endpoint ip address of transport node (optional)

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

invocationConfig - Configuration for the method invocation.