Package com.azure.resourcemanager.storagemover.models

Interface JobDefinition

public interface JobDefinition
An immutable client-side representation of JobDefinition.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    JobDefinition.Definition
    The entirety of the JobDefinition definition.
    static interface 
    JobDefinition.DefinitionStages
    The JobDefinition definition stages.
    static interface 
    JobDefinition.Update
    The template for JobDefinition update.
    static interface 
    JobDefinition.UpdateStages
    The JobDefinition update stages.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    agentName()
    Gets the agentName property: Name of the Agent to assign for new Job Runs of this Job Definition.
    String
    agentResourceId()
    Gets the agentResourceId property: Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
    CopyMode
    copyMode()
    Gets the copyMode property: Strategy to use for copy.
    String
    description()
    Gets the description property: A description for the Job Definition.
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    JobDefinitionInner
    innerModel()
    Gets the inner com.azure.resourcemanager.storagemover.fluent.models.JobDefinitionInner object.
    String
    latestJobRunName()
    Gets the latestJobRunName property: The name of the Job Run in a non-terminal state, if exists.
    String
    latestJobRunResourceId()
    Gets the latestJobRunResourceId property: The fully qualified resource ID of the Job Run in a non-terminal state, if exists.
    JobRunStatus
    latestJobRunStatus()
    Gets the latestJobRunStatus property: The current status of the Job Run in a non-terminal state, if exists.
    String
    name()
    Gets the name property: The name of the resource.
    ProvisioningState
    provisioningState()
    Gets the provisioningState property: The provisioning state of this resource.
    JobDefinition
    refresh()
    Refreshes the resource to sync with Azure.
    JobDefinition
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    String
    resourceGroupName()
    Gets the name of the resource group.
    String
    sourceName()
    Gets the sourceName property: The name of the source Endpoint.
    String
    sourceResourceId()
    Gets the sourceResourceId property: Fully qualified resource ID of the source Endpoint.
    String
    sourceSubpath()
    Gets the sourceSubpath property: The subpath to use when reading from the source Endpoint.
    JobRunResourceId
    startJob()
    Creates a new Job Run resource for the specified Job Definition and passes it to the Agent for execution.
    com.azure.core.http.rest.Response<JobRunResourceId>
    startJobWithResponse(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.
    JobRunResourceId
    stopJob()
    Requests the Agent of any active instance of this Job Definition to stop.
    com.azure.core.http.rest.Response<JobRunResourceId>
    stopJobWithResponse(com.azure.core.util.Context context)
    Requests the Agent of any active instance of this Job Definition to stop.
    com.azure.core.management.SystemData
    systemData()
    Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
    String
    targetName()
    Gets the targetName property: The name of the target Endpoint.
    String
    targetResourceId()
    Gets the targetResourceId property: Fully qualified resource ID of the target Endpoint.
    String
    targetSubpath()
    Gets the targetSubpath property: The subpath to use when writing to the target Endpoint.
    String
    type()
    Gets the type property: The type of the resource.
    JobDefinition.Update
    update()
    Begins update for the JobDefinition resource.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
      Returns:
      the systemData value.

    • description

      String description()
      Gets the description property: A description for the Job Definition.
      Returns:
      the description value.

    • copyMode

      CopyMode copyMode()
      Gets the copyMode property: Strategy to use for copy.
      Returns:
      the copyMode value.

    • sourceName

      String sourceName()
      Gets the sourceName property: The name of the source Endpoint.
      Returns:
      the sourceName value.

    • sourceResourceId

      String sourceResourceId()
      Gets the sourceResourceId property: Fully qualified resource ID of the source Endpoint.
      Returns:
      the sourceResourceId value.

    • sourceSubpath

      String sourceSubpath()
      Gets the sourceSubpath property: The subpath to use when reading from the source Endpoint.
      Returns:
      the sourceSubpath value.

    • targetName

      String targetName()
      Gets the targetName property: The name of the target Endpoint.
      Returns:
      the targetName value.

    • targetResourceId

      String targetResourceId()
      Gets the targetResourceId property: Fully qualified resource ID of the target Endpoint.
      Returns:
      the targetResourceId value.

    • targetSubpath

      String targetSubpath()
      Gets the targetSubpath property: The subpath to use when writing to the target Endpoint.
      Returns:
      the targetSubpath value.

    • latestJobRunName

      String latestJobRunName()
      Gets the latestJobRunName property: The name of the Job Run in a non-terminal state, if exists.
      Returns:
      the latestJobRunName value.

    • latestJobRunResourceId

      String latestJobRunResourceId()
      Gets the latestJobRunResourceId property: The fully qualified resource ID of the Job Run in a non-terminal state, if exists.
      Returns:
      the latestJobRunResourceId value.

    • latestJobRunStatus

      JobRunStatus latestJobRunStatus()
      Gets the latestJobRunStatus property: The current status of the Job Run in a non-terminal state, if exists.
      Returns:
      the latestJobRunStatus value.

    • agentName

      String agentName()
      Gets the agentName property: Name of the Agent to assign for new Job Runs of this Job Definition.
      Returns:
      the agentName value.

    • agentResourceId

      String agentResourceId()
      Gets the agentResourceId property: Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
      Returns:
      the agentResourceId value.

    • provisioningState

      ProvisioningState provisioningState()
      Gets the provisioningState property: The provisioning state of this resource.
      Returns:
      the provisioningState value.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      JobDefinitionInner innerModel()
      Gets the inner com.azure.resourcemanager.storagemover.fluent.models.JobDefinitionInner object.
      Returns:
      the inner object.

    • update

      JobDefinition.Update update()
      Begins update for the JobDefinition resource.
      Returns:
      the stage of resource update.

    • refresh

      JobDefinition refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      JobDefinition refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • startJobWithResponse

      com.azure.core.http.rest.Response<JobRunResourceId> startJobWithResponse(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:
      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()
      Creates a new Job Run resource for the specified Job Definition and passes it to the Agent for execution.
      Returns:
      response that identifies a Job Run.
      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.

    • stopJobWithResponse

      com.azure.core.http.rest.Response<JobRunResourceId> stopJobWithResponse(com.azure.core.util.Context context)
      Requests the Agent of any active instance of this Job Definition to stop.
      Parameters:
      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()
      Requests the Agent of any active instance of this Job Definition to stop.
      Returns:
      response that identifies a Job Run.
      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.