JobsClient Interface

Package:

com.azure.resourcemanager.databox.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-databox:1.0.0-beta.4

public interface JobsClient

An instance of this class provides access to all the operations defined in JobsClient.

Method Summary

Modifier and Type	Method and Description
abstract SyncPoller<PollResult<JobResourceInner>,JobResourceInner>	beginCreate(String resourceGroupName, String jobName, JobResourceInner jobResource) Creates a new job with the specified parameters.
abstract SyncPoller<PollResult<JobResourceInner>,JobResourceInner>	beginCreate(String resourceGroupName, String jobName, JobResourceInner jobResource, Context context) Creates a new job with the specified parameters.
abstract SyncPoller<PollResult<Void>,Void>	beginDelete(String resourceGroupName, String jobName) Deletes a job.
abstract SyncPoller<PollResult<Void>,Void>	beginDelete(String resourceGroupName, String jobName, Context context) Deletes a job.
abstract SyncPoller<PollResult<JobResourceInner>,JobResourceInner>	beginUpdate(String resourceGroupName, String jobName, JobResourceUpdateParameter jobResourceUpdateParameter) Updates the properties of an existing job.
abstract SyncPoller<PollResult<JobResourceInner>,JobResourceInner>	beginUpdate(String resourceGroupName, String jobName, JobResourceUpdateParameter jobResourceUpdateParameter, String ifMatch, Context context) Updates the properties of an existing job.
abstract ShipmentPickUpResponseInner	bookShipmentPickUp(String resourceGroupName, String jobName, ShipmentPickUpRequest shipmentPickUpRequest) Book shipment pick up.
abstract Response<ShipmentPickUpResponseInner>	bookShipmentPickUpWithResponse(String resourceGroupName, String jobName, ShipmentPickUpRequest shipmentPickUpRequest, Context context) Book shipment pick up.
abstract void	cancel(String resourceGroupName, String jobName, CancellationReason cancellationReason) CancelJob.
abstract Response<Void>	cancelWithResponse(String resourceGroupName, String jobName, CancellationReason cancellationReason, Context context) CancelJob.
abstract JobResourceInner	create(String resourceGroupName, String jobName, JobResourceInner jobResource) Creates a new job with the specified parameters.
abstract JobResourceInner	create(String resourceGroupName, String jobName, JobResourceInner jobResource, Context context) Creates a new job with the specified parameters.
abstract void	delete(String resourceGroupName, String jobName) Deletes a job.
abstract void	delete(String resourceGroupName, String jobName, Context context) Deletes a job.
abstract JobResourceInner	getByResourceGroup(String resourceGroupName, String jobName) Gets information about the specified job.
abstract Response<JobResourceInner>	getByResourceGroupWithResponse(String resourceGroupName, String jobName, String expand, Context context) Gets information about the specified job.
abstract PagedIterable<JobResourceInner>	list() Lists all the jobs available under the subscription.
abstract PagedIterable<JobResourceInner>	list(String skipToken, Context context) Lists all the jobs available under the subscription.
abstract PagedIterable<JobResourceInner>	listByResourceGroup(String resourceGroupName) Lists all the jobs available under the given resource group.
abstract PagedIterable<JobResourceInner>	listByResourceGroup(String resourceGroupName, String skipToken, Context context) Lists all the jobs available under the given resource group.
abstract PagedIterable<UnencryptedCredentialsInner>	listCredentials(String resourceGroupName, String jobName) This method gets the unencrypted secrets related to the job.
abstract PagedIterable<UnencryptedCredentialsInner>	listCredentials(String resourceGroupName, String jobName, Context context) This method gets the unencrypted secrets related to the job.
abstract void	markDevicesShipped(String jobName, String resourceGroupName, MarkDevicesShippedRequest markDevicesShippedRequest) Request to mark devices for a given job as shipped.
abstract Response<Void>	markDevicesShippedWithResponse(String jobName, String resourceGroupName, MarkDevicesShippedRequest markDevicesShippedRequest, Context context) Request to mark devices for a given job as shipped.
abstract JobResourceInner	update(String resourceGroupName, String jobName, JobResourceUpdateParameter jobResourceUpdateParameter) Updates the properties of an existing job.
abstract JobResourceInner	update(String resourceGroupName, String jobName, JobResourceUpdateParameter jobResourceUpdateParameter, String ifMatch, Context context) Updates the properties of an existing job.

Method Details

beginCreate

public abstract SyncPoller<PollResult<JobResourceInner>,JobResourceInner> beginCreate(String resourceGroupName, String jobName, JobResourceInner jobResource)

Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

jobResource - Job details from request body.

Returns:

the SyncPoller<T,U> for polling of job Resource.

beginCreate

public abstract SyncPoller<PollResult<JobResourceInner>,JobResourceInner> beginCreate(String resourceGroupName, String jobName, JobResourceInner jobResource, Context context)

Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

jobResource - Job details from request body.

context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of job Resource.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String jobName)

Deletes a job.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String jobName, Context context)

Deletes a job.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginUpdate

public abstract SyncPoller<PollResult<JobResourceInner>,JobResourceInner> beginUpdate(String resourceGroupName, String jobName, JobResourceUpdateParameter jobResourceUpdateParameter)

Updates the properties of an existing job.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

jobResourceUpdateParameter - Job update parameters from request body.

Returns:

the SyncPoller<T,U> for polling of job Resource.

beginUpdate

public abstract SyncPoller<PollResult<JobResourceInner>,JobResourceInner> beginUpdate(String resourceGroupName, String jobName, JobResourceUpdateParameter jobResourceUpdateParameter, String ifMatch, Context context)

Updates the properties of an existing job.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

jobResourceUpdateParameter - Job update parameters from request body.

ifMatch - Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.

context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of job Resource.

bookShipmentPickUp

public abstract ShipmentPickUpResponseInner bookShipmentPickUp(String resourceGroupName, String jobName, ShipmentPickUpRequest shipmentPickUpRequest)

Book shipment pick up.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

shipmentPickUpRequest - Details of shipment pick up request.

Returns:

shipment pick up response.

bookShipmentPickUpWithResponse

public abstract Response<ShipmentPickUpResponseInner> bookShipmentPickUpWithResponse(String resourceGroupName, String jobName, ShipmentPickUpRequest shipmentPickUpRequest, Context context)

Book shipment pick up.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

shipmentPickUpRequest - Details of shipment pick up request.

context - The context to associate with this operation.

Returns:

shipment pick up response along with Response<T>.

cancel

public abstract void cancel(String resourceGroupName, String jobName, CancellationReason cancellationReason)

CancelJob.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

cancellationReason - Reason for cancellation.

cancelWithResponse

public abstract Response<Void> cancelWithResponse(String resourceGroupName, String jobName, CancellationReason cancellationReason, Context context)

CancelJob.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

cancellationReason - Reason for cancellation.

context - The context to associate with this operation.

Returns:

the Response<T>.

create

public abstract JobResourceInner create(String resourceGroupName, String jobName, JobResourceInner jobResource)

Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

jobResource - Job details from request body.

Returns:

job Resource.

create

public abstract JobResourceInner create(String resourceGroupName, String jobName, JobResourceInner jobResource, Context context)

Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

jobResource - Job details from request body.

context - The context to associate with this operation.

Returns:

job Resource.

delete

public abstract void delete(String resourceGroupName, String jobName)

Deletes a job.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

delete

public abstract void delete(String resourceGroupName, String jobName, Context context)

Deletes a job.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

context - The context to associate with this operation.

getByResourceGroup

public abstract JobResourceInner getByResourceGroup(String resourceGroupName, String jobName)

Gets information about the specified job.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

Returns:

information about the specified job.

getByResourceGroupWithResponse

public abstract Response<JobResourceInner> getByResourceGroupWithResponse(String resourceGroupName, String jobName, String expand, Context context)

Gets information about the specified job.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

expand - $expand is supported on details parameter for job, which provides details on the job stages.

context - The context to associate with this operation.

Returns:

information about the specified job along with Response<T>.

list

public abstract PagedIterable<JobResourceInner> list()

Lists all the jobs available under the subscription.

Returns:

job Resource Collection as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<JobResourceInner> list(String skipToken, Context context)

Lists all the jobs available under the subscription.

Parameters:

skipToken - $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.

context - The context to associate with this operation.

Returns:

job Resource Collection as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<JobResourceInner> listByResourceGroup(String resourceGroupName)

Lists all the jobs available under the given resource group.

Parameters:

resourceGroupName - The Resource Group Name.

Returns:

job Resource Collection as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<JobResourceInner> listByResourceGroup(String resourceGroupName, String skipToken, Context context)

Lists all the jobs available under the given resource group.

Parameters:

resourceGroupName - The Resource Group Name.

skipToken - $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.

context - The context to associate with this operation.

Returns:

job Resource Collection as paginated response with PagedIterable<T>.

listCredentials

public abstract PagedIterable<UnencryptedCredentialsInner> listCredentials(String resourceGroupName, String jobName)

This method gets the unencrypted secrets related to the job.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

Returns:

list of unencrypted credentials for accessing device as paginated response with PagedIterable<T>.

listCredentials

public abstract PagedIterable<UnencryptedCredentialsInner> listCredentials(String resourceGroupName, String jobName, Context context)

This method gets the unencrypted secrets related to the job.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

context - The context to associate with this operation.

Returns:

list of unencrypted credentials for accessing device as paginated response with PagedIterable<T>.

markDevicesShipped

public abstract void markDevicesShipped(String jobName, String resourceGroupName, MarkDevicesShippedRequest markDevicesShippedRequest)

Request to mark devices for a given job as shipped.

Parameters:

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

resourceGroupName - The Resource Group Name.

markDevicesShippedRequest - Mark Devices Shipped Request.

markDevicesShippedWithResponse

public abstract Response<Void> markDevicesShippedWithResponse(String jobName, String resourceGroupName, MarkDevicesShippedRequest markDevicesShippedRequest, Context context)

Request to mark devices for a given job as shipped.

Parameters:

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

resourceGroupName - The Resource Group Name.

markDevicesShippedRequest - Mark Devices Shipped Request.

context - The context to associate with this operation.

Returns:

the Response<T>.

update

public abstract JobResourceInner update(String resourceGroupName, String jobName, JobResourceUpdateParameter jobResourceUpdateParameter)

Updates the properties of an existing job.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

jobResourceUpdateParameter - Job update parameters from request body.

Returns:

job Resource.

update

public abstract JobResourceInner update(String resourceGroupName, String jobName, JobResourceUpdateParameter jobResourceUpdateParameter, String ifMatch, Context context)

Updates the properties of an existing job.

Parameters:

resourceGroupName - The Resource Group Name.

jobName - The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

jobResourceUpdateParameter - Job update parameters from request body.

ifMatch - Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.

context - The context to associate with this operation.

Returns:

job Resource.