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 Whether full-text indexing includes internal fields (`__FILENAME__`, `__HOSTNAME__`, and `__SOURCE__`) `false`: Full-text indexing does not include internal fields.
Long	getMetadataFlag() Get Whether full-text indexing includes metadata fields (which are prefixed with `__TAG__`) `0`: Full-text indexing includes only the metadata fields with key-value indexing enabled.
String	getModifyTime() Get Index modification time.
String	getRequestId() Get The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId).
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 Whether full-text indexing includes internal fields (`__FILENAME__`, `__HOSTNAME__`, and `__SOURCE__`) `false`: Full-text indexing does not include internal fields.
void	setMetadataFlag(Long MetadataFlag) Set Whether full-text indexing includes metadata fields (which are prefixed with `__TAG__`) `0`: Full-text indexing includes only the metadata fields with key-value indexing enabled.
void	setModifyTime(String ModifyTime) Set Index modification time.
void	setRequestId(String RequestId) Set The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId).
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, GetHeader, getMultipartRequestParams, getSkipSign, 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 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 Whether full-text indexing includes internal fields (`__FILENAME__`, `__HOSTNAME__`, and `__SOURCE__`) `false`: Full-text indexing does not include internal fields. `true`: Full-text indexing includes internal fields. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

IncludeInternalFields Whether full-text indexing includes internal fields (`__FILENAME__`, `__HOSTNAME__`, and `__SOURCE__`) `false`: Full-text indexing does not include internal fields. `true`: Full-text indexing includes internal fields. Note: This field may return null, indicating that no valid values can be obtained.

setIncludeInternalFields

public void setIncludeInternalFields(Boolean IncludeInternalFields)

Set Whether full-text indexing includes internal fields (`__FILENAME__`, `__HOSTNAME__`, and `__SOURCE__`) `false`: Full-text indexing does not include internal fields. `true`: Full-text indexing includes internal fields. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

IncludeInternalFields - Whether full-text indexing includes internal fields (`__FILENAME__`, `__HOSTNAME__`, and `__SOURCE__`) `false`: Full-text indexing does not include internal fields. `true`: Full-text indexing includes internal fields. Note: This field may return null, indicating that no valid values can be obtained.

getMetadataFlag

public Long getMetadataFlag()

Get Whether full-text indexing includes metadata fields (which are prefixed with `__TAG__`) `0`: Full-text indexing includes only the metadata fields with key-value indexing enabled. `1`: Full-text indexing includes all metadata fields. `2`: Full-text indexing does not include metadata fields. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

MetadataFlag Whether full-text indexing includes metadata fields (which are prefixed with `__TAG__`) `0`: Full-text indexing includes only the metadata fields with key-value indexing enabled. `1`: Full-text indexing includes all metadata fields. `2`: Full-text indexing does not include metadata fields. Note: This field may return null, indicating that no valid values can be obtained.

setMetadataFlag

public void setMetadataFlag(Long MetadataFlag)

Set Whether full-text indexing includes metadata fields (which are prefixed with `__TAG__`) `0`: Full-text indexing includes only the metadata fields with key-value indexing enabled. `1`: Full-text indexing includes all metadata fields. `2`: Full-text indexing does not include metadata fields. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

MetadataFlag - Whether full-text indexing includes metadata fields (which are prefixed with `__TAG__`) `0`: Full-text indexing includes only the metadata fields with key-value indexing enabled. `1`: Full-text indexing includes all metadata fields. `2`: Full-text indexing does not include metadata fields. Note: This field may return null, indicating that no valid values can be obtained.

getRequestId

public String getRequestId()

Get The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Returns:

RequestId The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

setRequestId

public void setRequestId(String RequestId)

Set The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Parameters:

RequestId - The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). 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