Package software.amazon.awssdk.services.elastictranscoder.model

Class Job

java.lang.Object
software.amazon.awssdk.services.elastictranscoder.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>

A section of the response body that provides information about the job that is created.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    Job.Builder
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final String
    arn()
    The Amazon Resource Name (ARN) for the job.
    static Job.Builder
    builder()
     
    final boolean
    equals(Object obj)
     
    final boolean
    equalsBySdkFields(Object obj)
    Indicates whether some other object is "equal to" this one by SDK fields.
    final <T> Optional<T>
    getValueForField(String fieldName, Class<T> clazz)
     
    final int
    hashCode()
     
    final boolean
    hasInputs()
    For responses, this returns true if the service returned a value for the Inputs property.
    final boolean
    hasOutputs()
    For responses, this returns true if the service returned a value for the Outputs property.
    final boolean
    hasPlaylists()
    For responses, this returns true if the service returned a value for the Playlists property.
    final boolean
    hasUserMetadata()
    For responses, this returns true if the service returned a value for the UserMetadata property.
    final String
    id()
    The identifier that Elastic Transcoder assigned to the job.
    final JobInput
    input()
    A section of the request or response body that provides information about the file that is being transcoded.
    final List<JobInput>
    inputs()
    Information about the files that you're transcoding.
    final JobOutput
    output()
    If you specified one output for a job, information about that output.
    final String
    outputKeyPrefix()
    The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.
    final List<JobOutput>
    outputs()
    Information about the output files.
    final String
    pipelineId()
    The Id of the pipeline that you want Elastic Transcoder to use for transcoding.
    final List<Playlist>
    playlists()
    final List<SdkField<?>>
    sdkFields()
     
    static Class<? extends Job.Builder>
    serializableBuilderClass()
     
    final String
    status()
    The status of the job: Submitted, Progressing, Complete, Canceled, or Error.
    final Timing
    timing()
    Details about the timing of a job.
    Job.Builder
    toBuilder()
    Take this object and create a builder that contains all of the current property values of this object.
    final String
    toString()
    Returns a string representation of this object.
    final Map<String,String>
    userMetadata()
    User-defined metadata that you want to associate with an Elastic Transcoder job.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

    copy

  • Method Details

    • id

      public final String id()

      The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.

      Returns:
      The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) for the job.

      Returns:
      The Amazon Resource Name (ARN) for the job.

    • pipelineId

      public final String pipelineId()

      The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

      Returns:
      The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

    • input

      public final JobInput input()

      A section of the request or response body that provides information about the file that is being transcoded.

      Returns:
      A section of the request or response body that provides information about the file that is being transcoded.

    • hasInputs

      public final boolean hasInputs()
      For responses, this returns true if the service returned a value for the Inputs 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.

    • inputs

      public final List<JobInput> inputs()

      Information about the files that you're transcoding. If you specified multiple files for this job, Elastic Transcoder stitches the files together to make one output.

      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 hasInputs() method.

      Returns:
      Information about the files that you're transcoding. If you specified multiple files for this job, Elastic Transcoder stitches the files together to make one output.

    • output

      public final JobOutput output()

      If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.

      Outputs recommended instead.

      A section of the request or response body that provides information about the transcoded (target) file.

      Returns:
      If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.

      Outputs recommended instead.

      A section of the request or response body that provides information about the transcoded (target) file.

    • hasOutputs

      public final boolean hasOutputs()
      For responses, this returns true if the service returned a value for the Outputs 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.

    • outputs

      public final List<JobOutput> outputs()

      Information about the output files. We recommend that you use the Outputs syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both the Outputs and Output syntaxes in the same request. You can create a maximum of 30 outputs per job.

      If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.

      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 hasOutputs() method.

      Returns:
      Information about the output files. We recommend that you use the Outputs syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both the Outputs and Output syntaxes in the same request. You can create a maximum of 30 outputs per job.

      If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.

    • outputKeyPrefix

      public final String outputKeyPrefix()

      The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of the OutputKeyPrefix.

      Returns:
      The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of the OutputKeyPrefix.

    • hasPlaylists

      public final boolean hasPlaylists()
      For responses, this returns true if the service returned a value for the Playlists 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.

    • playlists

      public final List<Playlist> playlists()

      Outputs in Fragmented MP4 or MPEG-TS format only.

      If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

      The maximum number of master playlists in a job is 30.

      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 hasPlaylists() method.

      Returns:

      Outputs in Fragmented MP4 or MPEG-TS format only.

      If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

      The maximum number of master playlists in a job is 30.

    • status

      public final String status()

      The status of the job: Submitted, Progressing, Complete, Canceled, or Error.

      Returns:
      The status of the job: Submitted, Progressing, Complete, Canceled, or Error.

    • 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 Elastic Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder does not guarantee that key/value pairs are returned in the same order in which you specify them.

      Metadata keys and values must use characters from the following list:

      • 0-9

      • A-Z and a-z

      • Space

      • The following symbols: _.:/=+-%@

      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 Elastic Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder does not guarantee that key/value pairs are returned in the same order in which you specify them.

      Metadata keys and values must use characters from the following list:

      • 0-9

      • A-Z and a-z

      • Space

      • The following symbols: _.:/=+-%@

    • timing

      public final Timing timing()

      Details about the timing of a job.

      Returns:
      Details about the timing of a job.

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