com.vmware.nsx

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

Field Summary

Fields inherited from interface com.vmware.nsx.TasksTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
TaskProperties	get(java.lang.String taskId) Get information about the specified task
void	get(java.lang.String taskId, com.vmware.vapi.bindings.client.AsyncCallback<TaskProperties> asyncCallback) Get information about the specified task
void	get(java.lang.String taskId, com.vmware.vapi.bindings.client.AsyncCallback<TaskProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get information about the specified task
TaskProperties	get(java.lang.String taskId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get information about the specified task
TaskListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String requestUri, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String status, java.lang.String user) Get information about all tasks
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String requestUri, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String status, java.lang.String user, com.vmware.vapi.bindings.client.AsyncCallback<TaskListResult> asyncCallback) Get information about all tasks
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String requestUri, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String status, java.lang.String user, com.vmware.vapi.bindings.client.AsyncCallback<TaskListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get information about all tasks
TaskListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String requestUri, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String status, java.lang.String user, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get information about all tasks

Method Detail

get

TaskProperties get(java.lang.String taskId)

Get information about the specified task

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

Parameters:

taskId - ID of task to read (required)

Returns:

com.vmware.nsx.model.TaskProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

TaskProperties get(java.lang.String taskId,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get information about the specified 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:

taskId - ID of task to read (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.TaskProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

void get(java.lang.String taskId,
         com.vmware.vapi.bindings.client.AsyncCallback<TaskProperties> asyncCallback)

Get information about the specified task

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

Invocation Result:
com.vmware.nsx.model.TaskProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

taskId - ID of task to read (required)

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

get

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

Get information about the specified 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.nsx.model.TaskProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

taskId - ID of task to read (required)

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

invocationConfig - Configuration for the method invocation.

list

TaskListResult list(java.lang.String cursor,
                    java.lang.String includedFields,
                    java.lang.Long pageSize,
                    java.lang.String requestUri,
                    java.lang.Boolean sortAscending,
                    java.lang.String sortBy,
                    java.lang.String status,
                    java.lang.String user)

Get information about all tasks

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

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

requestUri - Request URI(s) to include in query result (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

status - Status(es) to include in query result (optional)

user - Names of users to include in query result (optional)

Returns:

com.vmware.nsx.model.TaskListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

TaskListResult list(java.lang.String cursor,
                    java.lang.String includedFields,
                    java.lang.Long pageSize,
                    java.lang.String requestUri,
                    java.lang.Boolean sortAscending,
                    java.lang.String sortBy,
                    java.lang.String status,
                    java.lang.String user,
                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get information about all tasks

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:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

requestUri - Request URI(s) to include in query result (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

status - Status(es) to include in query result (optional)

user - Names of users to include in query result (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.TaskListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

void list(java.lang.String cursor,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.String requestUri,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String status,
          java.lang.String user,
          com.vmware.vapi.bindings.client.AsyncCallback<TaskListResult> asyncCallback)

Get information about all tasks

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

Invocation Result:
com.vmware.nsx.model.TaskListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

requestUri - Request URI(s) to include in query result (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

status - Status(es) to include in query result (optional)

user - Names of users to include in query result (optional)

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

list

void list(java.lang.String cursor,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.String requestUri,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String status,
          java.lang.String user,
          com.vmware.vapi.bindings.client.AsyncCallback<TaskListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get information about all tasks

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.nsx.model.TaskListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

requestUri - Request URI(s) to include in query result (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

status - Status(es) to include in query result (optional)

user - Names of users to include in query result (optional)

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

invocationConfig - Configuration for the method invocation.