com.vmware.nsx.upgrade

Interface UpgradeUnits

All Superinterfaces:

com.vmware.vapi.bindings.Service, UpgradeUnitsTypes

All Known Implementing Classes:

UpgradeUnitsStub

public interface UpgradeUnits
extends com.vmware.vapi.bindings.Service, UpgradeUnitsTypes

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
UpgradeUnit	get(java.lang.String upgradeUnitId) Get a specific upgrade unit
void	get(java.lang.String upgradeUnitId, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnit> asyncCallback) Get a specific upgrade unit
void	get(java.lang.String upgradeUnitId, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnit> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get a specific upgrade unit
UpgradeUnit	get(java.lang.String upgradeUnitId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get a specific upgrade unit
UpgradeUnitListResult	list(java.lang.String componentType, java.lang.String currentVersion, java.lang.String cursor, java.lang.String groupId, java.lang.Boolean hasWarnings, java.lang.String includedFields, java.lang.String metadata, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String upgradeUnitType) Get upgrade units
void	list(java.lang.String componentType, java.lang.String currentVersion, java.lang.String cursor, java.lang.String groupId, java.lang.Boolean hasWarnings, java.lang.String includedFields, java.lang.String metadata, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String upgradeUnitType, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitListResult> asyncCallback) Get upgrade units
void	list(java.lang.String componentType, java.lang.String currentVersion, java.lang.String cursor, java.lang.String groupId, java.lang.Boolean hasWarnings, java.lang.String includedFields, java.lang.String metadata, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String upgradeUnitType, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get upgrade units
UpgradeUnitListResult	list(java.lang.String componentType, java.lang.String currentVersion, java.lang.String cursor, java.lang.String groupId, java.lang.Boolean hasWarnings, java.lang.String includedFields, java.lang.String metadata, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String upgradeUnitType, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get upgrade units

Method Detail

get

UpgradeUnit get(java.lang.String upgradeUnitId)

Get a specific upgrade unit

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

Parameters:

upgradeUnitId - (required)

Returns:

com.vmware.nsx.model.UpgradeUnit

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

UpgradeUnit get(java.lang.String upgradeUnitId,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get a specific upgrade unit

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:

upgradeUnitId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UpgradeUnit

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 upgradeUnitId,
         com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnit> asyncCallback)

Get a specific upgrade unit

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

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

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

Parameters:

upgradeUnitId - (required)

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

get

void get(java.lang.String upgradeUnitId,
         com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnit> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get a specific upgrade unit

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

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

Parameters:

upgradeUnitId - (required)

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

invocationConfig - Configuration for the method invocation.

list

UpgradeUnitListResult list(java.lang.String componentType,
                           java.lang.String currentVersion,
                           java.lang.String cursor,
                           java.lang.String groupId,
                           java.lang.Boolean hasWarnings,
                           java.lang.String includedFields,
                           java.lang.String metadata,
                           java.lang.Long pageSize,
                           java.lang.Boolean sortAscending,
                           java.lang.String sortBy,
                           java.lang.String upgradeUnitType)

Get upgrade units

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)

currentVersion - Current version of upgrade unit 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 - UUID of group based on which upgrade units to be filtered (optional)

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

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

upgradeUnitType - Upgrade unit type based on which upgrade units to be filtered (optional)

Returns:

com.vmware.nsx.model.UpgradeUnitListResult

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

UpgradeUnitListResult list(java.lang.String componentType,
                           java.lang.String currentVersion,
                           java.lang.String cursor,
                           java.lang.String groupId,
                           java.lang.Boolean hasWarnings,
                           java.lang.String includedFields,
                           java.lang.String metadata,
                           java.lang.Long pageSize,
                           java.lang.Boolean sortAscending,
                           java.lang.String sortBy,
                           java.lang.String upgradeUnitType,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get 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:

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

currentVersion - Current version of upgrade unit 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 - UUID of group based on which upgrade units to be filtered (optional)

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

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

upgradeUnitType - Upgrade unit type based on which upgrade units to be filtered (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UpgradeUnitListResult

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 currentVersion,
          java.lang.String cursor,
          java.lang.String groupId,
          java.lang.Boolean hasWarnings,
          java.lang.String includedFields,
          java.lang.String metadata,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String upgradeUnitType,
          com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitListResult> asyncCallback)

Get upgrade units

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

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

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)

currentVersion - Current version of upgrade unit 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 - UUID of group based on which upgrade units to be filtered (optional)

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

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

upgradeUnitType - Upgrade unit type based on which upgrade units to be filtered (optional)

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

list

void list(java.lang.String componentType,
          java.lang.String currentVersion,
          java.lang.String cursor,
          java.lang.String groupId,
          java.lang.Boolean hasWarnings,
          java.lang.String includedFields,
          java.lang.String metadata,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String upgradeUnitType,
          com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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

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)

currentVersion - Current version of upgrade unit 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 - UUID of group based on which upgrade units to be filtered (optional)

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

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

upgradeUnitType - Upgrade unit type based on which upgrade units to be filtered (optional)

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

invocationConfig - Configuration for the method invocation.