com.vmware.appliance.networking

Class InterfacesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.appliance.networking.InterfacesStub

All Implemented Interfaces:

Interfaces, InterfacesTypes, 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.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.networking.InterfacesTypes

InterfacesTypes.InterfaceInfo, InterfacesTypes.InterfaceStatus

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.appliance.networking.InterfacesTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
InterfacesTypes.InterfaceInfo	get(java.lang.String interfaceName) Get information about a particular network interface.
void	get(java.lang.String interfaceName, AsyncCallback<InterfacesTypes.InterfaceInfo> asyncCallback) Get information about a particular network interface.
void	get(java.lang.String interfaceName, AsyncCallback<InterfacesTypes.InterfaceInfo> asyncCallback, InvocationConfig invocationConfig) Get information about a particular network interface.
InterfacesTypes.InterfaceInfo	get(java.lang.String interfaceName, InvocationConfig invocationConfig) Get information about a particular network interface.
java.util.List<InterfacesTypes.InterfaceInfo>	list() Get list of available network interfaces, including those that are not yet configured.
void	list(AsyncCallback<java.util.List<InterfacesTypes.InterfaceInfo>> asyncCallback) Get list of available network interfaces, including those that are not yet configured.
void	list(AsyncCallback<java.util.List<InterfacesTypes.InterfaceInfo>> asyncCallback, InvocationConfig invocationConfig) Get list of available network interfaces, including those that are not yet configured.
java.util.List<InterfacesTypes.InterfaceInfo>	list(InvocationConfig invocationConfig) Get list of available network interfaces, including those that are not yet configured.

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(ApiProvider apiProvider,
                      com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                      StubConfigurationBase config)

InterfacesStub

public InterfacesStub(ApiProvider apiProvider,
                      StubConfigurationBase config)

Method Detail

list

public java.util.List<InterfacesTypes.InterfaceInfo> list()

Description copied from interface: Interfaces

Get list of available network interfaces, including those that are not yet configured.

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

Specified by:

list in interface Interfaces

Returns:

List of InterfaceInfo structures.

list

public java.util.List<InterfacesTypes.InterfaceInfo> list(InvocationConfig invocationConfig)

Description copied from interface: Interfaces

Get list of available network interfaces, including those that are not yet configured.

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:

invocationConfig - Configuration for the method invocation.

Returns:

List of InterfaceInfo structures.

list

public void list(AsyncCallback<java.util.List<InterfacesTypes.InterfaceInfo>> asyncCallback)

Description copied from interface: Interfaces

Get list of available network interfaces, including those that are not yet configured.

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

Invocation Result:
List of InterfaceInfo structures.

Operation Errors:
Error - Generic error

Specified by:

list in interface Interfaces

Parameters:

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

list

public void list(AsyncCallback<java.util.List<InterfacesTypes.InterfaceInfo>> asyncCallback,
                 InvocationConfig invocationConfig)

Description copied from interface: Interfaces

Get list of available network interfaces, including those that are not yet configured.

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:
List of InterfaceInfo structures.

Operation Errors:
Error - Generic error

Specified by:

list in interface Interfaces

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

public InterfacesTypes.InterfaceInfo get(java.lang.String interfaceName)

Description copied from interface: Interfaces

Get information about a particular network interface.

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

Specified by:

get in interface Interfaces

Parameters:

interfaceName - Network interface, for example, "nic0". The parameter must be an identifier for the resource type: com.vmware.appliance.networking.interfaces.

Returns:

Network interface information.

get

public InterfacesTypes.InterfaceInfo get(java.lang.String interfaceName,
                                         InvocationConfig invocationConfig)

Description copied from interface: Interfaces

Get information about a particular network interface.

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:

interfaceName - Network interface, for example, "nic0". The parameter must be an identifier for the resource type: com.vmware.appliance.networking.interfaces.

invocationConfig - Configuration for the method invocation.

Returns:

Network interface information.

get

public void get(java.lang.String interfaceName,
                AsyncCallback<InterfacesTypes.InterfaceInfo> asyncCallback)

Description copied from interface: Interfaces

Get information about a particular network interface.

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

Invocation Result:
Network interface information.

Operation Errors:
NotFound - if the specified interface is not found.
Error - Generic error

Specified by:

get in interface Interfaces

Parameters:

interfaceName - Network interface, for example, "nic0". The parameter must be an identifier for the resource type: com.vmware.appliance.networking.interfaces.

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

get

public void get(java.lang.String interfaceName,
                AsyncCallback<InterfacesTypes.InterfaceInfo> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Interfaces

Get information about a particular network interface.

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:
Network interface information.

Operation Errors:
NotFound - if the specified interface is not found.
Error - Generic error

Specified by:

get in interface Interfaces

Parameters:

interfaceName - Network interface, for example, "nic0". The parameter must be an identifier for the resource type: com.vmware.appliance.networking.interfaces.

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

invocationConfig - Configuration for the method invocation.