software.amazon.awssdk.services.transcribestreaming.model

Class CategoryEvent

java.lang.Object

software.amazon.awssdk.services.transcribestreaming.model.CategoryEvent

All Implemented Interfaces:

Serializable, SdkPojo, CallAnalyticsTranscriptResultStream, ToCopyableBuilder<CategoryEvent.Builder,CategoryEvent>

Direct Known Subclasses:

DefaultCategoryEvent

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

Provides information on any TranscriptFilterType categories that matched your transcription output. Matches are identified for each segment upon completion of that segment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CategoryEvent.Builder
protected static class	CategoryEvent.BuilderImpl

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.transcribestreaming.model.CallAnalyticsTranscriptResultStream

CallAnalyticsTranscriptResultStream.EventType

Field Summary

Fields inherited from interface software.amazon.awssdk.services.transcribestreaming.model.CallAnalyticsTranscriptResultStream

UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CategoryEvent(CategoryEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method and Description
void	accept(StartCallAnalyticsStreamTranscriptionResponseHandler.Visitor visitor) Calls the appropriate visit method depending on the subtype of CategoryEvent.
static CategoryEvent.Builder	builder()
CategoryEvent	copy(Consumer<? super CategoryEvent.Builder> modifier)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMatchedCategories() For responses, this returns true if the service returned a value for the MatchedCategories property.
boolean	hasMatchedDetails() For responses, this returns true if the service returned a value for the MatchedDetails property.
List<String>	matchedCategories() Lists the categories that were matched in your audio segment.
Map<String,PointsOfInterest>	matchedDetails() Contains information about the matched categories, including category names and timestamps.
List<SdkField<?>>	sdkFields()
static Class<? extends CategoryEvent.Builder>	serializableBuilderClass()
CategoryEvent.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.services.transcribestreaming.model.CallAnalyticsTranscriptResultStream

categoryEventBuilder, sdkEventType, utteranceEventBuilder

Constructor Detail

CategoryEvent

protected CategoryEvent(CategoryEvent.BuilderImpl builder)

Method Detail

hasMatchedCategories

public final boolean hasMatchedCategories()

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

matchedCategories

public final List<String> matchedCategories()

Lists the categories that were matched in your audio segment.

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

Returns:

Lists the categories that were matched in your audio segment.

hasMatchedDetails

public final boolean hasMatchedDetails()

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

matchedDetails

public final Map<String,PointsOfInterest> matchedDetails()

Contains information about the matched categories, including category names and timestamps.

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

Returns:

Contains information about the matched categories, including category names and timestamps.

toBuilder

public CategoryEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CategoryEvent.Builder,CategoryEvent>

builder

public static CategoryEvent.Builder builder()

serializableBuilderClass

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

copy

public final CategoryEvent copy(Consumer<? super CategoryEvent.Builder> modifier)

Specified by:

copy in interface ToCopyableBuilder<CategoryEvent.Builder,CategoryEvent>

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

accept

public void accept(StartCallAnalyticsStreamTranscriptionResponseHandler.Visitor visitor)

Calls the appropriate visit method depending on the subtype of CategoryEvent.

Specified by:

accept in interface CallAnalyticsTranscriptResultStream

Parameters:

visitor - Visitor to invoke.