com.vmware.esx.settings.clusters.software

Class DraftsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.esx.settings.clusters.software.DraftsStub

All Implemented Interfaces:

Drafts, DraftsTypes, Service

public class DraftsStub
extends com.vmware.vapi.internal.bindings.Stub
implements Drafts

Remote stub implementation of the Drafts API service.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.settings.clusters.software.DraftsTypes

DraftsTypes._VAPI_OPERATIONS, DraftsTypes.CommitSpec, DraftsTypes.FilterSpec, DraftsTypes.ImportSpec, DraftsTypes.Info, DraftsTypes.Metadata, DraftsTypes.SourceType, DraftsTypes.StatusType, DraftsTypes.Summary, DraftsTypes.ValidateResult

Field Summary

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

apiProvider, converter, ifaceId, securityContext

Fields inherited from interface com.vmware.esx.settings.clusters.software.DraftsTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	commit_Task(java.lang.String cluster, java.lang.String draft, DraftsTypes.CommitSpec spec) Commits the specified draft as the desired state document.
void	commit_Task(java.lang.String cluster, java.lang.String draft, DraftsTypes.CommitSpec spec, AsyncCallback<java.lang.String> asyncCallback) Commits the specified draft as the desired state document.
void	commit_Task(java.lang.String cluster, java.lang.String draft, DraftsTypes.CommitSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Commits the specified draft as the desired state document.
java.lang.String	commit_Task(java.lang.String cluster, java.lang.String draft, DraftsTypes.CommitSpec spec, InvocationConfig invocationConfig) Commits the specified draft as the desired state document.
java.lang.String	create(java.lang.String cluster) Creates a new software draft from the desired document.
void	create(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback) Creates a new software draft from the desired document.
void	create(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a new software draft from the desired document.
java.lang.String	create(java.lang.String cluster, InvocationConfig invocationConfig) Creates a new software draft from the desired document.
void	delete(java.lang.String cluster, java.lang.String draft) Deletes the software draft.
void	delete(java.lang.String cluster, java.lang.String draft, AsyncCallback<java.lang.Void> asyncCallback) Deletes the software draft.
void	delete(java.lang.String cluster, java.lang.String draft, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes the software draft.
void	delete(java.lang.String cluster, java.lang.String draft, InvocationConfig invocationConfig) Deletes the software draft.
DraftsTypes.Info	get(java.lang.String cluster, java.lang.String draft) Returns the information about given software draft.
void	get(java.lang.String cluster, java.lang.String draft, AsyncCallback<DraftsTypes.Info> asyncCallback) Returns the information about given software draft.
void	get(java.lang.String cluster, java.lang.String draft, AsyncCallback<DraftsTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the information about given software draft.
DraftsTypes.Info	get(java.lang.String cluster, java.lang.String draft, InvocationConfig invocationConfig) Returns the information about given software draft.
java.lang.String	importSoftwareSpec(java.lang.String cluster, DraftsTypes.ImportSpec spec) Imports the desired software specification as a new draft.
void	importSoftwareSpec(java.lang.String cluster, DraftsTypes.ImportSpec spec, AsyncCallback<java.lang.String> asyncCallback) Imports the desired software specification as a new draft.
void	importSoftwareSpec(java.lang.String cluster, DraftsTypes.ImportSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Imports the desired software specification as a new draft.
java.lang.String	importSoftwareSpec(java.lang.String cluster, DraftsTypes.ImportSpec spec, InvocationConfig invocationConfig) Imports the desired software specification as a new draft.
java.util.Map<java.lang.String,DraftsTypes.Summary>	list(java.lang.String cluster, DraftsTypes.FilterSpec filter) Returns information about the software drafts for the specified cluster that match the DraftsTypes.FilterSpec.
void	list(java.lang.String cluster, DraftsTypes.FilterSpec filter, AsyncCallback<java.util.Map<java.lang.String,DraftsTypes.Summary>> asyncCallback) Returns information about the software drafts for the specified cluster that match the DraftsTypes.FilterSpec.
void	list(java.lang.String cluster, DraftsTypes.FilterSpec filter, AsyncCallback<java.util.Map<java.lang.String,DraftsTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about the software drafts for the specified cluster that match the DraftsTypes.FilterSpec.
java.util.Map<java.lang.String,DraftsTypes.Summary>	list(java.lang.String cluster, DraftsTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns information about the software drafts for the specified cluster that match the DraftsTypes.FilterSpec.
java.lang.String	scan_Task(java.lang.String cluster, java.lang.String draft) Scans all the hosts in the cluster against the software draft.
void	scan_Task(java.lang.String cluster, java.lang.String draft, AsyncCallback<java.lang.String> asyncCallback) Scans all the hosts in the cluster against the software draft.
void	scan_Task(java.lang.String cluster, java.lang.String draft, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Scans all the hosts in the cluster against the software draft.
java.lang.String	scan_Task(java.lang.String cluster, java.lang.String draft, InvocationConfig invocationConfig) Scans all the hosts in the cluster against the software draft.
java.lang.String	validate_Task(java.lang.String cluster, java.lang.String draft) Validates the software draft.
void	validate_Task(java.lang.String cluster, java.lang.String draft, AsyncCallback<java.lang.String> asyncCallback) Validates the software draft.
void	validate_Task(java.lang.String cluster, java.lang.String draft, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Validates the software draft.
java.lang.String	validate_Task(java.lang.String cluster, java.lang.String draft, InvocationConfig invocationConfig) Validates the software draft.

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

invokeMethod, invokeMethodAsync, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DraftsStub

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

DraftsStub

public DraftsStub(ApiProvider apiProvider,
                  StubConfigurationBase config)

Method Detail

commit_Task

public java.lang.String commit_Task(java.lang.String cluster,
                                    java.lang.String draft,
                                    DraftsTypes.CommitSpec spec)

Description copied from interface: Drafts

Commits the specified draft as the desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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

Specified by:

commit_Task in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the draft. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

spec - The spec to be used to create the commit.

Returns:

identifier for the task created by this API invocation

commit_Task

public java.lang.String commit_Task(java.lang.String cluster,
                                    java.lang.String draft,
                                    DraftsTypes.CommitSpec spec,
                                    InvocationConfig invocationConfig)

Description copied from interface: Drafts

Commits the specified draft as the desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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.

Specified by:

commit_Task in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the draft. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

spec - The spec to be used to create the commit.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

commit_Task

public void commit_Task(java.lang.String cluster,
                        java.lang.String draft,
                        DraftsTypes.CommitSpec spec,
                        AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Drafts

Commits the specified draft as the desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster or no draft associated with draft in the system.
NotAllowedInCurrentState - If there is another operation in progress.
InvalidArgument - If validation of the software document fails. The value of the data property of Error will be a class that contains all the properties defined in DraftsTypes.ValidateResult.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Specified by:

commit_Task in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the draft. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

spec - The spec to be used to create the commit.

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

commit_Task

public void commit_Task(java.lang.String cluster,
                        java.lang.String draft,
                        DraftsTypes.CommitSpec spec,
                        AsyncCallback<java.lang.String> asyncCallback,
                        InvocationConfig invocationConfig)

Description copied from interface: Drafts

Commits the specified draft as the desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster or no draft associated with draft in the system.
NotAllowedInCurrentState - If there is another operation in progress.
InvalidArgument - If validation of the software document fails. The value of the data property of Error will be a class that contains all the properties defined in DraftsTypes.ValidateResult.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Specified by:

commit_Task in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the draft. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

spec - The spec to be used to create the commit.

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

invocationConfig - Configuration for the method invocation.

create

public java.lang.String create(java.lang.String cluster)

Description copied from interface: Drafts

Creates a new software draft from the desired document. It will be deleted, when the draft is committed successfully. If a desired document is missing, then this method will create an empty draft.

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

Specified by:

create in interface Drafts

Parameters:

cluster - Identifier of the cluster The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

Identifier of the working copy of the document. The return value will be an identifier for the resource type: com.vmware.esx.settings.draft.

create

public java.lang.String create(java.lang.String cluster,
                               InvocationConfig invocationConfig)

Description copied from interface: Drafts

Creates a new software draft from the desired document. It will be deleted, when the draft is committed successfully. If a desired document is missing, then this method will create an empty draft.

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 Drafts

Parameters:

cluster - Identifier of the cluster The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

Identifier of the working copy of the document. The return value will be an identifier for the resource type: com.vmware.esx.settings.draft.

create

public void create(java.lang.String cluster,
                   AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Drafts

Creates a new software draft from the desired document. It will be deleted, when the draft is committed successfully. If a desired document is missing, then this method will create an empty draft.

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

Invocation Result:
Identifier of the working copy of the document. The return value will be an identifier for the resource type: com.vmware.esx.settings.draft.

Operation Errors:
AlreadyExists - If there is already a draft created by this user.
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Specified by:

create in interface Drafts

Parameters:

cluster - Identifier of the cluster The parameter must be an identifier for the resource type: ClusterComputeResource.

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

create

public void create(java.lang.String cluster,
                   AsyncCallback<java.lang.String> asyncCallback,
                   InvocationConfig invocationConfig)

Description copied from interface: Drafts

Creates a new software draft from the desired document. It will be deleted, when the draft is committed successfully. If a desired document is missing, then this method will create an empty draft.

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:
Identifier of the working copy of the document. The return value will be an identifier for the resource type: com.vmware.esx.settings.draft.

Operation Errors:
AlreadyExists - If there is already a draft created by this user.
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Specified by:

create in interface Drafts

Parameters:

cluster - Identifier of the cluster The parameter must be an identifier for the resource type: ClusterComputeResource.

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

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String cluster,
                   java.lang.String draft)

Description copied from interface: Drafts

Deletes the software draft.

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

Specified by:

delete in interface Drafts

Parameters:

cluster - Identifier of the cluster The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the working copy of the document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

delete

public void delete(java.lang.String cluster,
                   java.lang.String draft,
                   InvocationConfig invocationConfig)

Description copied from interface: Drafts

Deletes the software draft.

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:

delete in interface Drafts

Parameters:

cluster - Identifier of the cluster The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the working copy of the document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String cluster,
                   java.lang.String draft,
                   AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Drafts

Deletes the software draft.

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

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster or no draft associated with draft in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Specified by:

delete in interface Drafts

Parameters:

cluster - Identifier of the cluster The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the working copy of the document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

delete

public void delete(java.lang.String cluster,
                   java.lang.String draft,
                   AsyncCallback<java.lang.Void> asyncCallback,
                   InvocationConfig invocationConfig)

Description copied from interface: Drafts

Deletes the software draft.

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:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster or no draft associated with draft in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Specified by:

delete in interface Drafts

Parameters:

cluster - Identifier of the cluster The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the working copy of the document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

invocationConfig - Configuration for the method invocation.

get

public DraftsTypes.Info get(java.lang.String cluster,
                            java.lang.String draft)

Description copied from interface: Drafts

Returns the information about given software draft.

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

Specified by:

get in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the software draft. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

Returns:

Information about the Software Draft.

get

public DraftsTypes.Info get(java.lang.String cluster,
                            java.lang.String draft,
                            InvocationConfig invocationConfig)

Description copied from interface: Drafts

Returns the information about given software draft.

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 Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the software draft. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the Software Draft.

get

public void get(java.lang.String cluster,
                java.lang.String draft,
                AsyncCallback<DraftsTypes.Info> asyncCallback)

Description copied from interface: Drafts

Returns the information about given software draft.

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

Invocation Result:
Information about the Software Draft.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster or no draft associated with draft in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Specified by:

get in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the software draft. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

get

public void get(java.lang.String cluster,
                java.lang.String draft,
                AsyncCallback<DraftsTypes.Info> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Drafts

Returns the information about given software draft.

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:
Information about the Software Draft.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster or no draft associated with draft in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Specified by:

get in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the software draft. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

invocationConfig - Configuration for the method invocation.

list

public java.util.Map<java.lang.String,DraftsTypes.Summary> list(java.lang.String cluster,
                                                                DraftsTypes.FilterSpec filter)

Description copied from interface: Drafts

Returns information about the software drafts for the specified cluster that match the DraftsTypes.FilterSpec.

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

Specified by:

list in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

filter - Filter to be applied while returning drafts. If null, all drafts will be returned.

Returns:

Map of software drafts keyed by their identifiers. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.draft.

list

public java.util.Map<java.lang.String,DraftsTypes.Summary> list(java.lang.String cluster,
                                                                DraftsTypes.FilterSpec filter,
                                                                InvocationConfig invocationConfig)

Description copied from interface: Drafts

Returns information about the software drafts for the specified cluster that match the DraftsTypes.FilterSpec.

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:

list in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

filter - Filter to be applied while returning drafts. If null, all drafts will be returned.

invocationConfig - Configuration for the method invocation.

Returns:

Map of software drafts keyed by their identifiers. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.draft.

list

public void list(java.lang.String cluster,
                 DraftsTypes.FilterSpec filter,
                 AsyncCallback<java.util.Map<java.lang.String,DraftsTypes.Summary>> asyncCallback)

Description copied from interface: Drafts

Returns information about the software drafts for the specified cluster that match the DraftsTypes.FilterSpec.

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

Invocation Result:
Map of software drafts keyed by their identifiers. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.draft.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Specified by:

list in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

filter - Filter to be applied while returning drafts. If null, all drafts will be returned.

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

list

public void list(java.lang.String cluster,
                 DraftsTypes.FilterSpec filter,
                 AsyncCallback<java.util.Map<java.lang.String,DraftsTypes.Summary>> asyncCallback,
                 InvocationConfig invocationConfig)

Description copied from interface: Drafts

Returns information about the software drafts for the specified cluster that match the DraftsTypes.FilterSpec.

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:
Map of software drafts keyed by their identifiers. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.draft.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Specified by:

list in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

filter - Filter to be applied while returning drafts. If null, all drafts will be returned.

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

invocationConfig - Configuration for the method invocation.

validate_Task

public java.lang.String validate_Task(java.lang.String cluster,
                                      java.lang.String draft)

Description copied from interface: Drafts

Validates the software draft. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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

Specified by:

validate_Task in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the software draft. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

Returns:

identifier for the task created by this API invocation

validate_Task

public java.lang.String validate_Task(java.lang.String cluster,
                                      java.lang.String draft,
                                      InvocationConfig invocationConfig)

Description copied from interface: Drafts

Validates the software draft. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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.

Specified by:

validate_Task in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the software draft. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

validate_Task

public void validate_Task(java.lang.String cluster,
                          java.lang.String draft,
                          AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Drafts

Validates the software draft. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster or no draft associated with draft in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Specified by:

validate_Task in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the software draft. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

validate_Task

public void validate_Task(java.lang.String cluster,
                          java.lang.String draft,
                          AsyncCallback<java.lang.String> asyncCallback,
                          InvocationConfig invocationConfig)

Description copied from interface: Drafts

Validates the software draft. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster or no draft associated with draft in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Specified by:

validate_Task in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the software draft. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

invocationConfig - Configuration for the method invocation.

scan_Task

public java.lang.String scan_Task(java.lang.String cluster,
                                  java.lang.String draft)

Description copied from interface: Drafts

Scans all the hosts in the cluster against the software draft. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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

Specified by:

scan_Task in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the working copy of the document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

Returns:

identifier for the task created by this API invocation

scan_Task

public java.lang.String scan_Task(java.lang.String cluster,
                                  java.lang.String draft,
                                  InvocationConfig invocationConfig)

Description copied from interface: Drafts

Scans all the hosts in the cluster against the software draft. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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.

Specified by:

scan_Task in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the working copy of the document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

scan_Task

public void scan_Task(java.lang.String cluster,
                      java.lang.String draft,
                      AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Drafts

Scans all the hosts in the cluster against the software draft. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster or no draft associated with draft in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Specified by:

scan_Task in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the working copy of the document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

scan_Task

public void scan_Task(java.lang.String cluster,
                      java.lang.String draft,
                      AsyncCallback<java.lang.String> asyncCallback,
                      InvocationConfig invocationConfig)

Description copied from interface: Drafts

Scans all the hosts in the cluster against the software draft. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster or no draft associated with draft in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Specified by:

scan_Task in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of the working copy of the document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

invocationConfig - Configuration for the method invocation.

importSoftwareSpec

public java.lang.String importSoftwareSpec(java.lang.String cluster,
                                           DraftsTypes.ImportSpec spec)

Description copied from interface: Drafts

Imports the desired software specification as a new draft. If a desired document is missing, then this method will create an empty draft except when the source type is of either DraftsTypes.SourceType.LATEST_RECOMMENDATION or DraftsTypes.SourceType.CURRENT_SERIES_RECOMMENDATION, then NotFound error is reported. In addition, the exisiting draft will be overwritten when the source type is of either LATEST_RECOMMENDATION or CURRENT_SERIES_RECOMMENDATION.

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

Specified by:

importSoftwareSpec in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification to import desired software specification.

Returns:

Identifier of the software draft. The return value will be an identifier for the resource type: com.vmware.esx.settings.draft.

importSoftwareSpec

public java.lang.String importSoftwareSpec(java.lang.String cluster,
                                           DraftsTypes.ImportSpec spec,
                                           InvocationConfig invocationConfig)

Description copied from interface: Drafts

Imports the desired software specification as a new draft. If a desired document is missing, then this method will create an empty draft except when the source type is of either DraftsTypes.SourceType.LATEST_RECOMMENDATION or DraftsTypes.SourceType.CURRENT_SERIES_RECOMMENDATION, then NotFound error is reported. In addition, the exisiting draft will be overwritten when the source type is of either LATEST_RECOMMENDATION or CURRENT_SERIES_RECOMMENDATION.

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:

importSoftwareSpec in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification to import desired software specification.

invocationConfig - Configuration for the method invocation.

Returns:

Identifier of the software draft. The return value will be an identifier for the resource type: com.vmware.esx.settings.draft.

importSoftwareSpec

public void importSoftwareSpec(java.lang.String cluster,
                               DraftsTypes.ImportSpec spec,
                               AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Drafts

Imports the desired software specification as a new draft. If a desired document is missing, then this method will create an empty draft except when the source type is of either DraftsTypes.SourceType.LATEST_RECOMMENDATION or DraftsTypes.SourceType.CURRENT_SERIES_RECOMMENDATION, then NotFound error is reported. In addition, the exisiting draft will be overwritten when the source type is of either LATEST_RECOMMENDATION or CURRENT_SERIES_RECOMMENDATION.

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

Invocation Result:
Identifier of the software draft. The return value will be an identifier for the resource type: com.vmware.esx.settings.draft.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system or if the source type of import specification is of either LATEST_RECOMMENDATION or CURRENT_SERIES_RECOMMENDATION, and a recommendation does not exist for the cluster. It was either never generated or deleted due to changes in cluster state such as a new desired image spec being committed.
ServiceUnavailable - If the service is not available.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Specified by:

importSoftwareSpec in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification to import desired software specification.

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

importSoftwareSpec

public void importSoftwareSpec(java.lang.String cluster,
                               DraftsTypes.ImportSpec spec,
                               AsyncCallback<java.lang.String> asyncCallback,
                               InvocationConfig invocationConfig)

Description copied from interface: Drafts

Imports the desired software specification as a new draft. If a desired document is missing, then this method will create an empty draft except when the source type is of either DraftsTypes.SourceType.LATEST_RECOMMENDATION or DraftsTypes.SourceType.CURRENT_SERIES_RECOMMENDATION, then NotFound error is reported. In addition, the exisiting draft will be overwritten when the source type is of either LATEST_RECOMMENDATION or CURRENT_SERIES_RECOMMENDATION.

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:
Identifier of the software draft. The return value will be an identifier for the resource type: com.vmware.esx.settings.draft.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system or if the source type of import specification is of either LATEST_RECOMMENDATION or CURRENT_SERIES_RECOMMENDATION, and a recommendation does not exist for the cluster. It was either never generated or deleted due to changes in cluster state such as a new desired image spec being committed.
ServiceUnavailable - If the service is not available.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Specified by:

importSoftwareSpec in interface Drafts

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification to import desired software specification.

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

invocationConfig - Configuration for the method invocation.