com.tencentcloudapi.faceid.v20180301.models.LivenessRecognitionRequest Maven / Gradle / Ivy
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. 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.
* 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.tencentcloudapi.faceid.v20180301.models;
import com.tencentcloudapi.common.AbstractModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class LivenessRecognitionRequest extends AbstractModel{
/**
* 身份证号
*/
@SerializedName("IdCard")
@Expose
private String IdCard;
/**
* 姓名。中文请使用UTF-8编码。
*/
@SerializedName("Name")
@Expose
private String Name;
/**
* 活体检测类型，取值：LIP/ACTION/SILENT。
LIP为数字模式，ACTION为动作模式，SILENT为静默模式，三种模式选择一种传入。
*/
@SerializedName("LivenessType")
@Expose
private String LivenessType;
/**
* 用于活体检测的视频，视频的BASE64值；
BASE64编码后的大小不超过8M，支持mp4、avi、flv格式。
*/
@SerializedName("VideoBase64")
@Expose
private String VideoBase64;
/**
* 用于活体检测的视频Url 地址。视频下载后经Base64编码不超过 8M，视频下载耗时不超过4S，支持mp4、avi、flv格式。
视频的 VideoUrl、VideoBase64 必须提供一个，如果都提供，只使用 VideoBase64。
建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
@SerializedName("VideoUrl")
@Expose
private String VideoUrl;
/**
* 数字模式传参：传数字验证码，验证码需先调用获取数字验证码接口得到；
动作模式传参：传动作顺序，动作顺序需先调用获取动作顺序接口得到；
静默模式传参：空。
*/
@SerializedName("ValidateData")
@Expose
private String ValidateData;
/**
* 额外配置，传入JSON字符串。
{
"BestFrameNum": 2 //需要返回多张最佳截图，取值范围2-10
}
*/
@SerializedName("Optional")
@Expose
private String Optional;
/**
* 敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。
*/
@SerializedName("Encryption")
@Expose
private Encryption Encryption;
/**
* Get 身份证号
* @return IdCard 身份证号
*/
public String getIdCard() {
return this.IdCard;
}
/**
* Set 身份证号
* @param IdCard 身份证号
*/
public void setIdCard(String IdCard) {
this.IdCard = IdCard;
}
/**
* Get 姓名。中文请使用UTF-8编码。
* @return Name 姓名。中文请使用UTF-8编码。
*/
public String getName() {
return this.Name;
}
/**
* Set 姓名。中文请使用UTF-8编码。
* @param Name 姓名。中文请使用UTF-8编码。
*/
public void setName(String Name) {
this.Name = Name;
}
/**
* Get 活体检测类型，取值：LIP/ACTION/SILENT。
LIP为数字模式，ACTION为动作模式，SILENT为静默模式，三种模式选择一种传入。
* @return LivenessType 活体检测类型，取值：LIP/ACTION/SILENT。
LIP为数字模式，ACTION为动作模式，SILENT为静默模式，三种模式选择一种传入。
*/
public String getLivenessType() {
return this.LivenessType;
}
/**
* Set 活体检测类型，取值：LIP/ACTION/SILENT。
LIP为数字模式，ACTION为动作模式，SILENT为静默模式，三种模式选择一种传入。
* @param LivenessType 活体检测类型，取值：LIP/ACTION/SILENT。
LIP为数字模式，ACTION为动作模式，SILENT为静默模式，三种模式选择一种传入。
*/
public void setLivenessType(String LivenessType) {
this.LivenessType = LivenessType;
}
/**
* Get 用于活体检测的视频，视频的BASE64值；
BASE64编码后的大小不超过8M，支持mp4、avi、flv格式。
* @return VideoBase64 用于活体检测的视频，视频的BASE64值；
BASE64编码后的大小不超过8M，支持mp4、avi、flv格式。
*/
public String getVideoBase64() {
return this.VideoBase64;
}
/**
* Set 用于活体检测的视频，视频的BASE64值；
BASE64编码后的大小不超过8M，支持mp4、avi、flv格式。
* @param VideoBase64 用于活体检测的视频，视频的BASE64值；
BASE64编码后的大小不超过8M，支持mp4、avi、flv格式。
*/
public void setVideoBase64(String VideoBase64) {
this.VideoBase64 = VideoBase64;
}
/**
* Get 用于活体检测的视频Url 地址。视频下载后经Base64编码不超过 8M，视频下载耗时不超过4S，支持mp4、avi、flv格式。
视频的 VideoUrl、VideoBase64 必须提供一个，如果都提供，只使用 VideoBase64。
建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
* @return VideoUrl 用于活体检测的视频Url 地址。视频下载后经Base64编码不超过 8M，视频下载耗时不超过4S，支持mp4、avi、flv格式。
视频的 VideoUrl、VideoBase64 必须提供一个，如果都提供，只使用 VideoBase64。
建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
public String getVideoUrl() {
return this.VideoUrl;
}
/**
* Set 用于活体检测的视频Url 地址。视频下载后经Base64编码不超过 8M，视频下载耗时不超过4S，支持mp4、avi、flv格式。
视频的 VideoUrl、VideoBase64 必须提供一个，如果都提供，只使用 VideoBase64。
建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
* @param VideoUrl 用于活体检测的视频Url 地址。视频下载后经Base64编码不超过 8M，视频下载耗时不超过4S，支持mp4、avi、flv格式。
视频的 VideoUrl、VideoBase64 必须提供一个，如果都提供，只使用 VideoBase64。
建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
public void setVideoUrl(String VideoUrl) {
this.VideoUrl = VideoUrl;
}
/**
* Get 数字模式传参：传数字验证码，验证码需先调用获取数字验证码接口得到；
动作模式传参：传动作顺序，动作顺序需先调用获取动作顺序接口得到；
静默模式传参：空。
* @return ValidateData 数字模式传参：传数字验证码，验证码需先调用获取数字验证码接口得到；
动作模式传参：传动作顺序，动作顺序需先调用获取动作顺序接口得到；
静默模式传参：空。
*/
public String getValidateData() {
return this.ValidateData;
}
/**
* Set 数字模式传参：传数字验证码，验证码需先调用获取数字验证码接口得到；
动作模式传参：传动作顺序，动作顺序需先调用获取动作顺序接口得到；
静默模式传参：空。
* @param ValidateData 数字模式传参：传数字验证码，验证码需先调用获取数字验证码接口得到；
动作模式传参：传动作顺序，动作顺序需先调用获取动作顺序接口得到；
静默模式传参：空。
*/
public void setValidateData(String ValidateData) {
this.ValidateData = ValidateData;
}
/**
* Get 额外配置，传入JSON字符串。
{
"BestFrameNum": 2 //需要返回多张最佳截图，取值范围2-10
}
* @return Optional 额外配置，传入JSON字符串。
{
"BestFrameNum": 2 //需要返回多张最佳截图，取值范围2-10
}
*/
public String getOptional() {
return this.Optional;
}
/**
* Set 额外配置，传入JSON字符串。
{
"BestFrameNum": 2 //需要返回多张最佳截图，取值范围2-10
}
* @param Optional 额外配置，传入JSON字符串。
{
"BestFrameNum": 2 //需要返回多张最佳截图，取值范围2-10
}
*/
public void setOptional(String Optional) {
this.Optional = Optional;
}
/**
* Get 敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。
* @return Encryption 敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。
*/
public Encryption getEncryption() {
return this.Encryption;
}
/**
* Set 敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。
* @param Encryption 敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。
*/
public void setEncryption(Encryption Encryption) {
this.Encryption = Encryption;
}
public LivenessRecognitionRequest() {
}
/**
* NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
* and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
*/
public LivenessRecognitionRequest(LivenessRecognitionRequest source) {
if (source.IdCard != null) {
this.IdCard = new String(source.IdCard);
}
if (source.Name != null) {
this.Name = new String(source.Name);
}
if (source.LivenessType != null) {
this.LivenessType = new String(source.LivenessType);
}
if (source.VideoBase64 != null) {
this.VideoBase64 = new String(source.VideoBase64);
}
if (source.VideoUrl != null) {
this.VideoUrl = new String(source.VideoUrl);
}
if (source.ValidateData != null) {
this.ValidateData = new String(source.ValidateData);
}
if (source.Optional != null) {
this.Optional = new String(source.Optional);
}
if (source.Encryption != null) {
this.Encryption = new Encryption(source.Encryption);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamSimple(map, prefix + "IdCard", this.IdCard);
this.setParamSimple(map, prefix + "Name", this.Name);
this.setParamSimple(map, prefix + "LivenessType", this.LivenessType);
this.setParamSimple(map, prefix + "VideoBase64", this.VideoBase64);
this.setParamSimple(map, prefix + "VideoUrl", this.VideoUrl);
this.setParamSimple(map, prefix + "ValidateData", this.ValidateData);
this.setParamSimple(map, prefix + "Optional", this.Optional);
this.setParamObj(map, prefix + "Encryption.", this.Encryption);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy