com.vmware.snapservice

Class TasksStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.snapservice.TasksStub

All Implemented Interfaces:

Tasks, TasksTypes, com.vmware.vapi.bindings.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.snapservice.TasksTypes

TasksTypes.FilterSpec, TasksTypes.ListItem, TasksTypes.ListResult

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.snapservice.TasksTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

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.

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

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TasksStub

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

TasksStub

public TasksStub(com.vmware.vapi.core.ApiProvider apiProvider,
                 com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

list

public TasksTypes.ListResult list(TasksTypes.FilterSpec filter)

Description copied from interface: Tasks

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.

Specified by:

list in interface Tasks

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.

list

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

Description copied from interface: Tasks

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.

Specified by:

list in interface Tasks

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.

list

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

Description copied from interface: Tasks

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.

Specified by:

list in interface Tasks

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

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

Description copied from interface: Tasks

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.

Specified by:

list in interface Tasks

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

public Info get(java.lang.String task)

Description copied from interface: Tasks

Returns information about a task.

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

Returns:

Information about the specified task.

get

public Info get(java.lang.String task,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Tasks

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.

Specified by:

get in interface Tasks

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.

get

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

Description copied from interface: Tasks

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.

Specified by:

get in interface Tasks

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

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

Description copied from interface: Tasks

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.

Specified by:

get in interface Tasks

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.