Struct aws_sdk_elastictranscoder::types::Job

#[non_exhaustive]
pub struct Job {
    pub id: Option<String>,
    pub arn: Option<String>,
    pub pipeline_id: Option<String>,
    pub input: Option<JobInput>,
    pub inputs: Option<Vec<JobInput>>,
    pub output: Option<JobOutput>,
    pub outputs: Option<Vec<JobOutput>>,
    pub output_key_prefix: Option<String>,
    pub playlists: Option<Vec<Playlist>>,
    pub status: Option<String>,
    pub user_metadata: Option<HashMap<String, String>>,
    pub timing: Option<Timing>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Option<String>

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: Option<String>

The Amazon Resource Name (ARN) for the job.

pipeline_id: Option<String>

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: Option<JobInput>

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

inputs: Option<Vec<JobInput>>

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: Option<JobOutput>

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.

outputs: Option<Vec<JobOutput>>

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.

output_key_prefix: Option<String>

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.

playlists: Option<Vec<Playlist>>

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: Option<String>

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

user_metadata: Option<HashMap<String, String>>

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: Option<Timing>

Details about the timing of a job.

Implementations

impl Job

pub fn id(&self) -> Option<&str>

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

pub fn arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) for the job.

pub fn pipeline_id(&self) -> Option<&str>

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.

pub fn input(&self) -> Option<&JobInput>

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

pub fn inputs(&self) -> &[JobInput]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .inputs.is_none().

pub fn output(&self) -> Option<&JobOutput>

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.

pub fn outputs(&self) -> &[JobOutput]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .outputs.is_none().

pub fn output_key_prefix(&self) -> Option<&str>

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.

pub fn playlists(&self) -> &[Playlist]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .playlists.is_none().

pub fn status(&self) -> Option<&str>

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

pub fn user_metadata(&self) -> Option<&HashMap<String, String>>

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: _.:/=+-%@

pub fn timing(&self) -> Option<&Timing>

Details about the timing of a job.

impl Job

pub fn builder() -> JobBuilder

Creates a new builder-style object to manufacture Job.

Trait Implementations

impl Clone for Job

fn clone(&self) -> Job

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Job

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Job

fn eq(&self, other: &Job) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Job