com.vmware.vmc.draas

Interface Task

All Superinterfaces:

Service, TaskTypes

All Known Implementing Classes:

TaskStub

public interface Task
extends Service, TaskTypes

Field Summary

Fields inherited from interface com.vmware.vmc.draas.TaskTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
Task	get(java.lang.String org, java.lang.String task) Retrieve details of a task.
void	get(java.lang.String org, java.lang.String task, AsyncCallback<Task> asyncCallback) Retrieve details of a task.
void	get(java.lang.String org, java.lang.String task, AsyncCallback<Task> asyncCallback, InvocationConfig invocationConfig) Retrieve details of a task.
Task	get(java.lang.String org, java.lang.String task, InvocationConfig invocationConfig) Retrieve details of a task.
java.util.List<Task>	list(java.lang.String org, java.lang.String filter) List all tasks with optional filtering.
void	list(java.lang.String org, java.lang.String filter, AsyncCallback<java.util.List<Task>> asyncCallback) List all tasks with optional filtering.
void	list(java.lang.String org, java.lang.String filter, AsyncCallback<java.util.List<Task>> asyncCallback, InvocationConfig invocationConfig) List all tasks with optional filtering.
java.util.List<Task>	list(java.lang.String org, java.lang.String filter, InvocationConfig invocationConfig) List all tasks with optional filtering.
Task	update(java.lang.String org, java.lang.String task, java.lang.String action) Request that a running task be canceled.
void	update(java.lang.String org, java.lang.String task, java.lang.String action, AsyncCallback<Task> asyncCallback) Request that a running task be canceled.
void	update(java.lang.String org, java.lang.String task, java.lang.String action, AsyncCallback<Task> asyncCallback, InvocationConfig invocationConfig) Request that a running task be canceled.
Task	update(java.lang.String org, java.lang.String task, java.lang.String action, InvocationConfig invocationConfig) Request that a running task be canceled.

Method Detail

get

Task get(java.lang.String org,
         java.lang.String task)

Retrieve details of a task.

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

Parameters:

org - Organization identifier (required)

task - task identifier (required)

Returns:

com.vmware.vmc.draas.model.Task

Throws:

Unauthenticated - Unauthorized

Unauthorized - Forbidden

NotFound - Cannot find the task with given identifier

get

Task get(java.lang.String org,
         java.lang.String task,
         InvocationConfig invocationConfig)

Retrieve details of 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:

org - Organization identifier (required)

