com.tencentcloudapi.cls.v20201016.models

Class SearchLogRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cls.v20201016.models.SearchLogRequest

public class SearchLogRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
SearchLogRequest()
SearchLogRequest(SearchLogRequest 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
String	getContext() Get 透传上次接口返回的Context值，可获取后续更多日志，总计最多可获取1万条原始日志，过期时间1小时。 注意： 透传该参数时，请勿修改除该参数外的其它参数 仅适用于单日志主题检索，检索多个日志主题时，请使用Topics中的Context 仅当检索分析语句(Query)不包含SQL时有效，SQL获取后续结果参考SQL LIMIT语法
Long	getFrom() Get 要检索分析的日志的起始时间，**Unix时间戳（毫秒）**
Boolean	getHighLight() Get 是否高亮符合检索条件的关键词，一般用于高亮显示。仅支持键值检索，不支持全文检索
Long	getLimit() Get 表示单次查询返回的原始日志条数，默认为100，最大值为1000。 注意： 仅当检索分析语句(Query)不包含SQL时有效 SQL结果条数指定方式参考SQL LIMIT语法 可通过两种方式获取后续更多日志： Context:透传上次接口返回的Context值，获取后续更多日志，总计最多可获取1万条原始日志 Offset:偏移量，表示从第几行开始返回原始日志，无日志条数限制
Long	getOffset() Get 查询原始日志的偏移量，表示从第几行开始返回原始日志，默认为0。 注意： 仅当检索分析语句(Query)不包含SQL时有效 不能与Context参数同时使用 仅适用于单日志主题检索
String	getQuery() Get 检索分析语句，最大长度为12KB 语句由 [检索条件] | [SQL语句]构成，无需对日志进行统计分析时，可省略其中的管道符 | 及SQL语句 使用*或空字符串可查询所有日志
Float	getSamplingRate() Get 执行统计分析（Query中包含SQL）时，是否对原始日志先进行采样，再进行统计分析。 0：自动采样; 0～1：按指定采样率采样，例如0.02; 1：不采样，即精确分析 默认值为1
String	getSort() Get 原始日志是否按时间排序返回；可选值：asc(升序)、desc(降序)，默认为 desc 注意： 仅当检索分析语句(Query)不包含SQL时有效 SQL结果排序方式参考SQL ORDER BY语法
Long	getSyntaxRule() Get 检索语法规则，默认值为0，推荐使用1 。 - 0：Lucene语法 - 1：CQL语法（CLS Query Language，日志服务专用检索语法） ⚠️⚠️ **注意** 该参数值建议设置为 1，使用 CQL 语法规则，控制台日志检索及仪表盘默认均使用该语法规则。** 该参数值未指定或者为 0 时，将使用 Lucene 语法，语法容易报错且查询结果与控制台默认语法规则不一致。详细说明参见检索条件语法规则。
Long	getTo() Get 要检索分析的日志的结束时间，**Unix时间戳（毫秒）**
String	getTopicId() Get - 要检索分析的日志主题ID，仅能指定一个日志主题。 - 如需同时检索多个日志主题，请使用Topics参数。 - TopicId 和 Topics 不能同时使用，在一次请求中有且只能选择一个。
MultiTopicSearchInformation[]	getTopics() Get - 要检索分析的日志主题列表，最大支持50个日志主题。 - 检索单个日志主题时请使用TopicId。 - TopicId 和 Topics 不能同时使用，在一次请求中有且只能选择一个。
Boolean	getUseNewAnalysis() Get 为true代表使用新的检索结果返回方式，输出参数AnalysisRecords和Columns有效 为false时代表使用老的检索结果返回方式, 输出AnalysisResults和ColNames有效 两种返回方式在编码格式上有少量区别，建议使用true
void	setContext(String Context) Set 透传上次接口返回的Context值，可获取后续更多日志，总计最多可获取1万条原始日志，过期时间1小时。 注意： 透传该参数时，请勿修改除该参数外的其它参数 仅适用于单日志主题检索，检索多个日志主题时，请使用Topics中的Context 仅当检索分析语句(Query)不包含SQL时有效，SQL获取后续结果参考SQL LIMIT语法
void	setFrom(Long From) Set 要检索分析的日志的起始时间，**Unix时间戳（毫秒）**
void	setHighLight(Boolean HighLight) Set 是否高亮符合检索条件的关键词，一般用于高亮显示。仅支持键值检索，不支持全文检索
void	setLimit(Long Limit) Set 表示单次查询返回的原始日志条数，默认为100，最大值为1000。 注意： 仅当检索分析语句(Query)不包含SQL时有效 SQL结果条数指定方式参考SQL LIMIT语法 可通过两种方式获取后续更多日志： Context:透传上次接口返回的Context值，获取后续更多日志，总计最多可获取1万条原始日志 Offset:偏移量，表示从第几行开始返回原始日志，无日志条数限制
void	setOffset(Long Offset) Set 查询原始日志的偏移量，表示从第几行开始返回原始日志，默认为0。 注意： 仅当检索分析语句(Query)不包含SQL时有效 不能与Context参数同时使用 仅适用于单日志主题检索
void	setQuery(String Query) Set 检索分析语句，最大长度为12KB 语句由 [检索条件] | [SQL语句]构成，无需对日志进行统计分析时，可省略其中的管道符 | 及SQL语句 使用*或空字符串可查询所有日志
void	setSamplingRate(Float SamplingRate) Set 执行统计分析（Query中包含SQL）时，是否对原始日志先进行采样，再进行统计分析。 0：自动采样; 0～1：按指定采样率采样，例如0.02; 1：不采样，即精确分析 默认值为1
void	setSort(String Sort) Set 原始日志是否按时间排序返回；可选值：asc(升序)、desc(降序)，默认为 desc 注意： 仅当检索分析语句(Query)不包含SQL时有效 SQL结果排序方式参考SQL ORDER BY语法
void	setSyntaxRule(Long SyntaxRule) Set 检索语法规则，默认值为0，推荐使用1 。 - 0：Lucene语法 - 1：CQL语法（CLS Query Language，日志服务专用检索语法） ⚠️⚠️ **注意** 该参数值建议设置为 1，使用 CQL 语法规则，控制台日志检索及仪表盘默认均使用该语法规则。** 该参数值未指定或者为 0 时，将使用 Lucene 语法，语法容易报错且查询结果与控制台默认语法规则不一致。详细说明参见检索条件语法规则。
void	setTo(Long To) Set 要检索分析的日志的结束时间，**Unix时间戳（毫秒）**
void	setTopicId(String TopicId) Set - 要检索分析的日志主题ID，仅能指定一个日志主题。 - 如需同时检索多个日志主题，请使用Topics参数。 - TopicId 和 Topics 不能同时使用，在一次请求中有且只能选择一个。
void	setTopics(MultiTopicSearchInformation[] Topics) Set - 要检索分析的日志主题列表，最大支持50个日志主题。 - 检索单个日志主题时请使用TopicId。 - TopicId 和 Topics 不能同时使用，在一次请求中有且只能选择一个。
void	setUseNewAnalysis(Boolean UseNewAnalysis) Set 为true代表使用新的检索结果返回方式，输出参数AnalysisRecords和Columns有效 为false时代表使用老的检索结果返回方式, 输出AnalysisResults和ColNames有效 两种返回方式在编码格式上有少量区别，建议使用true
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

SearchLogRequest

public SearchLogRequest()

SearchLogRequest

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

getFrom

public Long getFrom()

Get 要检索分析的日志的起始时间，**Unix时间戳（毫秒）**

Returns:

From 要检索分析的日志的起始时间，**Unix时间戳（毫秒）**

setFrom

public void setFrom(Long From)

Set 要检索分析的日志的起始时间，**Unix时间戳（毫秒）**

Parameters:

From - 要检索分析的日志的起始时间，**Unix时间戳（毫秒）**

getTo

public Long getTo()

Get 要检索分析的日志的结束时间，**Unix时间戳（毫秒）**

Returns:

To 要检索分析的日志的结束时间，**Unix时间戳（毫秒）**

setTo

public void setTo(Long To)

Set 要检索分析的日志的结束时间，**Unix时间戳（毫秒）**

Parameters:

To - 要检索分析的日志的结束时间，**Unix时间戳（毫秒）**

getQuery

public String getQuery()

Get 检索分析语句，最大长度为12KB 语句由 [检索条件] | [SQL语句]构成，无需对日志进行统计分析时，可省略其中的管道符 | 及SQL语句 使用*或空字符串可查询所有日志

Returns:

Query 检索分析语句，最大长度为12KB 语句由 [检索条件] | [SQL语句]构成，无需对日志进行统计分析时，可省略其中的管道符 | 及SQL语句 使用*或空字符串可查询所有日志

setQuery

public void setQuery(String Query)

Set 检索分析语句，最大长度为12KB 语句由 [检索条件] | [SQL语句]构成，无需对日志进行统计分析时，可省略其中的管道符 | 及SQL语句 使用*或空字符串可查询所有日志

Parameters:

Query - 检索分析语句，最大长度为12KB 语句由 [检索条件] | [SQL语句]构成，无需对日志进行统计分析时，可省略其中的管道符 | 及SQL语句 使用*或空字符串可查询所有日志

getSyntaxRule

public Long getSyntaxRule()

Get 检索语法规则，默认值为0，推荐使用1 。 - 0：Lucene语法 - 1：CQL语法（CLS Query Language，日志服务专用检索语法） ⚠️⚠️ **注意** 该参数值建议设置为 1，使用 CQL 语法规则，控制台日志检索及仪表盘默认均使用该语法规则。** 该参数值未指定或者为 0 时，将使用 Lucene 语法，语法容易报错且查询结果与控制台默认语法规则不一致。详细说明参见检索条件语法规则。

Returns:

SyntaxRule 检索语法规则，默认值为0，推荐使用1 。 - 0：Lucene语法 - 1：CQL语法（CLS Query Language，日志服务专用检索语法） ⚠️⚠️ **注意** 该参数值建议设置为 1，使用 CQL 语法规则，控制台日志检索及仪表盘默认均使用该语法规则。** 该参数值未指定或者为 0 时，将使用 Lucene 语法，语法容易报错且查询结果与控制台默认语法规则不一致。详细说明参见检索条件语法规则。

setSyntaxRule

public void setSyntaxRule(Long SyntaxRule)

Set 检索语法规则，默认值为0，推荐使用1 。 - 0：Lucene语法 - 1：CQL语法（CLS Query Language，日志服务专用检索语法） ⚠️⚠️ **注意** 该参数值建议设置为 1，使用 CQL 语法规则，控制台日志检索及仪表盘默认均使用该语法规则。** 该参数值未指定或者为 0 时，将使用 Lucene 语法，语法容易报错且查询结果与控制台默认语法规则不一致。详细说明参见检索条件语法规则。

Parameters:

SyntaxRule - 检索语法规则，默认值为0，推荐使用1 。 - 0：Lucene语法 - 1：CQL语法（CLS Query Language，日志服务专用检索语法） ⚠️⚠️ **注意** 该参数值建议设置为 1，使用 CQL 语法规则，控制台日志检索及仪表盘默认均使用该语法规则。** 该参数值未指定或者为 0 时，将使用 Lucene 语法，语法容易报错且查询结果与控制台默认语法规则不一致。详细说明参见检索条件语法规则。

getTopicId

public String getTopicId()

Get - 要检索分析的日志主题ID，仅能指定一个日志主题。 - 如需同时检索多个日志主题，请使用Topics参数。 - TopicId 和 Topics 不能同时使用，在一次请求中有且只能选择一个。

Returns:

TopicId - 要检索分析的日志主题ID，仅能指定一个日志主题。 - 如需同时检索多个日志主题，请使用Topics参数。 - TopicId 和 Topics 不能同时使用，在一次请求中有且只能选择一个。

setTopicId

public void setTopicId(String TopicId)

Set - 要检索分析的日志主题ID，仅能指定一个日志主题。 - 如需同时检索多个日志主题，请使用Topics参数。 - TopicId 和 Topics 不能同时使用，在一次请求中有且只能选择一个。

Parameters:

TopicId - - 要检索分析的日志主题ID，仅能指定一个日志主题。 - 如需同时检索多个日志主题，请使用Topics参数。 - TopicId 和 Topics 不能同时使用，在一次请求中有且只能选择一个。

getTopics

public MultiTopicSearchInformation[] getTopics()

Get - 要检索分析的日志主题列表，最大支持50个日志主题。 - 检索单个日志主题时请使用TopicId。 - TopicId 和 Topics 不能同时使用，在一次请求中有且只能选择一个。

Returns:

Topics - 要检索分析的日志主题列表，最大支持50个日志主题。 - 检索单个日志主题时请使用TopicId。 - TopicId 和 Topics 不能同时使用，在一次请求中有且只能选择一个。

setTopics

public void setTopics(MultiTopicSearchInformation[] Topics)

Set - 要检索分析的日志主题列表，最大支持50个日志主题。 - 检索单个日志主题时请使用TopicId。 - TopicId 和 Topics 不能同时使用，在一次请求中有且只能选择一个。

Parameters:

Topics - - 要检索分析的日志主题列表，最大支持50个日志主题。 - 检索单个日志主题时请使用TopicId。 - TopicId 和 Topics 不能同时使用，在一次请求中有且只能选择一个。

getSort

public String getSort()

Get 原始日志是否按时间排序返回；可选值：asc(升序)、desc(降序)，默认为 desc 注意： 仅当检索分析语句(Query)不包含SQL时有效 SQL结果排序方式参考SQL ORDER BY语法

Returns:

Sort 原始日志是否按时间排序返回；可选值：asc(升序)、desc(降序)，默认为 desc 注意： 仅当检索分析语句(Query)不包含SQL时有效 SQL结果排序方式参考SQL ORDER BY语法

setSort

public void setSort(String Sort)

Set 原始日志是否按时间排序返回；可选值：asc(升序)、desc(降序)，默认为 desc 注意： 仅当检索分析语句(Query)不包含SQL时有效 SQL结果排序方式参考SQL ORDER BY语法

Parameters:

Sort - 原始日志是否按时间排序返回；可选值：asc(升序)、desc(降序)，默认为 desc 注意： 仅当检索分析语句(Query)不包含SQL时有效 SQL结果排序方式参考SQL ORDER BY语法

getLimit

public Long getLimit()

Get 表示单次查询返回的原始日志条数，默认为100，最大值为1000。 注意： 仅当检索分析语句(Query)不包含SQL时有效 SQL结果条数指定方式参考SQL LIMIT语法 可通过两种方式获取后续更多日志： Context:透传上次接口返回的Context值，获取后续更多日志，总计最多可获取1万条原始日志 Offset:偏移量，表示从第几行开始返回原始日志，无日志条数限制

Returns:

Limit 表示单次查询返回的原始日志条数，默认为100，最大值为1000。 注意： 仅当检索分析语句(Query)不包含SQL时有效 SQL结果条数指定方式参考SQL LIMIT语法 可通过两种方式获取后续更多日志： Context:透传上次接口返回的Context值，获取后续更多日志，总计最多可获取1万条原始日志 Offset:偏移量，表示从第几行开始返回原始日志，无日志条数限制

setLimit

public void setLimit(Long Limit)

Set 表示单次查询返回的原始日志条数，默认为100，最大值为1000。 注意： 仅当检索分析语句(Query)不包含SQL时有效 SQL结果条数指定方式参考SQL LIMIT语法 可通过两种方式获取后续更多日志： Context:透传上次接口返回的Context值，获取后续更多日志，总计最多可获取1万条原始日志 Offset:偏移量，表示从第几行开始返回原始日志，无日志条数限制

Parameters:

Limit - 表示单次查询返回的原始日志条数，默认为100，最大值为1000。 注意： 仅当检索分析语句(Query)不包含SQL时有效 SQL结果条数指定方式参考SQL LIMIT语法 可通过两种方式获取后续更多日志： Context:透传上次接口返回的Context值，获取后续更多日志，总计最多可获取1万条原始日志 Offset:偏移量，表示从第几行开始返回原始日志，无日志条数限制

getOffset

public Long getOffset()

Get 查询原始日志的偏移量，表示从第几行开始返回原始日志，默认为0。 注意： 仅当检索分析语句(Query)不包含SQL时有效 不能与Context参数同时使用 仅适用于单日志主题检索

Returns:

Offset 查询原始日志的偏移量，表示从第几行开始返回原始日志，默认为0。 注意： 仅当检索分析语句(Query)不包含SQL时有效 不能与Context参数同时使用 仅适用于单日志主题检索

setOffset

public void setOffset(Long Offset)

Set 查询原始日志的偏移量，表示从第几行开始返回原始日志，默认为0。 注意： 仅当检索分析语句(Query)不包含SQL时有效 不能与Context参数同时使用 仅适用于单日志主题检索

Parameters:

Offset - 查询原始日志的偏移量，表示从第几行开始返回原始日志，默认为0。 注意： 仅当检索分析语句(Query)不包含SQL时有效 不能与Context参数同时使用 仅适用于单日志主题检索

getContext

public String getContext()

Get 透传上次接口返回的Context值，可获取后续更多日志，总计最多可获取1万条原始日志，过期时间1小时。 注意： 透传该参数时，请勿修改除该参数外的其它参数 仅适用于单日志主题检索，检索多个日志主题时，请使用Topics中的Context 仅当检索分析语句(Query)不包含SQL时有效，SQL获取后续结果参考SQL LIMIT语法

Returns:

Context 透传上次接口返回的Context值，可获取后续更多日志，总计最多可获取1万条原始日志，过期时间1小时。 注意： 透传该参数时，请勿修改除该参数外的其它参数 仅适用于单日志主题检索，检索多个日志主题时，请使用Topics中的Context 仅当检索分析语句(Query)不包含SQL时有效，SQL获取后续结果参考SQL LIMIT语法

setContext

public void setContext(String Context)

Set 透传上次接口返回的Context值，可获取后续更多日志，总计最多可获取1万条原始日志，过期时间1小时。 注意： 透传该参数时，请勿修改除该参数外的其它参数 仅适用于单日志主题检索，检索多个日志主题时，请使用Topics中的Context 仅当检索分析语句(Query)不包含SQL时有效，SQL获取后续结果参考SQL LIMIT语法

Parameters:

Context - 透传上次接口返回的Context值，可获取后续更多日志，总计最多可获取1万条原始日志，过期时间1小时。 注意： 透传该参数时，请勿修改除该参数外的其它参数 仅适用于单日志主题检索，检索多个日志主题时，请使用Topics中的Context 仅当检索分析语句(Query)不包含SQL时有效，SQL获取后续结果参考SQL LIMIT语法

getSamplingRate

public Float getSamplingRate()

Get 执行统计分析（Query中包含SQL）时，是否对原始日志先进行采样，再进行统计分析。 0：自动采样; 0～1：按指定采样率采样，例如0.02; 1：不采样，即精确分析 默认值为1

Returns:

SamplingRate 执行统计分析（Query中包含SQL）时，是否对原始日志先进行采样，再进行统计分析。 0：自动采样; 0～1：按指定采样率采样，例如0.02; 1：不采样，即精确分析 默认值为1

setSamplingRate

public void setSamplingRate(Float SamplingRate)

Set 执行统计分析（Query中包含SQL）时，是否对原始日志先进行采样，再进行统计分析。 0：自动采样; 0～1：按指定采样率采样，例如0.02; 1：不采样，即精确分析 默认值为1

Parameters:

SamplingRate - 执行统计分析（Query中包含SQL）时，是否对原始日志先进行采样，再进行统计分析。 0：自动采样; 0～1：按指定采样率采样，例如0.02; 1：不采样，即精确分析 默认值为1

getUseNewAnalysis

public Boolean getUseNewAnalysis()

Get 为true代表使用新的检索结果返回方式，输出参数AnalysisRecords和Columns有效 为false时代表使用老的检索结果返回方式, 输出AnalysisResults和ColNames有效 两种返回方式在编码格式上有少量区别，建议使用true

Returns:

UseNewAnalysis 为true代表使用新的检索结果返回方式，输出参数AnalysisRecords和Columns有效 为false时代表使用老的检索结果返回方式, 输出AnalysisResults和ColNames有效 两种返回方式在编码格式上有少量区别，建议使用true

setUseNewAnalysis

public void setUseNewAnalysis(Boolean UseNewAnalysis)

Set 为true代表使用新的检索结果返回方式，输出参数AnalysisRecords和Columns有效 为false时代表使用老的检索结果返回方式, 输出AnalysisResults和ColNames有效 两种返回方式在编码格式上有少量区别，建议使用true

Parameters:

UseNewAnalysis - 为true代表使用新的检索结果返回方式，输出参数AnalysisRecords和Columns有效 为false时代表使用老的检索结果返回方式, 输出AnalysisResults和ColNames有效 两种返回方式在编码格式上有少量区别，建议使用true

getHighLight

public Boolean getHighLight()

Get 是否高亮符合检索条件的关键词，一般用于高亮显示。仅支持键值检索，不支持全文检索

Returns:

HighLight 是否高亮符合检索条件的关键词，一般用于高亮显示。仅支持键值检索，不支持全文检索

setHighLight

public void setHighLight(Boolean HighLight)

Set 是否高亮符合检索条件的关键词，一般用于高亮显示。仅支持键值检索，不支持全文检索

Parameters:

HighLight - 是否高亮符合检索条件的关键词，一般用于高亮显示。仅支持键值检索，不支持全文检索

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.