Interface JobsClient
-
public interface JobsClient
An instance of this class provides access to all the operations defined in JobsClient.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
beginDelete(String resourceGroupName, String workspaceName, String id)
Deletes a Job (asynchronous).com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
beginDelete(String resourceGroupName, String workspaceName, String id, com.azure.core.util.Context context)
Deletes a Job (asynchronous).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.JobBaseDataInner
createOrUpdate(String resourceGroupName, String workspaceName, String id, JobBaseDataInner body)
Creates and executes a Job.com.azure.core.http.rest.Response<JobBaseDataInner>
createOrUpdateWithResponse(String resourceGroupName, String workspaceName, String id, JobBaseDataInner body, com.azure.core.util.Context context)
Creates and executes a Job.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).JobBaseDataInner
get(String resourceGroupName, String workspaceName, String id)
Gets a Job by name/id.com.azure.core.http.rest.Response<JobBaseDataInner>
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<JobBaseDataInner>
list(String resourceGroupName, String workspaceName)
Lists Jobs in the workspace.com.azure.core.http.rest.PagedIterable<JobBaseDataInner>
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<JobBaseDataInner> 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<JobBaseDataInner> 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.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
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
JobBaseDataInner 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<JobBaseDataInner> 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.
-
createOrUpdate
JobBaseDataInner createOrUpdate(String resourceGroupName, String workspaceName, String id, JobBaseDataInner body)
Creates and executes 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.body
- Job definition object.- Returns:
- azure Resource Manager resource envelope.
- 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<JobBaseDataInner> createOrUpdateWithResponse(String resourceGroupName, String workspaceName, String id, JobBaseDataInner body, com.azure.core.util.Context context)
Creates and executes 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.body
- Job definition object.context
- The context to associate with this operation.- Returns:
- azure Resource Manager resource envelope 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.
-
-