com.vmware.nsx.logical_ports

Class StatusStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.logical_ports.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_ports.StatusTypes

_VAPI_SERVICE_ID, GET_SOURCE_CACHED, GET_SOURCE_REALTIME, GETALL_ATTACHMENT_TYPE_BRIDGEENDPOINT, GETALL_ATTACHMENT_TYPE_DHCP_SERVICE, GETALL_ATTACHMENT_TYPE_L2VPN_SESSION, GETALL_ATTACHMENT_TYPE_LOGICALROUTER, GETALL_ATTACHMENT_TYPE_METADATA_PROXY, GETALL_ATTACHMENT_TYPE_NONE, GETALL_ATTACHMENT_TYPE_VIF, GETALL_SOURCE_CACHED, GETALL_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
LogicalPortOperationalStatus	get(java.lang.String lportId, java.lang.String source) Returns operational status of a specified logical port.
void	get(java.lang.String lportId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortOperationalStatus> asyncCallback) Returns operational status of a specified logical port.
void	get(java.lang.String lportId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortOperationalStatus> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns operational status of a specified logical port.
LogicalPortOperationalStatus	get(java.lang.String lportId, java.lang.String source, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns operational status of a specified logical port.
LogicalPortStatusSummary	getall(java.lang.String attachmentId, java.lang.String attachmentType, java.lang.String bridgeClusterId, java.lang.Boolean containerPortsOnly, java.lang.String cursor, java.lang.Boolean diagnostic, java.lang.String includedFields, java.lang.String logicalSwitchId, java.lang.Long pageSize, java.lang.String parentVifId, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String switchingProfileId, java.lang.String transportNodeId, java.lang.String transportZoneId) Returns operational status of all logical ports.
void	getall(java.lang.String attachmentId, java.lang.String attachmentType, java.lang.String bridgeClusterId, java.lang.Boolean containerPortsOnly, java.lang.String cursor, java.lang.Boolean diagnostic, java.lang.String includedFields, java.lang.String logicalSwitchId, java.lang.Long pageSize, java.lang.String parentVifId, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String switchingProfileId, java.lang.String transportNodeId, java.lang.String transportZoneId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortStatusSummary> asyncCallback) Returns operational status of all logical ports.
void	getall(java.lang.String attachmentId, java.lang.String attachmentType, java.lang.String bridgeClusterId, java.lang.Boolean containerPortsOnly, java.lang.String cursor, java.lang.Boolean diagnostic, java.lang.String includedFields, java.lang.String logicalSwitchId, java.lang.Long pageSize, java.lang.String parentVifId, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String switchingProfileId, java.lang.String transportNodeId, java.lang.String transportZoneId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortStatusSummary> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns operational status of all logical ports.
LogicalPortStatusSummary	getall(java.lang.String attachmentId, java.lang.String attachmentType, java.lang.String bridgeClusterId, java.lang.Boolean containerPortsOnly, java.lang.String cursor, java.lang.Boolean diagnostic, java.lang.String includedFields, java.lang.String logicalSwitchId, java.lang.Long pageSize, java.lang.String parentVifId, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String switchingProfileId, java.lang.String transportNodeId, java.lang.String transportZoneId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns operational status of all logical ports.

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

get

public LogicalPortOperationalStatus get(java.lang.String lportId,
                                        java.lang.String source)

Description copied from interface: Status

Returns operational status of a specified logical port.

This api is deprecated from 3.2.2. Please use policy api -
/infra/segments//ports//status

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

Specified by:

get in interface Status

Parameters:

lportId - (required)

source - Data source type. (optional)

Returns:

com.vmware.nsx.model.LogicalPortOperationalStatus

get

public LogicalPortOperationalStatus get(java.lang.String lportId,
                                        java.lang.String source,
                                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Status

Returns operational status of a specified logical port.

This api is deprecated from 3.2.2. Please use policy api -
/infra/segments//ports//status

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:

get in interface Status

Parameters:

lportId - (required)

source - Data source type. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalPortOperationalStatus

get

public void get(java.lang.String lportId,
                java.lang.String source,
                com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortOperationalStatus> asyncCallback)

Description copied from interface: Status

Returns operational status of a specified logical port.

This api is deprecated from 3.2.2. Please use policy api -
/infra/segments//ports//status

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

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

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

Specified by:

get in interface Status

Parameters:

lportId - (required)

source - Data source type. (optional)

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

get

public void get(java.lang.String lportId,
                java.lang.String source,
                com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortOperationalStatus> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Status

Returns operational status of a specified logical port.

This api is deprecated from 3.2.2. Please use policy api -
/infra/segments//ports//status

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

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

Specified by:

get in interface Status

Parameters:

lportId - (required)

source - Data source type. (optional)

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

invocationConfig - Configuration for the method invocation.

getall

public LogicalPortStatusSummary getall(java.lang.String attachmentId,
                                       java.lang.String attachmentType,
                                       java.lang.String bridgeClusterId,
                                       java.lang.Boolean containerPortsOnly,
                                       java.lang.String cursor,
                                       java.lang.Boolean diagnostic,
                                       java.lang.String includedFields,
                                       java.lang.String logicalSwitchId,
                                       java.lang.Long pageSize,
                                       java.lang.String parentVifId,
                                       java.lang.Boolean sortAscending,
                                       java.lang.String sortBy,
                                       java.lang.String source,
                                       java.lang.String switchingProfileId,
                                       java.lang.String transportNodeId,
                                       java.lang.String transportZoneId)

Description copied from interface: Status

Returns operational status of all logical ports. The query parameter \"source=realtime\" is not supported. Pagination is not supported for this API. The query parameters \"cursor\", \"sort_ascending\", \"sort_by\", \"page_size\" and \"included_fields\" will be ignored.

This api is deprecated from 3.2.2. Please use policy api -
/search/query?query=resource_type:SegmentPort&included_fields=id&included_fields=admin_state

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

Specified by:

getall in interface Status

Parameters:

attachmentId - Logical Port attachment Id (optional)

attachmentType - Type of attachment for logical port; for query only. (optional)

bridgeClusterId - Bridge Cluster identifier (optional)

containerPortsOnly - Only container VIF logical ports will be returned if true (optional, default to false)

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

diagnostic - Flag to enable showing of transit logical port. (optional, default to false)

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

logicalSwitchId - Logical Switch identifier (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

parentVifId - ID of the VIF of type PARENT (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

switchingProfileId - Network Profile identifier (optional)

transportNodeId - Transport node identifier (optional)

transportZoneId - Transport zone identifier (optional)

Returns:

com.vmware.nsx.model.LogicalPortStatusSummary

getall

public LogicalPortStatusSummary getall(java.lang.String attachmentId,
                                       java.lang.String attachmentType,
                                       java.lang.String bridgeClusterId,
                                       java.lang.Boolean containerPortsOnly,
                                       java.lang.String cursor,
                                       java.lang.Boolean diagnostic,
                                       java.lang.String includedFields,
                                       java.lang.String logicalSwitchId,
                                       java.lang.Long pageSize,
                                       java.lang.String parentVifId,
                                       java.lang.Boolean sortAscending,
                                       java.lang.String sortBy,
                                       java.lang.String source,
                                       java.lang.String switchingProfileId,
                                       java.lang.String transportNodeId,
                                       java.lang.String transportZoneId,
                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Status

Returns operational status of all logical ports. The query parameter \"source=realtime\" is not supported. Pagination is not supported for this API. The query parameters \"cursor\", \"sort_ascending\", \"sort_by\", \"page_size\" and \"included_fields\" will be ignored.

This api is deprecated from 3.2.2. Please use policy api -
/search/query?query=resource_type:SegmentPort&included_fields=id&included_fields=admin_state

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:

getall in interface Status

Parameters:

attachmentId - Logical Port attachment Id (optional)

attachmentType - Type of attachment for logical port; for query only. (optional)

bridgeClusterId - Bridge Cluster identifier (optional)

containerPortsOnly - Only container VIF logical ports will be returned if true (optional, default to false)

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

diagnostic - Flag to enable showing of transit logical port. (optional, default to false)

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

logicalSwitchId - Logical Switch identifier (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

parentVifId - ID of the VIF of type PARENT (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

switchingProfileId - Network Profile identifier (optional)

transportNodeId - Transport node identifier (optional)

transportZoneId - Transport zone identifier (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalPortStatusSummary

getall

public void getall(java.lang.String attachmentId,
                   java.lang.String attachmentType,
                   java.lang.String bridgeClusterId,
                   java.lang.Boolean containerPortsOnly,
                   java.lang.String cursor,
                   java.lang.Boolean diagnostic,
                   java.lang.String includedFields,
                   java.lang.String logicalSwitchId,
                   java.lang.Long pageSize,
                   java.lang.String parentVifId,
                   java.lang.Boolean sortAscending,
                   java.lang.String sortBy,
                   java.lang.String source,
                   java.lang.String switchingProfileId,
                   java.lang.String transportNodeId,
                   java.lang.String transportZoneId,
                   com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortStatusSummary> asyncCallback)

Description copied from interface: Status

Returns operational status of all logical ports. The query parameter \"source=realtime\" is not supported. Pagination is not supported for this API. The query parameters \"cursor\", \"sort_ascending\", \"sort_by\", \"page_size\" and \"included_fields\" will be ignored.

This api is deprecated from 3.2.2. Please use policy api -
/search/query?query=resource_type:SegmentPort&included_fields=id&included_fields=admin_state

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

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

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

Specified by:

getall in interface Status

Parameters:

attachmentId - Logical Port attachment Id (optional)

attachmentType - Type of attachment for logical port; for query only. (optional)

bridgeClusterId - Bridge Cluster identifier (optional)

containerPortsOnly - Only container VIF logical ports will be returned if true (optional, default to false)

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

diagnostic - Flag to enable showing of transit logical port. (optional, default to false)

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

logicalSwitchId - Logical Switch identifier (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

parentVifId - ID of the VIF of type PARENT (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

switchingProfileId - Network Profile identifier (optional)

transportNodeId - Transport node identifier (optional)

transportZoneId - Transport zone identifier (optional)

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

getall

public void getall(java.lang.String attachmentId,
                   java.lang.String attachmentType,
                   java.lang.String bridgeClusterId,
                   java.lang.Boolean containerPortsOnly,
                   java.lang.String cursor,
                   java.lang.Boolean diagnostic,
                   java.lang.String includedFields,
                   java.lang.String logicalSwitchId,
                   java.lang.Long pageSize,
                   java.lang.String parentVifId,
                   java.lang.Boolean sortAscending,
                   java.lang.String sortBy,
                   java.lang.String source,
                   java.lang.String switchingProfileId,
                   java.lang.String transportNodeId,
                   java.lang.String transportZoneId,
                   com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortStatusSummary> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Status

Returns operational status of all logical ports. The query parameter \"source=realtime\" is not supported. Pagination is not supported for this API. The query parameters \"cursor\", \"sort_ascending\", \"sort_by\", \"page_size\" and \"included_fields\" will be ignored.

This api is deprecated from 3.2.2. Please use policy api -
/search/query?query=resource_type:SegmentPort&included_fields=id&included_fields=admin_state

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

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

Specified by:

getall in interface Status

Parameters:

attachmentId - Logical Port attachment Id (optional)

attachmentType - Type of attachment for logical port; for query only. (optional)

bridgeClusterId - Bridge Cluster identifier (optional)

containerPortsOnly - Only container VIF logical ports will be returned if true (optional, default to false)

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

diagnostic - Flag to enable showing of transit logical port. (optional, default to false)

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

logicalSwitchId - Logical Switch identifier (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

parentVifId - ID of the VIF of type PARENT (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

switchingProfileId - Network Profile identifier (optional)

transportNodeId - Transport node identifier (optional)

transportZoneId - Transport zone identifier (optional)

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

invocationConfig - Configuration for the method invocation.