com.amazonaws.services.transcribe.model

Class ChannelDefinition

java.lang.Object

com.amazonaws.services.transcribe.model.ChannelDefinition

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ChannelDefinition
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ChannelDefinition()

Method Summary

Modifier and Type	Method and Description
ChannelDefinition	clone()
boolean	equals(Object obj)
Integer	getChannelId() Specify the audio channel you want to define.
String	getParticipantRole() Specify the speaker you want to define.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setChannelId(Integer channelId) Specify the audio channel you want to define.
void	setParticipantRole(String participantRole) Specify the speaker you want to define.
String	toString() Returns a string representation of this object.
ChannelDefinition	withChannelId(Integer channelId) Specify the audio channel you want to define.
ChannelDefinition	withParticipantRole(ParticipantRole participantRole) Specify the speaker you want to define.
ChannelDefinition	withParticipantRole(String participantRole) Specify the speaker you want to define.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChannelDefinition

public ChannelDefinition()

Method Detail

setChannelId

public void setChannelId(Integer channelId)

Specify the audio channel you want to define.

Parameters:

channelId - Specify the audio channel you want to define.

getChannelId

public Integer getChannelId()

Specify the audio channel you want to define.

Returns:

Specify the audio channel you want to define.

withChannelId

public ChannelDefinition withChannelId(Integer channelId)

Specify the audio channel you want to define.

Parameters:

channelId - Specify the audio channel you want to define.

Returns:

Returns a reference to this object so that method calls can be chained together.

setParticipantRole

public void setParticipantRole(String participantRole)

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

Parameters:

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

See Also:

ParticipantRole

getParticipantRole

public String getParticipantRole()

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

Returns:

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

See Also:

ParticipantRole

withParticipantRole

public ChannelDefinition withParticipantRole(String participantRole)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ParticipantRole

withParticipantRole

public ChannelDefinition withParticipantRole(ParticipantRole participantRole)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ParticipantRole

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ChannelDefinition clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.