com.vmware.nsx.logical_routers.routing

Interface RouteMaps

All Superinterfaces:

RouteMapsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

RouteMapsStub

public interface RouteMaps
extends com.vmware.vapi.bindings.Service, RouteMapsTypes

Field Summary

Fields inherited from interface com.vmware.nsx.logical_routers.routing.RouteMapsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
RouteMap	create(java.lang.String logicalRouterId, RouteMap routeMap) Deprecated.
void	create(java.lang.String logicalRouterId, RouteMap routeMap, com.vmware.vapi.bindings.client.AsyncCallback<RouteMap> asyncCallback) Deprecated.
void	create(java.lang.String logicalRouterId, RouteMap routeMap, com.vmware.vapi.bindings.client.AsyncCallback<RouteMap> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
RouteMap	create(java.lang.String logicalRouterId, RouteMap routeMap, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String logicalRouterId, java.lang.String id) Deprecated.
void	delete(java.lang.String logicalRouterId, java.lang.String id, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	delete(java.lang.String logicalRouterId, java.lang.String id, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String logicalRouterId, java.lang.String id, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
RouteMap	get(java.lang.String logicalRouterId, java.lang.String id) Deprecated.
void	get(java.lang.String logicalRouterId, java.lang.String id, com.vmware.vapi.bindings.client.AsyncCallback<RouteMap> asyncCallback) Deprecated.
void	get(java.lang.String logicalRouterId, java.lang.String id, com.vmware.vapi.bindings.client.AsyncCallback<RouteMap> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
RouteMap	get(java.lang.String logicalRouterId, java.lang.String id, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
RouteMapListResult	list(java.lang.String logicalRouterId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Deprecated.
void	list(java.lang.String logicalRouterId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<RouteMapListResult> asyncCallback) Deprecated.
void	list(java.lang.String logicalRouterId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<RouteMapListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
RouteMapListResult	list(java.lang.String logicalRouterId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
RouteMap	update(java.lang.String logicalRouterId, java.lang.String id, RouteMap routeMap) Deprecated.
void	update(java.lang.String logicalRouterId, java.lang.String id, RouteMap routeMap, com.vmware.vapi.bindings.client.AsyncCallback<RouteMap> asyncCallback) Deprecated.
void	update(java.lang.String logicalRouterId, java.lang.String id, RouteMap routeMap, com.vmware.vapi.bindings.client.AsyncCallback<RouteMap> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
RouteMap	update(java.lang.String logicalRouterId, java.lang.String id, RouteMap routeMap, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

create

@Deprecated
RouteMap create(java.lang.String logicalRouterId,
                            RouteMap routeMap)

Deprecated.

Adds a new RouteMap on a Logical Router

Please use below Policy APIs.
POST /policy/api/v1/infra/tier-0s//route-maps/

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

Parameters:

logicalRouterId - (required)

routeMap - (required)

Returns:

com.vmware.nsx.model.RouteMap

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

create

@Deprecated
RouteMap create(java.lang.String logicalRouterId,
                            RouteMap routeMap,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Adds a new RouteMap on a Logical Router

Please use below Policy APIs.
POST /policy/api/v1/infra/tier-0s//route-maps/

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

logicalRouterId - (required)

routeMap - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.RouteMap

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

create

@Deprecated
void create(java.lang.String logicalRouterId,
                        RouteMap routeMap,
                        com.vmware.vapi.bindings.client.AsyncCallback<RouteMap> asyncCallback)

Deprecated.

Adds a new RouteMap on a Logical Router

Please use below Policy APIs.
POST /policy/api/v1/infra/tier-0s//route-maps/

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

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

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

Parameters:

logicalRouterId - (required)

routeMap - (required)

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

create

@Deprecated
void create(java.lang.String logicalRouterId,
                        RouteMap routeMap,
                        com.vmware.vapi.bindings.client.AsyncCallback<RouteMap> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Adds a new RouteMap on a Logical Router

Please use below Policy APIs.
POST /policy/api/v1/infra/tier-0s//route-maps/

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

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

Parameters:

logicalRouterId - (required)

routeMap - (required)

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

invocationConfig - Configuration for the method invocation.

delete

@Deprecated
void delete(java.lang.String logicalRouterId,
                        java.lang.String id)

Deprecated.

Deletes a specific RouteMap on the specified logical router.

Please use below Policy APIs.
DELETE /policy/api/v1/infra/tier-0s/route-maps/

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

Parameters:

logicalRouterId - (required)

id - (required)

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

delete

@Deprecated
void delete(java.lang.String logicalRouterId,
                        java.lang.String id,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Deletes a specific RouteMap on the specified logical router.

Please use below Policy APIs.
DELETE /policy/api/v1/infra/tier-0s/route-maps/

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

logicalRouterId - (required)

id - (required)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

delete

@Deprecated
void delete(java.lang.String logicalRouterId,
                        java.lang.String id,
                        com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Deprecated.

Deletes a specific RouteMap on the specified logical router.

Please use below Policy APIs.
DELETE /policy/api/v1/infra/tier-0s/route-maps/

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

Parameters:

logicalRouterId - (required)

id - (required)

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

delete

@Deprecated
void delete(java.lang.String logicalRouterId,
                        java.lang.String id,
                        com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Deletes a specific RouteMap on the specified logical router.

Please use below Policy APIs.
DELETE /policy/api/v1/infra/tier-0s/route-maps/

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

Parameters:

logicalRouterId - (required)

id - (required)

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

invocationConfig - Configuration for the method invocation.

get

@Deprecated
RouteMap get(java.lang.String logicalRouterId,
                         java.lang.String id)

Deprecated.

Read a specific RouteMap on the specified logical router.

Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s//route-maps/

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

Parameters:

logicalRouterId - (required)

id - (required)

Returns:

com.vmware.nsx.model.RouteMap

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

@Deprecated
RouteMap get(java.lang.String logicalRouterId,
                         java.lang.String id,
                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Read a specific RouteMap on the specified logical router.

Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s//route-maps/

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

logicalRouterId - (required)

id - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.RouteMap

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

@Deprecated
void get(java.lang.String logicalRouterId,
                     java.lang.String id,
                     com.vmware.vapi.bindings.client.AsyncCallback<RouteMap> asyncCallback)

Deprecated.

Read a specific RouteMap on the specified logical router.

Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s//route-maps/

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

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

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

Parameters:

logicalRouterId - (required)

id - (required)

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

get

@Deprecated
void get(java.lang.String logicalRouterId,
                     java.lang.String id,
                     com.vmware.vapi.bindings.client.AsyncCallback<RouteMap> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Read a specific RouteMap on the specified logical router.

Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s//route-maps/

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

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

Parameters:

logicalRouterId - (required)

id - (required)

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

invocationConfig - Configuration for the method invocation.

list

@Deprecated
RouteMapListResult list(java.lang.String logicalRouterId,
                                    java.lang.String cursor,
                                    java.lang.String includedFields,
                                    java.lang.Long pageSize,
                                    java.lang.Boolean sortAscending,
                                    java.lang.String sortBy)

Deprecated.

Paginated List of RouteMaps

Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s//route-maps

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

Parameters:

logicalRouterId - (required)

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)

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)

Returns:

com.vmware.nsx.model.RouteMapListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

@Deprecated
RouteMapListResult list(java.lang.String logicalRouterId,
                                    java.lang.String cursor,
                                    java.lang.String includedFields,
                                    java.lang.Long pageSize,
                                    java.lang.Boolean sortAscending,
                                    java.lang.String sortBy,
                                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Paginated List of RouteMaps

Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s//route-maps

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

logicalRouterId - (required)

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)

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)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.RouteMapListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

@Deprecated
void list(java.lang.String logicalRouterId,
                      java.lang.String cursor,
                      java.lang.String includedFields,
                      java.lang.Long pageSize,
                      java.lang.Boolean sortAscending,
                      java.lang.String sortBy,
                      com.vmware.vapi.bindings.client.AsyncCallback<RouteMapListResult> asyncCallback)

Deprecated.

Paginated List of RouteMaps

Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s//route-maps

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

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

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

Parameters:

logicalRouterId - (required)

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)

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)

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

list

@Deprecated
void list(java.lang.String logicalRouterId,
                      java.lang.String cursor,
                      java.lang.String includedFields,
                      java.lang.Long pageSize,
                      java.lang.Boolean sortAscending,
                      java.lang.String sortBy,
                      com.vmware.vapi.bindings.client.AsyncCallback<RouteMapListResult> asyncCallback,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Paginated List of RouteMaps

Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s//route-maps

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

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

Parameters:

logicalRouterId - (required)

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)

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)

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

invocationConfig - Configuration for the method invocation.

update

@Deprecated
RouteMap update(java.lang.String logicalRouterId,
                            java.lang.String id,
                            RouteMap routeMap)

Deprecated.

Update a specific RouteMap on the specified logical router.

Please use below Policy APIs.
PUT /policy/api/v1/infra/tier-0s//route-maps/

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

Parameters:

logicalRouterId - (required)

id - (required)

routeMap - (required)

Returns:

com.vmware.nsx.model.RouteMap

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

update

@Deprecated
RouteMap update(java.lang.String logicalRouterId,
                            java.lang.String id,
                            RouteMap routeMap,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Update a specific RouteMap on the specified logical router.

Please use below Policy APIs.
PUT /policy/api/v1/infra/tier-0s//route-maps/

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

logicalRouterId - (required)

id - (required)

routeMap - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.RouteMap

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

update

@Deprecated
void update(java.lang.String logicalRouterId,
                        java.lang.String id,
                        RouteMap routeMap,
                        com.vmware.vapi.bindings.client.AsyncCallback<RouteMap> asyncCallback)

Deprecated.

Update a specific RouteMap on the specified logical router.

Please use below Policy APIs.
PUT /policy/api/v1/infra/tier-0s//route-maps/

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

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

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

Parameters:

logicalRouterId - (required)

id - (required)

routeMap - (required)

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

update

@Deprecated
void update(java.lang.String logicalRouterId,
                        java.lang.String id,
                        RouteMap routeMap,
                        com.vmware.vapi.bindings.client.AsyncCallback<RouteMap> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Update a specific RouteMap on the specified logical router.

Please use below Policy APIs.
PUT /policy/api/v1/infra/tier-0s//route-maps/

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

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

Parameters:

logicalRouterId - (required)

id - (required)

routeMap - (required)

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

invocationConfig - Configuration for the method invocation.