CreateJobRequest (AWS Java SDK :: Services :: AWS Elemental MediaConvert 2.16.76 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateJobRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccelerationSettings`	`accelerationSettings()` Optional.
`BillingTagsSource`	`billingTagsSource()` Optional.
`String`	`billingTagsSourceAsString()` Optional.
`static CreateJobRequest.Builder`	`builder()`
`String`	`clientRequestToken()` Optional.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasHopDestinations()` Returns true if the HopDestinations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasUserMetadata()` Returns true if the UserMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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()
```
    Optional. Idempotency token for CreateJob operation.
    
    Returns:
    
    Optional. Idempotency token for CreateJob operation.
  - hasHopDestinations
```
public final boolean hasHopDestinations()
```
    Returns true if the HopDestinations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasHopDestinations() to see if a value was sent in this field.
    
    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()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    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()
```
    Returns true if the UserMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasUserMetadata() to see if a value was sent in this field.
    
    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

Class CreateJobRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

accelerationSettings

billingTagsSource

billingTagsSourceAsString

clientRequestToken

hasHopDestinations

hopDestinations

jobTemplate

priority

queue

role

settings

simulateReservedQueue

simulateReservedQueueAsString

statusUpdateInterval

statusUpdateIntervalAsString

hasTags

tags

hasUserMetadata

userMetadata

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields