com.vmware.nsx.node.network

Class RoutesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.node.network.RoutesStub

All Implemented Interfaces:

Routes, RoutesTypes, com.vmware.vapi.bindings.Service

public class RoutesStub
extends com.vmware.vapi.internal.bindings.Stub
implements Routes

Remote stub implementation of the Routes 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.node.network.RoutesTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
RoutesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
RoutesStub(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
NodeRouteProperties	create(NodeRouteProperties nodeRouteProperties) Add a route to the node routing table.
void	create(NodeRouteProperties nodeRouteProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeRouteProperties> asyncCallback) Add a route to the node routing table.
void	create(NodeRouteProperties nodeRouteProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeRouteProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Add a route to the node routing table.
NodeRouteProperties	create(NodeRouteProperties nodeRouteProperties, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Add a route to the node routing table.
void	delete(java.lang.String routeId) Delete a route from the node routing table.
void	delete(java.lang.String routeId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete a route from the node routing table.
void	delete(java.lang.String routeId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete a route from the node routing table.
void	delete(java.lang.String routeId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete a route from the node routing table.
NodeRouteProperties	get(java.lang.String routeId) Returns detailed information about a specified route in the node routing table.
void	get(java.lang.String routeId, com.vmware.vapi.bindings.client.AsyncCallback<NodeRouteProperties> asyncCallback) Returns detailed information about a specified route in the node routing table.
void	get(java.lang.String routeId, com.vmware.vapi.bindings.client.AsyncCallback<NodeRouteProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns detailed information about a specified route in the node routing table.
NodeRouteProperties	get(java.lang.String routeId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns detailed information about a specified route in the node routing table.
NodeRoutePropertiesListResult	list() Returns detailed information about each route in the node routing table.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<NodeRoutePropertiesListResult> asyncCallback) Returns detailed information about each route in the node routing table.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<NodeRoutePropertiesListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns detailed information about each route in the node routing table.
NodeRoutePropertiesListResult	list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns detailed information about each route in the node routing table.

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

RoutesStub

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

RoutesStub

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

Method Detail

create

public NodeRouteProperties create(NodeRouteProperties nodeRouteProperties)

Description copied from interface: Routes

Add a route to the node routing table. For static routes, the route_type, interface_id, netmask, and destination are required parameters. For default routes, the route_type, gateway address, and interface_id are required. For blackhole routes, the route_type and destination are required. All other parameters are optional. When you add a static route, the scope and route_id are created automatically. When you add a default or blackhole route, the route_id is created automatically. The route_id is read-only, meaning that it cannot be modified. All other properties can be modified by deleting and readding the route.

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

Specified by:

create in interface Routes

Parameters:

nodeRouteProperties - (required)

Returns:

com.vmware.nsx.model.NodeRouteProperties

create

public NodeRouteProperties create(NodeRouteProperties nodeRouteProperties,
                                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Routes

Add a route to the node routing table. For static routes, the route_type, interface_id, netmask, and destination are required parameters. For default routes, the route_type, gateway address, and interface_id are required. For blackhole routes, the route_type and destination are required. All other parameters are optional. When you add a static route, the scope and route_id are created automatically. When you add a default or blackhole route, the route_id is created automatically. The route_id is read-only, meaning that it cannot be modified. All other properties can be modified by deleting and readding the route.

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:

create in interface Routes

Parameters:

nodeRouteProperties - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeRouteProperties

create

public void create(NodeRouteProperties nodeRouteProperties,
                   com.vmware.vapi.bindings.client.AsyncCallback<NodeRouteProperties> asyncCallback)

Description copied from interface: Routes

Add a route to the node routing table. For static routes, the route_type, interface_id, netmask, and destination are required parameters. For default routes, the route_type, gateway address, and interface_id are required. For blackhole routes, the route_type and destination are required. All other parameters are optional. When you add a static route, the scope and route_id are created automatically. When you add a default or blackhole route, the route_id is created automatically. The route_id is read-only, meaning that it cannot be modified. All other properties can be modified by deleting and readding the route.

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

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

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

Specified by:

create in interface Routes

Parameters:

nodeRouteProperties - (required)

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

create

public void create(NodeRouteProperties nodeRouteProperties,
                   com.vmware.vapi.bindings.client.AsyncCallback<NodeRouteProperties> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Routes

Add a route to the node routing table. For static routes, the route_type, interface_id, netmask, and destination are required parameters. For default routes, the route_type, gateway address, and interface_id are required. For blackhole routes, the route_type and destination are required. All other parameters are optional. When you add a static route, the scope and route_id are created automatically. When you add a default or blackhole route, the route_id is created automatically. The route_id is read-only, meaning that it cannot be modified. All other properties can be modified by deleting and readding the route.

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

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

Specified by:

create in interface Routes

Parameters:

nodeRouteProperties - (required)

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

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String routeId)

Description copied from interface: Routes

Delete a route from the node routing table. You can modify an existing route by deleting it and then posting the modified version of the route. To verify, remove the route ID from the URI, issue a GET request, and note the absense of the deleted route.

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

Specified by:

delete in interface Routes

Parameters:

routeId - ID of route to delete (required)

delete

public void delete(java.lang.String routeId,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Routes

Delete a route from the node routing table. You can modify an existing route by deleting it and then posting the modified version of the route. To verify, remove the route ID from the URI, issue a GET request, and note the absense of the deleted route.

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:

delete in interface Routes

Parameters:

routeId - ID of route to delete (required)

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String routeId,
                   com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Routes

Delete a route from the node routing table. You can modify an existing route by deleting it and then posting the modified version of the route. To verify, remove the route ID from the URI, issue a GET request, and note the absense of the deleted route.

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

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

Specified by:

delete in interface Routes

Parameters:

routeId - ID of route to delete (required)

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

delete

public void delete(java.lang.String routeId,
                   com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Routes

Delete a route from the node routing table. You can modify an existing route by deleting it and then posting the modified version of the route. To verify, remove the route ID from the URI, issue a GET request, and note the absense of the deleted route.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

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

Specified by:

delete in interface Routes

Parameters:

routeId - ID of route to delete (required)

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

invocationConfig - Configuration for the method invocation.

get

public NodeRouteProperties get(java.lang.String routeId)

Description copied from interface: Routes

Returns detailed information about a specified route in the node routing table.

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

Specified by:

get in interface Routes

Parameters:

routeId - ID of route to read (required)

Returns:

com.vmware.nsx.model.NodeRouteProperties

get

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

Description copied from interface: Routes

Returns detailed information about a specified route in the node routing table.

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 Routes

Parameters:

routeId - ID of route to read (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeRouteProperties

get

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

Description copied from interface: Routes

Returns detailed information about a specified route in the node routing table.

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

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

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

Specified by:

get in interface Routes

Parameters:

routeId - ID of route to read (required)

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

get

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

Description copied from interface: Routes

Returns detailed information about a specified route in the node routing table.

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

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

Specified by:

get in interface Routes

Parameters:

routeId - ID of route to read (required)

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

invocationConfig - Configuration for the method invocation.

list

public NodeRoutePropertiesListResult list()

Description copied from interface: Routes

Returns detailed information about each route in the node routing table. Routes can be of any type i.e. IPv4 or IPv6 or both. Route information includes the route ipv6 flag (True or False), route type (default, static, and so on), a unique route identifier, the route metric, the protocol from which the route was learned, the route source (which is the preferred egress interface), the route destination, and the route scope. If ipv6 flag is True then route information is for IPv6 route else for IPv4 route. The route scope refers to the distance to the destination network: The \"host\" scope leads to a destination address on the node, such as a loopback address; the \"link\" scope leads to a destination on the local network; and the \"global\" scope leads to addresses that are more than one hop away.

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

Specified by:

list in interface Routes

Returns:

com.vmware.nsx.model.NodeRoutePropertiesListResult

list

public NodeRoutePropertiesListResult list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Routes

Returns detailed information about each route in the node routing table. Routes can be of any type i.e. IPv4 or IPv6 or both. Route information includes the route ipv6 flag (True or False), route type (default, static, and so on), a unique route identifier, the route metric, the protocol from which the route was learned, the route source (which is the preferred egress interface), the route destination, and the route scope. If ipv6 flag is True then route information is for IPv6 route else for IPv4 route. The route scope refers to the distance to the destination network: The \"host\" scope leads to a destination address on the node, such as a loopback address; the \"link\" scope leads to a destination on the local network; and the \"global\" scope leads to addresses that are more than one hop away.

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 Routes

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeRoutePropertiesListResult

list

public void list(com.vmware.vapi.bindings.client.AsyncCallback<NodeRoutePropertiesListResult> asyncCallback)

Description copied from interface: Routes

Returns detailed information about each route in the node routing table. Routes can be of any type i.e. IPv4 or IPv6 or both. Route information includes the route ipv6 flag (True or False), route type (default, static, and so on), a unique route identifier, the route metric, the protocol from which the route was learned, the route source (which is the preferred egress interface), the route destination, and the route scope. If ipv6 flag is True then route information is for IPv6 route else for IPv4 route. The route scope refers to the distance to the destination network: The \"host\" scope leads to a destination address on the node, such as a loopback address; the \"link\" scope leads to a destination on the local network; and the \"global\" scope leads to addresses that are more than one hop away.

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

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

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

Specified by:

list in interface Routes

Parameters:

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

list

public void list(com.vmware.vapi.bindings.client.AsyncCallback<NodeRoutePropertiesListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Routes

Returns detailed information about each route in the node routing table. Routes can be of any type i.e. IPv4 or IPv6 or both. Route information includes the route ipv6 flag (True or False), route type (default, static, and so on), a unique route identifier, the route metric, the protocol from which the route was learned, the route source (which is the preferred egress interface), the route destination, and the route scope. If ipv6 flag is True then route information is for IPv6 route else for IPv4 route. The route scope refers to the distance to the destination network: The \"host\" scope leads to a destination address on the node, such as a loopback address; the \"link\" scope leads to a destination on the local network; and the \"global\" scope leads to addresses that are more than one hop away.

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

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

Specified by:

list in interface Routes

Parameters:

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

invocationConfig - Configuration for the method invocation.