Package software.amazon.awssdk.services.elastictranscoder.model

Class InputCaptions

java.lang.Object

software.amazon.awssdk.services.elastictranscoder.model.InputCaptions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InputCaptions.Builder,InputCaptions>

@Generated("software.amazon.awssdk:codegen")
public final class InputCaptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InputCaptions.Builder,InputCaptions>

The captions to be created, if any.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InputCaptions.Builder

Method Summary

Modifier and Type	Method	Description
static InputCaptions.Builder	builder()
List<CaptionSource>	captionSources()	Source files for the input sidecar captions used during the transcoding process.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCaptionSources()	For responses, this returns true if the service returned a value for the CaptionSources property.
int	hashCode()
String	mergePolicy()	A policy that determines how Elastic Transcoder handles the existence of multiple captions.
List<SdkField<?>>	sdkFields()
static Class<? extends InputCaptions.Builder>	serializableBuilderClass()
InputCaptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

mergePolicy

public final String mergePolicy()

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

public final boolean hasCaptionSources()

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

public final List<CaptionSource> captionSources()

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.

toBuilder

public InputCaptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InputCaptions.Builder,InputCaptions>

builder

public static InputCaptions.Builder builder()

serializableBuilderClass

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

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo