com.tencentcloudapi.cls.v20201016.models

Class DescribeDashboardsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cls.v20201016.models.DescribeDashboardsRequest

public class DescribeDashboardsRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeDashboardsRequest()
DescribeDashboardsRequest(DescribeDashboardsRequest 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
Filter[]	getFilters() Get - dashboardId 按照【仪表盘id】进行过滤，类型：String， 必选：否。 - 示例值：dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5 - dashboardName 按照【仪表盘名字】进行模糊搜索过滤，类型：String，必选：否。 - 示例值：业务大盘 - dashboardRegion 按照【仪表盘地域】进行过滤（兼容老的仪表盘），通过云API创建的仪表盘该属性，类型：String，必选：否。 - 参考 [地域和访问域名](https://cloud.tencent.com/document/product/614/18940) - 示例：ap-guangzhou - tagKey 按照【标签键】进行过滤，类型：String，必选：否。 - 示例值： ``` "Filters":[ { "Key": "tagKey", "Values": [ "tag-key-test" ] } ] ``` - tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换，类型：String，必选：否， - 参考 [示例1](https://cloud.tencent.com/document/api/614/95636#4.-.E7.A4.BA.E4.BE.8B) 使用。 ``` "Filters": [ { "Key": "tag:tag-key-test", "Values": [ "12" ] } ] ``` 每次请求的Filters的上限为10，Filter.Values的上限为100。
Long	getLimit() Get 分页单页限制数目，默认值为20，最大值100。
Long	getOffset() Get 分页的偏移量，默认值为0。
TopicIdAndRegion[]	getTopicIdRegionFilter() Get 按照topicId和regionId过滤。 - topicId:日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 - 示例值：439a5304-08f9-484b-9c4d-46ff57133816 - regionId - 1:广州 - 4:上海 - 5:中国香港 - 7:上海金融 - 8:北京 - 9:新加坡 - 11:深圳金融 - 15:硅谷 - 16:成都 - 17:法兰克福 - 18:首尔 - 19:重庆 - 22:弗吉尼亚 - 23:曼谷 - 25:东京 - 33:南京 - 36:天津 - 39:台北 - 46:北京金融 - 72:雅加达 - 74:圣保罗 - 78:上海自动驾驶云
void	setFilters(Filter[] Filters) Set - dashboardId 按照【仪表盘id】进行过滤，类型：String， 必选：否。 - 示例值：dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5 - dashboardName 按照【仪表盘名字】进行模糊搜索过滤，类型：String，必选：否。 - 示例值：业务大盘 - dashboardRegion 按照【仪表盘地域】进行过滤（兼容老的仪表盘），通过云API创建的仪表盘该属性，类型：String，必选：否。 - 参考 [地域和访问域名](https://cloud.tencent.com/document/product/614/18940) - 示例：ap-guangzhou - tagKey 按照【标签键】进行过滤，类型：String，必选：否。 - 示例值： ``` "Filters":[ { "Key": "tagKey", "Values": [ "tag-key-test" ] } ] ``` - tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换，类型：String，必选：否， - 参考 [示例1](https://cloud.tencent.com/document/api/614/95636#4.-.E7.A4.BA.E4.BE.8B) 使用。 ``` "Filters": [ { "Key": "tag:tag-key-test", "Values": [ "12" ] } ] ``` 每次请求的Filters的上限为10，Filter.Values的上限为100。
void	setLimit(Long Limit) Set 分页单页限制数目，默认值为20，最大值100。
void	setOffset(Long Offset) Set 分页的偏移量，默认值为0。
void	setTopicIdRegionFilter(TopicIdAndRegion[] TopicIdRegionFilter) Set 按照topicId和regionId过滤。 - topicId:日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 - 示例值：439a5304-08f9-484b-9c4d-46ff57133816 - regionId - 1:广州 - 4:上海 - 5:中国香港 - 7:上海金融 - 8:北京 - 9:新加坡 - 11:深圳金融 - 15:硅谷 - 16:成都 - 17:法兰克福 - 18:首尔 - 19:重庆 - 22:弗吉尼亚 - 23:曼谷 - 25:东京 - 33:南京 - 36:天津 - 39:台北 - 46:北京金融 - 72:雅加达 - 74:圣保罗 - 78:上海自动驾驶云
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

DescribeDashboardsRequest

public DescribeDashboardsRequest()

DescribeDashboardsRequest

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

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。

getFilters

public Filter[] getFilters()

Get - dashboardId 按照【仪表盘id】进行过滤，类型：String， 必选：否。 - 示例值：dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5 - dashboardName 按照【仪表盘名字】进行模糊搜索过滤，类型：String，必选：否。 - 示例值：业务大盘 - dashboardRegion 按照【仪表盘地域】进行过滤（兼容老的仪表盘），通过云API创建的仪表盘该属性，类型：String，必选：否。 - 参考 [地域和访问域名](https://cloud.tencent.com/document/product/614/18940) - 示例：ap-guangzhou - tagKey 按照【标签键】进行过滤，类型：String，必选：否。 - 示例值： ``` "Filters":[ { "Key": "tagKey", "Values": [ "tag-key-test" ] } ] ``` - tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换，类型：String，必选：否， - 参考 [示例1](https://cloud.tencent.com/document/api/614/95636#4.-.E7.A4.BA.E4.BE.8B) 使用。 ``` "Filters": [ { "Key": "tag:tag-key-test", "Values": [ "12" ] } ] ``` 每次请求的Filters的上限为10，Filter.Values的上限为100。

Returns:

Filters - dashboardId 按照【仪表盘id】进行过滤，类型：String， 必选：否。 - 示例值：dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5 - dashboardName 按照【仪表盘名字】进行模糊搜索过滤，类型：String，必选：否。 - 示例值：业务大盘 - dashboardRegion 按照【仪表盘地域】进行过滤（兼容老的仪表盘），通过云API创建的仪表盘该属性，类型：String，必选：否。 - 参考 [地域和访问域名](https://cloud.tencent.com/document/product/614/18940) - 示例：ap-guangzhou - tagKey 按照【标签键】进行过滤，类型：String，必选：否。 - 示例值： ``` "Filters":[ { "Key": "tagKey", "Values": [ "tag-key-test" ] } ] ``` - tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换，类型：String，必选：否， - 参考 [示例1](https://cloud.tencent.com/document/api/614/95636#4.-.E7.A4.BA.E4.BE.8B) 使用。 ``` "Filters": [ { "Key": "tag:tag-key-test", "Values": [ "12" ] } ] ``` 每次请求的Filters的上限为10，Filter.Values的上限为100。

setFilters

public void setFilters(Filter[] Filters)

Set - dashboardId 按照【仪表盘id】进行过滤，类型：String， 必选：否。 - 示例值：dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5 - dashboardName 按照【仪表盘名字】进行模糊搜索过滤，类型：String，必选：否。 - 示例值：业务大盘 - dashboardRegion 按照【仪表盘地域】进行过滤（兼容老的仪表盘），通过云API创建的仪表盘该属性，类型：String，必选：否。 - 参考 [地域和访问域名](https://cloud.tencent.com/document/product/614/18940) - 示例：ap-guangzhou - tagKey 按照【标签键】进行过滤，类型：String，必选：否。 - 示例值： ``` "Filters":[ { "Key": "tagKey", "Values": [ "tag-key-test" ] } ] ``` - tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换，类型：String，必选：否， - 参考 [示例1](https://cloud.tencent.com/document/api/614/95636#4.-.E7.A4.BA.E4.BE.8B) 使用。 ``` "Filters": [ { "Key": "tag:tag-key-test", "Values": [ "12" ] } ] ``` 每次请求的Filters的上限为10，Filter.Values的上限为100。

Parameters:

Filters - - dashboardId 按照【仪表盘id】进行过滤，类型：String， 必选：否。 - 示例值：dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5 - dashboardName 按照【仪表盘名字】进行模糊搜索过滤，类型：String，必选：否。 - 示例值：业务大盘 - dashboardRegion 按照【仪表盘地域】进行过滤（兼容老的仪表盘），通过云API创建的仪表盘该属性，类型：String，必选：否。 - 参考 [地域和访问域名](https://cloud.tencent.com/document/product/614/18940) - 示例：ap-guangzhou - tagKey 按照【标签键】进行过滤，类型：String，必选：否。 - 示例值： ``` "Filters":[ { "Key": "tagKey", "Values": [ "tag-key-test" ] } ] ``` - tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换，类型：String，必选：否， - 参考 [示例1](https://cloud.tencent.com/document/api/614/95636#4.-.E7.A4.BA.E4.BE.8B) 使用。 ``` "Filters": [ { "Key": "tag:tag-key-test", "Values": [ "12" ] } ] ``` 每次请求的Filters的上限为10，Filter.Values的上限为100。

getTopicIdRegionFilter

public TopicIdAndRegion[] getTopicIdRegionFilter()

Get 按照topicId和regionId过滤。 - topicId:日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 - 示例值：439a5304-08f9-484b-9c4d-46ff57133816 - regionId - 1:广州 - 4:上海 - 5:中国香港 - 7:上海金融 - 8:北京 - 9:新加坡 - 11:深圳金融 - 15:硅谷 - 16:成都 - 17:法兰克福 - 18:首尔 - 19:重庆 - 22:弗吉尼亚 - 23:曼谷 - 25:东京 - 33:南京 - 36:天津 - 39:台北 - 46:北京金融 - 72:雅加达 - 74:圣保罗 - 78:上海自动驾驶云

Returns:

TopicIdRegionFilter 按照topicId和regionId过滤。 - topicId:日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 - 示例值：439a5304-08f9-484b-9c4d-46ff57133816 - regionId - 1:广州 - 4:上海 - 5:中国香港 - 7:上海金融 - 8:北京 - 9:新加坡 - 11:深圳金融 - 15:硅谷 - 16:成都 - 17:法兰克福 - 18:首尔 - 19:重庆 - 22:弗吉尼亚 - 23:曼谷 - 25:东京 - 33:南京 - 36:天津 - 39:台北 - 46:北京金融 - 72:雅加达 - 74:圣保罗 - 78:上海自动驾驶云

setTopicIdRegionFilter

public void setTopicIdRegionFilter(TopicIdAndRegion[] TopicIdRegionFilter)

Set 按照topicId和regionId过滤。 - topicId:日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 - 示例值：439a5304-08f9-484b-9c4d-46ff57133816 - regionId - 1:广州 - 4:上海 - 5:中国香港 - 7:上海金融 - 8:北京 - 9:新加坡 - 11:深圳金融 - 15:硅谷 - 16:成都 - 17:法兰克福 - 18:首尔 - 19:重庆 - 22:弗吉尼亚 - 23:曼谷 - 25:东京 - 33:南京 - 36:天津 - 39:台北 - 46:北京金融 - 72:雅加达 - 74:圣保罗 - 78:上海自动驾驶云

Parameters:

TopicIdRegionFilter - 按照topicId和regionId过滤。 - topicId:日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 - 示例值：439a5304-08f9-484b-9c4d-46ff57133816 - regionId - 1:广州 - 4:上海 - 5:中国香港 - 7:上海金融 - 8:北京 - 9:新加坡 - 11:深圳金融 - 15:硅谷 - 16:成都 - 17:法兰克福 - 18:首尔 - 19:重庆 - 22:弗吉尼亚 - 23:曼谷 - 25:东京 - 33:南京 - 36:天津 - 39:台北 - 46:北京金融 - 72:雅加达 - 74:圣保罗 - 78:上海自动驾驶云

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.