com.vmware.nsx.logical_routers.routing

Class ForwardingTableStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.logical_routers.routing.ForwardingTableStub

All Implemented Interfaces:

ForwardingTable, ForwardingTableTypes, com.vmware.vapi.bindings.Service

public class ForwardingTableStub
extends com.vmware.vapi.internal.bindings.Stub
implements ForwardingTable

Remote stub implementation of the ForwardingTable 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.logical_routers.routing.ForwardingTableTypes

_VAPI_SERVICE_ID, LIST_COMPONENT_TYPE_ROUTES, LIST_SOURCE_CACHED, LIST_SOURCE_REALTIME

Constructor Summary

Constructors

Constructor and Description
ForwardingTableStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
ForwardingTableStub(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
LogicalRouterRouteTable	list(java.lang.String logicalRouterId, java.lang.String componentType, java.lang.String cursor, java.lang.String includedFields, java.lang.String networkPrefix, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String transportNodeId) Returns the FIB for the logical router on a node of the given transport-node-id.
void	list(java.lang.String logicalRouterId, java.lang.String componentType, java.lang.String cursor, java.lang.String includedFields, java.lang.String networkPrefix, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String transportNodeId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouterRouteTable> asyncCallback) Returns the FIB for the logical router on a node of the given transport-node-id.
void	list(java.lang.String logicalRouterId, java.lang.String componentType, java.lang.String cursor, java.lang.String includedFields, java.lang.String networkPrefix, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String transportNodeId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouterRouteTable> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the FIB for the logical router on a node of the given transport-node-id.
LogicalRouterRouteTable	list(java.lang.String logicalRouterId, java.lang.String componentType, java.lang.String cursor, java.lang.String includedFields, java.lang.String networkPrefix, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String transportNodeId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the FIB for the logical router on a node of the given transport-node-id.

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

ForwardingTableStub

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

ForwardingTableStub

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

Method Detail

list

public LogicalRouterRouteTable list(java.lang.String logicalRouterId,
                                    java.lang.String componentType,
                                    java.lang.String cursor,
                                    java.lang.String includedFields,
                                    java.lang.String networkPrefix,
                                    java.lang.Long pageSize,
                                    java.lang.Boolean sortAscending,
                                    java.lang.String sortBy,
                                    java.lang.String source,
                                    java.lang.String transportNodeId)

Description copied from interface: ForwardingTable

Returns the FIB for the logical router on a node of the given transport-node-id. Query parameter \"transport_node_id=\" is required. To filter the result by network address, paramter \"network_prefix=\" needs to be specified. Query parameter \"source=realtime\" is the only supported source.

Please use below Policy API.
GET /policy/api/v1/infra/tier-0s//forwarding-table
GET /policy/api/v1/infra/tier-1s//forwarding-table

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

Specified by:

list in interface ForwardingTable

Parameters:

logicalRouterId - (required)

componentType - Define the DR routes (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)

networkPrefix - IPv4 or IPv6 CIDR Block (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)

source - Data source type. (optional)

transportNodeId - TransportNode Id (optional)

Returns:

com.vmware.nsx.model.LogicalRouterRouteTable

list

public LogicalRouterRouteTable list(java.lang.String logicalRouterId,
                                    java.lang.String componentType,
                                    java.lang.String cursor,
                                    java.lang.String includedFields,
                                    java.lang.String networkPrefix,
                                    java.lang.Long pageSize,
                                    java.lang.Boolean sortAscending,
                                    java.lang.String sortBy,
                                    java.lang.String source,
                                    java.lang.String transportNodeId,
                                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ForwardingTable

Returns the FIB for the logical router on a node of the given transport-node-id. Query parameter \"transport_node_id=\" is required. To filter the result by network address, paramter \"network_prefix=\" needs to be specified. Query parameter \"source=realtime\" is the only supported source.

Please use below Policy API.
GET /policy/api/v1/infra/tier-0s//forwarding-table
GET /policy/api/v1/infra/tier-1s//forwarding-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:

list in interface ForwardingTable

Parameters:

logicalRouterId - (required)

componentType - Define the DR routes (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)

networkPrefix - IPv4 or IPv6 CIDR Block (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)

source - Data source type. (optional)

transportNodeId - TransportNode Id (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalRouterRouteTable

list

public void list(java.lang.String logicalRouterId,
                 java.lang.String componentType,
                 java.lang.String cursor,
                 java.lang.String includedFields,
                 java.lang.String networkPrefix,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 java.lang.String source,
                 java.lang.String transportNodeId,
                 com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouterRouteTable> asyncCallback)

Description copied from interface: ForwardingTable

Returns the FIB for the logical router on a node of the given transport-node-id. Query parameter \"transport_node_id=\" is required. To filter the result by network address, paramter \"network_prefix=\" needs to be specified. Query parameter \"source=realtime\" is the only supported source.

Please use below Policy API.
GET /policy/api/v1/infra/tier-0s//forwarding-table
GET /policy/api/v1/infra/tier-1s//forwarding-table

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

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

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

Specified by:

list in interface ForwardingTable

Parameters:

logicalRouterId - (required)

componentType - Define the DR routes (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)

networkPrefix - IPv4 or IPv6 CIDR Block (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)

source - Data source type. (optional)

transportNodeId - TransportNode Id (optional)

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

list

public void list(java.lang.String logicalRouterId,
                 java.lang.String componentType,
                 java.lang.String cursor,
                 java.lang.String includedFields,
                 java.lang.String networkPrefix,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 java.lang.String source,
                 java.lang.String transportNodeId,
                 com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouterRouteTable> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ForwardingTable

Returns the FIB for the logical router on a node of the given transport-node-id. Query parameter \"transport_node_id=\" is required. To filter the result by network address, paramter \"network_prefix=\" needs to be specified. Query parameter \"source=realtime\" is the only supported source.

Please use below Policy API.
GET /policy/api/v1/infra/tier-0s//forwarding-table
GET /policy/api/v1/infra/tier-1s//forwarding-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.LogicalRouterRouteTable

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

Specified by:

list in interface ForwardingTable

Parameters:

logicalRouterId - (required)

componentType - Define the DR routes (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)

networkPrefix - IPv4 or IPv6 CIDR Block (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)

source - Data source type. (optional)

transportNodeId - TransportNode Id (optional)

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

invocationConfig - Configuration for the method invocation.