com.vmware.nsx.upgrade

Class BundlesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.upgrade.BundlesStub

All Implemented Interfaces:

Bundles, BundlesTypes, com.vmware.vapi.bindings.Service

public class BundlesStub
extends com.vmware.vapi.internal.bindings.Stub
implements Bundles

Remote stub implementation of the Bundles API service.

WARNING: Internal class, subject to change in future versions.

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

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

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
BundlesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
BundlesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)

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

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BundlesStub

public BundlesStub(com.vmware.vapi.core.ApiProvider apiProvider,
                   com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                   com.vmware.vapi.bindings.StubConfigurationBase config)

BundlesStub

public BundlesStub(com.vmware.vapi.core.ApiProvider apiProvider,
                   com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

cancelupload

public void cancelupload(java.lang.String bundleId)

Description copied from interface: Bundles

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.

Specified by:

cancelupload in interface Bundles

Parameters:

bundleId - (required)

cancelupload

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

Description copied from interface: Bundles

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.

Specified by:

cancelupload in interface Bundles

Parameters:

bundleId - (required)

invocationConfig - Configuration for the method invocation.

cancelupload

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

Description copied from interface: Bundles

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

Specified by:

cancelupload in interface Bundles

Parameters:

bundleId - (required)

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

cancelupload

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

Description copied from interface: Bundles

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

Specified by:

cancelupload in interface Bundles

Parameters:

bundleId - (required)

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

invocationConfig - Configuration for the method invocation.

create

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

Description copied from interface: Bundles

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.

Specified by:

create in interface Bundles

Parameters:

upgradeBundleFetchRequest - (required)

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

Returns:

com.vmware.nsx.model.UpgradeBundleId

create

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

Description copied from interface: Bundles

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.

Specified by:

create in interface Bundles

Parameters:

upgradeBundleFetchRequest - (required)

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

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UpgradeBundleId

create

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

Description copied from interface: Bundles

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

Specified by:

create in interface Bundles

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

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

Description copied from interface: Bundles

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

Specified by:

create in interface Bundles

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

public UpgradeBundleInfo get(java.lang.String bundleId)

Description copied from interface: Bundles

Get uploaded upgrade bundle information

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

Specified by:

get in interface Bundles

Parameters:

bundleId - (required)

Returns:

com.vmware.nsx.model.UpgradeBundleInfo

get

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

Description copied from interface: Bundles

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.

Specified by:

get in interface Bundles

Parameters:

bundleId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UpgradeBundleInfo

get

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

Description copied from interface: Bundles

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

Specified by:

get in interface Bundles

Parameters:

bundleId - (required)

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

get

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

Description copied from interface: Bundles

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

Specified by:

get in interface Bundles

Parameters:

bundleId - (required)

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

invocationConfig - Configuration for the method invocation.