Interface TasksClient
-
Method Summary
Modifier and TypeMethodDescriptionCancel a taskcom.azure.core.http.rest.Response<ProjectTaskInner>
cancelWithResponse
(String groupName, String serviceName, String projectName, String taskName, com.azure.core.util.Context context) Cancel a taskcreateOrUpdate
(String groupName, String serviceName, String projectName, String taskName, ProjectTaskInner parameters) Create or update taskcom.azure.core.http.rest.Response<ProjectTaskInner>
createOrUpdateWithResponse
(String groupName, String serviceName, String projectName, String taskName, ProjectTaskInner parameters, com.azure.core.util.Context context) Create or update taskvoid
Delete taskcom.azure.core.http.rest.Response<Void>
deleteWithResponse
(String groupName, String serviceName, String projectName, String taskName, Boolean deleteRunningTasks, com.azure.core.util.Context context) Delete taskGet task informationcom.azure.core.http.rest.Response<ProjectTaskInner>
getWithResponse
(String groupName, String serviceName, String projectName, String taskName, String expand, com.azure.core.util.Context context) Get task informationcom.azure.core.http.rest.PagedIterable<ProjectTaskInner>
Get tasks in a servicecom.azure.core.http.rest.PagedIterable<ProjectTaskInner>
list
(String groupName, String serviceName, String projectName, String taskType, com.azure.core.util.Context context) Get tasks in a serviceupdate
(String groupName, String serviceName, String projectName, String taskName, ProjectTaskInner parameters) Create or update taskcom.azure.core.http.rest.Response<ProjectTaskInner>
updateWithResponse
(String groupName, String serviceName, String projectName, String taskName, ProjectTaskInner parameters, com.azure.core.util.Context context) Create or update task
-
Method Details
-
list
com.azure.core.http.rest.PagedIterable<ProjectTaskInner> list(String groupName, String serviceName, String projectName) Get tasks in a serviceThe 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<ProjectTaskInner> list(String groupName, String serviceName, String projectName, String taskType, com.azure.core.util.Context context) Get tasks in a serviceThe 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.
-
createOrUpdateWithResponse
com.azure.core.http.rest.Response<ProjectTaskInner> createOrUpdateWithResponse(String groupName, String serviceName, String projectName, String taskName, ProjectTaskInner parameters, com.azure.core.util.Context context) Create or update taskThe tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an existing one.
- Parameters:
groupName
- Name of the resource group.serviceName
- Name of the service.projectName
- Name of the project.taskName
- Name of the Task.parameters
- Information about 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.
-
createOrUpdate
ProjectTaskInner createOrUpdate(String groupName, String serviceName, String projectName, String taskName, ProjectTaskInner parameters) Create or update taskThe tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an existing one.
- Parameters:
groupName
- Name of the resource group.serviceName
- Name of the service.projectName
- Name of the project.taskName
- Name of the Task.parameters
- Information about 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.
-
getWithResponse
com.azure.core.http.rest.Response<ProjectTaskInner> getWithResponse(String groupName, String serviceName, String projectName, String taskName, String expand, com.azure.core.util.Context context) Get task informationThe 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
Get task informationThe 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 taskThe 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
Delete taskThe 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.
-
updateWithResponse
com.azure.core.http.rest.Response<ProjectTaskInner> updateWithResponse(String groupName, String serviceName, String projectName, String taskName, ProjectTaskInner parameters, com.azure.core.util.Context context) Create or update taskThe tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PATCH method updates an existing task, but since tasks have no mutable custom properties, there is little reason to do so.
- Parameters:
groupName
- Name of the resource group.serviceName
- Name of the service.projectName
- Name of the project.taskName
- Name of the Task.parameters
- Information about 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.
-
update
ProjectTaskInner update(String groupName, String serviceName, String projectName, String taskName, ProjectTaskInner parameters) Create or update taskThe tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PATCH method updates an existing task, but since tasks have no mutable custom properties, there is little reason to do so.
- Parameters:
groupName
- Name of the resource group.serviceName
- Name of the service.projectName
- Name of the project.taskName
- Name of the Task.parameters
- Information about 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.
-
cancelWithResponse
com.azure.core.http.rest.Response<ProjectTaskInner> cancelWithResponse(String groupName, String serviceName, String projectName, String taskName, com.azure.core.util.Context context) Cancel a taskThe 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
Cancel a taskThe 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.
-