Package com.azure.resourcemanager.storagemover.models

Interface JobDefinitions

public interface JobDefinitions
Resource collection API of JobDefinitions.

  • Method Details

    • list

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

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

    • 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<JobRunResourceId> 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

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

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

    • getById

      JobDefinition getById(String id)
      Gets a Job Definition resource.
      Parameters:
      id - the resource ID.
      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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<JobDefinition> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets a Job Definition resource.
      Parameters:
      id - the resource ID.
      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.

    • deleteById

      void deleteById(String id)
      Deletes a Job Definition resource.
      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 Definition resource.
      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

      JobDefinition.DefinitionStages.Blank define(String name)
      Begins definition for a new JobDefinition resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new JobDefinition definition.