Result (AWS Java SDK :: Services :: AWS Transcribe Streaming 2.20.156 API)

java.lang.Object
- software.amazon.awssdk.services.transcribestreaming.model.Result

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Result.Builder,Result>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Result
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Result.Builder,Result>
```
The Result associated with a .
Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identification, partial result stabilization, language identification, and other transcription-related data.
See Also: Serialized Form










Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


static interface 
Result.Builder 









Method Summary

All Methods Static Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


List<Alternative>
alternatives()

 A list of possible alternative transcriptions for the input audio.



static Result.Builder
builder() 


String
channelId()

 Indicates which audio channel is associated with the Result.



Double
endTime()

 The end time, in milliseconds, of the Result.



boolean
equals(Object obj) 


boolean
equalsBySdkFields(Object obj) 


<T> Optional<T>
getValueForField(String fieldName,
                Class<T> clazz) 


boolean
hasAlternatives()
For responses, this returns true if the service returned a value for the Alternatives property.



int
hashCode() 


boolean
hasLanguageIdentification()
For responses, this returns true if the service returned a value for the LanguageIdentification property.



Boolean
isPartial()

 Indicates if the segment is complete.



LanguageCode
languageCode()

 The language code that represents the language spoken in your audio stream.



String
languageCodeAsString()

 The language code that represents the language spoken in your audio stream.



List<LanguageWithScore>
languageIdentification()

 The language code of the dominant language identified in your stream.



String
resultId()

 Provides a unique identifier for the Result.



List<SdkField<?>>
sdkFields() 


static Class<? extends Result.Builder>
serializableBuilderClass() 


Double
startTime()

 The start time, in milliseconds, of the Result.



Result.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





resultId
public final String resultId()

 Provides a unique identifier for the Result.
 

Returns:
Provides a unique identifier for the Result.








startTime
public final Double startTime()

 The start time, in milliseconds, of the Result.
 

Returns:
The start time, in milliseconds, of the Result.








endTime
public final Double endTime()

 The end time, in milliseconds, of the Result.
 

Returns:
The end time, in milliseconds, of the Result.








isPartial
public final Boolean isPartial()

 Indicates if the segment is complete.
 
 
 If IsPartial is true, the segment is not complete. If IsPartial is
 false, the segment is complete.
 

Returns:
Indicates if the segment is complete.
         
         If IsPartial is true, the segment is not complete. If IsPartial is
         false, the segment is complete.








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







alternatives
public final List<Alternative> alternatives()

 A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of
 Items, Entities, or Transcript.
 
 
 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 hasAlternatives() method.
 

Returns:
A list of possible alternative transcriptions for the input audio. Each alternative may contain one or
         more of Items, Entities, or Transcript.








channelId
public final String channelId()

 Indicates which audio channel is associated with the Result.
 

Returns:
Indicates which audio channel is associated with the Result.








languageCode
public final LanguageCode languageCode()

 The language code that represents the language spoken in your audio stream.
 
 
 If the service returns an enum value that is not available in the current SDK version, languageCode will
 return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
 languageCodeAsString().
 

Returns:
The language code that represents the language spoken in your audio stream.
See Also:
LanguageCode








languageCodeAsString
public final String languageCodeAsString()

 The language code that represents the language spoken in your audio stream.
 
 
 If the service returns an enum value that is not available in the current SDK version, languageCode will
 return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
 languageCodeAsString().
 

Returns:
The language code that represents the language spoken in your audio stream.
See Also:
LanguageCode








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







languageIdentification
public final List<LanguageWithScore> languageIdentification()

 The language code of the dominant language identified in your stream.
 
 
 If you enabled channel identification and each channel of your audio contains a different language, you may have
 more than one result.
 
 
 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 hasLanguageIdentification() method.
 

Returns:
The language code of the dominant language identified in your stream.
         
         If you enabled channel identification and each channel of your audio contains a different language, you
         may have more than one result.








toBuilder
public Result.Builder toBuilder()

Specified by:
toBuilder in interface ToCopyableBuilder<Result.Builder,Result>








builder
public static Result.Builder builder()







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

Modifier and Type	Method and Description
`List<Alternative>`	`alternatives()` A list of possible alternative transcriptions for the input audio.
`static Result.Builder`	`builder()`
`String`	`channelId()` Indicates which audio channel is associated with the `Result`.
`Double`	`endTime()` The end time, in milliseconds, of the `Result`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAlternatives()` For responses, this returns true if the service returned a value for the Alternatives property.
`int`	`hashCode()`
`boolean`	`hasLanguageIdentification()` For responses, this returns true if the service returned a value for the LanguageIdentification property.
`Boolean`	`isPartial()` Indicates if the segment is complete.
`LanguageCode`	`languageCode()` The language code that represents the language spoken in your audio stream.
`String`	`languageCodeAsString()` The language code that represents the language spoken in your audio stream.
`List<LanguageWithScore>`	`languageIdentification()` The language code of the dominant language identified in your stream.
`String`	`resultId()` Provides a unique identifier for the `Result`.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Result.Builder>`	`serializableBuilderClass()`
`Double`	`startTime()` The start time, in milliseconds, of the `Result`.
`Result.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Class Result

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

resultId

startTime

endTime

isPartial

hasAlternatives

alternatives

channelId

languageCode

languageCodeAsString

hasLanguageIdentification

languageIdentification

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields