#[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>,
}
Expand description
A section of the response body that provides information about the job that is created.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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
anda-z
-
Space
-
The following symbols:
_.:/=+-%@
timing: Option<Timing>
Details about the timing of a job.
Implementations§
Source§impl Job
impl Job
Sourcepub fn id(&self) -> Option<&str>
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.
Sourcepub fn pipeline_id(&self) -> Option<&str>
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.
Sourcepub fn input(&self) -> Option<&JobInput>
pub fn input(&self) -> Option<&JobInput>
A section of the request or response body that provides information about the file that is being transcoded.
Sourcepub fn inputs(&self) -> &[JobInput]
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()
.
Sourcepub fn output(&self) -> Option<&JobOutput>
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.
Sourcepub fn outputs(&self) -> &[JobOutput]
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()
.
Sourcepub fn output_key_prefix(&self) -> Option<&str>
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
.
Sourcepub fn playlists(&self) -> &[Playlist]
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()
.
Sourcepub fn status(&self) -> Option<&str>
pub fn status(&self) -> Option<&str>
The status of the job: Submitted
, Progressing
, Complete
, Canceled
, or Error
.
Sourcepub fn user_metadata(&self) -> Option<&HashMap<String, String>>
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
anda-z
-
Space
-
The following symbols:
_.:/=+-%@
Trait Implementations§
impl StructuralPartialEq for Job
Auto Trait Implementations§
impl Freeze for Job
impl RefUnwindSafe for Job
impl Send for Job
impl Sync for Job
impl Unpin for Job
impl UnwindSafe for Job
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);