com.vmware.nsx.repository

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.repository.BundlesTypes

_VAPI_SERVICE_ID, CANCELUPLOAD_PRODUCT_ALB_CONTROLLER, CANCELUPLOAD_PRODUCT_INTELLIGENCE, CANCELUPLOAD_PRODUCT_SAMPLE, CREATE_FILE_TYPE_OVA, CREATE_PRODUCT_ALB_CONTROLLER, CREATE_PRODUCT_INTELLIGENCE, CREATE_PRODUCT_SAMPLE, GET_FILE_TYPE_OVA, GET_PRODUCT_ALB_CONTROLLER, GET_PRODUCT_INTELLIGENCE, GET_PRODUCT_SAMPLE

Method Summary

Modifier and Type	Method and Description
void	cancelupload(java.lang.String bundleId, java.lang.String product) Cancel upload of bundle.
void	cancelupload(java.lang.String bundleId, java.lang.String product, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Cancel upload of bundle.
void	cancelupload(java.lang.String bundleId, java.lang.String product, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Cancel upload of bundle.
void	cancelupload(java.lang.String bundleId, java.lang.String product, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Cancel upload of bundle.
BundleId	create(RemoteBundleUrl remoteBundleUrl, java.lang.String fileType, java.lang.String product) Upload the bundle from remote bundle URL.
void	create(RemoteBundleUrl remoteBundleUrl, java.lang.String fileType, java.lang.String product, com.vmware.vapi.bindings.client.AsyncCallback<BundleId> asyncCallback) Upload the bundle from remote bundle URL.
void	create(RemoteBundleUrl remoteBundleUrl, java.lang.String fileType, java.lang.String product, com.vmware.vapi.bindings.client.AsyncCallback<BundleId> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Upload the bundle from remote bundle URL.
BundleId	create(RemoteBundleUrl remoteBundleUrl, java.lang.String fileType, java.lang.String product, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Upload the bundle from remote bundle URL.
BundleIds	get(java.lang.String fileType, java.lang.String product) Get list of bundle-ids which are available in repository or in-progress
void	get(java.lang.String fileType, java.lang.String product, com.vmware.vapi.bindings.client.AsyncCallback<BundleIds> asyncCallback) Get list of bundle-ids which are available in repository or in-progress
void	get(java.lang.String fileType, java.lang.String product, com.vmware.vapi.bindings.client.AsyncCallback<BundleIds> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get list of bundle-ids which are available in repository or in-progress
BundleIds	get(java.lang.String fileType, java.lang.String product, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get list of bundle-ids which are available in repository or in-progress

Method Detail

cancelupload

void cancelupload(java.lang.String bundleId,
                  java.lang.String product)

Cancel upload of bundle. This API works only when bundle upload is in-progress and will not work during post-processing of 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)

product - Name of the appliance (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,
                  java.lang.String product,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Cancel upload of bundle. This API works only when bundle upload is in-progress and will not work during post-processing of 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)

product - Name of the appliance (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,
                  java.lang.String product,
                  com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Cancel upload of bundle. This API works only when bundle upload is in-progress and will not work during post-processing of 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)

product - Name of the appliance (required)

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

cancelupload

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

Cancel upload of bundle. This API works only when bundle upload is in-progress and will not work during post-processing of 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)

product - Name of the appliance (required)

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

invocationConfig - Configuration for the method invocation.

create

BundleId create(RemoteBundleUrl remoteBundleUrl,
                java.lang.String fileType,
                java.lang.String product)

Upload the bundle from remote bundle URL. The call returns after fetch is initiated. Check status by periodically retrieving bundle upload status using GET /repository/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:

remoteBundleUrl - (required)

fileType - Type of file (required)

product - Name of the appliance (required)

Returns:

com.vmware.nsx.model.BundleId

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

BundleId create(RemoteBundleUrl remoteBundleUrl,
                java.lang.String fileType,
                java.lang.String product,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Upload the bundle from remote bundle URL. The call returns after fetch is initiated. Check status by periodically retrieving bundle upload status using GET /repository/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:

remoteBundleUrl - (required)

fileType - Type of file (required)

product - Name of the appliance (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.BundleId

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(RemoteBundleUrl remoteBundleUrl,
            java.lang.String fileType,
            java.lang.String product,
            com.vmware.vapi.bindings.client.AsyncCallback<BundleId> asyncCallback)

Upload the bundle from remote bundle URL. The call returns after fetch is initiated. Check status by periodically retrieving bundle upload status using GET /repository/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.BundleId

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

Parameters:

remoteBundleUrl - (required)

fileType - Type of file (required)

product - Name of the appliance (required)

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

create

void create(RemoteBundleUrl remoteBundleUrl,
            java.lang.String fileType,
            java.lang.String product,
            com.vmware.vapi.bindings.client.AsyncCallback<BundleId> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Upload the bundle from remote bundle URL. The call returns after fetch is initiated. Check status by periodically retrieving bundle upload status using GET /repository/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.BundleId

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

Parameters:

remoteBundleUrl - (required)

fileType - Type of file (required)

product - Name of the appliance (required)

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

invocationConfig - Configuration for the method invocation.

get

BundleIds get(java.lang.String fileType,
              java.lang.String product)

Get list of bundle-ids which are available in repository or in-progress

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

Parameters:

fileType - Type of file (required)

product - Name of the appliance (required)

Returns:

com.vmware.nsx.model.BundleIds

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

BundleIds get(java.lang.String fileType,
              java.lang.String product,
              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get list of bundle-ids which are available in repository or in-progress

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:

fileType - Type of file (required)

product - Name of the appliance (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.BundleIds

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 fileType,
         java.lang.String product,
         com.vmware.vapi.bindings.client.AsyncCallback<BundleIds> asyncCallback)

Get list of bundle-ids which are available in repository or in-progress

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

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

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

Parameters:

fileType - Type of file (required)

product - Name of the appliance (required)

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

get

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

Get list of bundle-ids which are available in repository or in-progress

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

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

Parameters:

fileType - Type of file (required)

product - Name of the appliance (required)

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

invocationConfig - Configuration for the method invocation.