Class SubtitlesOutput
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SubtitlesOutput.Builder,
SubtitlesOutput>
Provides information about your subtitle file, including format, start index, and Amazon S3 location.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SubtitlesOutput.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<SubtitleFormat> formats()
Provides the format of your subtitle files.Provides the format of your subtitle files.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Formats property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SubtitleFileUris property.final Integer
Provides the start index value for your subtitle files.static Class
<? extends SubtitlesOutput.Builder> The Amazon S3 location of your transcript.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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 theisEmpty()
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
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 includedOutputKey
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, andTranscriptFileUri
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 aGetTranscriptionJob
orListTranscriptionJob
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 includedOutputKey
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, andTranscriptFileUri
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 aGetTranscriptionJob
orListTranscriptionJob
request.
-
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
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 interfaceToCopyableBuilder<SubtitlesOutput.Builder,
SubtitlesOutput> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-