@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateJobRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateJobRequest() |
Modifier and Type | Method and Description |
---|---|
CreateJobRequest |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
CreateJobRequest |
addUserMetadataEntry(String key,
String value)
Add a single UserMetadata entry
|
CreateJobRequest |
clearTagsEntries()
Removes all the entries added into Tags.
|
CreateJobRequest |
clearUserMetadataEntries()
Removes all the entries added into UserMetadata.
|
CreateJobRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
AccelerationSettings |
getAccelerationSettings()
Optional.
|
String |
getBillingTagsSource()
Optional.
|
String |
getClientRequestToken()
Prevent duplicate jobs from being created and ensure idempotency for your requests.
|
List<HopDestination> |
getHopDestinations()
Optional.
|
String |
getJobTemplate()
Optional.
|
Integer |
getPriority()
Optional.
|
String |
getQueue()
Optional.
|
String |
getRole()
Required.
|
JobSettings |
getSettings()
JobSettings contains all the transcode settings for a job.
|
String |
getSimulateReservedQueue()
Optional.
|
String |
getStatusUpdateInterval()
Optional.
|
Map<String,String> |
getTags()
Optional.
|
Map<String,String> |
getUserMetadata()
Optional.
|
int |
hashCode() |
void |
setAccelerationSettings(AccelerationSettings accelerationSettings)
Optional.
|
void |
setBillingTagsSource(String billingTagsSource)
Optional.
|
void |
setClientRequestToken(String clientRequestToken)
Prevent duplicate jobs from being created and ensure idempotency for your requests.
|
void |
setHopDestinations(Collection<HopDestination> hopDestinations)
Optional.
|
void |
setJobTemplate(String jobTemplate)
Optional.
|
void |
setPriority(Integer priority)
Optional.
|
void |
setQueue(String queue)
Optional.
|
void |
setRole(String role)
Required.
|
void |
setSettings(JobSettings settings)
JobSettings contains all the transcode settings for a job.
|
void |
setSimulateReservedQueue(String simulateReservedQueue)
Optional.
|
void |
setStatusUpdateInterval(String statusUpdateInterval)
Optional.
|
void |
setTags(Map<String,String> tags)
Optional.
|
void |
setUserMetadata(Map<String,String> userMetadata)
Optional.
|
String |
toString()
Returns a string representation of this object.
|
CreateJobRequest |
withAccelerationSettings(AccelerationSettings accelerationSettings)
Optional.
|
CreateJobRequest |
withBillingTagsSource(BillingTagsSource billingTagsSource)
Optional.
|
CreateJobRequest |
withBillingTagsSource(String billingTagsSource)
Optional.
|
CreateJobRequest |
withClientRequestToken(String clientRequestToken)
Prevent duplicate jobs from being created and ensure idempotency for your requests.
|
CreateJobRequest |
withHopDestinations(Collection<HopDestination> hopDestinations)
Optional.
|
CreateJobRequest |
withHopDestinations(HopDestination... hopDestinations)
Optional.
|
CreateJobRequest |
withJobTemplate(String jobTemplate)
Optional.
|
CreateJobRequest |
withPriority(Integer priority)
Optional.
|
CreateJobRequest |
withQueue(String queue)
Optional.
|
CreateJobRequest |
withRole(String role)
Required.
|
CreateJobRequest |
withSettings(JobSettings settings)
JobSettings contains all the transcode settings for a job.
|
CreateJobRequest |
withSimulateReservedQueue(SimulateReservedQueue simulateReservedQueue)
Optional.
|
CreateJobRequest |
withSimulateReservedQueue(String simulateReservedQueue)
Optional.
|
CreateJobRequest |
withStatusUpdateInterval(StatusUpdateInterval statusUpdateInterval)
Optional.
|
CreateJobRequest |
withStatusUpdateInterval(String statusUpdateInterval)
Optional.
|
CreateJobRequest |
withTags(Map<String,String> tags)
Optional.
|
CreateJobRequest |
withUserMetadata(Map<String,String> userMetadata)
Optional.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setAccelerationSettings(AccelerationSettings 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.public AccelerationSettings getAccelerationSettings()
public CreateJobRequest withAccelerationSettings(AccelerationSettings 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.public void setBillingTagsSource(String 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.BillingTagsSource
public String getBillingTagsSource()
BillingTagsSource
public CreateJobRequest withBillingTagsSource(String 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.BillingTagsSource
public CreateJobRequest withBillingTagsSource(BillingTagsSource 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.BillingTagsSource
public void setClientRequestToken(String 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.public String getClientRequestToken()
public CreateJobRequest withClientRequestToken(String 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.public List<HopDestination> getHopDestinations()
public void setHopDestinations(Collection<HopDestination> hopDestinations)
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 CreateJobRequest withHopDestinations(HopDestination... hopDestinations)
NOTE: This method appends the values to the existing list (if any). Use
setHopDestinations(java.util.Collection)
or withHopDestinations(java.util.Collection)
if you
want to override the existing values.
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 CreateJobRequest withHopDestinations(Collection<HopDestination> hopDestinations)
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 setJobTemplate(String jobTemplate)
jobTemplate
- Optional. When you create a job, you can either specify a job template or specify the transcoding settings
individually.public String getJobTemplate()
public CreateJobRequest withJobTemplate(String jobTemplate)
jobTemplate
- Optional. When you create a job, you can either specify a job template or specify the transcoding settings
individually.public void setPriority(Integer 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.public Integer getPriority()
public CreateJobRequest withPriority(Integer 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.public void setQueue(String 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.public String getQueue()
public CreateJobRequest withQueue(String 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.public void setRole(String 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.public String getRole()
public CreateJobRequest withRole(String 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.public void setSettings(JobSettings settings)
settings
- JobSettings contains all the transcode settings for a job.public JobSettings getSettings()
public CreateJobRequest withSettings(JobSettings settings)
settings
- JobSettings contains all the transcode settings for a job.public void setSimulateReservedQueue(String 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.SimulateReservedQueue
public String getSimulateReservedQueue()
SimulateReservedQueue
public CreateJobRequest withSimulateReservedQueue(String 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.SimulateReservedQueue
public CreateJobRequest withSimulateReservedQueue(SimulateReservedQueue 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.SimulateReservedQueue
public void setStatusUpdateInterval(String 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.StatusUpdateInterval
public String getStatusUpdateInterval()
StatusUpdateInterval
public CreateJobRequest withStatusUpdateInterval(String 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.StatusUpdateInterval
public CreateJobRequest withStatusUpdateInterval(StatusUpdateInterval 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.StatusUpdateInterval
public Map<String,String> getTags()
public void setTags(Map<String,String> 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.public CreateJobRequest withTags(Map<String,String> 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.public CreateJobRequest addTagsEntry(String key, String value)
public CreateJobRequest clearTagsEntries()
public Map<String,String> getUserMetadata()
public void setUserMetadata(Map<String,String> 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.public CreateJobRequest withUserMetadata(Map<String,String> 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.public CreateJobRequest addUserMetadataEntry(String key, String value)
public CreateJobRequest clearUserMetadataEntries()
public String toString()
toString
in class Object
Object.toString()
public CreateJobRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()