software.amazon.awssdk.services.mediaconvert.model

Class CreateJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.mediaconvert.model.MediaConvertRequest

software.amazon.awssdk.services.mediaconvert.model.CreateJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateJobRequest
extends MediaConvertRequest
implements ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
AccelerationSettings	accelerationSettings() Accelerated transcoding can significantly speed up jobs with long, visually complex content.
BillingTagsSource	billingTagsSource() Optional.
String	billingTagsSourceAsString() Optional.
static CreateJobRequest.Builder	builder()
String	clientRequestToken() Idempotency token for CreateJob operation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobTemplate() When you create a job, you can either specify a job template or specify the transcoding settings individually
Integer	priority() Specify the relative priority for this job.
String	queue() Optional.
String	role() Required.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateJobRequest.Builder>	serializableBuilderClass()
JobSettings	settings() JobSettings contains all the transcode settings for a job.
SimulateReservedQueue	simulateReservedQueue() Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need.
String	simulateReservedQueueAsString() Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need.
StatusUpdateInterval	statusUpdateInterval() Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.
String	statusUpdateIntervalAsString() Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.
Map<String,String>	tags() The tags that you want to add to the resource.
CreateJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Map<String,String>	userMetadata() User-defined metadata that you want to associate with an MediaConvert job.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

accelerationSettings

public AccelerationSettings accelerationSettings()

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.

Returns:

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.

billingTagsSource

public 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.

If the service returns an enum value that is not available in the current SDK version, billingTagsSource will return BillingTagsSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from billingTagsSourceAsString().

Returns:

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 Also:

BillingTagsSource

billingTagsSourceAsString

public String billingTagsSourceAsString()

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.

If the service returns an enum value that is not available in the current SDK version, billingTagsSource will return BillingTagsSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from billingTagsSourceAsString().

Returns:

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 Also:

BillingTagsSource

clientRequestToken

public String clientRequestToken()

Idempotency token for CreateJob operation.

Returns:

Idempotency token for CreateJob operation.

jobTemplate

public String jobTemplate()

When you create a job, you can either specify a job template or specify the transcoding settings individually

Returns:

When you create a job, you can either specify a job template or specify the transcoding settings individually

priority

public Integer priority()

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.

Returns:

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.

queue

public String 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 http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html.

Returns:

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 http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html.

role

public String 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 http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.

Returns:

Required. The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.

settings

public JobSettings settings()

JobSettings contains all the transcode settings for a job.

Returns:

JobSettings contains all the transcode settings for a job.

simulateReservedQueue

public SimulateReservedQueue 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.

If the service returns an enum value that is not available in the current SDK version, simulateReservedQueue will return SimulateReservedQueue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from simulateReservedQueueAsString().

Returns:

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 Also:

SimulateReservedQueue

simulateReservedQueueAsString

public String simulateReservedQueueAsString()

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.

If the service returns an enum value that is not available in the current SDK version, simulateReservedQueue will return SimulateReservedQueue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from simulateReservedQueueAsString().

Returns:

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 Also:

SimulateReservedQueue

statusUpdateInterval

public StatusUpdateInterval 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.

If the service returns an enum value that is not available in the current SDK version, statusUpdateInterval will return StatusUpdateInterval.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusUpdateIntervalAsString().

Returns:

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 Also:

StatusUpdateInterval

statusUpdateIntervalAsString

public String statusUpdateIntervalAsString()

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.

If the service returns an enum value that is not available in the current SDK version, statusUpdateInterval will return StatusUpdateInterval.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusUpdateIntervalAsString().

Returns:

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 Also:

StatusUpdateInterval

tags

public Map<String,String> tags()

The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.

userMetadata

public Map<String,String> userMetadata()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

toBuilder

public CreateJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>

Specified by:

toBuilder in class MediaConvertRequest

builder

public static CreateJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateJobRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

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.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo