Tasks Interface

Package:

com.azure.resourcemanager.datamigration.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-datamigration:1.1.0-beta.1

public interface Tasks

Resource collection API of Tasks.

Method Summary

Modifier and Type	Method and Description
abstract 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 (classic) instance.
abstract Response<ProjectTask>	cancelWithResponse(String groupName, String serviceName, String projectName, String taskName, Context context) Cancel a task The tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance.
abstract CommandProperties	command(String groupName, String serviceName, String projectName, String taskName, CommandPropertiesInner parameters) Execute a command on a task The tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance.
abstract Response<CommandProperties>	commandWithResponse(String groupName, String serviceName, String projectName, String taskName, CommandPropertiesInner parameters, Context context) Execute a command on a task The tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance.
abstract Blank	define(String name) Begins definition for a new ProjectTask resource.
abstract 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 (classic) instance.
abstract void	deleteById(String id) Delete task The tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance.
abstract Response<Void>	deleteByIdWithResponse(String id, Boolean deleteRunningTasks, Context context) Delete task The tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance.
abstract Response<Void>	deleteWithResponse(String groupName, String serviceName, String projectName, String taskName, Boolean deleteRunningTasks, Context context) Delete task The tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance.
abstract 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 (classic) instance.
abstract ProjectTask	getById(String id) Get task information The tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance.
abstract Response<ProjectTask>	getByIdWithResponse(String id, String expand, Context context) Get task information The tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance.
abstract Response<ProjectTask>	getWithResponse(String groupName, String serviceName, String projectName, String taskName, String expand, Context context) Get task information The tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance.
abstract 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 Azure Database Migration Service (classic).
abstract PagedIterable<ProjectTask>	list(String groupName, String serviceName, String projectName, String taskType, Context context) Get tasks in a service The services resource is the top-level resource that represents the Azure Database Migration Service (classic).

Method Details

cancel

public abstract 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 (classic) 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.

cancelWithResponse

public abstract Response<ProjectTask> cancelWithResponse(String groupName, String serviceName, String projectName, String taskName, Context context)

Cancel a task The tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) 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<T>.

command

public abstract CommandProperties command(String groupName, String serviceName, String projectName, String taskName, CommandPropertiesInner parameters)

Execute a command on a task The tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance. This method executes a command on a running task.

Parameters:

groupName - Name of the resource group.

serviceName - Name of the service.

projectName - Name of the project.

taskName - Name of the Task.

parameters - Command to execute.

Returns:

base class for all types of DMS (classic) command properties.

commandWithResponse

public abstract Response<CommandProperties> commandWithResponse(String groupName, String serviceName, String projectName, String taskName, CommandPropertiesInner parameters, Context context)

Execute a command on a task The tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance. This method executes a command on a running task.

Parameters:

groupName - Name of the resource group.

serviceName - Name of the service.

projectName - Name of the project.

taskName - Name of the Task.

parameters - Command to execute.

context - The context to associate with this operation.

Returns:

base class for all types of DMS (classic) command properties along with Response<T>.

define

public abstract 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.

delete

public abstract 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 (classic) 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.

deleteById

public abstract void deleteById(String id)

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

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response<Void> deleteByIdWithResponse(String id, Boolean deleteRunningTasks, Context context)

Delete task The tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) 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<T>.

deleteWithResponse

public abstract Response<Void> deleteWithResponse(String groupName, String serviceName, String projectName, String taskName, Boolean deleteRunningTasks, Context context)

Delete task The tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) 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<T>.

get

public abstract 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 (classic) 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.

getById

public abstract ProjectTask getById(String id)

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

Parameters:

id - the resource ID.

Returns:

a task resource along with Response<T>.

getByIdWithResponse

public abstract Response<ProjectTask> getByIdWithResponse(String id, String expand, Context context)

Get task information The tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) 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<T>.

getWithResponse

public abstract Response<ProjectTask> getWithResponse(String groupName, String serviceName, String projectName, String taskName, String expand, Context context)

Get task information The tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) 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<T>.

list

public abstract 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 Azure Database Migration Service (classic). 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<T>.

list

public abstract PagedIterable<ProjectTask> list(String groupName, String serviceName, String projectName, String taskType, Context context)

Get tasks in a service The services resource is the top-level resource that represents the Azure Database Migration Service (classic). 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<T>.