Package com.vmware.nsx_policy.infra.tier_0s

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_policy.infra.tier_0s.RouteMapsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method	Description
void	delete(java.lang.String tier0Id, java.lang.String routeMapId)	Delete a route map
void	delete(java.lang.String tier0Id, java.lang.String routeMapId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	Delete a route map
void	delete(java.lang.String tier0Id, java.lang.String routeMapId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Delete a route map
void	delete(java.lang.String tier0Id, java.lang.String routeMapId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Delete a route map
Tier0RouteMap	get(java.lang.String tier0Id, java.lang.String routeMapId)	Read a route map
void	get(java.lang.String tier0Id, java.lang.String routeMapId, com.vmware.vapi.bindings.client.AsyncCallback<Tier0RouteMap> asyncCallback)	Read a route map
void	get(java.lang.String tier0Id, java.lang.String routeMapId, com.vmware.vapi.bindings.client.AsyncCallback<Tier0RouteMap> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read a route map
Tier0RouteMap	get(java.lang.String tier0Id, java.lang.String routeMapId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read a route map
Tier0RouteMapListResult	list(java.lang.String tier0Id, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)	Paginated list of all route maps under a tier-0
void	list(java.lang.String tier0Id, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<Tier0RouteMapListResult> asyncCallback)	Paginated list of all route maps under a tier-0
void	list(java.lang.String tier0Id, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<Tier0RouteMapListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Paginated list of all route maps under a tier-0
Tier0RouteMapListResult	list(java.lang.String tier0Id, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Paginated list of all route maps under a tier-0
void	patch(java.lang.String tier0Id, java.lang.String routeMapId, Tier0RouteMap tier0RouteMap)	If a route map with the route-map-id is not already present, create a new route map.
void	patch(java.lang.String tier0Id, java.lang.String routeMapId, Tier0RouteMap tier0RouteMap, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	If a route map with the route-map-id is not already present, create a new route map.
void	patch(java.lang.String tier0Id, java.lang.String routeMapId, Tier0RouteMap tier0RouteMap, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	If a route map with the route-map-id is not already present, create a new route map.
void	patch(java.lang.String tier0Id, java.lang.String routeMapId, Tier0RouteMap tier0RouteMap, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	If a route map with the route-map-id is not already present, create a new route map.
Tier0RouteMap	update(java.lang.String tier0Id, java.lang.String routeMapId, Tier0RouteMap tier0RouteMap)	If a route map with the route-map-id is not already present, create a new route map.
void	update(java.lang.String tier0Id, java.lang.String routeMapId, Tier0RouteMap tier0RouteMap, com.vmware.vapi.bindings.client.AsyncCallback<Tier0RouteMap> asyncCallback)	If a route map with the route-map-id is not already present, create a new route map.
void	update(java.lang.String tier0Id, java.lang.String routeMapId, Tier0RouteMap tier0RouteMap, com.vmware.vapi.bindings.client.AsyncCallback<Tier0RouteMap> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	If a route map with the route-map-id is not already present, create a new route map.
Tier0RouteMap	update(java.lang.String tier0Id, java.lang.String routeMapId, Tier0RouteMap tier0RouteMap, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	If a route map with the route-map-id is not already present, create a new route map.

Method Detail

delete

void delete(java.lang.String tier0Id,
            java.lang.String routeMapId)

Delete a route map

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

Parameters:

tier0Id - (required)

routeMapId - (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

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

Delete a route map

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:

tier0Id - (required)

routeMapId - (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

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

Delete a route map

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:

tier0Id - (required)

routeMapId - (required)

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

delete

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

Delete a route map

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:

tier0Id - (required)

routeMapId - (required)

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

invocationConfig - Configuration for the method invocation.

get

Tier0RouteMap get(java.lang.String tier0Id,
                  java.lang.String routeMapId)

Read a route map

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

Parameters:

tier0Id - (required)

routeMapId - (required)

Returns:

com.vmware.nsx_policy.model.Tier0RouteMap

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

Tier0RouteMap get(java.lang.String tier0Id,
                  java.lang.String routeMapId,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read a route map

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:

tier0Id - (required)

routeMapId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.Tier0RouteMap

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

void get(java.lang.String tier0Id,
         java.lang.String routeMapId,
         com.vmware.vapi.bindings.client.AsyncCallback<Tier0RouteMap> asyncCallback)

Read a route map

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

Invocation Result:
com.vmware.nsx_policy.model.Tier0RouteMap

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

Parameters:

tier0Id - (required)

routeMapId - (required)

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

get

void get(java.lang.String tier0Id,
         java.lang.String routeMapId,
         com.vmware.vapi.bindings.client.AsyncCallback<Tier0RouteMap> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read a route map

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_policy.model.Tier0RouteMap

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

Parameters:

tier0Id - (required)

routeMapId - (required)

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

invocationConfig - Configuration for the method invocation.

list

Tier0RouteMapListResult list(java.lang.String tier0Id,
                             java.lang.String cursor,
                             java.lang.Boolean includeMarkForDeleteObjects,
                             java.lang.String includedFields,
                             java.lang.Long pageSize,
                             java.lang.Boolean sortAscending,
                             java.lang.String sortBy)

Paginated list of all route maps under a tier-0

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

Parameters:

tier0Id - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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_policy.model.Tier0RouteMapListResult

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

Tier0RouteMapListResult list(java.lang.String tier0Id,
                             java.lang.String cursor,
                             java.lang.Boolean includeMarkForDeleteObjects,
                             java.lang.String includedFields,
                             java.lang.Long pageSize,
                             java.lang.Boolean sortAscending,
                             java.lang.String sortBy,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Paginated list of all route maps under a tier-0

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:

tier0Id - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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_policy.model.Tier0RouteMapListResult

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

void list(java.lang.String tier0Id,
          java.lang.String cursor,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<Tier0RouteMapListResult> asyncCallback)

Paginated list of all route maps under a tier-0

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

Invocation Result:
com.vmware.nsx_policy.model.Tier0RouteMapListResult

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

Parameters:

tier0Id - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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

void list(java.lang.String tier0Id,
          java.lang.String cursor,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<Tier0RouteMapListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Paginated list of all route maps under a tier-0

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_policy.model.Tier0RouteMapListResult

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

Parameters:

tier0Id - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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.

patch

void patch(java.lang.String tier0Id,
           java.lang.String routeMapId,
           Tier0RouteMap tier0RouteMap)

If a route map with the route-map-id is not already present, create a new route map. If it already exists, update the route map for specified attributes.

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

Parameters:

tier0Id - (required)

routeMapId - (required)

tier0RouteMap - (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

patch

void patch(java.lang.String tier0Id,
           java.lang.String routeMapId,
           Tier0RouteMap tier0RouteMap,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If a route map with the route-map-id is not already present, create a new route map. If it already exists, update the route map for specified attributes.

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:

tier0Id - (required)

routeMapId - (required)

tier0RouteMap - (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

patch

void patch(java.lang.String tier0Id,
           java.lang.String routeMapId,
           Tier0RouteMap tier0RouteMap,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

If a route map with the route-map-id is not already present, create a new route map. If it already exists, update the route map for specified attributes.

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:

tier0Id - (required)

routeMapId - (required)

tier0RouteMap - (required)

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

patch

void patch(java.lang.String tier0Id,
           java.lang.String routeMapId,
           Tier0RouteMap tier0RouteMap,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If a route map with the route-map-id is not already present, create a new route map. If it already exists, update the route map for specified attributes.

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:

tier0Id - (required)

routeMapId - (required)

tier0RouteMap - (required)

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

invocationConfig - Configuration for the method invocation.

update

Tier0RouteMap update(java.lang.String tier0Id,
                     java.lang.String routeMapId,
                     Tier0RouteMap tier0RouteMap)

If a route map with the route-map-id is not already present, create a new route map. If it already exists, replace the route map instance with the new object.

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

Parameters:

tier0Id - (required)

routeMapId - (required)

tier0RouteMap - (required)

Returns:

com.vmware.nsx_policy.model.Tier0RouteMap

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

Tier0RouteMap update(java.lang.String tier0Id,
                     java.lang.String routeMapId,
                     Tier0RouteMap tier0RouteMap,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If a route map with the route-map-id is not already present, create a new route map. If it already exists, replace the route map instance with the new object.

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:

tier0Id - (required)

routeMapId - (required)

tier0RouteMap - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.Tier0RouteMap

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

void update(java.lang.String tier0Id,
            java.lang.String routeMapId,
            Tier0RouteMap tier0RouteMap,
            com.vmware.vapi.bindings.client.AsyncCallback<Tier0RouteMap> asyncCallback)

If a route map with the route-map-id is not already present, create a new route map. If it already exists, replace the route map instance with the new object.

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

Invocation Result:
com.vmware.nsx_policy.model.Tier0RouteMap

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

Parameters:

tier0Id - (required)

routeMapId - (required)

tier0RouteMap - (required)

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

update

void update(java.lang.String tier0Id,
            java.lang.String routeMapId,
            Tier0RouteMap tier0RouteMap,
            com.vmware.vapi.bindings.client.AsyncCallback<Tier0RouteMap> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If a route map with the route-map-id is not already present, create a new route map. If it already exists, replace the route map instance with the new object.

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_policy.model.Tier0RouteMap

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

Parameters:

tier0Id - (required)

routeMapId - (required)

tier0RouteMap - (required)

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

invocationConfig - Configuration for the method invocation.