com.vmware.nsx.node

Class TasksStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.node.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.

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.nsx.node.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
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

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

cancel

public void cancel(java.lang.String taskId)

Description copied from interface: Tasks

Cancel specified task

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

Specified by:

cancel in interface Tasks

Parameters:

taskId - ID of task to delete (required)

cancel

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

Description copied from interface: Tasks

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.

Specified by:

cancel in interface Tasks

Parameters:

taskId - ID of task to delete (required)

invocationConfig - Configuration for the method invocation.

cancel

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

Description copied from interface: Tasks

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

Specified by:

cancel in interface Tasks

Parameters:

taskId - ID of task to delete (required)

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

cancel

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

Description copied from interface: Tasks

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

Specified by:

cancel in interface Tasks

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

public void delete(java.lang.String taskId)

Description copied from interface: Tasks

Delete task

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

Specified by:

delete in interface Tasks

Parameters:

taskId - ID of task to delete (required)

delete

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

Description copied from interface: Tasks

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.

Specified by:

delete in interface Tasks

Parameters:

taskId - ID of task to delete (required)

invocationConfig - Configuration for the method invocation.

delete

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

Description copied from interface: Tasks

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

Specified by:

delete in interface Tasks

Parameters:

taskId - ID of task to delete (required)

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

delete

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

Description copied from interface: Tasks

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

Specified by:

delete in interface Tasks

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

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

Description copied from interface: Tasks

Read task properties

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

Specified by:

get in interface Tasks

Parameters:

taskId - ID of task to read (required)

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

Returns:

com.vmware.nsx.model.ApplianceManagementTaskProperties

get

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

Description copied from interface: Tasks

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.

Specified by:

get in interface Tasks

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

get

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

Description copied from interface: Tasks

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

Specified by:

get in interface Tasks

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

public 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)

Description copied from interface: Tasks

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

Specified by:

get in interface Tasks

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

public 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)

Description copied from interface: Tasks

List appliance management tasks

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

Specified by:

list in interface Tasks

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

list

public 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)

Description copied from interface: Tasks

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.

Specified by:

list in interface Tasks

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

list

public 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)

Description copied from interface: Tasks

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

Specified by:

list in interface Tasks

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

public 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)

Description copied from interface: Tasks

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

Specified by:

list in interface Tasks

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.