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

Class NeighborsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

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

All Implemented Interfaces:

Neighbors, NeighborsTypes, com.vmware.vapi.bindings.Service

public class NeighborsStub
extends com.vmware.vapi.internal.bindings.Stub
implements Neighbors

Remote stub implementation of the Neighbors 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_policy.infra.tier_0s.locale_services.ospf.NeighborsTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
NeighborsStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
NeighborsStub(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
OspfNeighborsStatusListResult	list(java.lang.String tier0Id, java.lang.String localeServiceId, java.lang.String cursor, java.lang.String edgePath, java.lang.String includedFields, java.lang.String neighborAddress, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Get OSPF neighbor information.
void	list(java.lang.String tier0Id, java.lang.String localeServiceId, java.lang.String cursor, java.lang.String edgePath, java.lang.String includedFields, java.lang.String neighborAddress, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<OspfNeighborsStatusListResult> asyncCallback) Get OSPF neighbor information.
void	list(java.lang.String tier0Id, java.lang.String localeServiceId, java.lang.String cursor, java.lang.String edgePath, java.lang.String includedFields, java.lang.String neighborAddress, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<OspfNeighborsStatusListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get OSPF neighbor information.
OspfNeighborsStatusListResult	list(java.lang.String tier0Id, java.lang.String localeServiceId, java.lang.String cursor, java.lang.String edgePath, java.lang.String includedFields, java.lang.String neighborAddress, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get OSPF neighbor information.

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

NeighborsStub

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

NeighborsStub

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

Method Detail

list

public OspfNeighborsStatusListResult list(java.lang.String tier0Id,
                                          java.lang.String localeServiceId,
                                          java.lang.String cursor,
                                          java.lang.String edgePath,
                                          java.lang.String includedFields,
                                          java.lang.String neighborAddress,
                                          java.lang.Long pageSize,
                                          java.lang.Boolean sortAscending,
                                          java.lang.String sortBy)

Description copied from interface: Neighbors

Get OSPF neighbor information.

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

Specified by:

list in interface Neighbors

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)

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

neighborAddress - IPv4 or IPv6 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.OspfNeighborsStatusListResult

list

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

Description copied from interface: Neighbors

Get OSPF neighbor 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.

Specified by:

list in interface Neighbors

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)

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

neighborAddress - IPv4 or IPv6 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.OspfNeighborsStatusListResult

list

public void list(java.lang.String tier0Id,
                 java.lang.String localeServiceId,
                 java.lang.String cursor,
                 java.lang.String edgePath,
                 java.lang.String includedFields,
                 java.lang.String neighborAddress,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<OspfNeighborsStatusListResult> asyncCallback)

Description copied from interface: Neighbors

Get OSPF neighbor information.

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

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

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

Specified by:

list in interface Neighbors

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)

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

neighborAddress - IPv4 or IPv6 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

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

Description copied from interface: Neighbors

Get OSPF neighbor 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.OspfNeighborsStatusListResult

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

Specified by:

list in interface Neighbors

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)

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

neighborAddress - IPv4 or IPv6 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.