com.vmware.appliance

Interface SupportBundle

All Superinterfaces:

com.vmware.vapi.bindings.Service, SupportBundleTypes

All Known Implementing Classes:

SupportBundleStub

public interface SupportBundle
extends com.vmware.vapi.bindings.Service, SupportBundleTypes

The SupportBundle interface provides methods to create support bundle, list and delete generated support bundle. This interface was added in vSphere API 7.0.1.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.SupportBundleTypes

SupportBundleTypes._VAPI_OPERATIONS, SupportBundleTypes.ContentType, SupportBundleTypes.CreateSpec, SupportBundleTypes.CreationStatus, SupportBundleTypes.FilterSpec, SupportBundleTypes.Info, SupportBundleTypes.IterationSpec, SupportBundleTypes.ListResult

Field Summary

Fields inherited from interface com.vmware.appliance.SupportBundleTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	create_Task(SupportBundleTypes.CreateSpec spec) Create a support bundle.
void	create_Task(SupportBundleTypes.CreateSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Create a support bundle.
void	create_Task(SupportBundleTypes.CreateSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create a support bundle.
java.lang.String	create_Task(SupportBundleTypes.CreateSpec spec, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create a support bundle.
void	delete(java.lang.String id) Deletes the support bundle.
void	delete(java.lang.String id, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deletes the support bundle.
void	delete(java.lang.String id, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deletes the support bundle.
void	delete(java.lang.String id, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deletes the support bundle.
SupportBundleTypes.ListResult	list(SupportBundleTypes.IterationSpec iteration, SupportBundleTypes.FilterSpec filter) Get list of support-bundles generated.
void	list(SupportBundleTypes.IterationSpec iteration, SupportBundleTypes.FilterSpec filter, com.vmware.vapi.bindings.client.AsyncCallback<SupportBundleTypes.ListResult> asyncCallback) Get list of support-bundles generated.
void	list(SupportBundleTypes.IterationSpec iteration, SupportBundleTypes.FilterSpec filter, com.vmware.vapi.bindings.client.AsyncCallback<SupportBundleTypes.ListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get list of support-bundles generated.
SupportBundleTypes.ListResult	list(SupportBundleTypes.IterationSpec iteration, SupportBundleTypes.FilterSpec filter, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get list of support-bundles generated.

Method Detail

list

SupportBundleTypes.ListResult list(SupportBundleTypes.IterationSpec iteration,
                                   SupportBundleTypes.FilterSpec filter)

Get list of support-bundles generated. This method was added in vSphere API 7.0.1.0.

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

Parameters:

iteration -

filter -

Returns:

List of support bundle details.

Throws:

Error - Generic error.

list

SupportBundleTypes.ListResult list(SupportBundleTypes.IterationSpec iteration,
                                   SupportBundleTypes.FilterSpec filter,
                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get list of support-bundles generated. This method was added in vSphere API 7.0.1.0.

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:

iteration -

filter -

invocationConfig - Configuration for the method invocation.

Returns:

List of support bundle details.

Throws:

Error - Generic error.

list

void list(SupportBundleTypes.IterationSpec iteration,
          SupportBundleTypes.FilterSpec filter,
          com.vmware.vapi.bindings.client.AsyncCallback<SupportBundleTypes.ListResult> asyncCallback)

Get list of support-bundles generated. This method was added in vSphere API 7.0.1.0.

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

Invocation Result:
List of support bundle details.

Operation Errors:
Error - Generic error.

Parameters:

iteration -

filter -

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

list

void list(SupportBundleTypes.IterationSpec iteration,
          SupportBundleTypes.FilterSpec filter,
          com.vmware.vapi.bindings.client.AsyncCallback<SupportBundleTypes.ListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get list of support-bundles generated. This method was added in vSphere API 7.0.1.0.

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:
List of support bundle details.

Operation Errors:
Error - Generic error.

Parameters:

iteration -

filter -

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

invocationConfig - Configuration for the method invocation.

create_Task

java.lang.String create_Task(SupportBundleTypes.CreateSpec spec)

Create a support bundle. This method was added in vSphere API 7.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

spec -

Returns:

identifier for the task created by this API invocation

Throws:

NotAllowedInCurrentState - If already a support bundle task is in progress.

InvalidArgument

Error - Generic error.

create_Task

java.lang.String create_Task(SupportBundleTypes.CreateSpec spec,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create a support bundle. This method was added in vSphere API 7.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

spec -

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

NotAllowedInCurrentState - If already a support bundle task is in progress.

InvalidArgument

Error - Generic error.

create_Task

void create_Task(SupportBundleTypes.CreateSpec spec,
                 com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

Create a support bundle. This method was added in vSphere API 7.0.1.0.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
NotAllowedInCurrentState - If already a support bundle task is in progress.
InvalidArgument -
Error - Generic error.

Parameters:

spec -

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

create_Task

void create_Task(SupportBundleTypes.CreateSpec spec,
                 com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create a support bundle. This method was added in vSphere API 7.0.1.0.

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

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
NotAllowedInCurrentState - If already a support bundle task is in progress.
InvalidArgument -
Error - Generic error.

Parameters:

spec -

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String id)

Deletes the support bundle. This method was added in vSphere API 8.0.2.0.

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

Parameters:

id - The parameter must be an identifier for the resource type: com.vmware.appliance.supportbundle.

Throws:

NotFound - If support bundle Not Found.

Error - Generic error.

delete

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

Deletes the support bundle. This method was added in vSphere API 8.0.2.0.

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:

id - The parameter must be an identifier for the resource type: com.vmware.appliance.supportbundle.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - If support bundle Not Found.

Error - Generic error.

delete

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

Deletes the support bundle. This method was added in vSphere API 8.0.2.0.

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

Operation Errors:
NotFound - If support bundle Not Found.
Error - Generic error.

Parameters:

id - The parameter must be an identifier for the resource type: com.vmware.appliance.supportbundle.

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

delete

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

Deletes the support bundle. This method was added in vSphere API 8.0.2.0.

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:
NotFound - If support bundle Not Found.
Error - Generic error.

Parameters:

id - The parameter must be an identifier for the resource type: com.vmware.appliance.supportbundle.

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

invocationConfig - Configuration for the method invocation.