com.vmware.nsx.upgrade.upgrade_units

Interface AggregateInfo

All Superinterfaces:

AggregateInfoTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

AggregateInfoStub

public interface AggregateInfo
extends com.vmware.vapi.bindings.Service, AggregateInfoTypes

Field Summary

Fields inherited from interface com.vmware.nsx.upgrade.upgrade_units.AggregateInfoTypes

_VAPI_SERVICE_ID, LIST_SELECTION_STATUS_ALL, LIST_SELECTION_STATUS_DESELECTED, LIST_SELECTION_STATUS_SELECTED

Method Summary

Modifier and Type	Method and Description
UpgradeUnitAggregateInfoListResult	list(java.lang.String componentType, java.lang.String cursor, java.lang.String groupId, java.lang.Boolean hasErrors, java.lang.String includedFields, java.lang.String metadata, java.lang.Long pageSize, java.lang.String selectionStatus, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String upgradeUnitDisplayName) Get upgrade units aggregate-info
void	list(java.lang.String componentType, java.lang.String cursor, java.lang.String groupId, java.lang.Boolean hasErrors, java.lang.String includedFields, java.lang.String metadata, java.lang.Long pageSize, java.lang.String selectionStatus, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String upgradeUnitDisplayName, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitAggregateInfoListResult> asyncCallback) Get upgrade units aggregate-info
void	list(java.lang.String componentType, java.lang.String cursor, java.lang.String groupId, java.lang.Boolean hasErrors, java.lang.String includedFields, java.lang.String metadata, java.lang.Long pageSize, java.lang.String selectionStatus, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String upgradeUnitDisplayName, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitAggregateInfoListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get upgrade units aggregate-info
UpgradeUnitAggregateInfoListResult	list(java.lang.String componentType, java.lang.String cursor, java.lang.String groupId, java.lang.Boolean hasErrors, java.lang.String includedFields, java.lang.String metadata, java.lang.Long pageSize, java.lang.String selectionStatus, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String upgradeUnitDisplayName, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get upgrade units aggregate-info

Method Detail

list

UpgradeUnitAggregateInfoListResult list(java.lang.String componentType,
                                        java.lang.String cursor,
                                        java.lang.String groupId,
                                        java.lang.Boolean hasErrors,
                                        java.lang.String includedFields,
                                        java.lang.String metadata,
                                        java.lang.Long pageSize,
                                        java.lang.String selectionStatus,
                                        java.lang.Boolean sortAscending,
                                        java.lang.String sortBy,
                                        java.lang.String upgradeUnitDisplayName)

Get upgrade units aggregate-info

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

Parameters:

componentType - Component type based on which upgrade units to be filtered (optional)

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

groupId - Identifier of group based on which upgrade units to be filtered (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)

metadata - Metadata about upgrade unit to filter on (optional)

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

selectionStatus - Flag to indicate whether to return only selected, only deselected or both type of upgrade units (optional, default to ALL)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

upgradeUnitDisplayName - Display name of upgrade unit (optional)

Returns:

com.vmware.nsx.model.UpgradeUnitAggregateInfoListResult

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

UpgradeUnitAggregateInfoListResult list(java.lang.String componentType,
                                        java.lang.String cursor,
                                        java.lang.String groupId,
                                        java.lang.Boolean hasErrors,
                                        java.lang.String includedFields,
                                        java.lang.String metadata,
                                        java.lang.Long pageSize,
                                        java.lang.String selectionStatus,
                                        java.lang.Boolean sortAscending,
                                        java.lang.String sortBy,
                                        java.lang.String upgradeUnitDisplayName,
                                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get upgrade units aggregate-info

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:

componentType - Component type based on which upgrade units to be filtered (optional)

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

groupId - Identifier of group based on which upgrade units to be filtered (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)

metadata - Metadata about upgrade unit to filter on (optional)

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

selectionStatus - Flag to indicate whether to return only selected, only deselected or both type of upgrade units (optional, default to ALL)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

upgradeUnitDisplayName - Display name of upgrade unit (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UpgradeUnitAggregateInfoListResult

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 componentType,
          java.lang.String cursor,
          java.lang.String groupId,
          java.lang.Boolean hasErrors,
          java.lang.String includedFields,
          java.lang.String metadata,
          java.lang.Long pageSize,
          java.lang.String selectionStatus,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String upgradeUnitDisplayName,
          com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitAggregateInfoListResult> asyncCallback)

Get upgrade units aggregate-info

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

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

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

Parameters:

componentType - Component type based on which upgrade units to be filtered (optional)

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

groupId - Identifier of group based on which upgrade units to be filtered (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)

metadata - Metadata about upgrade unit to filter on (optional)

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

selectionStatus - Flag to indicate whether to return only selected, only deselected or both type of upgrade units (optional, default to ALL)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

upgradeUnitDisplayName - Display name of upgrade unit (optional)

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

list

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

Get upgrade units aggregate-info

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

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

Parameters:

componentType - Component type based on which upgrade units to be filtered (optional)

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

groupId - Identifier of group based on which upgrade units to be filtered (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)

metadata - Metadata about upgrade unit to filter on (optional)

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

selectionStatus - Flag to indicate whether to return only selected, only deselected or both type of upgrade units (optional, default to ALL)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

upgradeUnitDisplayName - Display name of upgrade unit (optional)

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

invocationConfig - Configuration for the method invocation.