com.vmware.nsx.logical_switches

Class StatusStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.logical_switches.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_switches.StatusTypes

_VAPI_SERVICE_ID, GET_SOURCE_CACHED, GET_SOURCE_REALTIME, GET_SWITCH_TYPE_DEFAULT, GET_SWITCH_TYPE_DHCP_RELAY, GET_SWITCH_TYPE_DVPG, GET_SWITCH_TYPE_EVPN, GET_SWITCH_TYPE_GLOBAL, GET_SWITCH_TYPE_INTER_ROUTER, GET_SWITCH_TYPE_SERVICE_PLANE, GET_TRANSPORT_TYPE_OVERLAY, GET_TRANSPORT_TYPE_VLAN

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
LogicalSwitchStatusSummary	get(java.lang.String cursor, java.lang.Boolean diagnostic, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String switchType, java.lang.String switchingProfileId, java.lang.String transportType, java.lang.String transportZoneId, java.lang.String uplinkTeamingPolicyName, java.lang.Long vlan, java.lang.Long vni) Returns Operational status of all logical switches.
void	get(java.lang.String cursor, java.lang.Boolean diagnostic, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String switchType, java.lang.String switchingProfileId, java.lang.String transportType, java.lang.String transportZoneId, java.lang.String uplinkTeamingPolicyName, java.lang.Long vlan, java.lang.Long vni, com.vmware.vapi.bindings.client.AsyncCallback<LogicalSwitchStatusSummary> asyncCallback) Returns Operational status of all logical switches.
void	get(java.lang.String cursor, java.lang.Boolean diagnostic, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String switchType, java.lang.String switchingProfileId, java.lang.String transportType, java.lang.String transportZoneId, java.lang.String uplinkTeamingPolicyName, java.lang.Long vlan, java.lang.Long vni, com.vmware.vapi.bindings.client.AsyncCallback<LogicalSwitchStatusSummary> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns Operational status of all logical switches.
LogicalSwitchStatusSummary	get(java.lang.String cursor, java.lang.Boolean diagnostic, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String switchType, java.lang.String switchingProfileId, java.lang.String transportType, java.lang.String transportZoneId, java.lang.String uplinkTeamingPolicyName, java.lang.Long vlan, java.lang.Long vni, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns Operational status of all logical switches.

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 LogicalSwitchStatusSummary get(java.lang.String cursor,
                                      java.lang.Boolean diagnostic,
                                      java.lang.String includedFields,
                                      java.lang.Long pageSize,
                                      java.lang.Boolean sortAscending,
                                      java.lang.String sortBy,
                                      java.lang.String source,
                                      java.lang.String switchType,
                                      java.lang.String switchingProfileId,
                                      java.lang.String transportType,
                                      java.lang.String transportZoneId,
                                      java.lang.String uplinkTeamingPolicyName,
                                      java.lang.Long vlan,
                                      java.lang.Long vni)

Description copied from interface: Status

Returns Operational status of all logical switches. The query parameter \"source=realtime\" is not supported.

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

Specified by:

get in interface Status

Parameters:

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 switch. (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)

source - Data source type. (optional)

switchType - Logical Switch type (optional)

switchingProfileId - Switching Profile identifier (optional)

transportType - Mode of transport supported in the transport zone for this logical switch (optional)

transportZoneId - Transport zone identifier (optional)

uplinkTeamingPolicyName - The logical switch's uplink teaming policy name (optional)

vlan - Virtual Local Area Network Identifier (optional)

vni - VNI of the OVERLAY LogicalSwitch(es) to return. (optional)

Returns:

com.vmware.nsx.model.LogicalSwitchStatusSummary

get

public LogicalSwitchStatusSummary get(java.lang.String cursor,
                                      java.lang.Boolean diagnostic,
                                      java.lang.String includedFields,
                                      java.lang.Long pageSize,
                                      java.lang.Boolean sortAscending,
                                      java.lang.String sortBy,
                                      java.lang.String source,
                                      java.lang.String switchType,
                                      java.lang.String switchingProfileId,
                                      java.lang.String transportType,
                                      java.lang.String transportZoneId,
                                      java.lang.String uplinkTeamingPolicyName,
                                      java.lang.Long vlan,
                                      java.lang.Long vni,
                                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Status

Returns Operational status of all logical switches. The query parameter \"source=realtime\" is not supported.

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:

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 switch. (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)

source - Data source type. (optional)

switchType - Logical Switch type (optional)

switchingProfileId - Switching Profile identifier (optional)

transportType - Mode of transport supported in the transport zone for this logical switch (optional)

transportZoneId - Transport zone identifier (optional)

uplinkTeamingPolicyName - The logical switch's uplink teaming policy name (optional)

vlan - Virtual Local Area Network Identifier (optional)

vni - VNI of the OVERLAY LogicalSwitch(es) to return. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalSwitchStatusSummary

get

public void get(java.lang.String cursor,
                java.lang.Boolean diagnostic,
                java.lang.String includedFields,
                java.lang.Long pageSize,
                java.lang.Boolean sortAscending,
                java.lang.String sortBy,
                java.lang.String source,
                java.lang.String switchType,
                java.lang.String switchingProfileId,
                java.lang.String transportType,
                java.lang.String transportZoneId,
                java.lang.String uplinkTeamingPolicyName,
                java.lang.Long vlan,
                java.lang.Long vni,
                com.vmware.vapi.bindings.client.AsyncCallback<LogicalSwitchStatusSummary> asyncCallback)

Description copied from interface: Status

Returns Operational status of all logical switches. The query parameter \"source=realtime\" is not supported.

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

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

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:

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 switch. (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)

source - Data source type. (optional)

switchType - Logical Switch type (optional)

switchingProfileId - Switching Profile identifier (optional)

transportType - Mode of transport supported in the transport zone for this logical switch (optional)

transportZoneId - Transport zone identifier (optional)

uplinkTeamingPolicyName - The logical switch's uplink teaming policy name (optional)

vlan - Virtual Local Area Network Identifier (optional)

vni - VNI of the OVERLAY LogicalSwitch(es) to return. (optional)

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

get

public void get(java.lang.String cursor,
                java.lang.Boolean diagnostic,
                java.lang.String includedFields,
                java.lang.Long pageSize,
                java.lang.Boolean sortAscending,
                java.lang.String sortBy,
                java.lang.String source,
                java.lang.String switchType,
                java.lang.String switchingProfileId,
                java.lang.String transportType,
                java.lang.String transportZoneId,
                java.lang.String uplinkTeamingPolicyName,
                java.lang.Long vlan,
                java.lang.Long vni,
                com.vmware.vapi.bindings.client.AsyncCallback<LogicalSwitchStatusSummary> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Status

Returns Operational status of all logical switches. The query parameter \"source=realtime\" is not supported.

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

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:

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 switch. (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)

source - Data source type. (optional)

switchType - Logical Switch type (optional)

switchingProfileId - Switching Profile identifier (optional)

transportType - Mode of transport supported in the transport zone for this logical switch (optional)

transportZoneId - Transport zone identifier (optional)

uplinkTeamingPolicyName - The logical switch's uplink teaming policy name (optional)

vlan - Virtual Local Area Network Identifier (optional)

vni - VNI of the OVERLAY LogicalSwitch(es) to return. (optional)

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

invocationConfig - Configuration for the method invocation.