com.tencentcloudapi.cls.v20201016.models

Class DescribeIndexResponse

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cls.v20201016.models.DescribeIndexResponse

public class DescribeIndexResponse
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeIndexResponse()
DescribeIndexResponse(DescribeIndexResponse 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
Boolean	getIncludeInternalFields() Get 内置保留字段（`__FILENAME__`，`__HOSTNAME__`及`__SOURCE__`）是否包含至全文索引 false:不包含 true:包含
Long	getMetadataFlag() Get 元数据字段（前缀为`__TAG__`的字段）是否包含至全文索引 0:仅包含开启键值索引的元数据字段 1:包含所有元数据字段 2:不包含任何元数据字段
String	getModifyTime() Get 索引修改时间，初始值为索引创建时间。格式 `YYYY-MM-DD HH:MM:SS`
String	getRequestId() Get 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
RuleInfo	getRule() Get 索引配置信息 注意：此字段可能返回 null，表示取不到有效值。
Boolean	getStatus() Get 索引状态。true：开启状态，false：关闭状态 开启后可对日志进行检索分析，将产生索引流量、索引存储及相应费用。[费用详情](https://cloud.tencent.com/document/product/614/45802#.E8.AE.A1.E8.B4.B9.E9.A1.B9)
String	getTopicId() Get 日志主题Id
void	setIncludeInternalFields(Boolean IncludeInternalFields) Set 内置保留字段（`__FILENAME__`，`__HOSTNAME__`及`__SOURCE__`）是否包含至全文索引 false:不包含 true:包含
void	setMetadataFlag(Long MetadataFlag) Set 元数据字段（前缀为`__TAG__`的字段）是否包含至全文索引 0:仅包含开启键值索引的元数据字段 1:包含所有元数据字段 2:不包含任何元数据字段
void	setModifyTime(String ModifyTime) Set 索引修改时间，初始值为索引创建时间。格式 `YYYY-MM-DD HH:MM:SS`
void	setRequestId(String RequestId) Set 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
void	setRule(RuleInfo Rule) Set 索引配置信息 注意：此字段可能返回 null，表示取不到有效值。
void	setStatus(Boolean Status) Set 索引状态。true：开启状态，false：关闭状态 开启后可对日志进行检索分析，将产生索引流量、索引存储及相应费用。[费用详情](https://cloud.tencent.com/document/product/614/45802#.E8.AE.A1.E8.B4.B9.E9.A1.B9)
void	setTopicId(String TopicId) Set 日志主题Id
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

DescribeIndexResponse

public DescribeIndexResponse()

DescribeIndexResponse

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

getTopicId

public String getTopicId()

Get 日志主题Id

Returns:

TopicId 日志主题Id

setTopicId

public void setTopicId(String TopicId)

Set 日志主题Id

Parameters:

TopicId - 日志主题Id

getStatus

public Boolean getStatus()

Get 索引状态。true：开启状态，false：关闭状态 开启后可对日志进行检索分析，将产生索引流量、索引存储及相应费用。[费用详情](https://cloud.tencent.com/document/product/614/45802#.E8.AE.A1.E8.B4.B9.E9.A1.B9)

Returns:

Status 索引状态。true：开启状态，false：关闭状态 开启后可对日志进行检索分析，将产生索引流量、索引存储及相应费用。[费用详情](https://cloud.tencent.com/document/product/614/45802#.E8.AE.A1.E8.B4.B9.E9.A1.B9)

setStatus

public void setStatus(Boolean Status)

Set 索引状态。true：开启状态，false：关闭状态 开启后可对日志进行检索分析，将产生索引流量、索引存储及相应费用。[费用详情](https://cloud.tencent.com/document/product/614/45802#.E8.AE.A1.E8.B4.B9.E9.A1.B9)

Parameters:

Status - 索引状态。true：开启状态，false：关闭状态 开启后可对日志进行检索分析，将产生索引流量、索引存储及相应费用。[费用详情](https://cloud.tencent.com/document/product/614/45802#.E8.AE.A1.E8.B4.B9.E9.A1.B9)

getRule

public RuleInfo getRule()

Get 索引配置信息 注意：此字段可能返回 null，表示取不到有效值。

Returns:

Rule 索引配置信息 注意：此字段可能返回 null，表示取不到有效值。

setRule

public void setRule(RuleInfo Rule)

Set 索引配置信息 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

Rule - 索引配置信息 注意：此字段可能返回 null，表示取不到有效值。

getModifyTime

public String getModifyTime()

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

Returns:

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

setModifyTime

public void setModifyTime(String ModifyTime)

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

Parameters:

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

getIncludeInternalFields

public Boolean getIncludeInternalFields()

Get 内置保留字段（`__FILENAME__`，`__HOSTNAME__`及`__SOURCE__`）是否包含至全文索引 false:不包含 true:包含

Returns:

IncludeInternalFields 内置保留字段（`__FILENAME__`，`__HOSTNAME__`及`__SOURCE__`）是否包含至全文索引 false:不包含 true:包含

setIncludeInternalFields

public void setIncludeInternalFields(Boolean IncludeInternalFields)

Set 内置保留字段（`__FILENAME__`，`__HOSTNAME__`及`__SOURCE__`）是否包含至全文索引 false:不包含 true:包含

Parameters:

IncludeInternalFields - 内置保留字段（`__FILENAME__`，`__HOSTNAME__`及`__SOURCE__`）是否包含至全文索引 false:不包含 true:包含

getMetadataFlag

public Long getMetadataFlag()

Get 元数据字段（前缀为`__TAG__`的字段）是否包含至全文索引 0:仅包含开启键值索引的元数据字段 1:包含所有元数据字段 2:不包含任何元数据字段

Returns:

MetadataFlag 元数据字段（前缀为`__TAG__`的字段）是否包含至全文索引 0:仅包含开启键值索引的元数据字段 1:包含所有元数据字段 2:不包含任何元数据字段

setMetadataFlag

public void setMetadataFlag(Long MetadataFlag)

Set 元数据字段（前缀为`__TAG__`的字段）是否包含至全文索引 0:仅包含开启键值索引的元数据字段 1:包含所有元数据字段 2:不包含任何元数据字段

Parameters:

MetadataFlag - 元数据字段（前缀为`__TAG__`的字段）是否包含至全文索引 0:仅包含开启键值索引的元数据字段 1:包含所有元数据字段 2:不包含任何元数据字段

getRequestId

public String getRequestId()

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

Returns:

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

setRequestId

public void setRequestId(String RequestId)

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

Parameters:

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

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.