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() Optional.
BillingTagsSource	billingTagsSource() Optional.
String	billingTagsSourceAsString() Optional.
static CreateJobRequest.Builder	builder()
String	clientRequestToken() Prevent duplicate jobs from being created and ensure idempotency for your requests.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasHopDestinations() For responses, this returns true if the service returned a value for the HopDestinations property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
boolean	hasUserMetadata() For responses, this returns true if the service returned a value for the UserMetadata property.
List<HopDestination>	hopDestinations() Optional.
String	jobTemplate() Optional.
Integer	priority() Optional.
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() Optional.
String	simulateReservedQueueAsString() Optional.
StatusUpdateInterval	statusUpdateInterval() Optional.
String	statusUpdateIntervalAsString() Optional.
Map<String,String>	tags() Optional.
CreateJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Map<String,String>	userMetadata() Optional.

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

Returns:

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.

billingTagsSource

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

Returns:

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.

hasHopDestinations

public final boolean hasHopDestinations()

For responses, this returns true if the service returned a value for the HopDestinations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

hopDestinations

public final List<HopDestination> 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.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHopDestinations() method.

Returns:

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.

jobTemplate

public final String jobTemplate()

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

Returns:

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

priority

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

Returns:

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.

queue

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

role

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

settings

public final JobSettings settings()

JobSettings contains all the transcode settings for a job.

Returns:

JobSettings contains all the transcode settings for a job.

simulateReservedQueue

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

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:

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

SimulateReservedQueue

simulateReservedQueueAsString

public final String simulateReservedQueueAsString()

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.

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:

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

SimulateReservedQueue

statusUpdateInterval

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

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:

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

StatusUpdateInterval

statusUpdateIntervalAsString

public final String statusUpdateIntervalAsString()

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.

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:

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

StatusUpdateInterval

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> 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.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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.

hasUserMetadata

public final boolean hasUserMetadata()

For responses, this returns true if the service returned a value for the UserMetadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

userMetadata

public final Map<String,String> 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.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserMetadata() method.

Returns:

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.

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 final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo