Package com.azure.resourcemanager.databox.models

Interface Jobs

public interface Jobs
Resource collection API of Jobs.

  • Method Details

    • list

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

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

    • deleteByResourceGroup

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

    • bookShipmentPickUpWithResponse

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

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

    • getById

      JobResource getById(String id)
      Gets information about the specified job.
      Parameters:
      id - the resource ID.
      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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<JobResource> getByIdWithResponse(String id, String expand, com.azure.core.util.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.
      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.
      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.
      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

      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.