Class JobTemplate
- java.lang.Object
-
- software.amazon.awssdk.services.mediaconvert.model.JobTemplate
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<JobTemplate.Builder,JobTemplate>
@Generated("software.amazon.awssdk:codegen") public final class JobTemplate extends Object implements SdkPojo, Serializable, ToCopyableBuilder<JobTemplate.Builder,JobTemplate>
A job template is a pre-made set of encoding instructions that you can use to quickly create a job.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceJobTemplate.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AccelerationSettingsaccelerationSettings()Accelerated transcoding can significantly speed up jobs with long, visually complex content.Stringarn()An identifier for this resource that is unique within all of AWS.static JobTemplate.Builderbuilder()Stringcategory()An optional category you create to organize your job templates.InstantcreatedAt()The timestamp in epoch seconds for Job template creation.Stringdescription()An optional description you create for each job template.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasHopDestinations()For responses, this returns true if the service returned a value for the HopDestinations property.List<HopDestination>hopDestinations()Optional list of hop destinations.InstantlastUpdated()The timestamp in epoch seconds when the Job template was last updated.Stringname()A name you create for each job template.Integerpriority()Relative priority on the job.Stringqueue()Optional.List<SdkField<?>>sdkFields()static Class<? extends JobTemplate.Builder>serializableBuilderClass()JobTemplateSettingssettings()JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.StatusUpdateIntervalstatusUpdateInterval()Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.StringstatusUpdateIntervalAsString()Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.JobTemplate.BuildertoBuilder()StringtoString()Returns a string representation of this object.Typetype()A job template can be of two types: system or custom.StringtypeAsString()A job template can be of two types: system or custom.-
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.- Returns:
- Accelerated transcoding can significantly speed up jobs with long, visually complex content.
-
arn
public final String arn()
An identifier for this resource that is unique within all of AWS.- Returns:
- An identifier for this resource that is unique within all of AWS.
-
category
public final String category()
An optional category you create to organize your job templates.- Returns:
- An optional category you create to organize your job templates.
-
createdAt
public final Instant createdAt()
The timestamp in epoch seconds for Job template creation.- Returns:
- The timestamp in epoch seconds for Job template creation.
-
description
public final String description()
An optional description you create for each job template.- Returns:
- An optional description you create for each job template.
-
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 theisEmpty()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 list of hop destinations.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 list of hop destinations.
-
lastUpdated
public final Instant lastUpdated()
The timestamp in epoch seconds when the Job template was last updated.- Returns:
- The timestamp in epoch seconds when the Job template was last updated.
-
name
public final String name()
A name you create for each job template. Each name must be unique within your account.- Returns:
- A name you create for each job template. Each name must be unique within your account.
-
priority
public final Integer priority()
Relative priority on the job.- Returns:
- Relative priority on the job.
-
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,
statusUpdateIntervalwill returnStatusUpdateInterval.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusUpdateIntervalAsString().- 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,
statusUpdateIntervalwill returnStatusUpdateInterval.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusUpdateIntervalAsString().- 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
-
type
public final Type type()
A job template can be of two types: system or custom. System or built-in job templates can't be modified or deleted by the user.If the service returns an enum value that is not available in the current SDK version,
typewill returnType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- A job template can be of two types: system or custom. System or built-in job templates can't be modified or deleted by the user.
- See Also:
Type
-
typeAsString
public final String typeAsString()
A job template can be of two types: system or custom. System or built-in job templates can't be modified or deleted by the user.If the service returns an enum value that is not available in the current SDK version,
typewill returnType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- A job template can be of two types: system or custom. System or built-in job templates can't be modified or deleted by the user.
- See Also:
Type
-
toBuilder
public JobTemplate.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<JobTemplate.Builder,JobTemplate>
-
builder
public static JobTemplate.Builder builder()
-
serializableBuilderClass
public static Class<? extends JobTemplate.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-