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

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 Internal field marker of full-text index.
Long	getMetadataFlag() Get Metadata flag.
String	getModifyTime() Get Index modification time.
String	getRequestId() Get The unique request ID, which is returned for each request.
RuleInfo	getRule() Get Index configuration information Note: this field may return `null`, indicating that no valid values can be obtained.
Boolean	getStatus() Get Whether it takes effect
String	getTopicId() Get Log topic ID
void	setIncludeInternalFields(Boolean IncludeInternalFields) Set Internal field marker of full-text index.
void	setMetadataFlag(Long MetadataFlag) Set Metadata flag.
void	setModifyTime(String ModifyTime) Set Index modification time.
void	setRequestId(String RequestId) Set The unique request ID, which is returned for each request.
void	setRule(RuleInfo Rule) Set Index configuration information Note: this field may return `null`, indicating that no valid values can be obtained.
void	setStatus(Boolean Status) Set Whether it takes effect
void	setTopicId(String TopicId) Set Log topic 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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, 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 Log topic ID

Returns:

TopicId Log topic ID

setTopicId

public void setTopicId(String TopicId)

Set Log topic ID

Parameters:

TopicId - Log topic ID

getStatus

public Boolean getStatus()

Get Whether it takes effect

Returns:

Status Whether it takes effect

setStatus

public void setStatus(Boolean Status)

Set Whether it takes effect

Parameters:

Status - Whether it takes effect

getRule

public RuleInfo getRule()

Get Index configuration information Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

Rule Index configuration information Note: this field may return `null`, indicating that no valid values can be obtained.

setRule

public void setRule(RuleInfo Rule)

Set Index configuration information Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

Rule - Index configuration information Note: this field may return `null`, indicating that no valid values can be obtained.

getModifyTime

public String getModifyTime()

Get Index modification time. The default value is the index creation time.

Returns:

ModifyTime Index modification time. The default value is the index creation time.

setModifyTime

public void setModifyTime(String ModifyTime)

Set Index modification time. The default value is the index creation time.

Parameters:

ModifyTime - Index modification time. The default value is the index creation time.

getIncludeInternalFields

public Boolean getIncludeInternalFields()

Get Internal field marker of full-text index. Default value: `false`. Valid value: `false`: excluding internal fields; `true`: including internal fields Note: This field may return `null`, indicating that no valid value was found.

Returns:

IncludeInternalFields Internal field marker of full-text index. Default value: `false`. Valid value: `false`: excluding internal fields; `true`: including internal fields Note: This field may return `null`, indicating that no valid value was found.

setIncludeInternalFields

public void setIncludeInternalFields(Boolean IncludeInternalFields)

Set Internal field marker of full-text index. Default value: `false`. Valid value: `false`: excluding internal fields; `true`: including internal fields Note: This field may return `null`, indicating that no valid value was found.

Parameters:

IncludeInternalFields - Internal field marker of full-text index. Default value: `false`. Valid value: `false`: excluding internal fields; `true`: including internal fields Note: This field may return `null`, indicating that no valid value was found.

getMetadataFlag

public Long getMetadataFlag()

Get Metadata flag. Default value: `0`. Valid value: `0`: full-text index (including the metadata field with key-value index enabled); `1`: full-text index (including all metadata fields); `2`: full-text index (excluding metadata fields). Note: This field may return `null`, indicating that no valid value was found.

Returns:

MetadataFlag Metadata flag. Default value: `0`. Valid value: `0`: full-text index (including the metadata field with key-value index enabled); `1`: full-text index (including all metadata fields); `2`: full-text index (excluding metadata fields). Note: This field may return `null`, indicating that no valid value was found.

setMetadataFlag

public void setMetadataFlag(Long MetadataFlag)

Set Metadata flag. Default value: `0`. Valid value: `0`: full-text index (including the metadata field with key-value index enabled); `1`: full-text index (including all metadata fields); `2`: full-text index (excluding metadata fields). Note: This field may return `null`, indicating that no valid value was found.

Parameters:

MetadataFlag - Metadata flag. Default value: `0`. Valid value: `0`: full-text index (including the metadata field with key-value index enabled); `1`: full-text index (including all metadata fields); `2`: full-text index (excluding metadata fields). Note: This field may return `null`, indicating that no valid value was found.

getRequestId

public String getRequestId()

Get The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Returns:

RequestId The unique request ID, which is returned for each request. RequestId is required for locating a problem.

setRequestId

public void setRequestId(String RequestId)

Set The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Parameters:

RequestId - The unique request ID, which is returned for each request. RequestId is required for locating a problem.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel