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 Embedded display configurations: Currently for ChatBI embedding scenarios; TableFilter represents data table list filtering, SqlView represents SQL view feature.
String	getExpireTime() Get Expiration time.
String	getExtraParam() Get Alternate field.
String	getGlobalParam() Get Global filter parameters: Applies to all report filter criteria.
String	getIntention() Get "embed" indicates page dashboard embedding, and "chatBIEmbed" indicates ChatBI embedding.
Long	getPageId() Get Shares the page ID.
Long	getProjectId() Get Shares the project ID.
String	getScope() Get "page" indicates embedding a page, "panel" indicates embedding the entire dashboard, and "project" is used for ChatBI embedding.
Long	getTicketNum() Get Access count limit (range: 1-99999).
Long	getTokenNum() Get The number of tokens created at one time.
Long	getTokenType() Get 100: no user bound.
String	getUserCorpId() Get User enterprise ID (only used for multi-user).
String	getUserId() Get User ID (only used for multi-user).
void	setConfigParam(String ConfigParam) Set Embedded display configurations: Currently for ChatBI embedding scenarios; TableFilter represents data table list filtering, SqlView represents SQL view feature.
void	setExpireTime(String ExpireTime) Set Expiration time.
void	setExtraParam(String ExtraParam) Set Alternate field.
void	setGlobalParam(String GlobalParam) Set Global filter parameters: Applies to all report filter criteria.
void	setIntention(String Intention) Set "embed" indicates page dashboard embedding, and "chatBIEmbed" indicates ChatBI embedding.
void	setPageId(Long PageId) Set Shares the page ID.
void	setProjectId(Long ProjectId) Set Shares the project ID.
void	setScope(String Scope) Set "page" indicates embedding a page, "panel" indicates embedding the entire dashboard, and "project" is used for ChatBI embedding.
void	setTicketNum(Long TicketNum) Set Access count limit (range: 1-99999).
void	setTokenNum(Long TokenNum) Set The number of tokens created at one time.
void	setTokenType(Long TokenType) Set 100: no user bound.
void	setUserCorpId(String UserCorpId) Set User enterprise ID (only used for multi-user).
void	setUserId(String UserId) Set User ID (only used for multi-user).
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 Shares the project ID.

Returns:

ProjectId Shares the project ID.

setProjectId

public void setProjectId(Long ProjectId)

Set Shares the project ID.

Parameters:

ProjectId - Shares the project ID.

getPageId

public Long getPageId()

Get Shares the page ID. This field is empty (0) for embedding a dashboard and is not passed for embedding ChatBI.

Returns:

PageId Shares the page ID. This field is empty (0) for embedding a dashboard and is not passed for embedding ChatBI.

setPageId

public void setPageId(Long PageId)

Set Shares the page ID. This field is empty (0) for embedding a dashboard and is not passed for embedding ChatBI.

Parameters:

PageId - Shares the page ID. This field is empty (0) for embedding a dashboard and is not passed for embedding ChatBI.

getIntention

public String getIntention()

Get "embed" indicates page dashboard embedding, and "chatBIEmbed" indicates ChatBI embedding.

Returns:

Intention "embed" indicates page dashboard embedding, and "chatBIEmbed" indicates ChatBI embedding.

setIntention

public void setIntention(String Intention)

Set "embed" indicates page dashboard embedding, and "chatBIEmbed" indicates ChatBI embedding.

Parameters:

Intention - "embed" indicates page dashboard embedding, and "chatBIEmbed" indicates ChatBI embedding.

getScope

public String getScope()

Get "page" indicates embedding a page, "panel" indicates embedding the entire dashboard, and "project" is used for ChatBI embedding.

Returns:

Scope "page" indicates embedding a page, "panel" indicates embedding the entire dashboard, and "project" is used for ChatBI embedding.

setScope

public void setScope(String Scope)

Set "page" indicates embedding a page, "panel" indicates embedding the entire dashboard, and "project" is used for ChatBI embedding.

Parameters:

Scope - "page" indicates embedding a page, "panel" indicates embedding the entire dashboard, and "project" is used for ChatBI embedding.

getExpireTime

public String getExpireTime()

Get Expiration time. Unit: minutes. Maximum value: 240 (namely, 4 hours). Default value: 240.

Returns:

ExpireTime Expiration time. Unit: minutes. Maximum value: 240 (namely, 4 hours). Default value: 240.

setExpireTime

public void setExpireTime(String ExpireTime)

Set Expiration time. Unit: minutes. Maximum value: 240 (namely, 4 hours). Default value: 240.

Parameters:

ExpireTime - Expiration time. Unit: minutes. Maximum value: 240 (namely, 4 hours). Default value: 240.

getExtraParam

public String getExtraParam()

Get Alternate field.

Returns:

ExtraParam Alternate field.

setExtraParam

public void setExtraParam(String ExtraParam)

Set Alternate field.

Parameters:

ExtraParam - Alternate field.

getUserCorpId

public String getUserCorpId()

Get User enterprise ID (only used for multi-user).

Returns:

UserCorpId User enterprise ID (only used for multi-user).

setUserCorpId

public void setUserCorpId(String UserCorpId)

Set User enterprise ID (only used for multi-user).

Parameters:

UserCorpId - User enterprise ID (only used for multi-user).

getUserId

public String getUserId()

Get User ID (only used for multi-user).

Returns:

UserId User ID (only used for multi-user).

setUserId

public void setUserId(String UserId)

Set User ID (only used for multi-user).

Parameters:

UserId - User ID (only used for multi-user).

getTicketNum

public Long getTicketNum()

Get Access count limit (range: 1-99999). Leave empty to disable access restrictions.

Returns:

