Package com.vmware.nsx_policy.infra.tier_0s.locale_services.ospf

Interface Routes

All Superinterfaces:

RoutesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

RoutesStub

public interface Routes
extends com.vmware.vapi.bindings.Service, RoutesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.tier_0s.locale_services.ospf.RoutesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method	Description
OspfRoutesListResult	list(java.lang.String tier0Id, java.lang.String localeServiceId, java.lang.String cursor, java.lang.String edgePath, java.lang.String enforcementPointPath, java.lang.String includedFields, java.lang.String networkPrefix, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)	Get OSPF route information.
void	list(java.lang.String tier0Id, java.lang.String localeServiceId, java.lang.String cursor, java.lang.String edgePath, java.lang.String enforcementPointPath, java.lang.String includedFields, java.lang.String networkPrefix, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<OspfRoutesListResult> asyncCallback)	Get OSPF route information.
void	list(java.lang.String tier0Id, java.lang.String localeServiceId, java.lang.String cursor, java.lang.String edgePath, java.lang.String enforcementPointPath, java.lang.String includedFields, java.lang.String networkPrefix, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<OspfRoutesListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Get OSPF route information.
OspfRoutesListResult	list(java.lang.String tier0Id, java.lang.String localeServiceId, java.lang.String cursor, java.lang.String edgePath, java.lang.String enforcementPointPath, java.lang.String includedFields, java.lang.String networkPrefix, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Get OSPF route information.

Method Detail

list

OspfRoutesListResult list(java.lang.String tier0Id,
                          java.lang.String localeServiceId,
                          java.lang.String cursor,
                          java.lang.String edgePath,
                          java.lang.String enforcementPointPath,
                          java.lang.String includedFields,
                          java.lang.String networkPrefix,
                          java.lang.Long pageSize,
                          java.lang.Boolean sortAscending,
                          java.lang.String sortBy)

Get OSPF route information.

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

Parameters:

tier0Id - (required)

localeServiceId - (required)

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

edgePath - Policy path of edge (optional)

enforcementPointPath - Enforcement point path (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

networkPrefix - CIDR network address (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.OspfRoutesListResult

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

OspfRoutesListResult list(java.lang.String tier0Id,
                          java.lang.String localeServiceId,
                          java.lang.String cursor,
                          java.lang.String edgePath,
                          java.lang.String enforcementPointPath,
                          java.lang.String includedFields,
                          java.lang.String networkPrefix,
                          java.lang.Long pageSize,
                          java.lang.Boolean sortAscending,
                          java.lang.String sortBy,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get OSPF route information.

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)

localeServiceId - (required)

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

edgePath - Policy path of edge (optional)

enforcementPointPath - Enforcement point path (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

networkPrefix - CIDR network address (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.OspfRoutesListResult

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 localeServiceId,
          java.lang.String cursor,
          java.lang.String edgePath,
          java.lang.String enforcementPointPath,
          java.lang.String includedFields,
          java.lang.String networkPrefix,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<OspfRoutesListResult> asyncCallback)

Get OSPF route information.

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

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

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

Parameters:

tier0Id - (required)

localeServiceId - (required)

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

edgePath - Policy path of edge (optional)

enforcementPointPath - Enforcement point path (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

networkPrefix - CIDR network address (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 localeServiceId,
          java.lang.String cursor,
          java.lang.String edgePath,
          java.lang.String enforcementPointPath,
          java.lang.String includedFields,
          java.lang.String networkPrefix,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<OspfRoutesListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get OSPF route information.

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

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

Parameters:

tier0Id - (required)

localeServiceId - (required)

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

edgePath - Policy path of edge (optional)

enforcementPointPath - Enforcement point path (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

networkPrefix - CIDR network address (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.