Class: TencentCloud::Cls::V20201016::DescribeIndexResponse

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

Overview

DescribeIndex返回参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(topicid = nil, status = nil, rule = nil, modifytime = nil, includeinternalfields = nil, metadataflag = nil, coveragefield = nil, requestid = nil) ⇒ DescribeIndexResponse

Returns a new instance of DescribeIndexResponse.



8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
 
# File 'lib/v20201016/models.rb', line 8512

def initialize(topicid=nil, status=nil, rule=nil, modifytime=nil, includeinternalfields=nil, metadataflag=nil, coveragefield=nil, requestid=nil)
  @TopicId = topicid
  @Status = status
  @Rule = rule
  @ModifyTime = modifytime
  @IncludeInternalFields = includeinternalfields
  @MetadataFlag = metadataflag
  @CoverageField = coveragefield
  @RequestId = requestid
end

Instance Attribute Details

#CoverageField ⇒ Object

开启后可对日志进行检索分析，将产生索引流量、索引存储及相应费用。费用详情 注意：此字段可能返回 null，表示取不到有效值。

  • false:不包含
  • true:包含
  • 0:仅包含开启键值索引的元数据字段
  • 1:包含所有元数据字段
  • 2:不包含任何元数据字段

Parameters:

  • TopicId: —

    日志主题Id

  • Status: —

    索引状态。true：开启状态，false：关闭状态

  • Rule: —

    索引配置信息

  • ModifyTime: —

    索引修改时间，初始值为索引创建时间。格式 YYYY-MM-DD HH:MM:SS

  • IncludeInternalFields: —

    内置保留字段（__FILENAME__，__HOSTNAME__及__SOURCE__）是否包含至全文索引

  • MetadataFlag: —

    元数据字段（前缀为__TAG__的字段）是否包含至全文索引

  • CoverageField: —

    自定义日志解析异常存储字段。

  • RequestId: —

    唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。



8510
8511
8512
 
# File 'lib/v20201016/models.rb', line 8510

def CoverageField
  @CoverageField
end

#IncludeInternalFields ⇒ Object

开启后可对日志进行检索分析，将产生索引流量、索引存储及相应费用。费用详情 注意：此字段可能返回 null，表示取不到有效值。

  • false:不包含
  • true:包含
  • 0:仅包含开启键值索引的元数据字段
  • 1:包含所有元数据字段
  • 2:不包含任何元数据字段

Parameters:

  • TopicId: —

    日志主题Id

  • Status: —

    索引状态。true：开启状态，false：关闭状态

  • Rule: —

    索引配置信息

  • ModifyTime: —

    索引修改时间，初始值为索引创建时间。格式 YYYY-MM-DD HH:MM:SS

  • IncludeInternalFields: —

    内置保留字段（__FILENAME__，__HOSTNAME__及__SOURCE__）是否包含至全文索引

  • MetadataFlag: —

    元数据字段（前缀为__TAG__的字段）是否包含至全文索引

  • CoverageField: —

    自定义日志解析异常存储字段。

  • RequestId: —

    唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。



8510
8511
8512
 
# File 'lib/v20201016/models.rb', line 8510

def IncludeInternalFields
  @IncludeInternalFields
end

#MetadataFlag ⇒ Object

开启后可对日志进行检索分析，将产生索引流量、索引存储及相应费用。费用详情 注意：此字段可能返回 null，表示取不到有效值。

  • false:不包含
  • true:包含
  • 0:仅包含开启键值索引的元数据字段
  • 1:包含所有元数据字段
  • 2:不包含任何元数据字段

Parameters:

  • TopicId: —

    日志主题Id

  • Status: —

    索引状态。true：开启状态，false：关闭状态

  • Rule: —

    索引配置信息

  • ModifyTime: —

    索引修改时间，初始值为索引创建时间。格式 YYYY-MM-DD HH:MM:SS

  • IncludeInternalFields: —

    内置保留字段（__FILENAME__，__HOSTNAME__及__SOURCE__）是否包含至全文索引

  • MetadataFlag: —

    元数据字段（前缀为__TAG__的字段）是否包含至全文索引

  • CoverageField: —

    自定义日志解析异常存储字段。

  • RequestId: —

    唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。



8510
8511
8512
 
# File 'lib/v20201016/models.rb', line 8510

def MetadataFlag
  @MetadataFlag
end

#ModifyTime ⇒ Object

开启后可对日志进行检索分析，将产生索引流量、索引存储及相应费用。费用详情 注意：此字段可能返回 null，表示取不到有效值。

  • false:不包含
  • true:包含
  • 0:仅包含开启键值索引的元数据字段
  • 1:包含所有元数据字段
  • 2:不包含任何元数据字段

Parameters:

  • TopicId: —

    日志主题Id

  • Status: —

    索引状态。true：开启状态，false：关闭状态

  • Rule: —

    索引配置信息

  • ModifyTime: —

    索引修改时间，初始值为索引创建时间。格式 YYYY-MM-DD HH:MM:SS

  • IncludeInternalFields: —

    内置保留字段（__FILENAME__，__HOSTNAME__及__SOURCE__）是否包含至全文索引

  • MetadataFlag: —

    元数据字段（前缀为__TAG__的字段）是否包含至全文索引

  • CoverageField: —

    自定义日志解析异常存储字段。

  • RequestId: —

    唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。



8510
8511
8512
 
# File 'lib/v20201016/models.rb', line 8510

def ModifyTime
  @ModifyTime
end

#RequestId ⇒ Object

开启后可对日志进行检索分析，将产生索引流量、索引存储及相应费用。费用详情 注意：此字段可能返回 null，表示取不到有效值。

  • false:不包含
  • true:包含
  • 0:仅包含开启键值索引的元数据字段
  • 1:包含所有元数据字段
  • 2:不包含任何元数据字段

Parameters:

  • TopicId: —

    日志主题Id

  • Status: —

    索引状态。true：开启状态，false：关闭状态

  • Rule: —

    索引配置信息

  • ModifyTime: —

    索引修改时间，初始值为索引创建时间。格式 YYYY-MM-DD HH:MM:SS

  • IncludeInternalFields: —

    内置保留字段（__FILENAME__，__HOSTNAME__及__SOURCE__）是否包含至全文索引

  • MetadataFlag: —

    元数据字段（前缀为__TAG__的字段）是否包含至全文索引

  • CoverageField: —

    自定义日志解析异常存储字段。

  • RequestId: —

    唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。



8510
8511
8512
 
# File 'lib/v20201016/models.rb', line 8510

def RequestId
  @RequestId
end

#Rule ⇒ Object

开启后可对日志进行检索分析，将产生索引流量、索引存储及相应费用。费用详情 注意：此字段可能返回 null，表示取不到有效值。

  • false:不包含
  • true:包含
  • 0:仅包含开启键值索引的元数据字段
  • 1:包含所有元数据字段
  • 2:不包含任何元数据字段

Parameters:

  • TopicId: —

    日志主题Id

  • Status: —

    索引状态。true：开启状态，false：关闭状态

  • Rule: —

    索引配置信息

  • ModifyTime: —

    索引修改时间，初始值为索引创建时间。格式 YYYY-MM-DD HH:MM:SS

  • IncludeInternalFields: —

    内置保留字段（__FILENAME__，__HOSTNAME__及__SOURCE__）是否包含至全文索引

  • MetadataFlag: —

    元数据字段（前缀为__TAG__的字段）是否包含至全文索引

  • CoverageField: —

    自定义日志解析异常存储字段。

  • RequestId: —

    唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。



8510
8511
8512
 
# File 'lib/v20201016/models.rb', line 8510

def Rule
  @Rule
end

#Status ⇒ Object

开启后可对日志进行检索分析，将产生索引流量、索引存储及相应费用。费用详情 注意：此字段可能返回 null，表示取不到有效值。

  • false:不包含
  • true:包含
  • 0:仅包含开启键值索引的元数据字段
  • 1:包含所有元数据字段
  • 2:不包含任何元数据字段

Parameters:

  • TopicId: —

    日志主题Id

  • Status: —

    索引状态。true：开启状态，false：关闭状态

  • Rule: —

    索引配置信息

  • ModifyTime: —

    索引修改时间，初始值为索引创建时间。格式 YYYY-MM-DD HH:MM:SS

  • IncludeInternalFields: —

    内置保留字段（__FILENAME__，__HOSTNAME__及__SOURCE__）是否包含至全文索引

  • MetadataFlag: —

    元数据字段（前缀为__TAG__的字段）是否包含至全文索引

  • CoverageField: —

    自定义日志解析异常存储字段。

  • RequestId: —

    唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。



8510
8511
8512
 
# File 'lib/v20201016/models.rb', line 8510

def Status
  @Status
end

#TopicId ⇒ Object

开启后可对日志进行检索分析，将产生索引流量、索引存储及相应费用。费用详情 注意：此字段可能返回 null，表示取不到有效值。

  • false:不包含
  • true:包含
  • 0:仅包含开启键值索引的元数据字段
  • 1:包含所有元数据字段
  • 2:不包含任何元数据字段

Parameters:

  • TopicId: —

    日志主题Id

  • Status: —

    索引状态。true：开启状态，false：关闭状态

  • Rule: —

    索引配置信息

  • ModifyTime: —

    索引修改时间，初始值为索引创建时间。格式 YYYY-MM-DD HH:MM:SS

  • IncludeInternalFields: —

    内置保留字段（__FILENAME__，__HOSTNAME__及__SOURCE__）是否包含至全文索引

  • MetadataFlag: —

    元数据字段（前缀为__TAG__的字段）是否包含至全文索引

  • CoverageField: —

    自定义日志解析异常存储字段。

  • RequestId: —

    唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。



8510
8511
8512
 
# File 'lib/v20201016/models.rb', line 8510

def TopicId
  @TopicId
end

Instance Method Details

#deserialize(params) ⇒ Object 



8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
 
# File 'lib/v20201016/models.rb', line 8523

def deserialize(params)
  @TopicId = params['TopicId']
  @Status = params['Status']
  unless params['Rule'].nil?
    @Rule = RuleInfo.new
    @Rule.deserialize(params['Rule'])
  end
  @ModifyTime = params['ModifyTime']
  @IncludeInternalFields = params['IncludeInternalFields']
  @MetadataFlag = params['MetadataFlag']
  @CoverageField = params['CoverageField']
  @RequestId = params['RequestId']
end