Class ChannelDefinition
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ChannelDefinition.Builder,
ChannelDefinition>
Makes it possible to specify which speaker is on which 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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ChannelDefinition.Builder
builder()
final Integer
Specify the audio channel you want to define.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final ParticipantRole
Specify the speaker you want to define.final String
Specify the speaker you want to define.static Class
<? extends ChannelDefinition.Builder> 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
-
channelId
Specify the audio channel you want to define.
- Returns:
- Specify the audio channel you want to define.
-
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 returnParticipantRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromparticipantRoleAsString()
.- Returns:
- Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.
- See Also:
-
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 returnParticipantRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromparticipantRoleAsString()
.- Returns:
- Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.
- See Also:
-
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<ChannelDefinition.Builder,
ChannelDefinition> - 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
-