com.amazonaws.services.transcribe.model.ChannelDefinition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-transcribe Show documentation
The AWS Java SDK for Amazon Transcribe module holds the client classes that are used for communicating with Amazon Transcribe Service
There is a newer version: 1.12.780
Show newest version
/*
 * Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.transcribe.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * 
 * 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 AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ChannelDefinition implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * Specify the audio channel you want to define.
     * 
     */
    private Integer channelId;
    /**
     * 
     * Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.
     * 
     */
    private String participantRole;

    /**
     * 
     * Specify the audio channel you want to define.
     * 
     * 
     * @param channelId
     *        Specify the audio channel you want to define.
     */

    public void setChannelId(Integer channelId) {
        this.channelId = channelId;
    }

    /**
     * 
     * Specify the audio channel you want to define.
     * 
     * 
     * @return Specify the audio channel you want to define.
     */

    public Integer getChannelId() {
        return this.channelId;
    }

    /**
     * 
     * Specify the audio channel you want to define.
     * 
     * 
     * @param channelId
     *        Specify the audio channel you want to define.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ChannelDefinition withChannelId(Integer channelId) {
        setChannelId(channelId);
        return this;
    }

    /**
     * 
     * Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.
     * 
     * 
     * @param participantRole
     *        Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both
     *        participants.
     * @see ParticipantRole
     */

    public void setParticipantRole(String participantRole) {
        this.participantRole = participantRole;
    }

    /**
     * 
     * Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.
     * 
     * 
     * @return Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both
     *         participants.
     * @see ParticipantRole
     */

    public String getParticipantRole() {
        return this.participantRole;
    }

    /**
     * 
     * Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.
     * 
     * 
     * @param participantRole
     *        Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both
     *        participants.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see ParticipantRole
     */

    public ChannelDefinition withParticipantRole(String participantRole) {
        setParticipantRole(participantRole);
        return this;
    }

    /**
     * 
     * Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.
     * 
     * 
     * @param participantRole
     *        Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both
     *        participants.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see ParticipantRole
     */

    public ChannelDefinition withParticipantRole(ParticipantRole participantRole) {
        this.participantRole = participantRole.toString();
        return this;
    }

    /**
     * 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.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getChannelId() != null)
            sb.append("ChannelId: ").append(getChannelId()).append(",");
        if (getParticipantRole() != null)
            sb.append("ParticipantRole: ").append(getParticipantRole());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof ChannelDefinition == false)
            return false;
        ChannelDefinition other = (ChannelDefinition) obj;
        if (other.getChannelId() == null ^ this.getChannelId() == null)
            return false;
        if (other.getChannelId() != null && other.getChannelId().equals(this.getChannelId()) == false)
            return false;
        if (other.getParticipantRole() == null ^ this.getParticipantRole() == null)
            return false;
        if (other.getParticipantRole() != null && other.getParticipantRole().equals(this.getParticipantRole()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getChannelId() == null) ? 0 : getChannelId().hashCode());
        hashCode = prime * hashCode + ((getParticipantRole() == null) ? 0 : getParticipantRole().hashCode());
        return hashCode;
    }

    @Override
    public ChannelDefinition clone() {
        try {
            return (ChannelDefinition) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

    @com.amazonaws.annotation.SdkInternalApi
    @Override
    public void marshall(ProtocolMarshaller protocolMarshaller) {
        com.amazonaws.services.transcribe.model.transform.ChannelDefinitionMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}