Jobs Interface

Package:

com.azure.resourcemanager.databox.models

Maven Artifact:

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

public interface Jobs

Resource collection API of Jobs.

Method Summary

Modifier and Type	Method and Description
abstract ShipmentPickUpResponse	bookShipmentPickUp(String resourceGroupName, String jobName, ShipmentPickUpRequest shipmentPickUpRequest) Book shipment pick up.
abstract Response<ShipmentPickUpResponse>	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 Blank	define(String name) Begins definition for a new JobResource resource.
abstract void	delete(String resourceGroupName, String jobName, Context context) Deletes a job.
abstract void	deleteById(String id) Deletes a job.
abstract void	deleteByIdWithResponse(String id, Context context) Deletes a job.
abstract void	deleteByResourceGroup(String resourceGroupName, String jobName) Deletes a job.
abstract JobResource	getById(String id) Gets information about the specified job.
abstract Response<JobResource>	getByIdWithResponse(String id, String expand, Context context) Gets information about the specified job.
abstract JobResource	getByResourceGroup(String resourceGroupName, String jobName) Gets information about the specified job.
abstract Response<JobResource>	getByResourceGroupWithResponse(String resourceGroupName, String jobName, String expand, Context context) Gets information about the specified job.
abstract PagedIterable<JobResource>	list() Lists all the jobs available under the subscription.
abstract PagedIterable<JobResource>	list(String skipToken, Context context) Lists all the jobs available under the subscription.
abstract PagedIterable<JobResource>	listByResourceGroup(String resourceGroupName) Lists all the jobs available under the given resource group.
abstract PagedIterable<JobResource>	listByResourceGroup(String resourceGroupName, String skipToken, Context context) Lists all the jobs available under the given resource group.
abstract PagedIterable<UnencryptedCredentials>	listCredentials(String resourceGroupName, String jobName) This method gets the unencrypted secrets related to the job.
abstract PagedIterable<UnencryptedCredentials>	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.

Method Details

bookShipmentPickUp

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

define

public abstract JobResource.DefinitionStages.Blank define(String name)

Begins definition for a new JobResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new JobResource definition.

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.

deleteById

public abstract void deleteById(String id)

Deletes a job.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Deletes a job.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(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.

getById

public abstract JobResource getById(String id)

Gets information about the specified job.

Parameters:

id - the resource ID.

Returns:

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

getByIdWithResponse

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

Gets information about the specified job.

Parameters:

id - the resource ID.

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

getByResourceGroup

public abstract JobResource 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<JobResource> 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<JobResource> list()

Lists all the jobs available under the subscription.

Returns:

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

list

public abstract PagedIterable<JobResource> 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<JobResource> 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<JobResource> 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<UnencryptedCredentials> 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<UnencryptedCredentials> 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>.