Package com.azure.resourcemanager.datamigration.models

Interface Tasks

public interface Tasks
Resource collection API of Tasks.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<ProjectTask> list(String groupName, String serviceName, String projectName)
      Get tasks in a service

      The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of tasks owned by a service resource. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      projectName - Name of the project.
      Returns:
      oData page of tasks as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<ProjectTask> list(String groupName, String serviceName, String projectName, String taskType, com.azure.core.util.Context context)
      Get tasks in a service

      The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of tasks owned by a service resource. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      projectName - Name of the project.
      taskType - Filter tasks by task type.
      context - The context to associate with this operation.
      Returns:
      oData page of tasks as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      com.azure.core.http.rest.Response<ProjectTask> getWithResponse(String groupName, String serviceName, String projectName, String taskName, String expand, com.azure.core.util.Context context)
      Get task information

      The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The GET method retrieves information about a task.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      projectName - Name of the project.
      taskName - Name of the Task.
      expand - Expand the response.
      context - The context to associate with this operation.
      Returns:
      a task resource along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      ProjectTask get(String groupName, String serviceName, String projectName, String taskName)
      Get task information

      The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The GET method retrieves information about a task.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      projectName - Name of the project.
      taskName - Name of the Task.
      Returns:
      a task resource.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String groupName, String serviceName, String projectName, String taskName, Boolean deleteRunningTasks, com.azure.core.util.Context context)
      Delete task

      The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The DELETE method deletes a task, canceling it first if it's running.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      projectName - Name of the project.
      taskName - Name of the Task.
      deleteRunningTasks - Delete the resource even if it contains running tasks.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String groupName, String serviceName, String projectName, String taskName)
      Delete task

      The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The DELETE method deletes a task, canceling it first if it's running.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      projectName - Name of the project.
      taskName - Name of the Task.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • cancelWithResponse

      com.azure.core.http.rest.Response<ProjectTask> cancelWithResponse(String groupName, String serviceName, String projectName, String taskName, com.azure.core.util.Context context)
      Cancel a task

      The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. This method cancels a task if it's currently queued or running.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      projectName - Name of the project.
      taskName - Name of the Task.
      context - The context to associate with this operation.
      Returns:
      a task resource along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • cancel

      ProjectTask cancel(String groupName, String serviceName, String projectName, String taskName)
      Cancel a task

      The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. This method cancels a task if it's currently queued or running.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      projectName - Name of the project.
      taskName - Name of the Task.
      Returns:
      a task resource.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getById

      ProjectTask getById(String id)
      Get task information

      The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The GET method retrieves information about a task.

      Parameters:
      id - the resource ID.
      Returns:
      a task resource along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<ProjectTask> getByIdWithResponse(String id, String expand, com.azure.core.util.Context context)
      Get task information

      The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The GET method retrieves information about a task.

      Parameters:
      id - the resource ID.
      expand - Expand the response.
      context - The context to associate with this operation.
      Returns:
      a task resource along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteById

      void deleteById(String id)
      Delete task

      The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The DELETE method deletes a task, canceling it first if it's running.

      Parameters:
      id - the resource ID.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteByIdWithResponse

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, Boolean deleteRunningTasks, com.azure.core.util.Context context)
      Delete task

      The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The DELETE method deletes a task, canceling it first if it's running.

      Parameters:
      id - the resource ID.
      deleteRunningTasks - Delete the resource even if it contains running tasks.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • define

      ProjectTask.DefinitionStages.Blank define(String name)
      Begins definition for a new ProjectTask resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new ProjectTask definition.