Package com.azure.resourcemanager.machinelearning.models

Interface Jobs

public interface Jobs

Resource collection API of Jobs.

Method Summary

Modifier and Type	Method	Description
void	cancel(String resourceGroupName, String workspaceName, String id)	Cancels a Job.
com.azure.core.http.rest.Response<Void>	cancelWithResponse(String resourceGroupName, String workspaceName, String id, com.azure.core.util.Context context)	Cancels a Job.
JobBaseData.DefinitionStages.Blank	define(String name)	Begins definition for a new JobBaseData resource.
void	delete(String resourceGroupName, String workspaceName, String id)	Deletes a Job (asynchronous).
void	delete(String resourceGroupName, String workspaceName, String id, com.azure.core.util.Context context)	Deletes a Job (asynchronous).
void	deleteById(String id)	Deletes a Job (asynchronous).
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a Job (asynchronous).
JobBaseData	get(String resourceGroupName, String workspaceName, String id)	Gets a Job by name/id.
JobBaseData	getById(String id)	Gets a Job by name/id.
com.azure.core.http.rest.Response<JobBaseData>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets a Job by name/id.
com.azure.core.http.rest.Response<JobBaseData>	getWithResponse(String resourceGroupName, String workspaceName, String id, com.azure.core.util.Context context)	Gets a Job by name/id.
com.azure.core.http.rest.PagedIterable<JobBaseData>	list(String resourceGroupName, String workspaceName)	Lists Jobs in the workspace.
com.azure.core.http.rest.PagedIterable<JobBaseData>	list(String resourceGroupName, String workspaceName, String skip, String jobType, String tag, ListViewType listViewType, Boolean scheduled, String scheduleId, com.azure.core.util.Context context)	Lists Jobs in the workspace.

Method Detail

list

com.azure.core.http.rest.PagedIterable<JobBaseData> list(String resourceGroupName,
                                                         String workspaceName)

Lists Jobs in the workspace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - Name of Azure Machine Learning workspace.

Returns:

a paginated list of JobBase entities 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<JobBaseData> list(String resourceGroupName,
                                                         String workspaceName,
                                                         String skip,
                                                         String jobType,
                                                         String tag,
                                                         ListViewType listViewType,
                                                         Boolean scheduled,
                                                         String scheduleId,
                                                         com.azure.core.util.Context context)

Lists Jobs in the workspace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - Name of Azure Machine Learning workspace.

skip - Continuation token for pagination.

jobType - Type of job to be returned.

tag - Jobs returned will have this tag key.

listViewType - View type for including/excluding (for example) archived entities.

scheduled - Indicator whether the job is scheduled job.

scheduleId - The scheduled id for listing the job triggered from.

context - The context to associate with this operation.

Returns:

a paginated list of JobBase entities 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.

delete

void delete(String resourceGroupName,
            String workspaceName,
            String id)

Deletes a Job (asynchronous).

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - Name of Azure Machine Learning workspace.

id - The name and identifier for the Job. This is case-sensitive.

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 resourceGroupName,
            String workspaceName,
            String id,
            com.azure.core.util.Context context)

Deletes a Job (asynchronous).

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - Name of Azure Machine Learning workspace.

id - The name and identifier for the Job. This is case-sensitive.

context - The context to associate with this operation.

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

JobBaseData get(String resourceGroupName,
                String workspaceName,
                String id)

Gets a Job by name/id.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - Name of Azure Machine Learning workspace.

id - The name and identifier for the Job. This is case-sensitive.

Returns:

a Job by name/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.

getWithResponse

com.azure.core.http.rest.Response<JobBaseData> getWithResponse(String resourceGroupName,
                                                               String workspaceName,
                                                               String id,
                                                               com.azure.core.util.Context context)

Gets a Job by name/id.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - Name of Azure Machine Learning workspace.

id - The name and identifier for the Job. This is case-sensitive.

context - The context to associate with this operation.

Returns:

a Job by name/id 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

void cancel(String resourceGroupName,
            String workspaceName,
            String id)

Cancels a Job.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - Name of Azure Machine Learning workspace.

id - The name and identifier for the Job. This is case-sensitive.

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<Void> cancelWithResponse(String resourceGroupName,
                                                           String workspaceName,
                                                           String id,
                                                           com.azure.core.util.Context context)

Cancels a Job.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - Name of Azure Machine Learning workspace.

id - The name and identifier for the Job. This is case-sensitive.

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.

getById

JobBaseData getById(String id)

Gets a Job by name/id.

Parameters:

id - the resource ID.

Returns:

a Job by name/id 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<JobBaseData> getByIdWithResponse(String id,
                                                                   com.azure.core.util.Context context)

Gets a Job by name/id.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

a Job by name/id 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)

Deletes a Job (asynchronous).

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

void deleteByIdWithResponse(String id,
                            com.azure.core.util.Context context)

Deletes a Job (asynchronous).

Parameters:

id - the resource ID.

context - The context to associate with this operation.

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

JobBaseData.DefinitionStages.Blank define(String name)

Begins definition for a new JobBaseData resource.

Parameters:

name - resource name.

Returns:

the first stage of the new JobBaseData definition.