TicketNum Access count limit (range: 1-99999). Leave empty to disable access restrictions.

setTicketNum

public void setTicketNum(Long TicketNum)

Set Access count limit (range: 1-99999). Leave empty to disable access restrictions.

Parameters:

TicketNum - Access count limit (range: 1-99999). Leave empty to disable access restrictions.

getGlobalParam

public String getGlobalParam()

Get Global filter parameters: Applies to all report filter criteria. Should be formatted as a JSON string. Currently, only character-type page parameters can be bound to global parameters. [ { "ParamKey": "name", page parameter name. "JoinType": "AND", // connection method. Currently, only AND is supported. "WhereList": [ { "Operator": "-neq", // operator. Refer to the following instructions. "Value": [ action value. For a single-value array, only one value is passed. "zZWJMD", "ZzVGHX", "Hunan province". "Hebei province". ] } ] }, { "ParamKey": "genderParam", "JoinType": "AND", "WhereList": [ { "Operator": "-neq", "Value": [ "Male". ] } ] } ] Currently supported operators. -neq not equal to != operator. -eq equal to = operator. -is in operator.

Returns:

GlobalParam Global filter parameters: Applies to all report filter criteria. Should be formatted as a JSON string. Currently, only character-type page parameters can be bound to global parameters. [ { "ParamKey": "name", page parameter name. "JoinType": "AND", // connection method. Currently, only AND is supported. "WhereList": [ { "Operator": "-neq", // operator. Refer to the following instructions. "Value": [ action value. For a single-value array, only one value is passed. "zZWJMD", "ZzVGHX", "Hunan province". "Hebei province". ] } ] }, { "ParamKey": "genderParam", "JoinType": "AND", "WhereList": [ { "Operator": "-neq", "Value": [ "Male". ] } ] } ] Currently supported operators. -neq not equal to != operator. -eq equal to = operator. -is in operator.

setGlobalParam

public void setGlobalParam(String GlobalParam)

Set Global filter parameters: Applies to all report filter criteria. Should be formatted as a JSON string. Currently, only character-type page parameters can be bound to global parameters. [ { "ParamKey": "name", page parameter name. "JoinType": "AND", // connection method. Currently, only AND is supported. "WhereList": [ { "Operator": "-neq", // operator. Refer to the following instructions. "Value": [ action value. For a single-value array, only one value is passed. "zZWJMD", "ZzVGHX", "Hunan province". "Hebei province". ] } ] }, { "ParamKey": "genderParam", "JoinType": "AND", "WhereList": [ { "Operator": "-neq", "Value": [ "Male". ] } ] } ] Currently supported operators. -neq not equal to != operator. -eq equal to = operator. -is in operator.

Parameters:

GlobalParam - Global filter parameters: Applies to all report filter criteria. Should be formatted as a JSON string. Currently, only character-type page parameters can be bound to global parameters. [ { "ParamKey": "name", page parameter name. "JoinType": "AND", // connection method. Currently, only AND is supported. "WhereList": [ { "Operator": "-neq", // operator. Refer to the following instructions. "Value": [ action value. For a single-value array, only one value is passed. "zZWJMD", "ZzVGHX", "Hunan province". "Hebei province". ] } ] }, { "ParamKey": "genderParam", "JoinType": "AND", "WhereList": [ { "Operator": "-neq", "Value": [ "Male". ] } ] } ] Currently supported operators. -neq not equal to != operator. -eq equal to = operator. -is in operator.

getTokenType

public Long getTokenType()

Get 100: no user bound. Create 1 token at a time. UserCorpId and UserId are optional. ChatBI embedding is not supported. 200: single token per user. Create 1 token at a time. UserCorpId and UserId required. 300: multiple tokens per user. Create multiple tokens at a time. UserCorpId and UserId required.

Returns:

TokenType 100: no user bound. Create 1 token at a time. UserCorpId and UserId are optional. ChatBI embedding is not supported. 200: single token per user. Create 1 token at a time. UserCorpId and UserId required. 300: multiple tokens per user. Create multiple tokens at a time. UserCorpId and UserId required.

setTokenType

public void setTokenType(Long TokenType)

Set 100: no user bound. Create 1 token at a time. UserCorpId and UserId are optional. ChatBI embedding is not supported. 200: single token per user. Create 1 token at a time. UserCorpId and UserId required. 300: multiple tokens per user. Create multiple tokens at a time. UserCorpId and UserId required.

Parameters:

TokenType - 100: no user bound. Create 1 token at a time. UserCorpId and UserId are optional. ChatBI embedding is not supported. 200: single token per user. Create 1 token at a time. UserCorpId and UserId required. 300: multiple tokens per user. Create multiple tokens at a time. UserCorpId and UserId required.

getTokenNum

public Long getTokenNum()

Get The number of tokens created at one time.

Returns:

TokenNum The number of tokens created at one time.

setTokenNum

public void setTokenNum(Long TokenNum)

Set The number of tokens created at one time.

Parameters:

TokenNum - The number of tokens created at one time.

getConfigParam

public String getConfigParam()

Get Embedded display configurations: Currently for ChatBI embedding scenarios; TableFilter represents data table list filtering, SqlView represents SQL view feature.

Returns:

ConfigParam Embedded display configurations: Currently for ChatBI embedding scenarios; TableFilter represents data table list filtering, SqlView represents SQL view feature.

setConfigParam

public void setConfigParam(String ConfigParam)

Set Embedded display configurations: Currently for ChatBI embedding scenarios; TableFilter represents data table list filtering, SqlView represents SQL view feature.

Parameters:

ConfigParam - Embedded display configurations: Currently for ChatBI embedding scenarios; TableFilter represents data table list filtering, SqlView represents SQL view feature.

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.