task - task identifier (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.vmc.draas.model.Task

Throws:

Unauthenticated - Unauthorized

Unauthorized - Forbidden

NotFound - Cannot find the task with given identifier

get

void get(java.lang.String org,
         java.lang.String task,
         AsyncCallback<Task> asyncCallback)

Retrieve details of a task.

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

Invocation Result:
com.vmware.vmc.draas.model.Task

Operation Errors:
Unauthenticated - Unauthorized
Unauthorized - Forbidden
NotFound - Cannot find the task with given identifier

Parameters:

org - Organization identifier (required)

task - task identifier (required)

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

get

void get(java.lang.String org,
         java.lang.String task,
         AsyncCallback<Task> asyncCallback,
         InvocationConfig invocationConfig)

Retrieve details of 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:
com.vmware.vmc.draas.model.Task

Operation Errors:
Unauthenticated - Unauthorized
Unauthorized - Forbidden
NotFound - Cannot find the task with given identifier

Parameters:

org - Organization identifier (required)

task - task identifier (required)

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

invocationConfig - Configuration for the method invocation.

list

java.util.List<Task> list(java.lang.String org,
                          java.lang.String filter)

List all tasks with optional filtering.

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

Parameters:

org - Organization identifier (required)

filter - Filter expression Binary Operators: 'eq', 'ne', 'lt', 'gt', 'le', 'ge', 'mul', 'div', 'mod', 'sub', 'add' Unary Operators: 'not', '-' (minus) String Operators: 'startswith', 'endswith', 'length', 'contains', 'tolower', 'toupper', Nested attributes are composed using '.' Dates must be formatted as yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss[.SSS]Z Strings should enclosed in single quotes, escape single quote with two single quotes The special literal 'created' will be mapped to the time the resource was first created. Examples: - $filter=(updated gt 2016-08-09T13:00:00Z) and (org_id eq 278710ff4e-6b6d-4d4e-aefb-ca637f38609e) - $filter=(created eq 2016-08-09) - $filter=(created gt 2016-08-09) and (sddc.status eq 'READY') (optional)

Throws:

Unauthenticated - Unauthorized

Unauthorized - Forbidden

list

java.util.List<Task> list(java.lang.String org,
                          java.lang.String filter,
                          InvocationConfig invocationConfig)

List all tasks with optional filtering.

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:

org - Organization identifier (required)

filter - Filter expression Binary Operators: 'eq', 'ne', 'lt', 'gt', 'le', 'ge', 'mul', 'div', 'mod', 'sub', 'add' Unary Operators: 'not', '-' (minus) String Operators: 'startswith', 'endswith', 'length', 'contains', 'tolower', 'toupper', Nested attributes are composed using '.' Dates must be formatted as yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss[.SSS]Z Strings should enclosed in single quotes, escape single quote with two single quotes The special literal 'created' will be mapped to the time the resource was first created. Examples: - $filter=(updated gt 2016-08-09T13:00:00Z) and (org_id eq 278710ff4e-6b6d-4d4e-aefb-ca637f38609e) - $filter=(created eq 2016-08-09) - $filter=(created gt 2016-08-09) and (sddc.status eq 'READY') (optional)

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - Unauthorized

Unauthorized - Forbidden

list

void list(java.lang.String org,
          java.lang.String filter,
          AsyncCallback<java.util.List<Task>> asyncCallback)

List all tasks with optional filtering.

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

Operation Errors:
Unauthenticated - Unauthorized
Unauthorized - Forbidden

Parameters:

org - Organization identifier (required)

filter - Filter expression Binary Operators: 'eq', 'ne', 'lt', 'gt', 'le', 'ge', 'mul', 'div', 'mod', 'sub', 'add' Unary Operators: 'not', '-' (minus) String Operators: 'startswith', 'endswith', 'length', 'contains', 'tolower', 'toupper', Nested attributes are composed using '.' Dates must be formatted as yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss[.SSS]Z Strings should enclosed in single quotes, escape single quote with two single quotes The special literal 'created' will be mapped to the time the resource was first created. Examples: - $filter=(updated gt 2016-08-09T13:00:00Z) and (org_id eq 278710ff4e-6b6d-4d4e-aefb-ca637f38609e) - $filter=(created eq 2016-08-09) - $filter=(created gt 2016-08-09) and (sddc.status eq 'READY') (optional)

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

list

void list(java.lang.String org,
          java.lang.String filter,
          AsyncCallback<java.util.List<Task>> asyncCallback,
          InvocationConfig invocationConfig)

List all tasks with optional filtering.

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:
Unauthenticated - Unauthorized
Unauthorized - Forbidden

Parameters:

org - Organization identifier (required)

filter - Filter expression Binary Operators: 'eq', 'ne', 'lt', 'gt', 'le', 'ge', 'mul', 'div', 'mod', 'sub', 'add' Unary Operators: 'not', '-' (minus) String Operators: 'startswith', 'endswith', 'length', 'contains', 'tolower', 'toupper', Nested attributes are composed using '.' Dates must be formatted as yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss[.SSS]Z Strings should enclosed in single quotes, escape single quote with two single quotes The special literal 'created' will be mapped to the time the resource was first created. Examples: - $filter=(updated gt 2016-08-09T13:00:00Z) and (org_id eq 278710ff4e-6b6d-4d4e-aefb-ca637f38609e) - $filter=(created eq 2016-08-09) - $filter=(created gt 2016-08-09) and (sddc.status eq 'READY') (optional)

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

invocationConfig - Configuration for the method invocation.

update

Task update(java.lang.String org,
            java.lang.String task,
            java.lang.String action)

Request that a running task be canceled. This is advisory only, some tasks may not be cancelable, and some tasks might take an arbitrary amount of time to respond to a cancelation request. The task must be monitored to determine subsequent status.

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

Parameters:

org - Organization identifier (required)

task - task identifier (required)

action - If = 'cancel', task will be canceled (optional)

Returns:

com.vmware.vmc.draas.model.Task

Throws:

Unauthenticated - Unauthorized

InvalidRequest - Invalid action or bad argument

Unauthorized - Forbidden

NotFound - Cannot find the task with given identifier

update

Task update(java.lang.String org,
            java.lang.String task,
            java.lang.String action,
            InvocationConfig invocationConfig)

Request that a running task be canceled. This is advisory only, some tasks may not be cancelable, and some tasks might take an arbitrary amount of time to respond to a cancelation request. The task must be monitored to determine subsequent status.

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:

org - Organization identifier (required)

task - task identifier (required)

action - If = 'cancel', task will be canceled (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.vmc.draas.model.Task

Throws:

Unauthenticated - Unauthorized

InvalidRequest - Invalid action or bad argument

Unauthorized - Forbidden

NotFound - Cannot find the task with given identifier

update

void update(java.lang.String org,
            java.lang.String task,
            java.lang.String action,
            AsyncCallback<Task> asyncCallback)

Request that a running task be canceled. This is advisory only, some tasks may not be cancelable, and some tasks might take an arbitrary amount of time to respond to a cancelation request. The task must be monitored to determine subsequent status.

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

Invocation Result:
com.vmware.vmc.draas.model.Task

Operation Errors:
Unauthenticated - Unauthorized
InvalidRequest - Invalid action or bad argument
Unauthorized - Forbidden
NotFound - Cannot find the task with given identifier

Parameters:

org - Organization identifier (required)

task - task identifier (required)

action - If = 'cancel', task will be canceled (optional)

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

update

void update(java.lang.String org,
            java.lang.String task,
            java.lang.String action,
            AsyncCallback<Task> asyncCallback,
            InvocationConfig invocationConfig)

Request that a running task be canceled. This is advisory only, some tasks may not be cancelable, and some tasks might take an arbitrary amount of time to respond to a cancelation request. The task must be monitored to determine subsequent status.

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:
com.vmware.vmc.draas.model.Task

Operation Errors:
Unauthenticated - Unauthorized
InvalidRequest - Invalid action or bad argument
Unauthorized - Forbidden
NotFound - Cannot find the task with given identifier

Parameters:

org - Organization identifier (required)

task - task identifier (required)

action - If = 'cancel', task will be canceled (optional)

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

invocationConfig - Configuration for the method invocation.