com.tencentcloudapi.cls.v20201016.models

Class DescribeTopicsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cls.v20201016.models.DescribeTopicsRequest

public class DescribeTopicsRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeTopicsRequest()
DescribeTopicsRequest(DescribeTopicsRequest 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
Long	getBizType() Get 主题类型 0:日志主题，默认值 1:指标主题
Filter[]	getFilters() Get topicName 按照【日志主题名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否 logsetName 按照【日志集名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否 topicId 按照【日志主题ID】进行过滤。类型：String。必选：否 logsetId 按照【日志集ID】进行过滤，可通过调用 DescribeLogsets 查询已创建的日志集列表或登录控制台进行查看；也可以调用 CreateLogset 创建新的日志集。类型：String。必选：否 tagKey 按照【标签键】进行过滤。类型：String。必选：否 tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换，例如 tag:exampleKey。类型：String。必选：否 storageType 按照【日志主题的存储类型】进行过滤。可选值 hot（标准存储），cold（低频存储）类型：String。必选：否 注意：每次请求的 Filters 的上限为10，Filter.Values 的上限为100。
Long	getLimit() Get 分页单页限制数目，默认值为20，最大值100。
Long	getOffset() Get 分页的偏移量，默认值为0。
Long	getPreciseSearch() Get 控制Filters相关字段是否为精确匹配。 0: 默认值，topicName 和 logsetName 模糊匹配 1: topicName 精确匹配 2: logsetName精确匹配 3: topicName 和logsetName 都精确匹配
void	setBizType(Long BizType) Set 主题类型 0:日志主题，默认值 1:指标主题
void	setFilters(Filter[] Filters) Set topicName 按照【日志主题名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否 logsetName 按照【日志集名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否 topicId 按照【日志主题ID】进行过滤。类型：String。必选：否 logsetId 按照【日志集ID】进行过滤，可通过调用 DescribeLogsets 查询已创建的日志集列表或登录控制台进行查看；也可以调用 CreateLogset 创建新的日志集。类型：String。必选：否 tagKey 按照【标签键】进行过滤。类型：String。必选：否 tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换，例如 tag:exampleKey。类型：String。必选：否 storageType 按照【日志主题的存储类型】进行过滤。可选值 hot（标准存储），cold（低频存储）类型：String。必选：否 注意：每次请求的 Filters 的上限为10，Filter.Values 的上限为100。
void	setLimit(Long Limit) Set 分页单页限制数目，默认值为20，最大值100。
void	setOffset(Long Offset) Set 分页的偏移量，默认值为0。
void	setPreciseSearch(Long PreciseSearch) Set 控制Filters相关字段是否为精确匹配。 0: 默认值，topicName 和 logsetName 模糊匹配 1: topicName 精确匹配 2: logsetName精确匹配 3: topicName 和logsetName 都精确匹配
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

DescribeTopicsRequest

public DescribeTopicsRequest()

DescribeTopicsRequest

public DescribeTopicsRequest(DescribeTopicsRequest 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

getFilters

public Filter[] getFilters()

Get

• topicName 按照【日志主题名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否
• logsetName 按照【日志集名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否
• topicId 按照【日志主题ID】进行过滤。类型：String。必选：否
• logsetId 按照【日志集ID】进行过滤，可通过调用 DescribeLogsets 查询已创建的日志集列表或登录控制台进行查看；也可以调用 CreateLogset 创建新的日志集。类型：String。必选：否
• tagKey 按照【标签键】进行过滤。类型：String。必选：否
• tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换，例如 tag:exampleKey。类型：String。必选：否
• storageType 按照【日志主题的存储类型】进行过滤。可选值 hot（标准存储），cold（低频存储）类型：String。必选：否

注意：每次请求的 Filters 的上限为10，Filter.Values 的上限为100。

Returns:

Filters

• topicName 按照【日志主题名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否
• logsetName 按照【日志集名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否
• topicId 按照【日志主题ID】进行过滤。类型：String。必选：否
• logsetId 按照【日志集ID】进行过滤，可通过调用 DescribeLogsets 查询已创建的日志集列表或登录控制台进行查看；也可以调用 CreateLogset 创建新的日志集。类型：String。必选：否
• tagKey 按照【标签键】进行过滤。类型：String。必选：否
• tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换，例如 tag:exampleKey。类型：String。必选：否
• storageType 按照【日志主题的存储类型】进行过滤。可选值 hot（标准存储），cold（低频存储）类型：String。必选：否

注意：每次请求的 Filters 的上限为10，Filter.Values 的上限为100。

setFilters

public void setFilters(Filter[] Filters)

Set

• topicName 按照【日志主题名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否
• logsetName 按照【日志集名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否
• topicId 按照【日志主题ID】进行过滤。类型：String。必选：否
• logsetId 按照【日志集ID】进行过滤，可通过调用 DescribeLogsets 查询已创建的日志集列表或登录控制台进行查看；也可以调用 CreateLogset 创建新的日志集。类型：String。必选：否
• tagKey 按照【标签键】进行过滤。类型：String。必选：否
• tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换，例如 tag:exampleKey。类型：String。必选：否
• storageType 按照【日志主题的存储类型】进行过滤。可选值 hot（标准存储），cold（低频存储）类型：String。必选：否

注意：每次请求的 Filters 的上限为10，Filter.Values 的上限为100。

Parameters:

Filters -

• topicName 按照【日志主题名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否
• logsetName 按照【日志集名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否
• topicId 按照【日志主题ID】进行过滤。类型：String。必选：否
• logsetId 按照【日志集ID】进行过滤，可通过调用 DescribeLogsets 查询已创建的日志集列表或登录控制台进行查看；也可以调用 CreateLogset 创建新的日志集。类型：String。必选：否
• tagKey 按照【标签键】进行过滤。类型：String。必选：否
• tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换，例如 tag:exampleKey。类型：String。必选：否
• storageType 按照【日志主题的存储类型】进行过滤。可选值 hot（标准存储），cold（低频存储）类型：String。必选：否

注意：每次请求的 Filters 的上限为10，Filter.Values 的上限为100。

getOffset

public Long getOffset()

Get 分页的偏移量，默认值为0。

Returns:

Offset 分页的偏移量，默认值为0。

setOffset

public void setOffset(Long Offset)

Set 分页的偏移量，默认值为0。

Parameters:

Offset - 分页的偏移量，默认值为0。

getLimit

public Long getLimit()

Get 分页单页限制数目，默认值为20，最大值100。

Returns:

Limit 分页单页限制数目，默认值为20，最大值100。

setLimit

public void setLimit(Long Limit)

Set 分页单页限制数目，默认值为20，最大值100。

Parameters:

Limit - 分页单页限制数目，默认值为20，最大值100。

getPreciseSearch

public Long getPreciseSearch()

Get 控制Filters相关字段是否为精确匹配。

• 0: 默认值，topicName 和 logsetName 模糊匹配
• 1: topicName 精确匹配
• 2: logsetName精确匹配
• 3: topicName 和logsetName 都精确匹配

Returns:

PreciseSearch 控制Filters相关字段是否为精确匹配。

• 0: 默认值，topicName 和 logsetName 模糊匹配
• 1: topicName 精确匹配
• 2: logsetName精确匹配
• 3: topicName 和logsetName 都精确匹配

setPreciseSearch

public void setPreciseSearch(Long PreciseSearch)

Set 控制Filters相关字段是否为精确匹配。

• 0: 默认值，topicName 和 logsetName 模糊匹配
• 1: topicName 精确匹配
• 2: logsetName精确匹配
• 3: topicName 和logsetName 都精确匹配

Parameters:

PreciseSearch - 控制Filters相关字段是否为精确匹配。

• 0: 默认值，topicName 和 logsetName 模糊匹配
• 1: topicName 精确匹配
• 2: logsetName精确匹配
• 3: topicName 和logsetName 都精确匹配

getBizType

public Long getBizType()

Get 主题类型

• 0:日志主题，默认值
• 1:指标主题

Returns:

BizType 主题类型

• 0:日志主题，默认值
• 1:指标主题

setBizType

public void setBizType(Long BizType)

Set 主题类型

• 0:日志主题，默认值
• 1:指标主题

Parameters:

BizType - 主题类型

• 0:日志主题，默认值
• 1:指标主题

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel