com.vmware.cis

Class TasksStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.cis.TasksStub

All Implemented Interfaces:

Tasks, TasksTypes, Service

public class TasksStub
extends com.vmware.vapi.internal.bindings.Stub
implements Tasks

Remote stub implementation of the Tasks API service.

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

Nested Class Summary

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

TasksTypes.FilterSpec, TasksTypes.GetSpec

Field Summary

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

apiProvider, converter, ifaceId, securityContext

Fields inherited from interface com.vmware.cis.TasksTypes

RESOURCE_TYPE

Constructor Summary

Constructors

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

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.

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

TasksStub

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

TasksStub

public TasksStub(ApiProvider apiProvider,
         StubConfigurationBase config)

Method Detail

get

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

Description copied from interface: Tasks

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.

Specified by:

get in interface Tasks

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.

get

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

Description copied from interface: Tasks

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.

Specified by:

get in interface Tasks

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.

get

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

Description copied from interface: Tasks

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.

Specified by:

get in interface Tasks

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

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

Description copied from interface: Tasks

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.

Specified by:

get in interface Tasks

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

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

Description copied from interface: Tasks

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.

Specified by:

list in interface Tasks

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.

list

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

Description copied from interface: Tasks

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.

Specified by:

list in interface Tasks

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.

list

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

Description copied from interface: Tasks

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.

Specified by:

list in interface Tasks

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

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

Description copied from interface: Tasks

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.

Specified by:

list in interface Tasks

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

public void cancel(java.lang.String task)

Description copied from interface: Tasks

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.

Specified by:

cancel in interface Tasks

Parameters:

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

cancel

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

Description copied from interface: Tasks

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.

Specified by:

cancel in interface Tasks

Parameters:

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

invocationConfig - Configuration for the method invocation.

cancel

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

Description copied from interface: Tasks

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.

Specified by:

cancel in interface Tasks

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

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

Description copied from interface: Tasks

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.

Specified by:

cancel in interface Tasks

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.