Package software.amazon.awssdk.services.transcribestreaming.model

Class ChannelDefinition

java.lang.Object

software.amazon.awssdk.services.transcribestreaming.model.ChannelDefinition

All Implemented Interfaces:

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

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

Makes it possible to specify which speaker is on which audio channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ChannelDefinition.Builder

Method Summary

Modifier and Type	Method	Description
static ChannelDefinition.Builder	builder()
Integer	channelId()	Specify the audio channel you want to define.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ParticipantRole	participantRole()	Specify the speaker you want to define.
String	participantRoleAsString()	Specify the speaker you want to define.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ChannelDefinition.Builder>	serializableBuilderClass()
ChannelDefinition.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

channelId

public final Integer channelId()

Specify the audio channel you want to define.

Returns:

Specify the audio channel you want to define.

participantRole

public final ParticipantRole participantRole()

Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.

If the service returns an enum value that is not available in the current SDK version, participantRole will return ParticipantRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from participantRoleAsString().

Returns:

Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.

See Also:

ParticipantRole

participantRoleAsString

public final String participantRoleAsString()

Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.

If the service returns an enum value that is not available in the current SDK version, participantRole will return ParticipantRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from participantRoleAsString().

Returns:

Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.

See Also:

ParticipantRole

toBuilder

public ChannelDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ChannelDefinition.Builder,ChannelDefinition>

builder

public static ChannelDefinition.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo