Class Captions

java.lang.Object
software.amazon.awssdk.services.elastictranscoder.model.Captions
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Captions.Builder,Captions>
@Generated("software.amazon.awssdk:codegen") public final class Captions extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Captions.Builder,Captions>

The captions to be created, if any.

See Also:

  • Method Details

    • mergePolicy

      @Deprecated public final String mergePolicy()
      Deprecated.

      A policy that determines how Elastic Transcoder handles the existence of multiple captions.

      • MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.

      • MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files.

      • Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources.

      MergePolicy cannot be null.

      Returns:
      A policy that determines how Elastic Transcoder handles the existence of multiple captions.

      • MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.

      • MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files.

      • Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources.

      MergePolicy cannot be null.

    • hasCaptionSources

      @Deprecated public final boolean hasCaptionSources()
      Deprecated.
      For responses, this returns true if the service returned a value for the CaptionSources 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.

    • captionSources

      @Deprecated public final List<CaptionSource> captionSources()
      Deprecated.

      Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank.

      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 hasCaptionSources() method.

      Returns:
      Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank.

    • hasCaptionFormats

      public final boolean hasCaptionFormats()
      For responses, this returns true if the service returned a value for the CaptionFormats 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.

    • captionFormats

      public final List<CaptionFormat> captionFormats()

      The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.

      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 hasCaptionFormats() method.

      Returns:
      The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.

    • toBuilder

      public Captions.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<Captions.Builder,Captions>
      Returns:
      a builder for type T

    • builder

      public static Captions.Builder builder()

    • serializableBuilderClass

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