com.tencentcloudapi.bi.v20220105.models

Class CreateEmbedTokenRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.bi.v20220105.models.CreateEmbedTokenRequest

public class CreateEmbedTokenRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateEmbedTokenRequest()
CreateEmbedTokenRequest(CreateEmbedTokenRequest source) 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.

Method Summary

Modifier and Type	Method and Description
String	getConfigParam() Get 嵌出显示配置，目前为ChatBI嵌出场景用，TableFilter表示数据表列表过滤，SqlView表示sql查看功能
String	getExpireTime() Get 过期时间。 单位：分钟 最大值：240。即，4小时 默认值：240
String	getExtraParam() Get 备用字段
String	getGlobalParam() Get 全局筛选参数 报表过滤条件的全局参数。 格式为JSON格式的字符串 目前仅支持字符类型页面参数绑定到全局参数 [ { "ParamKey": "name", //页面参数名称 "JoinType": "AND", // 连接方式,目前仅支持AND "WhereList": [ { "Operator": "-neq", // 操作符，参考以下说明 "Value": [ //操作值，单值数组只传一个值 "zZWJMD", "ZzVGHX", "湖南省", "河北省" ] } ] }, { "ParamKey": "genderParam", "JoinType": "AND", "WhereList": [ { "Operator": "-neq", "Value": [ "男" ] } ] } ] Operator 目前支持 -neq 不等于!=操作符 -eq 等于=操作符 -is in操作符
String	getIntention() Get embed表示页面看板嵌出，chatBIEmbed表示ChatBI嵌出
Long	getPageId() Get 分享页面id，嵌出看板时此为空值0，ChatBI嵌出时不传
Long	getProjectId() Get 分享项目id
String	getScope() Get page表示嵌出页面，panel表示嵌出整个看板，ChatBI嵌出时使用project
Long	getTicketNum() Get 访问次数限制，限制范围1-99999，为空则不设置访问次数限制
Long	getTokenNum() Get 一次创建的token数
Long	getTokenType() Get 100 不绑定用户, 一次创建一个token，UserCorpId和UserId 非必填，不支持 ChatBI 嵌出 200 单用户单token , 一次创建一个token， UserCorpId和UserId 必填 300 单用户多token, 一次创建多个token，UserCorpId和UserId 必填
String	getUserCorpId() Get 使用者企业Id(仅用于多用户)
String	getUserId() Get 使用者Id(仅用于多用户)
void	setConfigParam(String ConfigParam) Set 嵌出显示配置，目前为ChatBI嵌出场景用，TableFilter表示数据表列表过滤，SqlView表示sql查看功能
void	setExpireTime(String ExpireTime) Set 过期时间。 单位：分钟 最大值：240。即，4小时 默认值：240
void	setExtraParam(String ExtraParam) Set 备用字段
void	setGlobalParam(String GlobalParam) Set 全局筛选参数 报表过滤条件的全局参数。 格式为JSON格式的字符串 目前仅支持字符类型页面参数绑定到全局参数 [ { "ParamKey": "name", //页面参数名称 "JoinType": "AND", // 连接方式,目前仅支持AND "WhereList": [ { "Operator": "-neq", // 操作符，参考以下说明 "Value": [ //操作值，单值数组只传一个值 "zZWJMD", "ZzVGHX", "湖南省", "河北省" ] } ] }, { "ParamKey": "genderParam", "JoinType": "AND", "WhereList": [ { "Operator": "-neq", "Value": [ "男" ] } ] } ] Operator 目前支持 -neq 不等于!=操作符 -eq 等于=操作符 -is in操作符
void	setIntention(String Intention) Set embed表示页面看板嵌出，chatBIEmbed表示ChatBI嵌出
void	setPageId(Long PageId) Set 分享页面id，嵌出看板时此为空值0，ChatBI嵌出时不传
void	setProjectId(Long ProjectId) Set 分享项目id
void	setScope(String Scope) Set page表示嵌出页面，panel表示嵌出整个看板，ChatBI嵌出时使用project
void	setTicketNum(Long TicketNum) Set 访问次数限制，限制范围1-99999，为空则不设置访问次数限制
void	setTokenNum(Long TokenNum) Set 一次创建的token数
void	setTokenType(Long TokenType) Set 100 不绑定用户, 一次创建一个token，UserCorpId和UserId 非必填，不支持 ChatBI 嵌出 200 单用户单token , 一次创建一个token， UserCorpId和UserId 必填 300 单用户多token, 一次创建多个token，UserCorpId和UserId 必填
void	setUserCorpId(String UserCorpId) Set 使用者企业Id(仅用于多用户)
void	setUserId(String UserId) Set 使用者Id(仅用于多用户)
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreateEmbedTokenRequest

public CreateEmbedTokenRequest()

CreateEmbedTokenRequest

public CreateEmbedTokenRequest(CreateEmbedTokenRequest source)

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.

Method Detail

getProjectId

public Long getProjectId()

Get 分享项目id

Returns:

ProjectId 分享项目id

setProjectId

public void setProjectId(Long ProjectId)

Set 分享项目id

Parameters:

ProjectId - 分享项目id

getPageId

public Long getPageId()

Get 分享页面id，嵌出看板时此为空值0，ChatBI嵌出时不传

Returns:

PageId 分享页面id，嵌出看板时此为空值0，ChatBI嵌出时不传

setPageId

public void setPageId(Long PageId)

Set 分享页面id，嵌出看板时此为空值0，ChatBI嵌出时不传

Parameters:

PageId - 分享页面id，嵌出看板时此为空值0，ChatBI嵌出时不传

getIntention

public String getIntention()

Get embed表示页面看板嵌出，chatBIEmbed表示ChatBI嵌出

Returns:

Intention embed表示页面看板嵌出，chatBIEmbed表示ChatBI嵌出

setIntention

public void setIntention(String Intention)

Set embed表示页面看板嵌出，chatBIEmbed表示ChatBI嵌出

Parameters:

Intention - embed表示页面看板嵌出，chatBIEmbed表示ChatBI嵌出

getScope

public String getScope()

Get page表示嵌出页面，panel表示嵌出整个看板，ChatBI嵌出时使用project

Returns:

Scope page表示嵌出页面，panel表示嵌出整个看板，ChatBI嵌出时使用project

setScope

public void setScope(String Scope)

Set page表示嵌出页面，panel表示嵌出整个看板，ChatBI嵌出时使用project

Parameters:

Scope - page表示嵌出页面，panel表示嵌出整个看板，ChatBI嵌出时使用project

getExpireTime

public String getExpireTime()

Get 过期时间。 单位：分钟 最大值：240。即，4小时 默认值：240

Returns:

ExpireTime 过期时间。 单位：分钟 最大值：240。即，4小时 默认值：240

setExpireTime

public void setExpireTime(String ExpireTime)

Set 过期时间。 单位：分钟 最大值：240。即，4小时 默认值：240

Parameters:

ExpireTime - 过期时间。 单位：分钟 最大值：240。即，4小时 默认值：240

getExtraParam

public String getExtraParam()

Get 备用字段

Returns:

ExtraParam 备用字段

setExtraParam

public void setExtraParam(String ExtraParam)

Set 备用字段

Parameters:

ExtraParam - 备用字段

getUserCorpId

public String getUserCorpId()

Get 使用者企业Id(仅用于多用户)

Returns:

UserCorpId 使用者企业Id(仅用于多用户)

setUserCorpId

public void setUserCorpId(String UserCorpId)

Set 使用者企业Id(仅用于多用户)

Parameters:

UserCorpId - 使用者企业Id(仅用于多用户)

getUserId

public String getUserId()

Get 使用者Id(仅用于多用户)

Returns:

UserId 使用者Id(仅用于多用户)

setUserId

public void setUserId(String UserId)

Set 使用者Id(仅用于多用户)

Parameters:

UserId - 使用者Id(仅用于多用户)

getTicketNum

public Long getTicketNum()

Get 访问次数限制，限制范围1-99999，为空则不设置访问次数限制

Returns:

TicketNum 访问次数限制，限制范围1-99999，为空则不设置访问次数限制

setTicketNum

public void setTicketNum(Long TicketNum)

Set 访问次数限制，限制范围1-99999，为空则不设置访问次数限制

Parameters:

TicketNum - 访问次数限制，限制范围1-99999，为空则不设置访问次数限制

getGlobalParam

public String getGlobalParam()

Get 全局筛选参数 报表过滤条件的全局参数。 格式为JSON格式的字符串 目前仅支持字符类型页面参数绑定到全局参数 [ { "ParamKey": "name", //页面参数名称 "JoinType": "AND", // 连接方式,目前仅支持AND "WhereList": [ { "Operator": "-neq", // 操作符，参考以下说明 "Value": [ //操作值，单值数组只传一个值 "zZWJMD", "ZzVGHX", "湖南省", "河北省" ] } ] }, { "ParamKey": "genderParam", "JoinType": "AND", "WhereList": [ { "Operator": "-neq", "Value": [ "男" ] } ] } ] Operator 目前支持 -neq 不等于!=操作符 -eq 等于=操作符 -is in操作符

Returns:

GlobalParam 全局筛选参数 报表过滤条件的全局参数。 格式为JSON格式的字符串 目前仅支持字符类型页面参数绑定到全局参数 [ { "ParamKey": "name", //页面参数名称 "JoinType": "AND", // 连接方式,目前仅支持AND "WhereList": [ { "Operator": "-neq", // 操作符，参考以下说明 "Value": [ //操作值，单值数组只传一个值 "zZWJMD", "ZzVGHX", "湖南省", "河北省" ] } ] }, { "ParamKey": "genderParam", "JoinType": "AND", "WhereList": [ { "Operator": "-neq", "Value": [ "男" ] } ] } ] Operator 目前支持 -neq 不等于!=操作符 -eq 等于=操作符 -is in操作符

setGlobalParam

public void setGlobalParam(String GlobalParam)

Set 全局筛选参数 报表过滤条件的全局参数。 格式为JSON格式的字符串 目前仅支持字符类型页面参数绑定到全局参数 [ { "ParamKey": "name", //页面参数名称 "JoinType": "AND", // 连接方式,目前仅支持AND "WhereList": [ { "Operator": "-neq", // 操作符，参考以下说明 "Value": [ //操作值，单值数组只传一个值 "zZWJMD", "ZzVGHX", "湖南省", "河北省" ] } ] }, { "ParamKey": "genderParam", "JoinType": "AND", "WhereList": [ { "Operator": "-neq", "Value": [ "男" ] } ] } ] Operator 目前支持 -neq 不等于!=操作符 -eq 等于=操作符 -is in操作符

Parameters:

GlobalParam - 全局筛选参数 报表过滤条件的全局参数。 格式为JSON格式的字符串 目前仅支持字符类型页面参数绑定到全局参数 [ { "ParamKey": "name", //页面参数名称 "JoinType": "AND", // 连接方式,目前仅支持AND "WhereList": [ { "Operator": "-neq", // 操作符，参考以下说明 "Value": [ //操作值，单值数组只传一个值 "zZWJMD", "ZzVGHX", "湖南省", "河北省" ] } ] }, { "ParamKey": "genderParam", "JoinType": "AND", "WhereList": [ { "Operator": "-neq", "Value": [ "男" ] } ] } ] Operator 目前支持 -neq 不等于!=操作符 -eq 等于=操作符 -is in操作符

getTokenType

public Long getTokenType()

Get 100 不绑定用户, 一次创建一个token，UserCorpId和UserId 非必填，不支持 ChatBI 嵌出 200 单用户单token , 一次创建一个token， UserCorpId和UserId 必填 300 单用户多token, 一次创建多个token，UserCorpId和UserId 必填

Returns:

TokenType 100 不绑定用户, 一次创建一个token，UserCorpId和UserId 非必填，不支持 ChatBI 嵌出 200 单用户单token , 一次创建一个token， UserCorpId和UserId 必填 300 单用户多token, 一次创建多个token，UserCorpId和UserId 必填

setTokenType

public void setTokenType(Long TokenType)

Set 100 不绑定用户, 一次创建一个token，UserCorpId和UserId 非必填，不支持 ChatBI 嵌出 200 单用户单token , 一次创建一个token， UserCorpId和UserId 必填 300 单用户多token, 一次创建多个token，UserCorpId和UserId 必填

Parameters:

TokenType - 100 不绑定用户, 一次创建一个token，UserCorpId和UserId 非必填，不支持 ChatBI 嵌出 200 单用户单token , 一次创建一个token， UserCorpId和UserId 必填 300 单用户多token, 一次创建多个token，UserCorpId和UserId 必填

getTokenNum

public Long getTokenNum()

Get 一次创建的token数

Returns:

TokenNum 一次创建的token数

setTokenNum

public void setTokenNum(Long TokenNum)

Set 一次创建的token数

Parameters:

TokenNum - 一次创建的token数

getConfigParam

public String getConfigParam()

Get 嵌出显示配置，目前为ChatBI嵌出场景用，TableFilter表示数据表列表过滤，SqlView表示sql查看功能

Returns:

ConfigParam 嵌出显示配置，目前为ChatBI嵌出场景用，TableFilter表示数据表列表过滤，SqlView表示sql查看功能

setConfigParam

public void setConfigParam(String ConfigParam)

Set 嵌出显示配置，目前为ChatBI嵌出场景用，TableFilter表示数据表列表过滤，SqlView表示sql查看功能

Parameters:

ConfigParam - 嵌出显示配置，目前为ChatBI嵌出场景用，TableFilter表示数据表列表过滤，SqlView表示sql查看功能

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.