com.vonage.client.voice.SpeechTimeoutReason Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024 Vonage
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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.vonage.client.voice;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

/**
 * Represents the timeout reason in {@link SpeechResults#getTimeoutReason()}.
 *
 * @since 8.2.0
 */
public enum SpeechTimeoutReason {
    END_ON_SILENCE_TIMEOUT,
    MAX_DURATION,
    START_TIMEOUT,
    UNKNOWN;

    @JsonValue
    @Override
    public String toString() {
        return name().toLowerCase();
    }

    @JsonCreator
    public static SpeechTimeoutReason fromString(String name) {
        try {
            return SpeechTimeoutReason.valueOf(name.toUpperCase());
        }
        catch (IllegalArgumentException ex) {
            return UNKNOWN;
        }
    }
}