Class: TencentCloud::Cls::V20201016::DescribeTopicsRequest

Inherits:
TencentCloud::Common::AbstractModel
  • Object
show all
Defined in:
lib/v20201016/models.rb

Overview

DescribeTopics请求参数结构体

Instance Attribute Summary collapse

注意:每次请求的 Filters 的上限为10,Filter.Values 的上限为100。 - 0:日志主题,默认值 - 1:指标主题.
  • #Filters ⇒ Object
  • 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。 - 0:日志主题,默认值 - 1:指标主题.
  • #Limit ⇒ Object
  • 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。 - 0:日志主题,默认值 - 1:指标主题.
  • #Offset ⇒ Object
  • 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。 - 0:日志主题,默认值 - 1:指标主题.
  • #PreciseSearch ⇒ Object
  • 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。 - 0:日志主题,默认值 - 1:指标主题.

    Instance Method Summary collapse

    Constructor Details

    #initialize(filters = nil, offset = nil, limit = nil, precisesearch = nil, biztype = nil) ⇒ DescribeTopicsRequest

    Returns a new instance of DescribeTopicsRequest.

    
    
    10205
    10206
    10207
    10208
    10209
    10210
    10211
    # File 'lib/v20201016/models.rb', line 10205
    
    def initialize(filters=nil, offset=nil, limit=nil, precisesearch=nil, biztype=nil)
      @Filters = filters
      @Offset = offset
      @Limit = limit
      @PreciseSearch = precisesearch
      @BizType = biztype
    end
    

    Instance Attribute Details

    #BizType ⇒ Object

  • 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。
    • 0: 默认值,topicName 和 logsetName 模糊匹配
    • 1: topicName 精确匹配
    • 2: logsetName精确匹配
    • 3: topicName 和logsetName 都精确匹配
    - 0:日志主题,默认值 - 1:指标主题

    Parameters:

    • Filters: (ul) —
    • topicName 按照【主题名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否
  • Offset: —

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

  • Limit: —

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

  • PreciseSearch: —

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

  • BizType: —

    主题类型

  • 
    
    10203
    10204
    10205
    # File 'lib/v20201016/models.rb', line 10203
    
    def BizType
      @BizType
    end
    

    #Filters ⇒ Object

  • 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。
    • 0: 默认值,topicName 和 logsetName 模糊匹配
    • 1: topicName 精确匹配
    • 2: logsetName精确匹配
    • 3: topicName 和logsetName 都精确匹配
    - 0:日志主题,默认值 - 1:指标主题

    Parameters:

  • Offset: —

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

  • Limit: —

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

  • PreciseSearch: —

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

  • BizType: —

    主题类型

  • 
    
    10203
    10204
    10205
    # File 'lib/v20201016/models.rb', line 10203
    
    def Filters
      @Filters
    end
    

    #Limit ⇒ Object

  • 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。
    • 0: 默认值,topicName 和 logsetName 模糊匹配
    • 1: topicName 精确匹配
    • 2: logsetName精确匹配
    • 3: topicName 和logsetName 都精确匹配
    - 0:日志主题,默认值 - 1:指标主题

    Parameters:

  • Offset: —

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

  • Limit: —

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

  • PreciseSearch: —

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

  • BizType: —

    主题类型

  • 
    
    10203
    10204
    10205
    # File 'lib/v20201016/models.rb', line 10203
    
    def Limit
      @Limit
    end
    

    #Offset ⇒ Object

  • 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。
    • 0: 默认值,topicName 和 logsetName 模糊匹配
    • 1: topicName 精确匹配
    • 2: logsetName精确匹配
    • 3: topicName 和logsetName 都精确匹配
    - 0:日志主题,默认值 - 1:指标主题

    Parameters:

  • Offset: —

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

  • Limit: —

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

  • PreciseSearch: —

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

  • BizType: —

    主题类型

  • 
    
    10203
    10204
    10205
    # File 'lib/v20201016/models.rb', line 10203
    
    def Offset
      @Offset
    end
    

    #PreciseSearch ⇒ Object

  • 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。
    • 0: 默认值,topicName 和 logsetName 模糊匹配
    • 1: topicName 精确匹配
    • 2: logsetName精确匹配
    • 3: topicName 和logsetName 都精确匹配
    - 0:日志主题,默认值 - 1:指标主题

    Parameters:

  • Offset: —

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

  • Limit: —

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

  • PreciseSearch: —

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

  • BizType: —

    主题类型

  • 
    
    10203
    10204
    10205
    # File 'lib/v20201016/models.rb', line 10203
    
    def PreciseSearch
      @PreciseSearch
    end
    

    Instance Method Details

    #deserialize(params) ⇒ Object

    
    
    10213
    10214
    10215
    10216
    10217
    10218
    10219
    10220
    10221
    10222
    10223
    10224
    10225
    10226
    # File 'lib/v20201016/models.rb', line 10213
    
    def deserialize(params)
      unless params['Filters'].nil?
        @Filters = []
        params['Filters'].each do |i|
          filter_tmp = Filter.new
          filter_tmp.deserialize(i)
          @Filters << filter_tmp
        end
      end
      @Offset = params['Offset']
      @Limit = params['Limit']
      @PreciseSearch = params['PreciseSearch']
      @BizType = params['BizType']
    end