com.vmware.nsx.cluster.nodes.network

Class InterfacesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.cluster.nodes.network.InterfacesStub

All Implemented Interfaces:

Interfaces, InterfacesTypes, com.vmware.vapi.bindings.Service

public class InterfacesStub
extends com.vmware.vapi.internal.bindings.Stub
implements Interfaces

Remote stub implementation of the Interfaces 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.cluster.nodes.network.InterfacesTypes

_VAPI_SERVICE_ID, GET_SOURCE_CACHED, GET_SOURCE_REALTIME, LIST_SOURCE_CACHED, LIST_SOURCE_REALTIME

Constructor Summary

Constructors

Constructor and Description
InterfacesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
InterfacesStub(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
NodeInterfaceProperties	get(java.lang.String nodeId, java.lang.String interfaceId, java.lang.String source) Returns detailed information about the specified interface.
void	get(java.lang.String nodeId, java.lang.String interfaceId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<NodeInterfaceProperties> asyncCallback) Returns detailed information about the specified interface.
void	get(java.lang.String nodeId, java.lang.String interfaceId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<NodeInterfaceProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns detailed information about the specified interface.
NodeInterfaceProperties	get(java.lang.String nodeId, java.lang.String interfaceId, java.lang.String source, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns detailed information about the specified interface.
NodeInterfacePropertiesListResult	list(java.lang.String nodeId, java.lang.String source) Returns the number of interfaces on the node and detailed information about each interface.
void	list(java.lang.String nodeId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<NodeInterfacePropertiesListResult> asyncCallback) Returns the number of interfaces on the node and detailed information about each interface.
void	list(java.lang.String nodeId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<NodeInterfacePropertiesListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the number of interfaces on the node and detailed information about each interface.
NodeInterfacePropertiesListResult	list(java.lang.String nodeId, java.lang.String source, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the number of interfaces on the node and detailed information about each interface.

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

InterfacesStub

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

InterfacesStub

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

Method Detail

get

public NodeInterfaceProperties get(java.lang.String nodeId,
                                   java.lang.String interfaceId,
                                   java.lang.String source)

Description copied from interface: Interfaces

Returns detailed information about the specified interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP).

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

Specified by:

get in interface Interfaces

Parameters:

nodeId - (required)

interfaceId - (required)

source - Data source type. (optional)

Returns:

com.vmware.nsx.model.NodeInterfaceProperties

get

public NodeInterfaceProperties get(java.lang.String nodeId,
                                   java.lang.String interfaceId,
                                   java.lang.String source,
                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Interfaces

Returns detailed information about the specified interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP).

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 Interfaces

Parameters:

nodeId - (required)

interfaceId - (required)

source - Data source type. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeInterfaceProperties

get

public void get(java.lang.String nodeId,
                java.lang.String interfaceId,
                java.lang.String source,
                com.vmware.vapi.bindings.client.AsyncCallback<NodeInterfaceProperties> asyncCallback)

Description copied from interface: Interfaces

Returns detailed information about the specified interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP).

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

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

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

Specified by:

get in interface Interfaces

Parameters:

nodeId - (required)

interfaceId - (required)

source - Data source type. (optional)

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

get

public void get(java.lang.String nodeId,
                java.lang.String interfaceId,
                java.lang.String source,
                com.vmware.vapi.bindings.client.AsyncCallback<NodeInterfaceProperties> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Interfaces

Returns detailed information about the specified interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP).

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

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

Specified by:

get in interface Interfaces

Parameters:

nodeId - (required)

interfaceId - (required)

source - Data source type. (optional)

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

invocationConfig - Configuration for the method invocation.

list

public NodeInterfacePropertiesListResult list(java.lang.String nodeId,
                                              java.lang.String source)

Description copied from interface: Interfaces

Returns the number of interfaces on the node and detailed information about each interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP). Note that if virtual IP (VIP) addresses are configured, virtual interfaces will not be returned.

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

Specified by:

list in interface Interfaces

Parameters:

nodeId - (required)

source - Data source type. (optional)

Returns:

com.vmware.nsx.model.NodeInterfacePropertiesListResult

list

public NodeInterfacePropertiesListResult list(java.lang.String nodeId,
                                              java.lang.String source,
                                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Interfaces

Returns the number of interfaces on the node and detailed information about each interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP). Note that if virtual IP (VIP) addresses are configured, virtual interfaces will not 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 Interfaces

Parameters:

nodeId - (required)

source - Data source type. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeInterfacePropertiesListResult

list

public void list(java.lang.String nodeId,
                 java.lang.String source,
                 com.vmware.vapi.bindings.client.AsyncCallback<NodeInterfacePropertiesListResult> asyncCallback)

Description copied from interface: Interfaces

Returns the number of interfaces on the node and detailed information about each interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP). Note that if virtual IP (VIP) addresses are configured, virtual interfaces will not be returned.

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

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

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

Specified by:

list in interface Interfaces

Parameters:

nodeId - (required)

source - Data source type. (optional)

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

list

public void list(java.lang.String nodeId,
                 java.lang.String source,
                 com.vmware.vapi.bindings.client.AsyncCallback<NodeInterfacePropertiesListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Interfaces

Returns the number of interfaces on the node and detailed information about each interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP). Note that if virtual IP (VIP) addresses are configured, virtual interfaces will not 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.NodeInterfacePropertiesListResult

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

Specified by:

list in interface Interfaces

Parameters:

nodeId - (required)

source - Data source type. (optional)

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

invocationConfig - Configuration for the method invocation.