com.vmware.nsx.node

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.node.TasksTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	cancel(java.lang.String taskId) Cancel specified task
void	cancel(java.lang.String taskId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Cancel specified task
void	cancel(java.lang.String taskId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Cancel specified task
void	cancel(java.lang.String taskId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Cancel specified task
void	delete(java.lang.String taskId) Delete task
void	delete(java.lang.String taskId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete task
void	delete(java.lang.String taskId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete task
void	delete(java.lang.String taskId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete task
ApplianceManagementTaskProperties	get(java.lang.String taskId, java.lang.Boolean suppressRedirect) Read task properties
void	get(java.lang.String taskId, java.lang.Boolean suppressRedirect, com.vmware.vapi.bindings.client.AsyncCallback<ApplianceManagementTaskProperties> asyncCallback) Read task properties
void	get(java.lang.String taskId, java.lang.Boolean suppressRedirect, com.vmware.vapi.bindings.client.AsyncCallback<ApplianceManagementTaskProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read task properties
ApplianceManagementTaskProperties	get(java.lang.String taskId, java.lang.Boolean suppressRedirect, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read task properties
ApplianceManagementTaskListResult	list(java.lang.String fields, java.lang.String requestMethod, java.lang.String requestPath, java.lang.String requestUri, java.lang.String status, java.lang.String user) List appliance management tasks
void	list(java.lang.String fields, java.lang.String requestMethod, java.lang.String requestPath, java.lang.String requestUri, java.lang.String status, java.lang.String user, com.vmware.vapi.bindings.client.AsyncCallback<ApplianceManagementTaskListResult> asyncCallback) List appliance management tasks
void	list(java.lang.String fields, java.lang.String requestMethod, java.lang.String requestPath, java.lang.String requestUri, java.lang.String status, java.lang.String user, com.vmware.vapi.bindings.client.AsyncCallback<ApplianceManagementTaskListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List appliance management tasks
ApplianceManagementTaskListResult	list(java.lang.String fields, java.lang.String requestMethod, java.lang.String requestPath, java.lang.String requestUri, java.lang.String status, java.lang.String user, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List appliance management tasks

Method Detail

cancel

void cancel(java.lang.String taskId)

Cancel specified task

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

Parameters:

taskId - ID of task to delete (required)

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

cancel

void cancel(java.lang.String taskId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Cancel 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 delete (required)

invocationConfig - Configuration for the method invocation.

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

cancel

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

Cancel specified task

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

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 delete (required)

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

cancel

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

Cancel 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.

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 delete (required)

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String taskId)

Delete task

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

Parameters:

taskId - ID of task to delete (required)

Throws:

com.vmware.vapi.std.errors.ConcurrentChange - Conflict

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

delete

void delete(java.lang.String taskId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete 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 delete (required)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.ConcurrentChange - Conflict

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

delete

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

Delete task

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

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

Parameters:

taskId - ID of task to delete (required)

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

delete

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

Delete task

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:
ConcurrentChange - Conflict
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

taskId - ID of task to delete (required)

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

invocationConfig - Configuration for the method invocation.

get

ApplianceManagementTaskProperties get(java.lang.String taskId,
                                      java.lang.Boolean suppressRedirect)

Read task properties

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

Parameters:

taskId - ID of task to read (required)

suppressRedirect - Suppress redirect status if applicable (optional, default to false)

Returns:

com.vmware.nsx.model.ApplianceManagementTaskProperties

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

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

Read task properties

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)

suppressRedirect - Suppress redirect status if applicable (optional, default to false)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ApplianceManagementTaskProperties

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,
         java.lang.Boolean suppressRedirect,
         com.vmware.vapi.bindings.client.AsyncCallback<ApplianceManagementTaskProperties> asyncCallback)

Read task properties

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

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

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)

suppressRedirect - Suppress redirect status if applicable (optional, default to false)

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

get

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

Read task properties

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.ApplianceManagementTaskProperties

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)

suppressRedirect - Suppress redirect status if applicable (optional, default to false)

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

invocationConfig - Configuration for the method invocation.

list

ApplianceManagementTaskListResult list(java.lang.String fields,
                                       java.lang.String requestMethod,
                                       java.lang.String requestPath,
                                       java.lang.String requestUri,
                                       java.lang.String status,
                                       java.lang.String user)

List appliance management tasks

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

Parameters:

fields - Fields to include in query results (optional)

requestMethod - Request method(s) to include in query result (optional)

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

requestUri - Request URI(s) to include in query result (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.ApplianceManagementTaskListResult

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

ApplianceManagementTaskListResult list(java.lang.String fields,
                                       java.lang.String requestMethod,
                                       java.lang.String requestPath,
                                       java.lang.String requestUri,
                                       java.lang.String status,
                                       java.lang.String user,
                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List appliance management 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:

fields - Fields to include in query results (optional)

requestMethod - Request method(s) to include in query result (optional)

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

requestUri - Request URI(s) to include in query result (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.ApplianceManagementTaskListResult

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 fields,
          java.lang.String requestMethod,
          java.lang.String requestPath,
          java.lang.String requestUri,
          java.lang.String status,
          java.lang.String user,
          com.vmware.vapi.bindings.client.AsyncCallback<ApplianceManagementTaskListResult> asyncCallback)

List appliance management tasks

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

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

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

Parameters:

fields - Fields to include in query results (optional)

requestMethod - Request method(s) to include in query result (optional)

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

requestUri - Request URI(s) to include in query result (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 fields,
          java.lang.String requestMethod,
          java.lang.String requestPath,
          java.lang.String requestUri,
          java.lang.String status,
          java.lang.String user,
          com.vmware.vapi.bindings.client.AsyncCallback<ApplianceManagementTaskListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List appliance management 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.ApplianceManagementTaskListResult

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

Parameters:

fields - Fields to include in query results (optional)

requestMethod - Request method(s) to include in query result (optional)

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

requestUri - Request URI(s) to include in query result (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.