com.vmware.nsx.logical_routers.routing.bgp.neighbors

Class StatusStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.logical_routers.routing.bgp.neighbors.StatusStub

All Implemented Interfaces:

Status, StatusTypes, com.vmware.vapi.bindings.Service

public class StatusStub
extends com.vmware.vapi.internal.bindings.Stub
implements Status

Remote stub implementation of the Status 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.bgp.neighbors.StatusTypes

_VAPI_SERVICE_ID, LIST_SOURCE_CACHED, LIST_SOURCE_REALTIME

Constructor Summary

Constructors

Constructor and Description
StatusStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
StatusStub(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
BgpNeighborsStatusListResult	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, java.lang.String source, java.lang.String transportNodeId) Returns the status of all the BGP neighbors for the Logical Router of the given id.
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, java.lang.String source, java.lang.String transportNodeId, com.vmware.vapi.bindings.client.AsyncCallback<BgpNeighborsStatusListResult> asyncCallback) Returns the status of all the BGP neighbors for the Logical Router of the given id.
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, java.lang.String source, java.lang.String transportNodeId, com.vmware.vapi.bindings.client.AsyncCallback<BgpNeighborsStatusListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the status of all the BGP neighbors for the Logical Router of the given id.
BgpNeighborsStatusListResult	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, java.lang.String source, java.lang.String transportNodeId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the status of all the BGP neighbors for the Logical Router of the given 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

StatusStub

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

StatusStub

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

Method Detail

list

public BgpNeighborsStatusListResult 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,
                                         java.lang.String source,
                                         java.lang.String transportNodeId)

Description copied from interface: Status

Returns the status of all the BGP neighbors for the Logical Router of the given id. To get BGP neighbors status for the logical router from particular node, parameter \"transport_node_id=\" 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//locale-services//bgp/neighbors/status?enforcement_point_path=/infra/sites/default/enforcement-points/default
GET /policy/api/v1/infra/tier-1s//locale-services//bgp/neighbors/status?enforcement_point_path=/infra/sites/default/enforcement-points/default

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

Specified by:

list in interface Status

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)

source - Data source type. (optional)

transportNodeId - Transport node id (optional)

Returns:

com.vmware.nsx.model.BgpNeighborsStatusListResult

list

public BgpNeighborsStatusListResult 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,
                                         java.lang.String source,
                                         java.lang.String transportNodeId,
                                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Status

Returns the status of all the BGP neighbors for the Logical Router of the given id. To get BGP neighbors status for the logical router from particular node, parameter \"transport_node_id=\" 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//locale-services//bgp/neighbors/status?enforcement_point_path=/infra/sites/default/enforcement-points/default
GET /policy/api/v1/infra/tier-1s//locale-services//bgp/neighbors/status?enforcement_point_path=/infra/sites/default/enforcement-points/default

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 Status

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)

source - Data source type. (optional)

transportNodeId - Transport node id (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.BgpNeighborsStatusListResult

list

public 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,
                 java.lang.String source,
                 java.lang.String transportNodeId,
                 com.vmware.vapi.bindings.client.AsyncCallback<BgpNeighborsStatusListResult> asyncCallback)

Description copied from interface: Status

Returns the status of all the BGP neighbors for the Logical Router of the given id. To get BGP neighbors status for the logical router from particular node, parameter \"transport_node_id=\" 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//locale-services//bgp/neighbors/status?enforcement_point_path=/infra/sites/default/enforcement-points/default
GET /policy/api/v1/infra/tier-1s//locale-services//bgp/neighbors/status?enforcement_point_path=/infra/sites/default/enforcement-points/default

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

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

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

Specified by:

list in interface Status

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)

source - Data source type. (optional)

transportNodeId - Transport node 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 cursor,
                 java.lang.String includedFields,
                 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<BgpNeighborsStatusListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Status

Returns the status of all the BGP neighbors for the Logical Router of the given id. To get BGP neighbors status for the logical router from particular node, parameter \"transport_node_id=\" 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//locale-services//bgp/neighbors/status?enforcement_point_path=/infra/sites/default/enforcement-points/default
GET /policy/api/v1/infra/tier-1s//locale-services//bgp/neighbors/status?enforcement_point_path=/infra/sites/default/enforcement-points/default

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

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

Specified by:

list in interface Status

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)

source - Data source type. (optional)

transportNodeId - Transport node id (optional)

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

invocationConfig - Configuration for the method invocation.