Struct aws_sdk_mediaconvert::types::builders::JobBuilder

#[non_exhaustive]
pub struct JobBuilder { /* private fields */ }

A builder for Job.

Implementations

impl JobBuilder

pub fn acceleration_settings(self, input: AccelerationSettings) -> Self

Accelerated transcoding can significantly speed up jobs with long, visually complex content.

pub fn set_acceleration_settings( self, input: Option<AccelerationSettings> ) -> Self

Accelerated transcoding can significantly speed up jobs with long, visually complex content.

pub fn get_acceleration_settings(&self) -> &Option<AccelerationSettings>

Accelerated transcoding can significantly speed up jobs with long, visually complex content.

pub fn acceleration_status(self, input: AccelerationStatus) -> Self

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.

pub fn set_acceleration_status(self, input: Option<AccelerationStatus>) -> Self

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.

pub fn get_acceleration_status(&self) -> &Option<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.

pub fn arn(self, input: impl Into<String>) -> Self

An identifier for this resource that is unique within all of AWS.

pub fn set_arn(self, input: Option<String>) -> Self

An identifier for this resource that is unique within all of AWS.

pub fn get_arn(&self) -> &Option<String>

An identifier for this resource that is unique within all of AWS.

pub fn billing_tags_source(self, input: BillingTagsSource) -> Self

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.

pub fn set_billing_tags_source(self, input: Option<BillingTagsSource>) -> Self

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.

pub fn get_billing_tags_source(&self) -> &Option<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.

pub fn client_request_token(self, input: impl Into<String>) -> Self

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.

pub fn set_client_request_token(self, input: Option<String>) -> Self

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.

pub fn get_client_request_token(&self) -> &Option<String>

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.

pub fn created_at(self, input: DateTime) -> Self

The time, in Unix epoch format in seconds, when the job got created.

pub fn set_created_at(self, input: Option<DateTime>) -> Self

The time, in Unix epoch format in seconds, when the job got created.

pub fn get_created_at(&self) -> &Option<DateTime>

The time, in Unix epoch format in seconds, when the job got created.

pub fn current_phase(self, input: JobPhase) -> Self

A job’s phase can be PROBING, TRANSCODING OR UPLOADING

pub fn set_current_phase(self, input: Option<JobPhase>) -> Self

A job’s phase can be PROBING, TRANSCODING OR UPLOADING

pub fn get_current_phase(&self) -> &Option<JobPhase>

A job’s phase can be PROBING, TRANSCODING OR UPLOADING

pub fn error_code(self, input: i32) -> Self

Error code for the job

pub fn set_error_code(self, input: Option<i32>) -> Self

Error code for the job

pub fn get_error_code(&self) -> &Option<i32>

Error code for the job

pub fn error_message(self, input: impl Into<String>) -> Self

Error message of Job

pub fn set_error_message(self, input: Option<String>) -> Self

Error message of Job

pub fn get_error_message(&self) -> &Option<String>

Error message of Job

pub fn hop_destinations(self, input: HopDestination) -> Self

Appends an item to hop_destinations.

To override the contents of this collection use set_hop_destinations.

Optional list of hop destinations.

pub fn set_hop_destinations(self, input: Option<Vec<HopDestination>>) -> Self

Optional list of hop destinations.

pub fn get_hop_destinations(&self) -> &Option<Vec<HopDestination>>

Optional list of hop destinations.

pub fn id(self, input: impl Into<String>) -> Self

A portion of the job’s ARN, unique within your AWS Elemental MediaConvert resources

pub fn set_id(self, input: Option<String>) -> Self

A portion of the job’s ARN, unique within your AWS Elemental MediaConvert resources

pub fn get_id(&self) -> &Option<String>

A portion of the job’s ARN, unique within your AWS Elemental MediaConvert resources

pub fn job_percent_complete(self, input: i32) -> Self

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.

pub fn set_job_percent_complete(self, input: Option<i32>) -> Self

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.

pub fn get_job_percent_complete(&self) -> &Option<i32>

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.

pub fn job_template(self, input: impl Into<String>) -> Self

The job template that the job is created from, if it is created from a job template.

pub fn set_job_template(self, input: Option<String>) -> Self

The job template that the job is created from, if it is created from a job template.

pub fn get_job_template(&self) -> &Option<String>

The job template that the job is created from, if it is created from a job template.

pub fn messages(self, input: JobMessages) -> Self

Provides messages from the service about jobs that you have already successfully submitted.

pub fn set_messages(self, input: Option<JobMessages>) -> Self

Provides messages from the service about jobs that you have already successfully submitted.

pub fn get_messages(&self) -> &Option<JobMessages>

Provides messages from the service about jobs that you have already successfully submitted.

pub fn output_group_details(self, input: OutputGroupDetail) -> Self

Appends an item to output_group_details.

To override the contents of this collection use set_output_group_details.

List of output group details

pub fn set_output_group_details( self, input: Option<Vec<OutputGroupDetail>> ) -> Self

List of output group details

pub fn get_output_group_details(&self) -> &Option<Vec<OutputGroupDetail>>

List of output group details

pub fn priority(self, input: i32) -> Self

Relative priority on the job.

pub fn set_priority(self, input: Option<i32>) -> Self

Relative priority on the job.

pub fn get_priority(&self) -> &Option<i32>

Relative priority on the job.

pub fn queue(self, input: impl Into<String>) -> Self

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

pub fn set_queue(self, input: Option<String>) -> Self

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

pub fn get_queue(&self) -> &Option<String>

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

pub fn queue_transitions(self, input: QueueTransition) -> Self

Appends an item to queue_transitions.

To override the contents of this collection use set_queue_transitions.

The job’s queue hopping history.

pub fn set_queue_transitions(self, input: Option<Vec<QueueTransition>>) -> Self

The job’s queue hopping history.

pub fn get_queue_transitions(&self) -> &Option<Vec<QueueTransition>>

The job’s queue hopping history.

pub fn retry_count(self, input: i32) -> Self

The number of times that the service automatically attempted to process your job after encountering an error.

pub fn set_retry_count(self, input: Option<i32>) -> Self

The number of times that the service automatically attempted to process your job after encountering an error.

pub fn get_retry_count(&self) -> &Option<i32>

The number of times that the service automatically attempted to process your job after encountering an error.

pub fn role(self, input: impl Into<String>) -> Self

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 This field is required.

pub fn set_role(self, input: Option<String>) -> Self

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

pub fn get_role(&self) -> &Option<String>

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

pub fn settings(self, input: JobSettings) -> Self

JobSettings contains all the transcode settings for a job. This field is required.

pub fn set_settings(self, input: Option<JobSettings>) -> Self

JobSettings contains all the transcode settings for a job.

pub fn get_settings(&self) -> &Option<JobSettings>

JobSettings contains all the transcode settings for a job.

pub fn simulate_reserved_queue(self, input: SimulateReservedQueue) -> Self

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.

pub fn set_simulate_reserved_queue( self, input: Option<SimulateReservedQueue> ) -> Self

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.

pub fn get_simulate_reserved_queue(&self) -> &Option<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.

pub fn status(self, input: JobStatus) -> Self

A job’s status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

pub fn set_status(self, input: Option<JobStatus>) -> Self

A job’s status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

pub fn get_status(&self) -> &Option<JobStatus>

A job’s status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

pub fn status_update_interval(self, input: StatusUpdateInterval) -> Self

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.

pub fn set_status_update_interval( self, input: Option<StatusUpdateInterval> ) -> Self

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.

pub fn get_status_update_interval(&self) -> &Option<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.

pub fn timing(self, input: Timing) -> Self

Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.

pub fn set_timing(self, input: Option<Timing>) -> Self

Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.

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

Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.

pub fn user_metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to user_metadata.

To override the contents of this collection use set_user_metadata.

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

pub fn set_user_metadata(self, input: Option<HashMap<String, String>>) -> Self

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

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

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

pub fn warnings(self, input: WarningGroup) -> Self

Appends an item to warnings.

To override the contents of this collection use set_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

pub fn set_warnings(self, input: Option<Vec<WarningGroup>>) -> Self

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

pub fn get_warnings(&self) -> &Option<Vec<WarningGroup>>

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

pub fn build(self) -> Job

Consumes the builder and constructs a Job.

Trait Implementations

impl Clone for JobBuilder

fn clone(&self) -> JobBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JobBuilder

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

Formats the value using the given formatter.

impl Default for JobBuilder

fn default() -> JobBuilder

Returns the “default value” for a type.

impl PartialEq for JobBuilder

fn eq(&self, other: &JobBuilder) -> 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 JobBuilder