Class Job

java.lang.Object
software.amazon.awssdk.services.mediaconvert.model.Job
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Job.Builder,Job>
@Generated("software.amazon.awssdk:codegen") public final class Job extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Job.Builder,Job>
Each job converts an input file into an output file or files. For more information, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
See Also:

  • Method Details

    • accelerationSettings

      public final AccelerationSettings accelerationSettings()
      Accelerated transcoding can significantly speed up jobs with long, visually complex content.
      Returns:
      Accelerated transcoding can significantly speed up jobs with long, visually complex content.

    • accelerationStatus

      public final AccelerationStatus accelerationStatus()
      Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.

      If the service returns an enum value that is not available in the current SDK version, accelerationStatus will return AccelerationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accelerationStatusAsString().

      Returns:
      Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.
      See Also:

    • accelerationStatusAsString

      public final String accelerationStatusAsString()
      Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.

      If the service returns an enum value that is not available in the current SDK version, accelerationStatus will return AccelerationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accelerationStatusAsString().

      Returns:
      Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.
      See Also:

    • arn

      public final String arn()
      An identifier for this resource that is unique within all of AWS.
      Returns:
      An identifier for this resource that is unique within all of AWS.

    • billingTagsSource

      public final BillingTagsSource billingTagsSource()
      The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.

      If the service returns an enum value that is not available in the current SDK version, billingTagsSource will return BillingTagsSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from billingTagsSourceAsString().

      Returns:
      The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.
      See Also:

    • billingTagsSourceAsString

      public final String billingTagsSourceAsString()
      The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.

      If the service returns an enum value that is not available in the current SDK version, billingTagsSource will return BillingTagsSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from billingTagsSourceAsString().

      Returns:
      The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.
      See Also:

    • clientRequestToken

      public final String clientRequestToken()
      Prevent duplicate jobs from being created and ensure idempotency for your requests. A client request token can be any string that includes up to 64 ASCII characters. If you reuse a client request token within one minute of a successful request, the API returns the job details of the original request instead. For more information see https://docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html.
      Returns:
      Prevent duplicate jobs from being created and ensure idempotency for your requests. A client request token can be any string that includes up to 64 ASCII characters. If you reuse a client request token within one minute of a successful request, the API returns the job details of the original request instead. For more information see https://docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html.

    • createdAt

      public final Instant createdAt()
      The time, in Unix epoch format in seconds, when the job got created.
      Returns:
      The time, in Unix epoch format in seconds, when the job got created.

    • currentPhase

      public final JobPhase currentPhase()
      A job's phase can be PROBING, TRANSCODING OR UPLOADING

      If the service returns an enum value that is not available in the current SDK version, currentPhase will return JobPhase.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currentPhaseAsString().

      Returns:
      A job's phase can be PROBING, TRANSCODING OR UPLOADING
      See Also:

    • currentPhaseAsString

      public final String currentPhaseAsString()
      A job's phase can be PROBING, TRANSCODING OR UPLOADING

      If the service returns an enum value that is not available in the current SDK version, currentPhase will return JobPhase.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currentPhaseAsString().

      Returns:
      A job's phase can be PROBING, TRANSCODING OR UPLOADING
      See Also:

    • errorCode

      public final Integer errorCode()
      Error code for the job
      Returns:
      Error code for the job

    • errorMessage

      public final String errorMessage()
      Error message of Job
      Returns:
      Error message of Job

    • hasHopDestinations

      public final boolean hasHopDestinations()
      For responses, this returns true if the service returned a value for the HopDestinations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • hopDestinations

      public final List<HopDestination> hopDestinations()
      Optional list of hop destinations.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHopDestinations() method.

      Returns:
      Optional list of hop destinations.

    • id

      public final String id()
      A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources
      Returns:
      A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources

    • jobEngineVersionRequested

      public final String jobEngineVersionRequested()
      The Job engine version that you requested for your job. Valid versions are in a YYYY-MM-DD format.
      Returns:
      The Job engine version that you requested for your job. Valid versions are in a YYYY-MM-DD format.

    • jobEngineVersionUsed

      public final String jobEngineVersionUsed()
      The Job engine version that your job used. Job engine versions are in a YYYY-MM-DD format. When you request an expired version, the response for this property will be empty. Requests to create jobs with an expired version result in a regular job, as if no specific Job engine version was requested. When you request an invalid version, the response for this property will be empty. Requests to create jobs with an invalid version result in a 400 error message, and no job is created.
      Returns:
      The Job engine version that your job used. Job engine versions are in a YYYY-MM-DD format. When you request an expired version, the response for this property will be empty. Requests to create jobs with an expired version result in a regular job, as if no specific Job engine version was requested. When you request an invalid version, the response for this property will be empty. Requests to create jobs with an invalid version result in a 400 error message, and no job is created.

    • jobPercentComplete

      public final Integer jobPercentComplete()
      An estimate of how far your job has progressed. This estimate is shown as a percentage of the total time from when your job leaves its queue to when your output files appear in your output Amazon S3 bucket. AWS Elemental MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and in the response to GetJob and ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime, Transport Stream, MP4, and MXF. For some jobs, the service can't provide information about job progress. In those cases, jobPercentComplete returns a null value.
      Returns:
      An estimate of how far your job has progressed. This estimate is shown as a percentage of the total time from when your job leaves its queue to when your output files appear in your output Amazon S3 bucket. AWS Elemental MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and in the response to GetJob and ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime, Transport Stream, MP4, and MXF. For some jobs, the service can't provide information about job progress. In those cases, jobPercentComplete returns a null value.

    • jobTemplate

      public final String jobTemplate()
      The job template that the job is created from, if it is created from a job template.
      Returns:
      The job template that the job is created from, if it is created from a job template.

    • messages

      public final JobMessages messages()
      Provides messages from the service about jobs that you have already successfully submitted.
      Returns:
      Provides messages from the service about jobs that you have already successfully submitted.

    • hasOutputGroupDetails

      public final boolean hasOutputGroupDetails()
      For responses, this returns true if the service returned a value for the OutputGroupDetails property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • outputGroupDetails

      public final List<OutputGroupDetail> outputGroupDetails()
      List of output group details

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOutputGroupDetails() method.

      Returns:
      List of output group details

    • priority

      public final Integer priority()
      Relative priority on the job.
      Returns:
      Relative priority on the job.

    • queue

      public final String queue()
      When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
      Returns:
      When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

    • hasQueueTransitions

      public final boolean hasQueueTransitions()
      For responses, this returns true if the service returned a value for the QueueTransitions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • queueTransitions

      public final List<QueueTransition> queueTransitions()
      The job's queue hopping history.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasQueueTransitions() method.

      Returns:
      The job's queue hopping history.

    • retryCount

      public final Integer retryCount()
      The number of times that the service automatically attempted to process your job after encountering an error.
      Returns:
      The number of times that the service automatically attempted to process your job after encountering an error.

    • role

      public final String role()
      The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html
      Returns:
      The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html

    • settings

      public final JobSettings settings()
      JobSettings contains all the transcode settings for a job.
      Returns:
      JobSettings contains all the transcode settings for a job.

    • simulateReservedQueue

      public final SimulateReservedQueue simulateReservedQueue()
      Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.

      If the service returns an enum value that is not available in the current SDK version, simulateReservedQueue will return SimulateReservedQueue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from simulateReservedQueueAsString().

      Returns:
      Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.
      See Also:

    • simulateReservedQueueAsString

      public final String simulateReservedQueueAsString()
      Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.

      If the service returns an enum value that is not available in the current SDK version, simulateReservedQueue will return SimulateReservedQueue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from simulateReservedQueueAsString().

      Returns:
      Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.
      See Also:

    • status

      public final JobStatus status()
      A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

      If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
      See Also:

    • statusAsString

      public final String statusAsString()
      A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

      If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
      See Also:

    • statusUpdateInterval

      public final StatusUpdateInterval statusUpdateInterval()
      Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.

      If the service returns an enum value that is not available in the current SDK version, statusUpdateInterval will return StatusUpdateInterval.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusUpdateIntervalAsString().

      Returns:
      Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.
      See Also:

    • statusUpdateIntervalAsString

      public final String statusUpdateIntervalAsString()
      Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.

      If the service returns an enum value that is not available in the current SDK version, statusUpdateInterval will return StatusUpdateInterval.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusUpdateIntervalAsString().

      Returns:
      Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.
      See Also:

    • timing

      public final Timing timing()
      Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
      Returns:
      Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.

    • hasUserMetadata

      public final boolean hasUserMetadata()
      For responses, this returns true if the service returned a value for the UserMetadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • userMetadata

      public final Map<String,String> userMetadata()
      User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserMetadata() method.

      Returns:
      User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.

    • hasWarnings

      public final boolean hasWarnings()
      For responses, this returns true if the service returned a value for the Warnings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • warnings

      public final List<WarningGroup> warnings()
      Contains any warning messages for the job. Use to help identify potential issues with your input, output, or job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWarnings() method.

      Returns:
      Contains any warning messages for the job. Use to help identify potential issues with your input, output, or job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html

    • toBuilder

      public Job.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Job.Builder,Job>
      Returns:
      a builder for type T

    • builder

      public static Job.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Job.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.