com.vmware.snapservice

Interface Tasks

All Superinterfaces:

com.vmware.vapi.bindings.Service, TasksTypes

All Known Implementing Classes:

TasksStub

public interface Tasks
extends com.vmware.vapi.bindings.Service, TasksTypes

The Tasks interface provides methods for managing the tasks related to long running operations.

Nested Class Summary

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

TasksTypes.FilterSpec, TasksTypes.ListItem, TasksTypes.ListResult

Field Summary

Fields inherited from interface com.vmware.snapservice.TasksTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
Info	get(java.lang.String task) Returns information about a task.
void	get(java.lang.String task, com.vmware.vapi.bindings.client.AsyncCallback<Info> asyncCallback) Returns information about a task.
void	get(java.lang.String task, com.vmware.vapi.bindings.client.AsyncCallback<Info> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a task.
Info	get(java.lang.String task, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a task.
TasksTypes.ListResult	list(TasksTypes.FilterSpec filter) Returns information about at most 1000 visible (subject to permission checks) tasks matching the TasksTypes.FilterSpec.
void	list(TasksTypes.FilterSpec filter, com.vmware.vapi.bindings.client.AsyncCallback<TasksTypes.ListResult> asyncCallback) Returns information about at most 1000 visible (subject to permission checks) tasks matching the TasksTypes.FilterSpec.
void	list(TasksTypes.FilterSpec filter, com.vmware.vapi.bindings.client.AsyncCallback<TasksTypes.ListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) tasks matching the TasksTypes.FilterSpec.
TasksTypes.ListResult	list(TasksTypes.FilterSpec filter, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) tasks matching the TasksTypes.FilterSpec.

Method Detail

list

TasksTypes.ListResult list(TasksTypes.FilterSpec filter)

Returns information about at most 1000 visible (subject to permission checks) tasks matching the TasksTypes.FilterSpec.

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

Parameters:

filter - Specification of matching tasks. if null, the behavior is equivalent to a TasksTypes.FilterSpec with all properties null which means all tasks match the filter.

Returns:

ListResult including details of all the tasks.

Throws:

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

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

TasksTypes.ListResult list(TasksTypes.FilterSpec filter,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about at most 1000 visible (subject to permission checks) tasks matching the TasksTypes.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.

Parameters:

filter - Specification of matching tasks. if null, the behavior is equivalent to a TasksTypes.FilterSpec with all properties null which means all tasks match the filter.

invocationConfig - Configuration for the method invocation.

Returns:

ListResult including details of all the tasks.

Throws:

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

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 filter,
          com.vmware.vapi.bindings.client.AsyncCallback<TasksTypes.ListResult> asyncCallback)

Returns information about at most 1000 visible (subject to permission checks) tasks matching the TasksTypes.FilterSpec.

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

Invocation Result:
ListResult including details of all the tasks.

Operation Errors:
Error - if the system reports an error while responding to the request.
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:

filter - Specification of matching tasks. if null, the behavior is equivalent to a TasksTypes.FilterSpec with all properties null which means all tasks match the filter.

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

list

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

Returns information about at most 1000 visible (subject to permission checks) tasks matching the TasksTypes.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:
ListResult including details of all the tasks.

Operation Errors:
Error - if the system reports an error while responding to the request.
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:

filter - Specification of matching tasks. if null, the behavior is equivalent to a TasksTypes.FilterSpec with all properties null which means all tasks match the filter.

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

invocationConfig - Configuration for the method invocation.

get

Info get(java.lang.String task)

Returns information about a task.

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.snapservice.task.

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,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about a task.

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.snapservice.task.

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,
         com.vmware.vapi.bindings.client.AsyncCallback<Info> asyncCallback)

Returns information about a task.

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

Invocation 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.snapservice.task.

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

get

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

Returns information about a task.

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 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.snapservice.task.

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

invocationConfig - Configuration for the method invocation.