com.vmware.nsx.upgrade.upgrade_unit_groups

Interface Status

All Superinterfaces:

com.vmware.vapi.bindings.Service, StatusTypes

All Known Implementing Classes:

StatusStub

public interface Status
extends com.vmware.vapi.bindings.Service, StatusTypes

Field Summary

Fields inherited from interface com.vmware.nsx.upgrade.upgrade_unit_groups.StatusTypes

_VAPI_SERVICE_ID

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.

Method Detail

list

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

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

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

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

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

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

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

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

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

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.