com.vmware.nsx.upgrade

Interface UpgradeUnitGroups

All Superinterfaces:

com.vmware.vapi.bindings.Service, UpgradeUnitGroupsTypes

All Known Implementing Classes:

UpgradeUnitGroupsStub

public interface UpgradeUnitGroups
extends com.vmware.vapi.bindings.Service, UpgradeUnitGroupsTypes

Field Summary

Fields inherited from interface com.vmware.nsx.upgrade.UpgradeUnitGroupsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
UpgradeUnitList	addupgradeunits(java.lang.String groupId, UpgradeUnitList upgradeUnitList) Add upgrade units to specified upgrade unit group.
void	addupgradeunits(java.lang.String groupId, UpgradeUnitList upgradeUnitList, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitList> asyncCallback) Add upgrade units to specified upgrade unit group.
void	addupgradeunits(java.lang.String groupId, UpgradeUnitList upgradeUnitList, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Add upgrade units to specified upgrade unit group.
UpgradeUnitList	addupgradeunits(java.lang.String groupId, UpgradeUnitList upgradeUnitList, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Add upgrade units to specified upgrade unit group.
UpgradeUnitGroup	create(UpgradeUnitGroup upgradeUnitGroup) Create a group of upgrade units.
void	create(UpgradeUnitGroup upgradeUnitGroup, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitGroup> asyncCallback) Create a group of upgrade units.
void	create(UpgradeUnitGroup upgradeUnitGroup, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitGroup> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create a group of upgrade units.
UpgradeUnitGroup	create(UpgradeUnitGroup upgradeUnitGroup, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create a group of upgrade units.
void	delete(java.lang.String groupId) Delete the specified group.
void	delete(java.lang.String groupId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete the specified group.
void	delete(java.lang.String groupId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete the specified group.
void	delete(java.lang.String groupId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete the specified group.
UpgradeUnitGroup	get(java.lang.String groupId, java.lang.Boolean summary) Returns information about a specific upgrade unit group in the upgrade plan.
void	get(java.lang.String groupId, java.lang.Boolean summary, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitGroup> asyncCallback) Returns information about a specific upgrade unit group in the upgrade plan.
void	get(java.lang.String groupId, java.lang.Boolean summary, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitGroup> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specific upgrade unit group in the upgrade plan.
UpgradeUnitGroup	get(java.lang.String groupId, java.lang.Boolean summary, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specific upgrade unit group in the upgrade plan.
UpgradeUnitGroupListResult	list(java.lang.String componentType, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.Boolean summary, java.lang.Boolean sync) Return information of all upgrade unit groups in the upgrade plan.
void	list(java.lang.String componentType, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.Boolean summary, java.lang.Boolean sync, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitGroupListResult> asyncCallback) Return information of all upgrade unit groups in the upgrade plan.
void	list(java.lang.String componentType, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.Boolean summary, java.lang.Boolean sync, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitGroupListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Return information of all upgrade unit groups in the upgrade plan.
UpgradeUnitGroupListResult	list(java.lang.String componentType, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.Boolean summary, java.lang.Boolean sync, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Return information of all upgrade unit groups in the upgrade plan.
void	reorder(java.lang.String groupId, ReorderRequest reorderRequest) Reorder an upgrade unit group by placing it before/after the specified upgrade unit group.
void	reorder(java.lang.String groupId, ReorderRequest reorderRequest, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Reorder an upgrade unit group by placing it before/after the specified upgrade unit group.
void	reorder(java.lang.String groupId, ReorderRequest reorderRequest, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Reorder an upgrade unit group by placing it before/after the specified upgrade unit group.
void	reorder(java.lang.String groupId, ReorderRequest reorderRequest, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Reorder an upgrade unit group by placing it before/after the specified upgrade unit group.
UpgradeUnitGroup	update(java.lang.String groupId, UpgradeUnitGroup upgradeUnitGroup) Update the specified upgrade unit group.
void	update(java.lang.String groupId, UpgradeUnitGroup upgradeUnitGroup, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitGroup> asyncCallback) Update the specified upgrade unit group.
void	update(java.lang.String groupId, UpgradeUnitGroup upgradeUnitGroup, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitGroup> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Update the specified upgrade unit group.
UpgradeUnitGroup	update(java.lang.String groupId, UpgradeUnitGroup upgradeUnitGroup, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Update the specified upgrade unit group.

Method Detail

addupgradeunits

UpgradeUnitList addupgradeunits(java.lang.String groupId,
                                UpgradeUnitList upgradeUnitList)

Add upgrade units to specified upgrade unit group. The upgrade units will be added at the end of the upgrade unit list.

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

Parameters:

groupId - (required)

upgradeUnitList - (required)

Returns:

com.vmware.nsx.model.UpgradeUnitList

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

addupgradeunits

UpgradeUnitList addupgradeunits(java.lang.String groupId,
                                UpgradeUnitList upgradeUnitList,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Add upgrade units to specified upgrade unit group. The upgrade units will be added at the end of the upgrade unit list.

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)

upgradeUnitList - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UpgradeUnitList

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

addupgradeunits

void addupgradeunits(java.lang.String groupId,
                     UpgradeUnitList upgradeUnitList,
                     com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitList> asyncCallback)

Add upgrade units to specified upgrade unit group. The upgrade units will be added at the end of the upgrade unit list.

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

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

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

Parameters:

groupId - (required)

upgradeUnitList - (required)

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

addupgradeunits

void addupgradeunits(java.lang.String groupId,
                     UpgradeUnitList upgradeUnitList,
                     com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitList> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Add upgrade units to specified upgrade unit group. The upgrade units will be added at the end of the upgrade unit list.

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

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

Parameters:

groupId - (required)

upgradeUnitList - (required)

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

invocationConfig - Configuration for the method invocation.

create

UpgradeUnitGroup create(UpgradeUnitGroup upgradeUnitGroup)

Create a group of upgrade units.

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

Parameters:

upgradeUnitGroup - (required)

Returns:

com.vmware.nsx.model.UpgradeUnitGroup

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

create

UpgradeUnitGroup create(UpgradeUnitGroup upgradeUnitGroup,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create a group of upgrade units.

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:

upgradeUnitGroup - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UpgradeUnitGroup

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

create

void create(UpgradeUnitGroup upgradeUnitGroup,
            com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitGroup> asyncCallback)

Create a group of upgrade units.

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

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

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

Parameters:

upgradeUnitGroup - (required)

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

create

void create(UpgradeUnitGroup upgradeUnitGroup,
            com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitGroup> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create a group of upgrade units.

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

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

Parameters:

upgradeUnitGroup - (required)

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String groupId)

Delete the specified group. NOTE - A group can be deleted only if it is empty. If user tries to delete a group containing one or more upgrade units, the operation will fail and an error will be returned.

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

Parameters:

groupId - (required)

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

delete

void delete(java.lang.String groupId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete the specified group. NOTE - A group can be deleted only if it is empty. If user tries to delete a group containing one or more upgrade units, the operation will fail and an error will be returned.

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)

invocationConfig - Configuration for the method invocation.

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

delete

void delete(java.lang.String groupId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Delete the specified group. NOTE - A group can be deleted only if it is empty. If user tries to delete a group containing one or more upgrade units, the operation will fail and an error will be returned.

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

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

Parameters:

groupId - (required)

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

delete

void delete(java.lang.String groupId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete the specified group. NOTE - A group can be deleted only if it is empty. If user tries to delete a group containing one or more upgrade units, the operation will fail and an error will be returned.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

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

Parameters:

groupId - (required)

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

invocationConfig - Configuration for the method invocation.

get

UpgradeUnitGroup get(java.lang.String groupId,
                     java.lang.Boolean summary)

Returns information about a specific upgrade unit group in the upgrade plan. If request parameter summary is set to true, then only count of upgrade units will be returned, upgrade units list will be empty.

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

Parameters:

groupId - (required)

summary - Flag indicating whether to return the summary (optional, default to false)

Returns:

com.vmware.nsx.model.UpgradeUnitGroup

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

get

UpgradeUnitGroup get(java.lang.String groupId,
                     java.lang.Boolean summary,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about a specific upgrade unit group in the upgrade plan. If request parameter summary is set to true, then only count of upgrade units will be returned, upgrade units list will be empty.

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)

summary - Flag indicating whether to return the summary (optional, default to false)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UpgradeUnitGroup

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

get

void get(java.lang.String groupId,
         java.lang.Boolean summary,
         com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitGroup> asyncCallback)

Returns information about a specific upgrade unit group in the upgrade plan. If request parameter summary is set to true, then only count of upgrade units will be returned, upgrade units list will be empty.

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

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

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

Parameters:

groupId - (required)

summary - Flag indicating whether to return the summary (optional, default to false)

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

get

void get(java.lang.String groupId,
         java.lang.Boolean summary,
         com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitGroup> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about a specific upgrade unit group in the upgrade plan. If request parameter summary is set to true, then only count of upgrade units will be returned, upgrade units list will be empty.

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

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

Parameters:

groupId - (required)

summary - Flag indicating whether to return the summary (optional, default to false)

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

invocationConfig - Configuration for the method invocation.

list

UpgradeUnitGroupListResult list(java.lang.String componentType,
                                java.lang.String cursor,
                                java.lang.String includedFields,
                                java.lang.Long pageSize,
                                java.lang.Boolean sortAscending,
                                java.lang.String sortBy,
                                java.lang.Boolean summary,
                                java.lang.Boolean sync)

Return information of all upgrade unit groups in the upgrade plan. If request parameter summary is set to true, then only count of upgrade units will be returned, upgrade units list will be empty. If request parameter component type is specified, then all upgrade unit groups for that component will be returned.

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

Parameters:

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

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

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)

summary - Flag indicating whether to return summary (optional, default to false)

sync - Synchronize before returning upgrade unit groups (optional, default to false)

Returns:

com.vmware.nsx.model.UpgradeUnitGroupListResult

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

UpgradeUnitGroupListResult list(java.lang.String componentType,
                                java.lang.String cursor,
                                java.lang.String includedFields,
                                java.lang.Long pageSize,
                                java.lang.Boolean sortAscending,
                                java.lang.String sortBy,
                                java.lang.Boolean summary,
                                java.lang.Boolean sync,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Return information of all upgrade unit groups in the upgrade plan. If request parameter summary is set to true, then only count of upgrade units will be returned, upgrade units list will be empty. If request parameter component type is specified, then all upgrade unit groups for that component will be returned.

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 unit groups to be filtered (optional)

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

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)

summary - Flag indicating whether to return summary (optional, default to false)

sync - Synchronize before returning upgrade unit groups (optional, default to false)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UpgradeUnitGroupListResult

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 includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.Boolean summary,
          java.lang.Boolean sync,
          com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitGroupListResult> asyncCallback)

Return information of all upgrade unit groups in the upgrade plan. If request parameter summary is set to true, then only count of upgrade units will be returned, upgrade units list will be empty. If request parameter component type is specified, then all upgrade unit groups for that component will be returned.

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

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

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 unit groups to be filtered (optional)

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

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)

summary - Flag indicating whether to return summary (optional, default to false)

sync - Synchronize before returning upgrade unit groups (optional, default to false)

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 includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.Boolean summary,
          java.lang.Boolean sync,
          com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitGroupListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Return information of all upgrade unit groups in the upgrade plan. If request parameter summary is set to true, then only count of upgrade units will be returned, upgrade units list will be empty. If request parameter component type is specified, then all upgrade unit groups for that component will be returned.

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

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 unit groups to be filtered (optional)

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

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)

summary - Flag indicating whether to return summary (optional, default to false)

sync - Synchronize before returning upgrade unit groups (optional, default to false)

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

invocationConfig - Configuration for the method invocation.

reorder

void reorder(java.lang.String groupId,
             ReorderRequest reorderRequest)

Reorder an upgrade unit group by placing it before/after the specified upgrade unit group.

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

Parameters:

groupId - (required)

reorderRequest - (required)

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

reorder

void reorder(java.lang.String groupId,
             ReorderRequest reorderRequest,
             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Reorder an upgrade unit group by placing it before/after the specified upgrade unit group.

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)

reorderRequest - (required)

invocationConfig - Configuration for the method invocation.

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

reorder

void reorder(java.lang.String groupId,
             ReorderRequest reorderRequest,
             com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Reorder an upgrade unit group by placing it before/after the specified upgrade unit group.

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

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

Parameters:

groupId - (required)

reorderRequest - (required)

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

reorder

void reorder(java.lang.String groupId,
             ReorderRequest reorderRequest,
             com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Reorder an upgrade unit group by placing it before/after the specified upgrade unit group.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

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

Parameters:

groupId - (required)

reorderRequest - (required)

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

invocationConfig - Configuration for the method invocation.

update

UpgradeUnitGroup update(java.lang.String groupId,
                        UpgradeUnitGroup upgradeUnitGroup)

Update the specified upgrade unit group. Removal of upgrade units from the group using this is not allowed. An error will be returned in that case.

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

Parameters:

groupId - (required)

upgradeUnitGroup - (required)

Returns:

com.vmware.nsx.model.UpgradeUnitGroup

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

update

UpgradeUnitGroup update(java.lang.String groupId,
                        UpgradeUnitGroup upgradeUnitGroup,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Update the specified upgrade unit group. Removal of upgrade units from the group using this is not allowed. An error will be returned in that case.

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)

upgradeUnitGroup - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UpgradeUnitGroup

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

update

void update(java.lang.String groupId,
            UpgradeUnitGroup upgradeUnitGroup,
            com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitGroup> asyncCallback)

Update the specified upgrade unit group. Removal of upgrade units from the group using this is not allowed. An error will be returned in that case.

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

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

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

Parameters:

groupId - (required)

upgradeUnitGroup - (required)

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

update

void update(java.lang.String groupId,
            UpgradeUnitGroup upgradeUnitGroup,
            com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitGroup> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Update the specified upgrade unit group. Removal of upgrade units from the group using this is not allowed. An error will be returned in that case.

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

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

Parameters:

groupId - (required)

upgradeUnitGroup - (required)

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

invocationConfig - Configuration for the method invocation.