Package com.azure.resourcemanager.automation.models

Interface Job

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Job.Definition
    The entirety of the Job definition.
    static interface 
    Job.DefinitionStages
    The Job definition stages.

  • Method Summary

    Modifier and Type
    Method
    Description
    OffsetDateTime
    creationTime()
    Gets the creationTime property: Gets or sets the creation time of the job.
    OffsetDateTime
    endTime()
    Gets the endTime property: Gets or sets the end time of the job.
    String
    exception()
    Gets the exception property: Gets or sets the exception of the job.
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    JobInner
    innerModel()
    Gets the inner com.azure.resourcemanager.automation.fluent.models.JobInner object.
    UUID
    jobId()
    Gets the jobId property: Gets or sets the id of the job.
    OffsetDateTime
    lastModifiedTime()
    Gets the lastModifiedTime property: Gets or sets the last modified time of the job.
    OffsetDateTime
    lastStatusModifiedTime()
    Gets the lastStatusModifiedTime property: Gets or sets the last status modified time of the job.
    String
    name()
    Gets the name property: The name of the resource.
    Map<String,String>
    parameters()
    Gets the parameters property: Gets or sets the parameters of the job.
    JobProvisioningState
    provisioningState()
    Gets the provisioningState property: The current provisioning state of the job.
    Job
    refresh()
    Refreshes the resource to sync with Azure.
    Job
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    void
    resume()
    Resume the job identified by jobName.
    com.azure.core.http.rest.Response<Void>
    resumeWithResponse(String clientRequestId, com.azure.core.util.Context context)
    Resume the job identified by jobName.
    RunbookAssociationProperty
    runbook()
    Gets the runbook property: Gets or sets the runbook.
    String
    runOn()
    Gets the runOn property: Gets or sets the runOn which specifies the group name where the job is to be executed.
    String
    startedBy()
    Gets the startedBy property: Gets or sets the job started by.
    OffsetDateTime
    startTime()
    Gets the startTime property: Gets or sets the start time of the job.
    JobStatus
    status()
    Gets the status property: Gets or sets the status of the job.
    String
    statusDetails()
    Gets the statusDetails property: Gets or sets the status details of the job.
    void
    stop()
    Stop the job identified by jobName.
    com.azure.core.http.rest.Response<Void>
    stopWithResponse(String clientRequestId, com.azure.core.util.Context context)
    Stop the job identified by jobName.
    void
    suspend()
    Suspend the job identified by job name.
    com.azure.core.http.rest.Response<Void>
    suspendWithResponse(String clientRequestId, com.azure.core.util.Context context)
    Suspend the job identified by job name.
    String
    type()
    Gets the type property: The type of the 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.

    • runbook

      RunbookAssociationProperty runbook()
      Gets the runbook property: Gets or sets the runbook.
      Returns:
      the runbook value.

    • startedBy

      String startedBy()
      Gets the startedBy property: Gets or sets the job started by.
      Returns:
      the startedBy value.

    • runOn

      String runOn()
      Gets the runOn property: Gets or sets the runOn which specifies the group name where the job is to be executed.
      Returns:
      the runOn value.

    • jobId

      UUID jobId()
      Gets the jobId property: Gets or sets the id of the job.
      Returns:
      the jobId value.

    • creationTime

      OffsetDateTime creationTime()
      Gets the creationTime property: Gets or sets the creation time of the job.
      Returns:
      the creationTime value.

    • status

      JobStatus status()
      Gets the status property: Gets or sets the status of the job.
      Returns:
      the status value.

    • statusDetails

      String statusDetails()
      Gets the statusDetails property: Gets or sets the status details of the job.
      Returns:
      the statusDetails value.

    • startTime

      OffsetDateTime startTime()
      Gets the startTime property: Gets or sets the start time of the job.
      Returns:
      the startTime value.

    • endTime

      OffsetDateTime endTime()
      Gets the endTime property: Gets or sets the end time of the job.
      Returns:
      the endTime value.

    • exception

      String exception()
      Gets the exception property: Gets or sets the exception of the job.
      Returns:
      the exception value.

    • lastModifiedTime

      OffsetDateTime lastModifiedTime()
      Gets the lastModifiedTime property: Gets or sets the last modified time of the job.
      Returns:
      the lastModifiedTime value.

    • lastStatusModifiedTime

      OffsetDateTime lastStatusModifiedTime()
      Gets the lastStatusModifiedTime property: Gets or sets the last status modified time of the job.
      Returns:
      the lastStatusModifiedTime value.

    • parameters

      Map<String,String> parameters()
      Gets the parameters property: Gets or sets the parameters of the job.
      Returns:
      the parameters value.

    • provisioningState

      JobProvisioningState provisioningState()
      Gets the provisioningState property: The current provisioning state of the job.
      Returns:
      the provisioningState value.

    • innerModel

      JobInner innerModel()
      Gets the inner com.azure.resourcemanager.automation.fluent.models.JobInner object.
      Returns:
      the inner object.

    • refresh

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

    • refresh

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

    • suspend

      void suspend()
      Suspend the job identified by job name.
      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.

    • suspendWithResponse

      com.azure.core.http.rest.Response<Void> suspendWithResponse(String clientRequestId, com.azure.core.util.Context context)
      Suspend the job identified by job name.
      Parameters:
      clientRequestId - Identifies this specific client request.
      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.

    • stop

      void stop()
      Stop the job identified by jobName.
      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.

    • stopWithResponse

      com.azure.core.http.rest.Response<Void> stopWithResponse(String clientRequestId, com.azure.core.util.Context context)
      Stop the job identified by jobName.
      Parameters:
      clientRequestId - Identifies this specific client request.
      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.

    • resume

      void resume()
      Resume the job identified by jobName.
      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.

    • resumeWithResponse

      com.azure.core.http.rest.Response<Void> resumeWithResponse(String clientRequestId, com.azure.core.util.Context context)
      Resume the job identified by jobName.
      Parameters:
      clientRequestId - Identifies this specific client request.
      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.