com.tencentcloudapi.cls.v20201016.models

Class ExtractRuleInfo

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cls.v20201016.models.ExtractRuleInfo

public class ExtractRuleInfo
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
ExtractRuleInfo()
ExtractRuleInfo(ExtractRuleInfo 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	getAddress() Get Listening address and port specified by the syslog collection.
Long	getBacktracking() Get Size of the data to be rewound in incremental collection mode.
String	getBeginRegex() Get First-Line matching rule, which is valid only if `log_type` is `multiline_log` or `fullregex_log` Note: this field may return `null`, indicating that no valid values can be obtained.
String	getDelimiter() Get Delimiter for delimited log, which is valid only if `log_type` is `delimiter_log` Note: this field may return `null`, indicating that no valid values can be obtained.
KeyRegexInfo[]	getFilterKeyRegex() Get Log keys to be filtered and the corresponding regex Note: this field may return `null`, indicating that no valid values can be obtained.
Long	getIsGBK() Get Whether to be encoded in GBK format.
Long	getJsonStandard() Get Whether to be formatted as JSON (standard).
String[]	getKeys() Get Key name of each extracted field.
String	getLogRegex() Get Full log matching rule, which is valid only if `log_type` is `fullregex_log` Note: this field may return `null`, indicating that no valid values can be obtained.
String	getParseProtocol() Get `rfc3164`: Resolve logs by using the RFC 3164 protocol during the syslog collection.
String	getProtocol() Get Syslog protocol.
String	getTimeFormat() Get Time field format.
String	getTimeKey() Get Time field key name.
String	getUnMatchLogKey() Get Unmatched log key Note: this field may return `null`, indicating that no valid values can be obtained.
Boolean	getUnMatchUpLoadSwitch() Get Whether to upload the logs that failed to be parsed.
void	setAddress(String Address) Set Listening address and port specified by the syslog collection.
void	setBacktracking(Long Backtracking) Set Size of the data to be rewound in incremental collection mode.
void	setBeginRegex(String BeginRegex) Set First-Line matching rule, which is valid only if `log_type` is `multiline_log` or `fullregex_log` Note: this field may return `null`, indicating that no valid values can be obtained.
void	setDelimiter(String Delimiter) Set Delimiter for delimited log, which is valid only if `log_type` is `delimiter_log` Note: this field may return `null`, indicating that no valid values can be obtained.
void	setFilterKeyRegex(KeyRegexInfo[] FilterKeyRegex) Set Log keys to be filtered and the corresponding regex Note: this field may return `null`, indicating that no valid values can be obtained.
void	setIsGBK(Long IsGBK) Set Whether to be encoded in GBK format.
void	setJsonStandard(Long JsonStandard) Set Whether to be formatted as JSON (standard).
void	setKeys(String[] Keys) Set Key name of each extracted field.
void	setLogRegex(String LogRegex) Set Full log matching rule, which is valid only if `log_type` is `fullregex_log` Note: this field may return `null`, indicating that no valid values can be obtained.
void	setParseProtocol(String ParseProtocol) Set `rfc3164`: Resolve logs by using the RFC 3164 protocol during the syslog collection.
void	setProtocol(String Protocol) Set Syslog protocol.
void	setTimeFormat(String TimeFormat) Set Time field format.
void	setTimeKey(String TimeKey) Set Time field key name.
void	setUnMatchLogKey(String UnMatchLogKey) Set Unmatched log key Note: this field may return `null`, indicating that no valid values can be obtained.
void	setUnMatchUpLoadSwitch(Boolean UnMatchUpLoadSwitch) Set Whether to upload the logs that failed to be parsed.
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

ExtractRuleInfo

public ExtractRuleInfo()

ExtractRuleInfo

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

getTimeKey

public String getTimeKey()

Get Time field key name. `time_key` and `time_format` must appear in pairs Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

TimeKey Time field key name. `time_key` and `time_format` must appear in pairs Note: this field may return `null`, indicating that no valid values can be obtained.

setTimeKey

public void setTimeKey(String TimeKey)

Set Time field key name. `time_key` and `time_format` must appear in pairs Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

TimeKey - Time field key name. `time_key` and `time_format` must appear in pairs Note: this field may return `null`, indicating that no valid values can be obtained.

getTimeFormat

public String getTimeFormat()

Get Time field format. For more information, please see the output parameters of the time format description of the `strftime` function in C language Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

TimeFormat Time field format. For more information, please see the output parameters of the time format description of the `strftime` function in C language Note: this field may return `null`, indicating that no valid values can be obtained.

setTimeFormat

public void setTimeFormat(String TimeFormat)

Set Time field format. For more information, please see the output parameters of the time format description of the `strftime` function in C language Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

TimeFormat - Time field format. For more information, please see the output parameters of the time format description of the `strftime` function in C language Note: this field may return `null`, indicating that no valid values can be obtained.

getDelimiter

public String getDelimiter()

Get Delimiter for delimited log, which is valid only if `log_type` is `delimiter_log` Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

Delimiter Delimiter for delimited log, which is valid only if `log_type` is `delimiter_log` Note: this field may return `null`, indicating that no valid values can be obtained.

setDelimiter

public void setDelimiter(String Delimiter)

Set Delimiter for delimited log, which is valid only if `log_type` is `delimiter_log` Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

Delimiter - Delimiter for delimited log, which is valid only if `log_type` is `delimiter_log` Note: this field may return `null`, indicating that no valid values can be obtained.

getLogRegex

public String getLogRegex()

Get Full log matching rule, which is valid only if `log_type` is `fullregex_log` Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

LogRegex Full log matching rule, which is valid only if `log_type` is `fullregex_log` Note: this field may return `null`, indicating that no valid values can be obtained.

setLogRegex

public void setLogRegex(String LogRegex)

Set Full log matching rule, which is valid only if `log_type` is `fullregex_log` Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

LogRegex - Full log matching rule, which is valid only if `log_type` is `fullregex_log` Note: this field may return `null`, indicating that no valid values can be obtained.

getBeginRegex

public String getBeginRegex()

Get First-Line matching rule, which is valid only if `log_type` is `multiline_log` or `fullregex_log` Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

BeginRegex First-Line matching rule, which is valid only if `log_type` is `multiline_log` or `fullregex_log` Note: this field may return `null`, indicating that no valid values can be obtained.

setBeginRegex

public void setBeginRegex(String BeginRegex)

Set First-Line matching rule, which is valid only if `log_type` is `multiline_log` or `fullregex_log` Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

BeginRegex - First-Line matching rule, which is valid only if `log_type` is `multiline_log` or `fullregex_log` Note: this field may return `null`, indicating that no valid values can be obtained.

getKeys

public String[] getKeys()

Get Key name of each extracted field. An empty key indicates to discard the field. This parameter is valid only if `log_type` is `delimiter_log`. `json_log` logs use the key of JSON itself Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

Keys Key name of each extracted field. An empty key indicates to discard the field. This parameter is valid only if `log_type` is `delimiter_log`. `json_log` logs use the key of JSON itself Note: this field may return `null`, indicating that no valid values can be obtained.

setKeys

public void setKeys(String[] Keys)

Set Key name of each extracted field. An empty key indicates to discard the field. This parameter is valid only if `log_type` is `delimiter_log`. `json_log` logs use the key of JSON itself Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

Keys - Key name of each extracted field. An empty key indicates to discard the field. This parameter is valid only if `log_type` is `delimiter_log`. `json_log` logs use the key of JSON itself Note: this field may return `null`, indicating that no valid values can be obtained.

getFilterKeyRegex

public KeyRegexInfo[] getFilterKeyRegex()

Get Log keys to be filtered and the corresponding regex Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

FilterKeyRegex Log keys to be filtered and the corresponding regex Note: this field may return `null`, indicating that no valid values can be obtained.

setFilterKeyRegex

public void setFilterKeyRegex(KeyRegexInfo[] FilterKeyRegex)

Set Log keys to be filtered and the corresponding regex Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

FilterKeyRegex - Log keys to be filtered and the corresponding regex Note: this field may return `null`, indicating that no valid values can be obtained.

getUnMatchUpLoadSwitch

public Boolean getUnMatchUpLoadSwitch()

Get Whether to upload the logs that failed to be parsed. Valid values: `true`: yes; `false`: no Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

UnMatchUpLoadSwitch Whether to upload the logs that failed to be parsed. Valid values: `true`: yes; `false`: no Note: this field may return `null`, indicating that no valid values can be obtained.

setUnMatchUpLoadSwitch

public void setUnMatchUpLoadSwitch(Boolean UnMatchUpLoadSwitch)

Set Whether to upload the logs that failed to be parsed. Valid values: `true`: yes; `false`: no Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

UnMatchUpLoadSwitch - Whether to upload the logs that failed to be parsed. Valid values: `true`: yes; `false`: no Note: this field may return `null`, indicating that no valid values can be obtained.

getUnMatchLogKey

public String getUnMatchLogKey()

Get Unmatched log key Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

UnMatchLogKey Unmatched log key Note: this field may return `null`, indicating that no valid values can be obtained.

setUnMatchLogKey

public void setUnMatchLogKey(String UnMatchLogKey)

Set Unmatched log key Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

UnMatchLogKey - Unmatched log key Note: this field may return `null`, indicating that no valid values can be obtained.

getBacktracking

public Long getBacktracking()

Get Size of the data to be rewound in incremental collection mode. Default value: -1 (full collection) Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

Backtracking Size of the data to be rewound in incremental collection mode. Default value: -1 (full collection) Note: this field may return `null`, indicating that no valid values can be obtained.

setBacktracking

public void setBacktracking(Long Backtracking)

Set Size of the data to be rewound in incremental collection mode. Default value: -1 (full collection) Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

Backtracking - Size of the data to be rewound in incremental collection mode. Default value: -1 (full collection) Note: this field may return `null`, indicating that no valid values can be obtained.

getIsGBK

public Long getIsGBK()

Get Whether to be encoded in GBK format. Valid values: `0` (No) and `1` (Yes). Note: This field may return null, indicating that no valid values can be obtained.

Returns:

IsGBK Whether to be encoded in GBK format. Valid values: `0` (No) and `1` (Yes). Note: This field may return null, indicating that no valid values can be obtained.

setIsGBK

public void setIsGBK(Long IsGBK)

Set Whether to be encoded in GBK format. Valid values: `0` (No) and `1` (Yes). Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

IsGBK - Whether to be encoded in GBK format. Valid values: `0` (No) and `1` (Yes). Note: This field may return null, indicating that no valid values can be obtained.

getJsonStandard

public Long getJsonStandard()

Get Whether to be formatted as JSON (standard). Valid values: `0` (No) and `1` (Yes). Note: This field may return null, indicating that no valid values can be obtained.

Returns:

JsonStandard Whether to be formatted as JSON (standard). Valid values: `0` (No) and `1` (Yes). Note: This field may return null, indicating that no valid values can be obtained.

setJsonStandard

public void setJsonStandard(Long JsonStandard)

Set Whether to be formatted as JSON (standard). Valid values: `0` (No) and `1` (Yes). Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

JsonStandard - Whether to be formatted as JSON (standard). Valid values: `0` (No) and `1` (Yes). Note: This field may return null, indicating that no valid values can be obtained.

getProtocol

public String getProtocol()

Get Syslog protocol. Valid values: `tcp`, `udp`. This field can be used when you create or modify collection rule configurations. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Protocol Syslog protocol. Valid values: `tcp`, `udp`. This field can be used when you create or modify collection rule configurations. Note: This field may return null, indicating that no valid values can be obtained.

setProtocol

public void setProtocol(String Protocol)

Set Syslog protocol. Valid values: `tcp`, `udp`. This field can be used when you create or modify collection rule configurations. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Protocol - Syslog protocol. Valid values: `tcp`, `udp`. This field can be used when you create or modify collection rule configurations. Note: This field may return null, indicating that no valid values can be obtained.

getAddress

public String getAddress()

Get Listening address and port specified by the syslog collection. Format: [ip]:[port]. Example: 127.0.0.1:9000. This field can be used when you create or modify collection rule configurations. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Address Listening address and port specified by the syslog collection. Format: [ip]:[port]. Example: 127.0.0.1:9000. This field can be used when you create or modify collection rule configurations. Note: This field may return null, indicating that no valid values can be obtained.

setAddress

public void setAddress(String Address)

Set Listening address and port specified by the syslog collection. Format: [ip]:[port]. Example: 127.0.0.1:9000. This field can be used when you create or modify collection rule configurations. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Address - Listening address and port specified by the syslog collection. Format: [ip]:[port]. Example: 127.0.0.1:9000. This field can be used when you create or modify collection rule configurations. Note: This field may return null, indicating that no valid values can be obtained.

getParseProtocol

public String getParseProtocol()

Get `rfc3164`: Resolve logs by using the RFC 3164 protocol during the syslog collection. `rfc5424`: Resolve logs by using the RFC 5424 protocol during the syslog collection. `auto`: Automatically match either the RFC 3164 or RFC 5424 protocol. This field can be used when you create or modify collection rule configurations. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

ParseProtocol `rfc3164`: Resolve logs by using the RFC 3164 protocol during the syslog collection. `rfc5424`: Resolve logs by using the RFC 5424 protocol during the syslog collection. `auto`: Automatically match either the RFC 3164 or RFC 5424 protocol. This field can be used when you create or modify collection rule configurations. Note: This field may return null, indicating that no valid values can be obtained.

setParseProtocol

public void setParseProtocol(String ParseProtocol)

Set `rfc3164`: Resolve logs by using the RFC 3164 protocol during the syslog collection. `rfc5424`: Resolve logs by using the RFC 5424 protocol during the syslog collection. `auto`: Automatically match either the RFC 3164 or RFC 5424 protocol. This field can be used when you create or modify collection rule configurations. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

ParseProtocol - `rfc3164`: Resolve logs by using the RFC 3164 protocol during the syslog collection. `rfc5424`: Resolve logs by using the RFC 5424 protocol during the syslog collection. `auto`: Automatically match either the RFC 3164 or RFC 5424 protocol. This field can be used when you create or modify collection rule configurations. Note: This field may return null, indicating that no valid values can be obtained.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel