software.amazon.awssdk.services.mediaconvert.model

Class CreateJobTemplateRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateJobTemplateRequest.Builder,CreateJobTemplateRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateJobTemplateRequest.Builder

Method Summary

Modifier and Type	Method and Description
AccelerationSettings	accelerationSettings() Accelerated transcoding can significantly speed up jobs with long, visually complex content.
static CreateJobTemplateRequest.Builder	builder()
String	category() Optional.
String	description() Optional.
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.
List<HopDestination>	hopDestinations() Optional.
String	name() The name of the job template you are creating.
Integer	priority() Specify the relative priority for this job.
String	queue() Optional.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateJobTemplateRequest.Builder>	serializableBuilderClass()
JobTemplateSettings	settings() JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.
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.
CreateJobTemplateRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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()

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.

category

public final String category()

Optional. A category for the job template you are creating

Returns:

Optional. A category for the job template you are creating

description

public final String description()

Optional. A description of the job template you are creating.

Returns:

Optional. A description of the job template you are creating.

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.

name

public final String name()

The name of the job template you are creating.

Returns:

The name of the job template you are creating.

priority

public final 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 final String queue()

Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue.

Returns:

Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue.

settings

public final JobTemplateSettings settings()

JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.

Returns:

JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.

statusUpdateInterval

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

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()

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.

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:

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

toBuilder

public CreateJobTemplateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateJobTemplateRequest.Builder,CreateJobTemplateRequest>

Specified by:

toBuilder in class MediaConvertRequest

builder

public static CreateJobTemplateRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateJobTemplateRequest.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