com.aliyun.iot20180120.models.ShareSpeechByCombinationRequest Maven / Gradle / Ivy

Go to download
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.iot20180120.models;

import com.aliyun.tea.*;

public class ShareSpeechByCombinationRequest extends TeaModel {
    /**
     * The audio format. Valid values: wav, mp3, and amr.
     * 
     * example:
     * wav
     */
    @NameInMap("AudioFormat")
    public String audioFormat;

    /**
     * The combined content that you want to broadcast. The following types of content can be broadcasted:
     * 
     * The speeches that are pushed to the device. You must specify the identifiers of the speeches.
     * 
     * The custom content that you specify based on the supported format of the device.
     * For example, you can create a custom speech about the amount of money in the format of {$xxx}. xxx is the specific amount. If you specify {$1000}, the device broadcasts CNY 1000.
     * 
     * 
     * The device broadcasts the audio files in the sequence of the values that you specify in CombinationList.
     * This parameter is required.
     * 
     * example:
     * ZFBDZ
     */
    @NameInMap("CombinationList")
    public java.util.List combinationList;

    /**
     * The DeviceName of the device. If you specify this parameter, you must also specify the ProductKey parameter.
     * 
     * example:
     * test
     */
    @NameInMap("DeviceName")
    public String deviceName;

    /**
     * The ID of the device. You can call the QuerySpeechDevice operation to obtain the ID.
     * 
     * If you specify this parameter, you do not need to specify the ProductKey and DeviceName parameters. IotId specifies a globally unique identifier (GUID) of the device, which corresponds to a combination of ProductKey and DeviceName. If you specify the IotId, ProductKey, and DeviceName parameters, the value of the IotId parameter takes precedence.
     * 
     * 
     * example:
     * Q7uOhVRdZRRlDnTLv****00100
     */
    @NameInMap("IotId")
    public String iotId;

    /**
     * The instance ID. You can view the ID of the instance on the Overview page in the IoT Platform console.
     * 
     *  If your instance has an ID, you must specify this parameter. Otherwise, the request fails. If no Overview page exists or no instance ID is displayed, you do not need to specify this parameter.
     * 
     * For more information, see the Overview topic of IoT instances.
     * 
     * example:
     * iot_instc_pu****_c*-v64********
     */
    @NameInMap("IotInstanceId")
    public String iotInstanceId;

    /**
     * The ProductKey of the product to which the device belongs. If you specify this parameter, you must also specify the DeviceName parameter.
     * 
     * example:
     * a1BwAGV****
     */
    @NameInMap("ProductKey")
    public String productKey;

    /**
     * The unique ID of the combined speech that you want to broadcast. This ID is issued by IoT Platform to the device.
     * 
     *  If you do not specify this parameter, IoT Platform automatically generates an ID. If you need to retry broadcasting the speech, you must specify the ID to prevent repeated broadcasting.
     * 
     * 
     * example:
     * 42000011392021112380********
     */
    @NameInMap("SpeechId")
    public String speechId;

    public static ShareSpeechByCombinationRequest build(java.util.Map map) throws Exception {
        ShareSpeechByCombinationRequest self = new ShareSpeechByCombinationRequest();
        return TeaModel.build(map, self);
    }

    public ShareSpeechByCombinationRequest setAudioFormat(String audioFormat) {
        this.audioFormat = audioFormat;
        return this;
    }
    public String getAudioFormat() {
        return this.audioFormat;
    }

    public ShareSpeechByCombinationRequest setCombinationList(java.util.List combinationList) {
        this.combinationList = combinationList;
        return this;
    }
    public java.util.List getCombinationList() {
        return this.combinationList;
    }

    public ShareSpeechByCombinationRequest setDeviceName(String deviceName) {
        this.deviceName = deviceName;
        return this;
    }
    public String getDeviceName() {
        return this.deviceName;
    }

    public ShareSpeechByCombinationRequest setIotId(String iotId) {
        this.iotId = iotId;
        return this;
    }
    public String getIotId() {
        return this.iotId;
    }

    public ShareSpeechByCombinationRequest setIotInstanceId(String iotInstanceId) {
        this.iotInstanceId = iotInstanceId;
        return this;
    }
    public String getIotInstanceId() {
        return this.iotInstanceId;
    }

    public ShareSpeechByCombinationRequest setProductKey(String productKey) {
        this.productKey = productKey;
        return this;
    }
    public String getProductKey() {
        return this.productKey;
    }

    public ShareSpeechByCombinationRequest setSpeechId(String speechId) {
        this.speechId = speechId;
        return this;
    }
    public String getSpeechId() {
        return this.speechId;
    }

}