Package software.amazon.awssdk.services.mediaconvert.model

Class TeletextDestinationSettings

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.TeletextDestinationSettings

All Implemented Interfaces:

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

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

Settings related to teletext captions. Set up teletext captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/teletext-output-captions.html.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TeletextDestinationSettings.Builder

Method Summary

Modifier and Type	Method	Description
static TeletextDestinationSettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPageTypes()	For responses, this returns true if the service returned a value for the PageTypes property.
String	pageNumber()	Set pageNumber to the Teletext page number for the destination captions for this output.
List<TeletextPageType>	pageTypes()	Specify the page types for this Teletext page.
List<String>	pageTypesAsStrings()	Specify the page types for this Teletext page.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TeletextDestinationSettings.Builder>	serializableBuilderClass()
TeletextDestinationSettings.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

pageNumber

public final String pageNumber()

Set pageNumber to the Teletext page number for the destination captions for this output. This value must be a three-digit hexadecimal string; strings ending in -FF are invalid. If you are passing through the entire set of Teletext data, do not use this field.

Returns:

Set pageNumber to the Teletext page number for the destination captions for this output. This value must be a three-digit hexadecimal string; strings ending in -FF are invalid. If you are passing through the entire set of Teletext data, do not use this field.

pageTypes

public final List<TeletextPageType> pageTypes()

Specify the page types for this Teletext page. If you don't specify a value here, the service sets the page type to the default value Subtitle. If you pass through the entire set of Teletext data, don't use this field. When you pass through a set of Teletext pages, your output has the same page types as your input.

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

Returns:

Specify the page types for this Teletext page. If you don't specify a value here, the service sets the page type to the default value Subtitle. If you pass through the entire set of Teletext data, don't use this field. When you pass through a set of Teletext pages, your output has the same page types as your input.

hasPageTypes

public final boolean hasPageTypes()

For responses, this returns true if the service returned a value for the PageTypes 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.

pageTypesAsStrings

public final List<String> pageTypesAsStrings()

Specify the page types for this Teletext page. If you don't specify a value here, the service sets the page type to the default value Subtitle. If you pass through the entire set of Teletext data, don't use this field. When you pass through a set of Teletext pages, your output has the same page types as your input.

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

Returns:

Specify the page types for this Teletext page. If you don't specify a value here, the service sets the page type to the default value Subtitle. If you pass through the entire set of Teletext data, don't use this field. When you pass through a set of Teletext pages, your output has the same page types as your input.

toBuilder

public TeletextDestinationSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TeletextDestinationSettings.Builder,TeletextDestinationSettings>

builder

public static TeletextDestinationSettings.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo