com.amazonaws.services.mediaconvert.model.CreateJobRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-mediaconvert Show documentation
Show all versions of aws-java-sdk-mediaconvert Show documentation
The AWS Java SDK for AWS Elemental MediaConvert module holds the client classes that are used for communicating with AWS Elemental MediaConvert Service
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.mediaconvert.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateJobRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
* Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs
* that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental
* MediaConvert User Guide.
*/
private AccelerationSettings accelerationSettings;
/**
* Optional. Choose a 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. Any transcoding outputs that don't have an associated tag will
* appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will
* appear on the billing report unsorted.
*/
private String billingTagsSource;
/**
* 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.
*/
private String clientRequestToken;
/**
* Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to.
* Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For
* more information about this feature, see the AWS Elemental MediaConvert User Guide.
*/
private java.util.List hopDestinations;
/**
* Optional. When you create a job, you can either specify a job template or specify the transcoding settings
* individually.
*/
private String jobTemplate;
/**
* Optional. Specify the relative priority for this job. In any given queue, the service begins processing the job
* with the highest value first. When more than one job has the same priority, the service begins processing the job
* that you submitted first. If you don't specify a priority, the service uses the default value 0.
*/
private Integer priority;
/**
* Optional. 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.
*/
private String queue;
/**
* Required. 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.
*/
private String role;
/** JobSettings contains all the transcode settings for a job. */
private JobSettings settings;
/**
* Optional. 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.
*/
private String simulateReservedQueue;
/**
* Optional. 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.
*/
private String statusUpdateInterval;
/**
* Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or with only
* a key. Use standard AWS tags on your job for automatic integration with AWS services and for custom integrations
* and workflows.
*/
private java.util.Map tags;
/**
* Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in
* key/value pairs. Use only for existing integrations or workflows that rely on job metadata tags. Otherwise, we
* recommend that you use standard AWS tags.
*/
private java.util.Map userMetadata;
/**
* Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs
* that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental
* MediaConvert User Guide.
*
* @param accelerationSettings
* Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content.
* Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the
* AWS Elemental MediaConvert User Guide.
*/
public void setAccelerationSettings(AccelerationSettings accelerationSettings) {
this.accelerationSettings = accelerationSettings;
}
/**
* Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs
* that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental
* MediaConvert User Guide.
*
* @return Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content.
* Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the
* AWS Elemental MediaConvert User Guide.
*/
public AccelerationSettings getAccelerationSettings() {
return this.accelerationSettings;
}
/**
* Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs
* that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental
* MediaConvert User Guide.
*
* @param accelerationSettings
* Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content.
* Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the
* AWS Elemental MediaConvert User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobRequest withAccelerationSettings(AccelerationSettings accelerationSettings) {
setAccelerationSettings(accelerationSettings);
return this;
}
/**
* Optional. Choose a 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. Any transcoding outputs that don't have an associated tag will
* appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will
* appear on the billing report unsorted.
*
* @param billingTagsSource
* Optional. Choose a 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. Any transcoding outputs that don't have an
* associated tag will appear in your billing report unsorted. If you don't choose a valid value for this
* field, your job outputs will appear on the billing report unsorted.
* @see BillingTagsSource
*/
public void setBillingTagsSource(String billingTagsSource) {
this.billingTagsSource = billingTagsSource;
}
/**
* Optional. Choose a 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. Any transcoding outputs that don't have an associated tag will
* appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will
* appear on the billing report unsorted.
*
* @return Optional. Choose a 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. Any transcoding outputs that don't have an
* associated tag will appear in your billing report unsorted. If you don't choose a valid value for this
* field, your job outputs will appear on the billing report unsorted.
* @see BillingTagsSource
*/
public String getBillingTagsSource() {
return this.billingTagsSource;
}
/**
* Optional. Choose a 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. Any transcoding outputs that don't have an associated tag will
* appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will
* appear on the billing report unsorted.
*
* @param billingTagsSource
* Optional. Choose a 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. Any transcoding outputs that don't have an
* associated tag will appear in your billing report unsorted. If you don't choose a valid value for this
* field, your job outputs will appear on the billing report unsorted.
* @return Returns a reference to this object so that method calls can be chained together.
* @see BillingTagsSource
*/
public CreateJobRequest withBillingTagsSource(String billingTagsSource) {
setBillingTagsSource(billingTagsSource);
return this;
}
/**
* Optional. Choose a 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. Any transcoding outputs that don't have an associated tag will
* appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will
* appear on the billing report unsorted.
*
* @param billingTagsSource
* Optional. Choose a 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. Any transcoding outputs that don't have an
* associated tag will appear in your billing report unsorted. If you don't choose a valid value for this
* field, your job outputs will appear on the billing report unsorted.
* @return Returns a reference to this object so that method calls can be chained together.
* @see BillingTagsSource
*/
public CreateJobRequest withBillingTagsSource(BillingTagsSource billingTagsSource) {
this.billingTagsSource = billingTagsSource.toString();
return this;
}
/**
* 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.
*
* @param 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.
*/
public void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = 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.
*
* @return 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.
*/
public String getClientRequestToken() {
return this.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.
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobRequest withClientRequestToken(String clientRequestToken) {
setClientRequestToken(clientRequestToken);
return this;
}
/**
* Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to.
* Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For
* more information about this feature, see the AWS Elemental MediaConvert User Guide.
*
* @return Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your
* job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue
* before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.
*/
public java.util.List getHopDestinations() {
return hopDestinations;
}
/**
* Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to.
* Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For
* more information about this feature, see the AWS Elemental MediaConvert User Guide.
*
* @param hopDestinations
* Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your
* job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue
* before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.
*/
public void setHopDestinations(java.util.Collection hopDestinations) {
if (hopDestinations == null) {
this.hopDestinations = null;
return;
}
this.hopDestinations = new java.util.ArrayList(hopDestinations);
}
/**
* Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to.
* Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For
* more information about this feature, see the AWS Elemental MediaConvert User Guide.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setHopDestinations(java.util.Collection)} or {@link #withHopDestinations(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param hopDestinations
* Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your
* job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue
* before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobRequest withHopDestinations(HopDestination... hopDestinations) {
if (this.hopDestinations == null) {
setHopDestinations(new java.util.ArrayList(hopDestinations.length));
}
for (HopDestination ele : hopDestinations) {
this.hopDestinations.add(ele);
}
return this;
}
/**
* Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to.
* Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For
* more information about this feature, see the AWS Elemental MediaConvert User Guide.
*
* @param hopDestinations
* Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your
* job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue
* before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobRequest withHopDestinations(java.util.Collection hopDestinations) {
setHopDestinations(hopDestinations);
return this;
}
/**
* Optional. When you create a job, you can either specify a job template or specify the transcoding settings
* individually.
*
* @param jobTemplate
* Optional. When you create a job, you can either specify a job template or specify the transcoding settings
* individually.
*/
public void setJobTemplate(String jobTemplate) {
this.jobTemplate = jobTemplate;
}
/**
* Optional. When you create a job, you can either specify a job template or specify the transcoding settings
* individually.
*
* @return Optional. When you create a job, you can either specify a job template or specify the transcoding
* settings individually.
*/
public String getJobTemplate() {
return this.jobTemplate;
}
/**
* Optional. When you create a job, you can either specify a job template or specify the transcoding settings
* individually.
*
* @param jobTemplate
* Optional. When you create a job, you can either specify a job template or specify the transcoding settings
* individually.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobRequest withJobTemplate(String jobTemplate) {
setJobTemplate(jobTemplate);
return this;
}
/**
* Optional. Specify the relative priority for this job. In any given queue, the service begins processing the job
* with the highest value first. When more than one job has the same priority, the service begins processing the job
* that you submitted first. If you don't specify a priority, the service uses the default value 0.
*
* @param priority
* Optional. Specify the relative priority for this job. In any given queue, the service begins processing
* the job with the highest value first. When more than one job has the same priority, the service begins
* processing the job that you submitted first. If you don't specify a priority, the service uses the default
* value 0.
*/
public void setPriority(Integer priority) {
this.priority = priority;
}
/**
* Optional. Specify the relative priority for this job. In any given queue, the service begins processing the job
* with the highest value first. When more than one job has the same priority, the service begins processing the job
* that you submitted first. If you don't specify a priority, the service uses the default value 0.
*
* @return Optional. Specify the relative priority for this job. In any given queue, the service begins processing
* the job with the highest value first. When more than one job has the same priority, the service begins
* processing the job that you submitted first. If you don't specify a priority, the service uses the
* default value 0.
*/
public Integer getPriority() {
return this.priority;
}
/**
* Optional. Specify the relative priority for this job. In any given queue, the service begins processing the job
* with the highest value first. When more than one job has the same priority, the service begins processing the job
* that you submitted first. If you don't specify a priority, the service uses the default value 0.
*
* @param priority
* Optional. Specify the relative priority for this job. In any given queue, the service begins processing
* the job with the highest value first. When more than one job has the same priority, the service begins
* processing the job that you submitted first. If you don't specify a priority, the service uses the default
* value 0.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobRequest withPriority(Integer priority) {
setPriority(priority);
return this;
}
/**
* Optional. 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.
*
* @param queue
* Optional. 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.
*/
public void setQueue(String queue) {
this.queue = queue;
}
/**
* Optional. 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.
*
* @return Optional. 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.
*/
public String getQueue() {
return this.queue;
}
/**
* Optional. 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.
*
* @param queue
* Optional. 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobRequest withQueue(String queue) {
setQueue(queue);
return this;
}
/**
* Required. 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.
*
* @param role
* Required. 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.
*/
public void setRole(String role) {
this.role = role;
}
/**
* Required. 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.
*
* @return Required. 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.
*/
public String getRole() {
return this.role;
}
/**
* Required. 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.
*
* @param role
* Required. 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobRequest withRole(String role) {
setRole(role);
return this;
}
/**
* JobSettings contains all the transcode settings for a job.
*
* @param settings
* JobSettings contains all the transcode settings for a job.
*/
public void setSettings(JobSettings settings) {
this.settings = settings;
}
/**
* JobSettings contains all the transcode settings for a job.
*
* @return JobSettings contains all the transcode settings for a job.
*/
public JobSettings getSettings() {
return this.settings;
}
/**
* JobSettings contains all the transcode settings for a job.
*
* @param settings
* JobSettings contains all the transcode settings for a job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobRequest withSettings(JobSettings settings) {
setSettings(settings);
return this;
}
/**
* Optional. 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.
*
* @param simulateReservedQueue
* Optional. 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 SimulateReservedQueue
*/
public void setSimulateReservedQueue(String simulateReservedQueue) {
this.simulateReservedQueue = simulateReservedQueue;
}
/**
* Optional. 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.
*
* @return Optional. 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 SimulateReservedQueue
*/
public String getSimulateReservedQueue() {
return this.simulateReservedQueue;
}
/**
* Optional. 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.
*
* @param simulateReservedQueue
* Optional. 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SimulateReservedQueue
*/
public CreateJobRequest withSimulateReservedQueue(String simulateReservedQueue) {
setSimulateReservedQueue(simulateReservedQueue);
return this;
}
/**
* Optional. 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.
*
* @param simulateReservedQueue
* Optional. 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SimulateReservedQueue
*/
public CreateJobRequest withSimulateReservedQueue(SimulateReservedQueue simulateReservedQueue) {
this.simulateReservedQueue = simulateReservedQueue.toString();
return this;
}
/**
* Optional. 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.
*
* @param statusUpdateInterval
* Optional. 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 StatusUpdateInterval
*/
public void setStatusUpdateInterval(String statusUpdateInterval) {
this.statusUpdateInterval = statusUpdateInterval;
}
/**
* Optional. 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.
*
* @return Optional. 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 StatusUpdateInterval
*/
public String getStatusUpdateInterval() {
return this.statusUpdateInterval;
}
/**
* Optional. 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.
*
* @param statusUpdateInterval
* Optional. 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StatusUpdateInterval
*/
public CreateJobRequest withStatusUpdateInterval(String statusUpdateInterval) {
setStatusUpdateInterval(statusUpdateInterval);
return this;
}
/**
* Optional. 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.
*
* @param statusUpdateInterval
* Optional. 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StatusUpdateInterval
*/
public CreateJobRequest withStatusUpdateInterval(StatusUpdateInterval statusUpdateInterval) {
this.statusUpdateInterval = statusUpdateInterval.toString();
return this;
}
/**
* Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or with only
* a key. Use standard AWS tags on your job for automatic integration with AWS services and for custom integrations
* and workflows.
*
* @return Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or
* with only a key. Use standard AWS tags on your job for automatic integration with AWS services and for
* custom integrations and workflows.
*/
public java.util.Map getTags() {
return tags;
}
/**
* Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or with only
* a key. Use standard AWS tags on your job for automatic integration with AWS services and for custom integrations
* and workflows.
*
* @param tags
* Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or
* with only a key. Use standard AWS tags on your job for automatic integration with AWS services and for
* custom integrations and workflows.
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
* Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or with only
* a key. Use standard AWS tags on your job for automatic integration with AWS services and for custom integrations
* and workflows.
*
* @param tags
* Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or
* with only a key. Use standard AWS tags on your job for automatic integration with AWS services and for
* custom integrations and workflows.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobRequest withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see CreateJobRequest#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public CreateJobRequest addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap();
}
if (this.tags.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.tags.put(key, value);
return this;
}
/**
* Removes all the entries added into Tags.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobRequest clearTagsEntries() {
this.tags = null;
return this;
}
/**
* Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in
* key/value pairs. Use only for existing integrations or workflows that rely on job metadata tags. Otherwise, we
* recommend that you use standard AWS tags.
*
* @return Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata
* in key/value pairs. Use only for existing integrations or workflows that rely on job metadata tags.
* Otherwise, we recommend that you use standard AWS tags.
*/
public java.util.Map getUserMetadata() {
return userMetadata;
}
/**
* Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in
* key/value pairs. Use only for existing integrations or workflows that rely on job metadata tags. Otherwise, we
* recommend that you use standard AWS tags.
*
* @param userMetadata
* Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata
* in key/value pairs. Use only for existing integrations or workflows that rely on job metadata tags.
* Otherwise, we recommend that you use standard AWS tags.
*/
public void setUserMetadata(java.util.Map userMetadata) {
this.userMetadata = userMetadata;
}
/**
* Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in
* key/value pairs. Use only for existing integrations or workflows that rely on job metadata tags. Otherwise, we
* recommend that you use standard AWS tags.
*
* @param userMetadata
* Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata
* in key/value pairs. Use only for existing integrations or workflows that rely on job metadata tags.
* Otherwise, we recommend that you use standard AWS tags.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobRequest withUserMetadata(java.util.Map userMetadata) {
setUserMetadata(userMetadata);
return this;
}
/**
* Add a single UserMetadata entry
*
* @see CreateJobRequest#withUserMetadata
* @returns a reference to this object so that method calls can be chained together.
*/
public CreateJobRequest addUserMetadataEntry(String key, String value) {
if (null == this.userMetadata) {
this.userMetadata = new java.util.HashMap();
}
if (this.userMetadata.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.userMetadata.put(key, value);
return this;
}
/**
* Removes all the entries added into UserMetadata.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobRequest clearUserMetadataEntries() {
this.userMetadata = null;
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAccelerationSettings() != null)
sb.append("AccelerationSettings: ").append(getAccelerationSettings()).append(",");
if (getBillingTagsSource() != null)
sb.append("BillingTagsSource: ").append(getBillingTagsSource()).append(",");
if (getClientRequestToken() != null)
sb.append("ClientRequestToken: ").append(getClientRequestToken()).append(",");
if (getHopDestinations() != null)
sb.append("HopDestinations: ").append(getHopDestinations()).append(",");
if (getJobTemplate() != null)
sb.append("JobTemplate: ").append(getJobTemplate()).append(",");
if (getPriority() != null)
sb.append("Priority: ").append(getPriority()).append(",");
if (getQueue() != null)
sb.append("Queue: ").append(getQueue()).append(",");
if (getRole() != null)
sb.append("Role: ").append(getRole()).append(",");
if (getSettings() != null)
sb.append("Settings: ").append(getSettings()).append(",");
if (getSimulateReservedQueue() != null)
sb.append("SimulateReservedQueue: ").append(getSimulateReservedQueue()).append(",");
if (getStatusUpdateInterval() != null)
sb.append("StatusUpdateInterval: ").append(getStatusUpdateInterval()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getUserMetadata() != null)
sb.append("UserMetadata: ").append(getUserMetadata());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateJobRequest == false)
return false;
CreateJobRequest other = (CreateJobRequest) obj;
if (other.getAccelerationSettings() == null ^ this.getAccelerationSettings() == null)
return false;
if (other.getAccelerationSettings() != null && other.getAccelerationSettings().equals(this.getAccelerationSettings()) == false)
return false;
if (other.getBillingTagsSource() == null ^ this.getBillingTagsSource() == null)
return false;
if (other.getBillingTagsSource() != null && other.getBillingTagsSource().equals(this.getBillingTagsSource()) == false)
return false;
if (other.getClientRequestToken() == null ^ this.getClientRequestToken() == null)
return false;
if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false)
return false;
if (other.getHopDestinations() == null ^ this.getHopDestinations() == null)
return false;
if (other.getHopDestinations() != null && other.getHopDestinations().equals(this.getHopDestinations()) == false)
return false;
if (other.getJobTemplate() == null ^ this.getJobTemplate() == null)
return false;
if (other.getJobTemplate() != null && other.getJobTemplate().equals(this.getJobTemplate()) == false)
return false;
if (other.getPriority() == null ^ this.getPriority() == null)
return false;
if (other.getPriority() != null && other.getPriority().equals(this.getPriority()) == false)
return false;
if (other.getQueue() == null ^ this.getQueue() == null)
return false;
if (other.getQueue() != null && other.getQueue().equals(this.getQueue()) == false)
return false;
if (other.getRole() == null ^ this.getRole() == null)
return false;
if (other.getRole() != null && other.getRole().equals(this.getRole()) == false)
return false;
if (other.getSettings() == null ^ this.getSettings() == null)
return false;
if (other.getSettings() != null && other.getSettings().equals(this.getSettings()) == false)
return false;
if (other.getSimulateReservedQueue() == null ^ this.getSimulateReservedQueue() == null)
return false;
if (other.getSimulateReservedQueue() != null && other.getSimulateReservedQueue().equals(this.getSimulateReservedQueue()) == false)
return false;
if (other.getStatusUpdateInterval() == null ^ this.getStatusUpdateInterval() == null)
return false;
if (other.getStatusUpdateInterval() != null && other.getStatusUpdateInterval().equals(this.getStatusUpdateInterval()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getUserMetadata() == null ^ this.getUserMetadata() == null)
return false;
if (other.getUserMetadata() != null && other.getUserMetadata().equals(this.getUserMetadata()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAccelerationSettings() == null) ? 0 : getAccelerationSettings().hashCode());
hashCode = prime * hashCode + ((getBillingTagsSource() == null) ? 0 : getBillingTagsSource().hashCode());
hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode());
hashCode = prime * hashCode + ((getHopDestinations() == null) ? 0 : getHopDestinations().hashCode());
hashCode = prime * hashCode + ((getJobTemplate() == null) ? 0 : getJobTemplate().hashCode());
hashCode = prime * hashCode + ((getPriority() == null) ? 0 : getPriority().hashCode());
hashCode = prime * hashCode + ((getQueue() == null) ? 0 : getQueue().hashCode());
hashCode = prime * hashCode + ((getRole() == null) ? 0 : getRole().hashCode());
hashCode = prime * hashCode + ((getSettings() == null) ? 0 : getSettings().hashCode());
hashCode = prime * hashCode + ((getSimulateReservedQueue() == null) ? 0 : getSimulateReservedQueue().hashCode());
hashCode = prime * hashCode + ((getStatusUpdateInterval() == null) ? 0 : getStatusUpdateInterval().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getUserMetadata() == null) ? 0 : getUserMetadata().hashCode());
return hashCode;
}
@Override
public CreateJobRequest clone() {
return (CreateJobRequest) super.clone();
}
}