com.vmware.cis

Interface Tasks

All Superinterfaces:

Service, TasksTypes

All Known Implementing Classes:

TasksStub

public interface Tasks
extends Service, TasksTypes

The Tasks interface provides methods for managing the task related to a long running operation. This interface was added in vSphere API 6.7 U1.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.cis.TasksTypes

TasksTypes.FilterSpec, TasksTypes.GetSpec

Field Summary

Fields inherited from interface com.vmware.cis.TasksTypes

RESOURCE_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel(java.lang.String task) Cancel a running operation associated with the task.
void	cancel(java.lang.String task, AsyncCallback<java.lang.Void> asyncCallback) Cancel a running operation associated with the task.
void	cancel(java.lang.String task, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Cancel a running operation associated with the task.
void	cancel(java.lang.String task, InvocationConfig invocationConfig) Cancel a running operation associated with the task.
Info	get(java.lang.String task, TasksTypes.GetSpec spec) Returns information about a task.
void	get(java.lang.String task, TasksTypes.GetSpec spec, AsyncCallback<Info> asyncCallback) Returns information about a task.
void	get(java.lang.String task, TasksTypes.GetSpec spec, AsyncCallback<Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a task.
Info	get(java.lang.String task, TasksTypes.GetSpec spec, InvocationConfig invocationConfig) Returns information about a task.
java.util.Map<java.lang.String,Info>	list(TasksTypes.FilterSpec filterSpec, TasksTypes.GetSpec resultSpec) Returns information about at most 1000 visible (subject to permission checks) tasks matching the TasksTypes.FilterSpec.
void	list(TasksTypes.FilterSpec filterSpec, TasksTypes.GetSpec resultSpec, AsyncCallback<java.util.Map<java.lang.String,Info>> asyncCallback) Returns information about at most 1000 visible (subject to permission checks) tasks matching the TasksTypes.FilterSpec.
void	list(TasksTypes.FilterSpec filterSpec, TasksTypes.GetSpec resultSpec, AsyncCallback<java.util.Map<java.lang.String,Info>> asyncCallback, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) tasks matching the TasksTypes.FilterSpec.
java.util.Map<java.lang.String,Info>	list(TasksTypes.FilterSpec filterSpec, TasksTypes.GetSpec resultSpec, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) tasks matching the TasksTypes.FilterSpec.

Method Detail

get

Info get(java.lang.String task,
       TasksTypes.GetSpec spec)

Returns information about a task. This method was added in vSphere API 6.7 U1.

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

Parameters:

task - Task identifier. The parameter must be an identifier for the resource type: com.vmware.cis.task.

spec - Specification on what to get for a task. If null, the behavior is equivalent to a TasksTypes.GetSpec with all properties null which means only the data described in Info will be returned and the result of the operation will be return.

Returns:

Information about the specified task.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the task is not found.

ResourceInaccessible - if the task's state cannot be accessed.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

get

Info get(java.lang.String task,
       TasksTypes.GetSpec spec,
       InvocationConfig invocationConfig)

Returns information about a task. This method was added in vSphere API 6.7 U1.

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:

task - Task identifier. The parameter must be an identifier for the resource type: com.vmware.cis.task.

spec - Specification on what to get for a task. If null, the behavior is equivalent to a TasksTypes.GetSpec with all properties null which means only the data described in Info will be returned and the result of the operation will be return.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the specified task.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the task is not found.

ResourceInaccessible - if the task's state cannot be accessed.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

get

void get(java.lang.String task,
       TasksTypes.GetSpec spec,
       AsyncCallback<Info> asyncCallback)

Returns information about a task. This method was added in vSphere API 6.7 U1.

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

Operation Result:
Information about the specified task.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the task is not found.
ResourceInaccessible - if the task's state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

task - Task identifier. The parameter must be an identifier for the resource type: com.vmware.cis.task.

spec - Specification on what to get for a task. If null, the behavior is equivalent to a TasksTypes.GetSpec with all properties null which means only the data described in Info will be returned and the result of the operation will be return.

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

get

void get(java.lang.String task,
       TasksTypes.GetSpec spec,
       AsyncCallback<Info> asyncCallback,
       InvocationConfig invocationConfig)

Returns information about a task. This method was added in vSphere API 6.7 U1.

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

Operation Result:
Information about the specified task.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the task is not found.
ResourceInaccessible - if the task's state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

task - Task identifier. The parameter must be an identifier for the resource type: com.vmware.cis.task.

spec - Specification on what to get for a task. If null, the behavior is equivalent to a TasksTypes.GetSpec with all properties null which means only the data described in Info will be returned and the result of the operation will be return.

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

invocationConfig - Configuration for the method invocation.

list

java.util.Map<java.lang.String,Info> list(TasksTypes.FilterSpec filterSpec,
                                        TasksTypes.GetSpec resultSpec)

Returns information about at most 1000 visible (subject to permission checks) tasks matching the TasksTypes.FilterSpec. All tasks must be in the same provider. This method was added in vSphere API 6.7 U1.

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

Parameters:

filterSpec - Specification of matching tasks. This is currently required. In the future, if it is null, the behavior is equivalent to a TasksTypes.FilterSpec with all properties null which means all tasks match the filter.

resultSpec - Specification of what to return for a task. If null, the behavior is equivalent to a TasksTypes.GetSpec with all properties null which means only the data describe in Info will be returned and the result of the operation will be return.

Returns:

Map of task identifier to information about the task. The key in the return value Map will be an identifier for the resource type: com.vmware.cis.task.

Throws:

InvalidArgument - if any of the specified parameters are invalid.

ResourceInaccessible - if a task's state cannot be accessed or over 1000 tasks matching the TasksTypes.FilterSpec.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

list

java.util.Map<java.lang.String,Info> list(TasksTypes.FilterSpec filterSpec,
                                        TasksTypes.GetSpec resultSpec,
                                        InvocationConfig invocationConfig)

Returns information about at most 1000 visible (subject to permission checks) tasks matching the TasksTypes.FilterSpec. All tasks must be in the same provider. This method was added in vSphere API 6.7 U1.

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:

filterSpec - Specification of matching tasks. This is currently required. In the future, if it is null, the behavior is equivalent to a TasksTypes.FilterSpec with all properties null which means all tasks match the filter.

resultSpec - Specification of what to return for a task. If null, the behavior is equivalent to a TasksTypes.GetSpec with all properties null which means only the data describe in Info will be returned and the result of the operation will be return.

invocationConfig - Configuration for the method invocation.

Returns:

Map of task identifier to information about the task. The key in the return value Map will be an identifier for the resource type: com.vmware.cis.task.

Throws:

InvalidArgument - if any of the specified parameters are invalid.

ResourceInaccessible - if a task's state cannot be accessed or over 1000 tasks matching the TasksTypes.FilterSpec.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

list

void list(TasksTypes.FilterSpec filterSpec,
        TasksTypes.GetSpec resultSpec,
        AsyncCallback<java.util.Map<java.lang.String,Info>> asyncCallback)

Returns information about at most 1000 visible (subject to permission checks) tasks matching the TasksTypes.FilterSpec. All tasks must be in the same provider. This method was added in vSphere API 6.7 U1.

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

Operation Result:
Map of task identifier to information about the task. The key in the return value Map will be an identifier for the resource type: com.vmware.cis.task.

Operation Errors:
InvalidArgument - if any of the specified parameters are invalid.
ResourceInaccessible - if a task's state cannot be accessed or over 1000 tasks matching the TasksTypes.FilterSpec.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

filterSpec - Specification of matching tasks. This is currently required. In the future, if it is null, the behavior is equivalent to a TasksTypes.FilterSpec with all properties null which means all tasks match the filter.

resultSpec - Specification of what to return for a task. If null, the behavior is equivalent to a TasksTypes.GetSpec with all properties null which means only the data describe in Info will be returned and the result of the operation will be return.

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

list

void list(TasksTypes.FilterSpec filterSpec,
        TasksTypes.GetSpec resultSpec,
        AsyncCallback<java.util.Map<java.lang.String,Info>> asyncCallback,
        InvocationConfig invocationConfig)

Returns information about at most 1000 visible (subject to permission checks) tasks matching the TasksTypes.FilterSpec. All tasks must be in the same provider. This method was added in vSphere API 6.7 U1.

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

Operation Result:
Map of task identifier to information about the task. The key in the return value Map will be an identifier for the resource type: com.vmware.cis.task.

Operation Errors:
InvalidArgument - if any of the specified parameters are invalid.
ResourceInaccessible - if a task's state cannot be accessed or over 1000 tasks matching the TasksTypes.FilterSpec.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

filterSpec - Specification of matching tasks. This is currently required. In the future, if it is null, the behavior is equivalent to a TasksTypes.FilterSpec with all properties null which means all tasks match the filter.

resultSpec - Specification of what to return for a task. If null, the behavior is equivalent to a TasksTypes.GetSpec with all properties null which means only the data describe in Info will be returned and the result of the operation will be return.

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

invocationConfig - Configuration for the method invocation.

cancel

void cancel(java.lang.String task)

Cancel a running operation associated with the task. This is the best effort attempt. Operation may not be cancelled anymore once it reaches certain stage. This method was added in vSphere API 6.7 U1.

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

Parameters:

task - Task identifier. The parameter must be an identifier for the resource type: com.vmware.cis.task.

Throws:

Error - if the system reports an error while responding to the request.

NotAllowedInCurrentState - if the task is already canceled or completed.

NotFound - if the task is not found.

ResourceInaccessible - if the task's state cannot be accessed.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

Unsupported - if the task is not cancelable.

cancel

void cancel(java.lang.String task,
          InvocationConfig invocationConfig)

Cancel a running operation associated with the task. This is the best effort attempt. Operation may not be cancelled anymore once it reaches certain stage. This method was added in vSphere API 6.7 U1.

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:

task - Task identifier. The parameter must be an identifier for the resource type: com.vmware.cis.task.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

NotAllowedInCurrentState - if the task is already canceled or completed.

NotFound - if the task is not found.

ResourceInaccessible - if the task's state cannot be accessed.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

Unsupported - if the task is not cancelable.

cancel

void cancel(java.lang.String task,
          AsyncCallback<java.lang.Void> asyncCallback)

Cancel a running operation associated with the task. This is the best effort attempt. Operation may not be cancelled anymore once it reaches certain stage. This method was added in vSphere API 6.7 U1.

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

Operation Errors:
Error - if the system reports an error while responding to the request.
NotAllowedInCurrentState - if the task is already canceled or completed.
NotFound - if the task is not found.
ResourceInaccessible - if the task's state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unsupported - if the task is not cancelable.

Parameters:

task - Task identifier. The parameter must be an identifier for the resource type: com.vmware.cis.task.

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

cancel

void cancel(java.lang.String task,
          AsyncCallback<java.lang.Void> asyncCallback,
          InvocationConfig invocationConfig)

Cancel a running operation associated with the task. This is the best effort attempt. Operation may not be cancelled anymore once it reaches certain stage. This method was added in vSphere API 6.7 U1.

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 the system reports an error while responding to the request.
NotAllowedInCurrentState - if the task is already canceled or completed.
NotFound - if the task is not found.
ResourceInaccessible - if the task's state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unsupported - if the task is not cancelable.

Parameters:

task - Task identifier. The parameter must be an identifier for the resource type: com.vmware.cis.task.

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

invocationConfig - Configuration for the method invocation.