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("software.amazon.awssdk:codegen") public class CategoryEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CategoryEvent.Builder,CategoryEvent>, CallAnalyticsTranscriptResultStream
Provides information on any
TranscriptFilterTypecategories 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 Description static interfaceCategoryEvent.Builderprotected static classCategoryEvent.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 Description protectedCategoryEvent(CategoryEvent.BuilderImpl builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(StartCallAnalyticsStreamTranscriptionResponseHandler.Visitor visitor)Calls the appropriate visit method depending on the subtype ofCategoryEvent.static CategoryEvent.Builderbuilder()CategoryEventcopy(Consumer<? super CategoryEvent.Builder> modifier)booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasMatchedCategories()For responses, this returns true if the service returned a value for the MatchedCategories property.booleanhasMatchedDetails()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.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CategoryEvent.Builder>serializableBuilderClass()CategoryEvent.BuildertoBuilder()StringtoString()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
sdkEventType
-
-
-
-
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 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.
-
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 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.
-
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:
toBuilderin interfaceToCopyableBuilder<CategoryEvent.Builder,CategoryEvent>
-
builder
public static CategoryEvent.Builder builder()
-
serializableBuilderClass
public static Class<? extends CategoryEvent.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
copy
public final CategoryEvent copy(Consumer<? super CategoryEvent.Builder> modifier)
- Specified by:
copyin interfaceToCopyableBuilder<CategoryEvent.Builder,CategoryEvent>
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
accept
public void accept(StartCallAnalyticsStreamTranscriptionResponseHandler.Visitor visitor)
Calls the appropriate visit method depending on the subtype ofCategoryEvent.- Specified by:
acceptin interfaceCallAnalyticsTranscriptResultStream- Parameters:
visitor- Visitor to invoke.
-
-