Package com.azure.resourcemanager.databox.fluent

Interface JobsClient

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

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<JobResourceInner> list()
      Lists all the jobs available under the subscription.
      Returns:
      job Resource Collection as paginated response with PagedIterable.
      Throws:
      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<JobResourceInner> list(String skipToken, com.azure.core.util.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.
      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.

    • listByResourceGroup

      com.azure.core.http.rest.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.
      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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<JobResourceInner> listByResourceGroup(String resourceGroupName, String skipToken, com.azure.core.util.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.
      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.

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<JobResourceInner> getByResourceGroupWithResponse(String resourceGroupName, String jobName, String expand, com.azure.core.util.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.
      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.

    • getByResourceGroup

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

    • beginCreate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.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 for polling of job Resource.
      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.

    • beginCreate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<JobResourceInner>,JobResourceInner> beginCreate(String resourceGroupName, String jobName, JobResourceInner jobResource, com.azure.core.util.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 for polling of job Resource.
      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.

    • create

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

    • create

      JobResourceInner create(String resourceGroupName, String jobName, JobResourceInner jobResource, com.azure.core.util.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.
      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 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 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 jobName, com.azure.core.util.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 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 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.
      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 jobName, com.azure.core.util.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.
      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.

    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.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 for polling of job Resource.
      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.

    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<JobResourceInner>,JobResourceInner> beginUpdate(String resourceGroupName, String jobName, JobResourceUpdateParameter jobResourceUpdateParameter, String ifMatch, com.azure.core.util.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 for polling of job Resource.
      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.

    • update

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

    • update

      JobResourceInner update(String resourceGroupName, String jobName, JobResourceUpdateParameter jobResourceUpdateParameter, String ifMatch, com.azure.core.util.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.
      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.

    • bookShipmentPickUpWithResponse

      com.azure.core.http.rest.Response<ShipmentPickUpResponseInner> bookShipmentPickUpWithResponse(String resourceGroupName, String jobName, ShipmentPickUpRequest shipmentPickUpRequest, com.azure.core.util.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.
      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.

    • bookShipmentPickUp

      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.
      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 jobName, CancellationReason cancellationReason, com.azure.core.util.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.
      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 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.
      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.

    • listCredentials

      com.azure.core.http.rest.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.
      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.

    • listCredentials

      com.azure.core.http.rest.PagedIterable<UnencryptedCredentialsInner> listCredentials(String resourceGroupName, String jobName, com.azure.core.util.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.
      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.