Package com.vmware.nsx_policy

Class 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

    • Constructor Summary

      Constructors 
      Constructor 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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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

      • 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

      • get

        public TaskProperties get​(java.lang.String taskId)
        Description copied from interface: Tasks
        Get information about the specified task

        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)
        Returns:
        com.vmware.nsx_policy.model.TaskProperties

      • get

        public TaskProperties get​(java.lang.String taskId,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Tasks
        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.

        Specified by:
        get in interface Tasks
        Parameters:
        taskId - ID of task to read (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.TaskProperties

      • get

        public void get​(java.lang.String taskId,
                com.vmware.vapi.bindings.client.AsyncCallback<TaskProperties> asyncCallback)
        Description copied from interface: Tasks
        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_policy.model.TaskProperties

        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)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • get

        public void get​(java.lang.String taskId,
                com.vmware.vapi.bindings.client.AsyncCallback<TaskProperties> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Tasks
        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_policy.model.TaskProperties

        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)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • list

        public 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)
        Description copied from interface: Tasks
        Get information about all tasks

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

        Specified by:
        list in interface Tasks
        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_policy.model.TaskListResult

      • list

        public 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)
        Description copied from interface: Tasks
        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.

        Specified by:
        list in interface Tasks
        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_policy.model.TaskListResult

      • list

        public 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)
        Description copied from interface: Tasks
        Get information about all tasks

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

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

        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:
        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

        public 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)
        Description copied from interface: Tasks
        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_policy.model.TaskListResult

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