Package com.azure.resourcemanager.storagemover.fluent

Interface JobDefinitionsClient

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

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<JobDefinitionInner> list(String resourceGroupName, String storageMoverName, String projectName)
      Lists all Job Definitions in a Project.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      storageMoverName - The name of the Storage Mover resource.
      projectName - The name of the Project resource.
      Returns:
      list of Job Definitions 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<JobDefinitionInner> list(String resourceGroupName, String storageMoverName, String projectName, com.azure.core.util.Context context)
      Lists all Job Definitions in a Project.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      storageMoverName - The name of the Storage Mover resource.
      projectName - The name of the Project resource.
      context - The context to associate with this operation.
      Returns:
      list of Job Definitions 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.

    • getWithResponse

      com.azure.core.http.rest.Response<JobDefinitionInner> getWithResponse(String resourceGroupName, String storageMoverName, String projectName, String jobDefinitionName, com.azure.core.util.Context context)
      Gets a Job Definition resource.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      storageMoverName - The name of the Storage Mover resource.
      projectName - The name of the Project resource.
      jobDefinitionName - The name of the Job Definition resource.
      context - The context to associate with this operation.
      Returns:
      a Job Definition resource 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.

    • get

      JobDefinitionInner get(String resourceGroupName, String storageMoverName, String projectName, String jobDefinitionName)
      Gets a Job Definition resource.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      storageMoverName - The name of the Storage Mover resource.
      projectName - The name of the Project resource.
      jobDefinitionName - The name of the Job Definition resource.
      Returns:
      a Job Definition 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.

    • createOrUpdateWithResponse

      com.azure.core.http.rest.Response<JobDefinitionInner> createOrUpdateWithResponse(String resourceGroupName, String storageMoverName, String projectName, String jobDefinitionName, JobDefinitionInner jobDefinition, com.azure.core.util.Context context)
      Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      storageMoverName - The name of the Storage Mover resource.
      projectName - The name of the Project resource.
      jobDefinitionName - The name of the Job Definition resource.
      jobDefinition - The jobDefinition parameter.
      context - The context to associate with this operation.
      Returns:
      the Job Definition resource 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

      JobDefinitionInner createOrUpdate(String resourceGroupName, String storageMoverName, String projectName, String jobDefinitionName, JobDefinitionInner jobDefinition)
      Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      storageMoverName - The name of the Storage Mover resource.
      projectName - The name of the Project resource.
      jobDefinitionName - The name of the Job Definition resource.
      jobDefinition - The jobDefinition parameter.
      Returns:
      the Job Definition 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.

    • updateWithResponse

      com.azure.core.http.rest.Response<JobDefinitionInner> updateWithResponse(String resourceGroupName, String storageMoverName, String projectName, String jobDefinitionName, JobDefinitionUpdateParameters jobDefinition, com.azure.core.util.Context context)
      Updates properties for a Job Definition resource. Properties not specified in the request body will be unchanged.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      storageMoverName - The name of the Storage Mover resource.
      projectName - The name of the Project resource.
      jobDefinitionName - The name of the Job Definition resource.
      jobDefinition - The jobDefinition parameter.
      context - The context to associate with this operation.
      Returns:
      the Job Definition resource 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.

    • update

      JobDefinitionInner update(String resourceGroupName, String storageMoverName, String projectName, String jobDefinitionName, JobDefinitionUpdateParameters jobDefinition)
      Updates properties for a Job Definition resource. Properties not specified in the request body will be unchanged.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      storageMoverName - The name of the Storage Mover resource.
      projectName - The name of the Project resource.
      jobDefinitionName - The name of the Job Definition resource.
      jobDefinition - The jobDefinition parameter.
      Returns:
      the Job Definition 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 storageMoverName, String projectName, String jobDefinitionName)
      Deletes a Job Definition resource.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      storageMoverName - The name of the Storage Mover resource.
      projectName - The name of the Project resource.
      jobDefinitionName - The name of the Job Definition resource.
      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 storageMoverName, String projectName, String jobDefinitionName, com.azure.core.util.Context context)
      Deletes a Job Definition resource.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      storageMoverName - The name of the Storage Mover resource.
      projectName - The name of the Project resource.
      jobDefinitionName - The name of the Job Definition resource.
      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 storageMoverName, String projectName, String jobDefinitionName)
      Deletes a Job Definition resource.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      storageMoverName - The name of the Storage Mover resource.
      projectName - The name of the Project resource.
      jobDefinitionName - The name of the Job Definition 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.

    • delete

      void delete(String resourceGroupName, String storageMoverName, String projectName, String jobDefinitionName, com.azure.core.util.Context context)
      Deletes a Job Definition resource.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      storageMoverName - The name of the Storage Mover resource.
      projectName - The name of the Project resource.
      jobDefinitionName - The name of the Job Definition resource.
      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.

    • startJobWithResponse

      com.azure.core.http.rest.Response<JobRunResourceIdInner> startJobWithResponse(String resourceGroupName, String storageMoverName, String projectName, String jobDefinitionName, com.azure.core.util.Context context)
      Creates a new Job Run resource for the specified Job Definition and passes it to the Agent for execution.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      storageMoverName - The name of the Storage Mover resource.
      projectName - The name of the Project resource.
      jobDefinitionName - The name of the Job Definition resource.
      context - The context to associate with this operation.
      Returns:
      response that identifies a Job Run 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.

    • startJob

      JobRunResourceIdInner startJob(String resourceGroupName, String storageMoverName, String projectName, String jobDefinitionName)
      Creates a new Job Run resource for the specified Job Definition and passes it to the Agent for execution.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      storageMoverName - The name of the Storage Mover resource.
      projectName - The name of the Project resource.
      jobDefinitionName - The name of the Job Definition resource.
      Returns:
      response that identifies a Job Run.
      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.

    • stopJobWithResponse

      com.azure.core.http.rest.Response<JobRunResourceIdInner> stopJobWithResponse(String resourceGroupName, String storageMoverName, String projectName, String jobDefinitionName, com.azure.core.util.Context context)
      Requests the Agent of any active instance of this Job Definition to stop.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      storageMoverName - The name of the Storage Mover resource.
      projectName - The name of the Project resource.
      jobDefinitionName - The name of the Job Definition resource.
      context - The context to associate with this operation.
      Returns:
      response that identifies a Job Run 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.

    • stopJob

      JobRunResourceIdInner stopJob(String resourceGroupName, String storageMoverName, String projectName, String jobDefinitionName)
      Requests the Agent of any active instance of this Job Definition to stop.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      storageMoverName - The name of the Storage Mover resource.
      projectName - The name of the Project resource.
      jobDefinitionName - The name of the Job Definition resource.
      Returns:
      response that identifies a Job Run.
      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.