com.vmware.nsx.upgrade

Interface Bundles

All Superinterfaces:

BundlesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

BundlesStub

public interface Bundles
extends com.vmware.vapi.bindings.Service, BundlesTypes

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	cancelupload(java.lang.String bundleId) Cancel upload of upgrade bundle.
void	cancelupload(java.lang.String bundleId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Cancel upload of upgrade bundle.
void	cancelupload(java.lang.String bundleId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Cancel upload of upgrade bundle.
void	cancelupload(java.lang.String bundleId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Cancel upload of upgrade bundle.
UpgradeBundleId	create(UpgradeBundleFetchRequest upgradeBundleFetchRequest, java.lang.Boolean install) Fetches the upgrade bundle from url.
void	create(UpgradeBundleFetchRequest upgradeBundleFetchRequest, java.lang.Boolean install, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeBundleId> asyncCallback) Fetches the upgrade bundle from url.
void	create(UpgradeBundleFetchRequest upgradeBundleFetchRequest, java.lang.Boolean install, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeBundleId> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Fetches the upgrade bundle from url.
UpgradeBundleId	create(UpgradeBundleFetchRequest upgradeBundleFetchRequest, java.lang.Boolean install, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Fetches the upgrade bundle from url.
UpgradeBundleInfo	get(java.lang.String bundleId) Get uploaded upgrade bundle information
void	get(java.lang.String bundleId, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeBundleInfo> asyncCallback) Get uploaded upgrade bundle information
void	get(java.lang.String bundleId, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeBundleInfo> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get uploaded upgrade bundle information
UpgradeBundleInfo	get(java.lang.String bundleId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get uploaded upgrade bundle information

Method Detail

cancelupload

void cancelupload(java.lang.String bundleId)

Cancel upload of upgrade bundle. This API works only when bundle upload is in-progress and will not work during post-processing of upgrade bundle. If bundle upload is in-progress, then the API call returns http OK response after cancelling the upload and deleting partially uploaded bundle.

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

Parameters:

bundleId - (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

cancelupload

void cancelupload(java.lang.String bundleId,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Cancel upload of upgrade bundle. This API works only when bundle upload is in-progress and will not work during post-processing of upgrade bundle. If bundle upload is in-progress, then the API call returns http OK response after cancelling the upload and deleting partially uploaded bundle.

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:

bundleId - (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

cancelupload

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

Cancel upload of upgrade bundle. This API works only when bundle upload is in-progress and will not work during post-processing of upgrade bundle. If bundle upload is in-progress, then the API call returns http OK response after cancelling the upload and deleting partially uploaded bundle.

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:

bundleId - (required)

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

cancelupload

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

Cancel upload of upgrade bundle. This API works only when bundle upload is in-progress and will not work during post-processing of upgrade bundle. If bundle upload is in-progress, then the API call returns http OK response after cancelling the upload and deleting partially uploaded bundle.

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:

bundleId - (required)

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

invocationConfig - Configuration for the method invocation.

create

UpgradeBundleId create(UpgradeBundleFetchRequest upgradeBundleFetchRequest,
                       java.lang.Boolean install)

Fetches the upgrade bundle from url. The call returns after fetch is initiated. Check status by periodically retrieving upgrade bundle upload status using GET /upgrade/bundles//upload-status. The upload is complete when the status is SUCCESS.

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

Parameters:

upgradeBundleFetchRequest - (required)

install - Hint to install the bundle after upload. (optional)

Returns:

com.vmware.nsx.model.UpgradeBundleId

Throws:

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

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

UpgradeBundleId create(UpgradeBundleFetchRequest upgradeBundleFetchRequest,
                       java.lang.Boolean install,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Fetches the upgrade bundle from url. The call returns after fetch is initiated. Check status by periodically retrieving upgrade bundle upload status using GET /upgrade/bundles//upload-status. The upload is complete when the status is SUCCESS.

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:

upgradeBundleFetchRequest - (required)

install - Hint to install the bundle after upload. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UpgradeBundleId

Throws:

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

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(UpgradeBundleFetchRequest upgradeBundleFetchRequest,
            java.lang.Boolean install,
            com.vmware.vapi.bindings.client.AsyncCallback<UpgradeBundleId> asyncCallback)

Fetches the upgrade bundle from url. The call returns after fetch is initiated. Check status by periodically retrieving upgrade bundle upload status using GET /upgrade/bundles//upload-status. The upload is complete when the status is SUCCESS.

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

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

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

Parameters:

upgradeBundleFetchRequest - (required)

install - Hint to install the bundle after upload. (optional)

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

create

void create(UpgradeBundleFetchRequest upgradeBundleFetchRequest,
            java.lang.Boolean install,
            com.vmware.vapi.bindings.client.AsyncCallback<UpgradeBundleId> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Fetches the upgrade bundle from url. The call returns after fetch is initiated. Check status by periodically retrieving upgrade bundle upload status using GET /upgrade/bundles//upload-status. The upload is complete when the status is SUCCESS.

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

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

Parameters:

upgradeBundleFetchRequest - (required)

install - Hint to install the bundle after upload. (optional)

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

invocationConfig - Configuration for the method invocation.

get

UpgradeBundleInfo get(java.lang.String bundleId)

Get uploaded upgrade bundle information

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

Parameters:

bundleId - (required)

Returns:

com.vmware.nsx.model.UpgradeBundleInfo

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

UpgradeBundleInfo get(java.lang.String bundleId,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get uploaded upgrade bundle information

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:

bundleId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UpgradeBundleInfo

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

Get uploaded upgrade bundle information

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

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

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

Parameters:

bundleId - (required)

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

get

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

Get uploaded upgrade bundle information

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

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

Parameters:

bundleId - (required)

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

invocationConfig - Configuration for the method invocation.