Package com.azure.resourcemanager.mediaservices.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.
    static interface 
    Job.Update
    The template for Job update.
    static interface 
    Job.UpdateStages
    The Job update stages.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cancelJob()
    Cancel Job
    com.azure.core.http.rest.Response<Void>
    cancelJobWithResponse(com.azure.core.util.Context context)
    Cancel Job
    Map<String,String>
    correlationData()
    Gets the correlationData property: Customer provided key, value pairs that will be returned in Job and JobOutput state events.
    OffsetDateTime
    created()
    Gets the created property: The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format.
    String
    description()
    Gets the description property: Optional customer supplied description of the Job.
    OffsetDateTime
    endTime()
    Gets the endTime property: The UTC date and time at which this Job finished processing.
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    JobInner
    innerModel()
    Gets the inner com.azure.resourcemanager.mediaservices.fluent.models.JobInner object.
    JobInput
    input()
    Gets the input property: The inputs for the Job.
    OffsetDateTime
    lastModified()
    Gets the lastModified property: The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format.
    String
    name()
    Gets the name property: The name of the resource.
    List<JobOutput>
    outputs()
    Gets the outputs property: The outputs for the Job.
    Priority
    priority()
    Gets the priority property: Priority with which the job should be processed.
    Job
    refresh()
    Refreshes the resource to sync with Azure.
    Job
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    String
    resourceGroupName()
    Gets the name of the resource group.
    OffsetDateTime
    startTime()
    Gets the startTime property: The UTC date and time at which this Job began processing.
    JobState
    state()
    Gets the state property: The current state of the job.
    com.azure.core.management.SystemData
    systemData()
    Gets the systemData property: The system metadata relating to this resource.
    String
    type()
    Gets the type property: The type of the resource.
    Job.Update
    update()
    Begins update for the Job 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: The system metadata relating to this resource.
      Returns:
      the systemData value.

    • created

      OffsetDateTime created()
      Gets the created property: The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format.
      Returns:
      the created value.

    • state

      JobState state()
      Gets the state property: The current state of the job.
      Returns:
      the state value.

    • description

      String description()
      Gets the description property: Optional customer supplied description of the Job.
      Returns:
      the description value.

    • input

      JobInput input()
      Gets the input property: The inputs for the Job.
      Returns:
      the input value.

    • lastModified

      OffsetDateTime lastModified()
      Gets the lastModified property: The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format.
      Returns:
      the lastModified value.

    • outputs

      List<JobOutput> outputs()
      Gets the outputs property: The outputs for the Job.
      Returns:
      the outputs value.

    • priority

      Priority priority()
      Gets the priority property: Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal.
      Returns:
      the priority value.

    • correlationData

      Map<String,String> correlationData()
      Gets the correlationData property: Customer provided key, value pairs that will be returned in Job and JobOutput state events.
      Returns:
      the correlationData value.

    • startTime

      OffsetDateTime startTime()
      Gets the startTime property: The UTC date and time at which this Job began processing.
      Returns:
      the startTime value.

    • endTime

      OffsetDateTime endTime()
      Gets the endTime property: The UTC date and time at which this Job finished processing.
      Returns:
      the endTime value.

    • resourceGroupName

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

    • innerModel

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

    • update

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

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

    • cancelJobWithResponse

      com.azure.core.http.rest.Response<Void> cancelJobWithResponse(com.azure.core.util.Context context)
      Cancel Job

      Cancel a Job.

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

    • cancelJob

      void cancelJob()
      Cancel Job

      Cancel a Job.

      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.