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:

  • Method Details

    • 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 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 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, 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:

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

    • 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, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      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:

    • 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, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      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:

    • toBuilder

      public JobTemplate.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<JobTemplate.Builder,JobTemplate>
      Returns:
      a builder for type T

    • builder

      public static JobTemplate.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.