com.vmware.nsx.upgrade.upgrade_unit_groups

Class StatusStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.upgrade.upgrade_unit_groups.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.upgrade.upgrade_unit_groups.StatusTypes

_VAPI_SERVICE_ID

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
UpgradeUnitStatusListResult	list(java.lang.String groupId, java.lang.String cursor, java.lang.Boolean hasErrors, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Get upgrade status for upgrade units in the specified group.
void	list(java.lang.String groupId, java.lang.String cursor, java.lang.Boolean hasErrors, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitStatusListResult> asyncCallback) Get upgrade status for upgrade units in the specified group.
void	list(java.lang.String groupId, java.lang.String cursor, java.lang.Boolean hasErrors, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitStatusListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get upgrade status for upgrade units in the specified group.
UpgradeUnitStatusListResult	list(java.lang.String groupId, java.lang.String cursor, java.lang.Boolean hasErrors, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get upgrade status for upgrade units in the specified group.

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 UpgradeUnitStatusListResult list(java.lang.String groupId,
                                        java.lang.String cursor,
                                        java.lang.Boolean hasErrors,
                                        java.lang.String includedFields,
                                        java.lang.Long pageSize,
                                        java.lang.Boolean sortAscending,
                                        java.lang.String sortBy)

Description copied from interface: Status

Get upgrade status for upgrade units in the specified group. User can specify whether to show only the upgrade units with errors.

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

Specified by:

list in interface Status

Parameters:

groupId - (required)

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

hasErrors - Flag to indicate whether to return only upgrade units with errors (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)

Returns:

com.vmware.nsx.model.UpgradeUnitStatusListResult

list

public UpgradeUnitStatusListResult list(java.lang.String groupId,
                                        java.lang.String cursor,
                                        java.lang.Boolean hasErrors,
                                        java.lang.String includedFields,
                                        java.lang.Long pageSize,
                                        java.lang.Boolean sortAscending,
                                        java.lang.String sortBy,
                                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Status

Get upgrade status for upgrade units in the specified group. User can specify whether to show only the upgrade units with errors.

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:

groupId - (required)

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

hasErrors - Flag to indicate whether to return only upgrade units with errors (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)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UpgradeUnitStatusListResult

list

public void list(java.lang.String groupId,
                 java.lang.String cursor,
                 java.lang.Boolean hasErrors,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitStatusListResult> asyncCallback)

Description copied from interface: Status

Get upgrade status for upgrade units in the specified group. User can specify whether to show only the upgrade units with errors.

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

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

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:

groupId - (required)

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

hasErrors - Flag to indicate whether to return only upgrade units with errors (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)

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

list

public void list(java.lang.String groupId,
                 java.lang.String cursor,
                 java.lang.Boolean hasErrors,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitStatusListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Status

Get upgrade status for upgrade units in the specified group. User can specify whether to show only the upgrade units with errors.

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

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:

groupId - (required)

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

hasErrors - Flag to indicate whether to return only upgrade units with errors (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)

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

invocationConfig - Configuration for the method invocation.