software.amazon.awssdk.services.transcribe.model

Class SubtitlesOutput

java.lang.Object

software.amazon.awssdk.services.transcribe.model.SubtitlesOutput

All Implemented Interfaces:

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

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

Provides information about your subtitle file, including format, start index, and Amazon S3 location.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SubtitlesOutput.Builder

Method Summary

Modifier and Type	Method and Description
static SubtitlesOutput.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<SubtitleFormat>	formats() Provides the format of your subtitle files.
List<String>	formatsAsStrings() Provides the format of your subtitle files.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFormats() For responses, this returns true if the service returned a value for the Formats property.
int	hashCode()
boolean	hasSubtitleFileUris() For responses, this returns true if the service returned a value for the SubtitleFileUris property.
Integer	outputStartIndex() Provides the start index value for your subtitle files.
List<SdkField<?>>	sdkFields()
static Class<? extends SubtitlesOutput.Builder>	serializableBuilderClass()
List<String>	subtitleFileUris() The Amazon S3 location of your transcript.
SubtitlesOutput.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

formats

public final List<SubtitleFormat> formats()

Provides the format of your subtitle files. If your request included both WebVTT (vtt) and SubRip ( srt) formats, both formats are shown.

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

Returns:

Provides the format of your subtitle files. If your request included both WebVTT (vtt) and SubRip (srt) formats, both formats are shown.

hasFormats

public final boolean hasFormats()

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

formatsAsStrings

public final List<String> formatsAsStrings()

Provides the format of your subtitle files. If your request included both WebVTT (vtt) and SubRip ( srt) formats, both formats are shown.

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

Returns:

Provides the format of your subtitle files. If your request included both WebVTT (vtt) and SubRip (srt) formats, both formats are shown.

hasSubtitleFileUris

public final boolean hasSubtitleFileUris()

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

subtitleFileUris

public final List<String> subtitleFileUris()

The Amazon S3 location of your transcript. You can use this URI to access or download your subtitle file. Your subtitle file is stored in the same location as your transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are provided.

If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.

If you didn't include OutputBucketName in your transcription job request, your subtitle file is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your subtitle file.

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request.

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

Returns:

The Amazon S3 location of your transcript. You can use this URI to access or download your subtitle file. Your subtitle file is stored in the same location as your transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are provided.

If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.

If you didn't include OutputBucketName in your transcription job request, your subtitle file is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your subtitle file.

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request.

outputStartIndex

public final Integer outputStartIndex()

Provides the start index value for your subtitle files. If you did not specify a value in your request, the default value of 0 is used.

Returns:

Provides the start index value for your subtitle files. If you did not specify a value in your request, the default value of 0 is used.

toBuilder

public SubtitlesOutput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SubtitlesOutput.Builder,SubtitlesOutput>

builder

public static SubtitlesOutput.Builder builder()

serializableBuilderClass

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