Package com.tencentcloudapi.cls.v20201016.models

Class ExtractRuleInfo

    • Constructor Summary

      Constructors 
      Constructor 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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getAddress()
      Get syslog系统日志采集指定采集器监听的地址和端口 ，形式：[ip]:[port]。举例：127.0.0.1:9000 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。
      Long getBacktracking()
      Get 增量采集模式下的回溯数据量，默认-1（全量采集） 注意：此字段可能返回 null，表示取不到有效值。
      String getBeginRegex()
      Get 行首匹配规则，只有log_type为multiline_log或fullregex_log时有效 注意：此字段可能返回 null，表示取不到有效值。
      String getDelimiter()
      Get 分隔符类型日志的分隔符，只有log_type为delimiter_log时有效 注意：此字段可能返回 null，表示取不到有效值。
      EventLog[] getEventLogRules()
      Get windows事件日志采集
      KeyRegexInfo[] getFilterKeyRegex()
      Get 需要过滤日志的key，及其对应的regex 注意：此字段可能返回 null，表示取不到有效值。
      Long getIsGBK()
      Get 是否为Gbk编码.
      Long getJsonStandard()
      Get 是否为标准json.
      String[] getKeys()
      Get 取的每个字段的key名字，为空的key代表丢弃这个字段，只有log_type为delimiter_log时有效，json_log的日志使用json本身的key。限制100个。 注意：此字段可能返回 null，表示取不到有效值。
      String getLogRegex()
      Get 整条日志匹配规则，只有log_type为fullregex_log时有效 注意：此字段可能返回 null，表示取不到有效值。
      Long getMetadataType()
      Get 元数据类型，0: 不使用元数据信息，1:使用机器组元数据，2:使用用户自定义元数据，3:使用采集配置路径，
      MetaTagInfo[] getMetaTags()
      Get 用户自定义元数据信息，MetadataType为2时必填
      String getParseProtocol()
      Get rfc3164：指定系统日志采集使用RFC3164协议解析日志。 rfc5424：指定系统日志采集使用RFC5424协议解析日志。 auto：自动匹配rfc3164或者rfc5424其中一种协议 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。
      String getPathRegex()
      Get 采集配置路径正则表达式，MetadataType为3时必填 注意：此字段可能返回 null，表示取不到有效值。
      String getProtocol()
      Get syslog传输协议，取值为tcp或者udp。 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。
      String getTimeFormat()
      Get 时间字段的格式，参考c语言的strftime函数对于时间的格式说明输出参数 注意：此字段可能返回 null，表示取不到有效值。
      String getTimeKey()
      Get 时间字段的key名字，time_key和time_format必须成对出现 注意：此字段可能返回 null，表示取不到有效值。
      String getUnMatchLogKey()
      Get 失败日志的key 注意：此字段可能返回 null，表示取不到有效值。
      Boolean getUnMatchUpLoadSwitch()
      Get 解析失败日志是否上传，true表示上传，false表示不上传 注意：此字段可能返回 null，表示取不到有效值。
      void setAddress​(String Address)
      Set syslog系统日志采集指定采集器监听的地址和端口 ，形式：[ip]:[port]。举例：127.0.0.1:9000 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。
      void setBacktracking​(Long Backtracking)
      Set 增量采集模式下的回溯数据量，默认-1（全量采集） 注意：此字段可能返回 null，表示取不到有效值。
      void setBeginRegex​(String BeginRegex)
      Set 行首匹配规则，只有log_type为multiline_log或fullregex_log时有效 注意：此字段可能返回 null，表示取不到有效值。
      void setDelimiter​(String Delimiter)
      Set 分隔符类型日志的分隔符，只有log_type为delimiter_log时有效 注意：此字段可能返回 null，表示取不到有效值。
      void setEventLogRules​(EventLog[] EventLogRules)
      Set windows事件日志采集
      void setFilterKeyRegex​(KeyRegexInfo[] FilterKeyRegex)
      Set 需要过滤日志的key，及其对应的regex 注意：此字段可能返回 null，表示取不到有效值。
      void setIsGBK​(Long IsGBK)
      Set 是否为Gbk编码.
      void setJsonStandard​(Long JsonStandard)
      Set 是否为标准json.
      void setKeys​(String[] Keys)
      Set 取的每个字段的key名字，为空的key代表丢弃这个字段，只有log_type为delimiter_log时有效，json_log的日志使用json本身的key。限制100个。 注意：此字段可能返回 null，表示取不到有效值。
      void setLogRegex​(String LogRegex)
      Set 整条日志匹配规则，只有log_type为fullregex_log时有效 注意：此字段可能返回 null，表示取不到有效值。
      void setMetadataType​(Long MetadataType)
      Set 元数据类型，0: 不使用元数据信息，1:使用机器组元数据，2:使用用户自定义元数据，3:使用采集配置路径，
      void setMetaTags​(MetaTagInfo[] MetaTags)
      Set 用户自定义元数据信息，MetadataType为2时必填
      void setParseProtocol​(String ParseProtocol)
      Set rfc3164：指定系统日志采集使用RFC3164协议解析日志。 rfc5424：指定系统日志采集使用RFC5424协议解析日志。 auto：自动匹配rfc3164或者rfc5424其中一种协议 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。
      void setPathRegex​(String PathRegex)
      Set 采集配置路径正则表达式，MetadataType为3时必填 注意：此字段可能返回 null，表示取不到有效值。
      void setProtocol​(String Protocol)
      Set syslog传输协议，取值为tcp或者udp。 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。
      void setTimeFormat​(String TimeFormat)
      Set 时间字段的格式，参考c语言的strftime函数对于时间的格式说明输出参数 注意：此字段可能返回 null，表示取不到有效值。
      void setTimeKey​(String TimeKey)
      Set 时间字段的key名字，time_key和time_format必须成对出现 注意：此字段可能返回 null，表示取不到有效值。
      void setUnMatchLogKey​(String UnMatchLogKey)
      Set 失败日志的key 注意：此字段可能返回 null，表示取不到有效值。
      void setUnMatchUpLoadSwitch​(Boolean UnMatchUpLoadSwitch)
      Set 解析失败日志是否上传，true表示上传，false表示不上传 注意：此字段可能返回 null，表示取不到有效值。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • 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 时间字段的key名字，time_key和time_format必须成对出现 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        TimeKey 时间字段的key名字，time_key和time_format必须成对出现 注意：此字段可能返回 null，表示取不到有效值。

      • setTimeKey

        public void setTimeKey​(String TimeKey)
        Set 时间字段的key名字，time_key和time_format必须成对出现 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        TimeKey - 时间字段的key名字，time_key和time_format必须成对出现 注意：此字段可能返回 null，表示取不到有效值。

      • getTimeFormat

        public String getTimeFormat()
        Get 时间字段的格式，参考c语言的strftime函数对于时间的格式说明输出参数 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        TimeFormat 时间字段的格式，参考c语言的strftime函数对于时间的格式说明输出参数 注意：此字段可能返回 null，表示取不到有效值。

      • setTimeFormat

        public void setTimeFormat​(String TimeFormat)
        Set 时间字段的格式，参考c语言的strftime函数对于时间的格式说明输出参数 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        TimeFormat - 时间字段的格式，参考c语言的strftime函数对于时间的格式说明输出参数 注意：此字段可能返回 null，表示取不到有效值。

      • getDelimiter

        public String getDelimiter()
        Get 分隔符类型日志的分隔符，只有log_type为delimiter_log时有效 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        Delimiter 分隔符类型日志的分隔符，只有log_type为delimiter_log时有效 注意：此字段可能返回 null，表示取不到有效值。

      • setDelimiter

        public void setDelimiter​(String Delimiter)
        Set 分隔符类型日志的分隔符，只有log_type为delimiter_log时有效 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        Delimiter - 分隔符类型日志的分隔符，只有log_type为delimiter_log时有效 注意：此字段可能返回 null，表示取不到有效值。

      • getLogRegex

        public String getLogRegex()
        Get 整条日志匹配规则，只有log_type为fullregex_log时有效 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        LogRegex 整条日志匹配规则，只有log_type为fullregex_log时有效 注意：此字段可能返回 null，表示取不到有效值。

      • setLogRegex

        public void setLogRegex​(String LogRegex)
        Set 整条日志匹配规则，只有log_type为fullregex_log时有效 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        LogRegex - 整条日志匹配规则，只有log_type为fullregex_log时有效 注意：此字段可能返回 null，表示取不到有效值。

      • getBeginRegex

        public String getBeginRegex()
        Get 行首匹配规则，只有log_type为multiline_log或fullregex_log时有效 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        BeginRegex 行首匹配规则，只有log_type为multiline_log或fullregex_log时有效 注意：此字段可能返回 null，表示取不到有效值。

      • setBeginRegex

        public void setBeginRegex​(String BeginRegex)
        Set 行首匹配规则，只有log_type为multiline_log或fullregex_log时有效 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        BeginRegex - 行首匹配规则，只有log_type为multiline_log或fullregex_log时有效 注意：此字段可能返回 null，表示取不到有效值。

      • getKeys

        public String[] getKeys()
        Get 取的每个字段的key名字，为空的key代表丢弃这个字段，只有log_type为delimiter_log时有效，json_log的日志使用json本身的key。限制100个。 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        Keys 取的每个字段的key名字，为空的key代表丢弃这个字段，只有log_type为delimiter_log时有效，json_log的日志使用json本身的key。限制100个。 注意：此字段可能返回 null，表示取不到有效值。

      • setKeys

        public void setKeys​(String[] Keys)
        Set 取的每个字段的key名字，为空的key代表丢弃这个字段，只有log_type为delimiter_log时有效，json_log的日志使用json本身的key。限制100个。 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        Keys - 取的每个字段的key名字，为空的key代表丢弃这个字段，只有log_type为delimiter_log时有效，json_log的日志使用json本身的key。限制100个。 注意：此字段可能返回 null，表示取不到有效值。

      • getFilterKeyRegex

        public KeyRegexInfo[] getFilterKeyRegex()
        Get 需要过滤日志的key，及其对应的regex 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        FilterKeyRegex 需要过滤日志的key，及其对应的regex 注意：此字段可能返回 null，表示取不到有效值。

      • setFilterKeyRegex

        public void setFilterKeyRegex​(KeyRegexInfo[] FilterKeyRegex)
        Set 需要过滤日志的key，及其对应的regex 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        FilterKeyRegex - 需要过滤日志的key，及其对应的regex 注意：此字段可能返回 null，表示取不到有效值。

      • getUnMatchUpLoadSwitch

        public Boolean getUnMatchUpLoadSwitch()
        Get 解析失败日志是否上传，true表示上传，false表示不上传 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        UnMatchUpLoadSwitch 解析失败日志是否上传，true表示上传，false表示不上传 注意：此字段可能返回 null，表示取不到有效值。

      • setUnMatchUpLoadSwitch

        public void setUnMatchUpLoadSwitch​(Boolean UnMatchUpLoadSwitch)
        Set 解析失败日志是否上传，true表示上传，false表示不上传 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        UnMatchUpLoadSwitch - 解析失败日志是否上传，true表示上传，false表示不上传 注意：此字段可能返回 null，表示取不到有效值。

      • getUnMatchLogKey

        public String getUnMatchLogKey()
        Get 失败日志的key 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        UnMatchLogKey 失败日志的key 注意：此字段可能返回 null，表示取不到有效值。

      • setUnMatchLogKey

        public void setUnMatchLogKey​(String UnMatchLogKey)
        Set 失败日志的key 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        UnMatchLogKey - 失败日志的key 注意：此字段可能返回 null，表示取不到有效值。

      • getBacktracking

        public Long getBacktracking()
        Get 增量采集模式下的回溯数据量，默认-1（全量采集） 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        Backtracking 增量采集模式下的回溯数据量，默认-1（全量采集） 注意：此字段可能返回 null，表示取不到有效值。

      • setBacktracking

        public void setBacktracking​(Long Backtracking)
        Set 增量采集模式下的回溯数据量，默认-1（全量采集） 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        Backtracking - 增量采集模式下的回溯数据量，默认-1（全量采集） 注意：此字段可能返回 null，表示取不到有效值。

      • getIsGBK

        public Long getIsGBK()
        Get 是否为Gbk编码. 0: 否, 1: 是 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        IsGBK 是否为Gbk编码. 0: 否, 1: 是 注意：此字段可能返回 null，表示取不到有效值。

      • setIsGBK

        public void setIsGBK​(Long IsGBK)
        Set 是否为Gbk编码. 0: 否, 1: 是 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        IsGBK - 是否为Gbk编码. 0: 否, 1: 是 注意：此字段可能返回 null，表示取不到有效值。

      • getJsonStandard

        public Long getJsonStandard()
        Get 是否为标准json. 0: 否, 1: 是 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        JsonStandard 是否为标准json. 0: 否, 1: 是 注意：此字段可能返回 null，表示取不到有效值。

      • setJsonStandard

        public void setJsonStandard​(Long JsonStandard)
        Set 是否为标准json. 0: 否, 1: 是 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        JsonStandard - 是否为标准json. 0: 否, 1: 是 注意：此字段可能返回 null，表示取不到有效值。

      • getProtocol

        public String getProtocol()
        Get syslog传输协议，取值为tcp或者udp。 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        Protocol syslog传输协议，取值为tcp或者udp。 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。

      • setProtocol

        public void setProtocol​(String Protocol)
        Set syslog传输协议，取值为tcp或者udp。 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        Protocol - syslog传输协议，取值为tcp或者udp。 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。

      • getAddress

        public String getAddress()
        Get syslog系统日志采集指定采集器监听的地址和端口 ，形式：[ip]:[port]。举例：127.0.0.1:9000 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        Address syslog系统日志采集指定采集器监听的地址和端口 ，形式：[ip]:[port]。举例：127.0.0.1:9000 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。

      • setAddress

        public void setAddress​(String Address)
        Set syslog系统日志采集指定采集器监听的地址和端口 ，形式：[ip]:[port]。举例：127.0.0.1:9000 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        Address - syslog系统日志采集指定采集器监听的地址和端口 ，形式：[ip]:[port]。举例：127.0.0.1:9000 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。

      • getParseProtocol

        public String getParseProtocol()
        Get rfc3164：指定系统日志采集使用RFC3164协议解析日志。 rfc5424：指定系统日志采集使用RFC5424协议解析日志。 auto：自动匹配rfc3164或者rfc5424其中一种协议 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        ParseProtocol rfc3164：指定系统日志采集使用RFC3164协议解析日志。 rfc5424：指定系统日志采集使用RFC5424协议解析日志。 auto：自动匹配rfc3164或者rfc5424其中一种协议 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。

      • setParseProtocol

        public void setParseProtocol​(String ParseProtocol)
        Set rfc3164：指定系统日志采集使用RFC3164协议解析日志。 rfc5424：指定系统日志采集使用RFC5424协议解析日志。 auto：自动匹配rfc3164或者rfc5424其中一种协议 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        ParseProtocol - rfc3164：指定系统日志采集使用RFC3164协议解析日志。 rfc5424：指定系统日志采集使用RFC5424协议解析日志。 auto：自动匹配rfc3164或者rfc5424其中一种协议 该字段适用于：创建采集规则配置、修改采集规则配置 注意：此字段可能返回 null，表示取不到有效值。

      • getMetadataType

        public Long getMetadataType()
        Get 元数据类型，0: 不使用元数据信息，1:使用机器组元数据，2:使用用户自定义元数据，3:使用采集配置路径，
        Returns:
        MetadataType 元数据类型，0: 不使用元数据信息，1:使用机器组元数据，2:使用用户自定义元数据，3:使用采集配置路径，

      • setMetadataType

        public void setMetadataType​(Long MetadataType)
        Set 元数据类型，0: 不使用元数据信息，1:使用机器组元数据，2:使用用户自定义元数据，3:使用采集配置路径，
        Parameters:
        MetadataType - 元数据类型，0: 不使用元数据信息，1:使用机器组元数据，2:使用用户自定义元数据，3:使用采集配置路径，

      • getPathRegex

        public String getPathRegex()
        Get 采集配置路径正则表达式，MetadataType为3时必填 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        PathRegex 采集配置路径正则表达式，MetadataType为3时必填 注意：此字段可能返回 null，表示取不到有效值。

      • setPathRegex

        public void setPathRegex​(String PathRegex)
        Set 采集配置路径正则表达式，MetadataType为3时必填 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        PathRegex - 采集配置路径正则表达式，MetadataType为3时必填 注意：此字段可能返回 null，表示取不到有效值。

      • getMetaTags

        public MetaTagInfo[] getMetaTags()
        Get 用户自定义元数据信息，MetadataType为2时必填
        Returns:
        MetaTags 用户自定义元数据信息，MetadataType为2时必填

      • setMetaTags

        public void setMetaTags​(MetaTagInfo[] MetaTags)
        Set 用户自定义元数据信息，MetadataType为2时必填
        Parameters:
        MetaTags - 用户自定义元数据信息，MetadataType为2时必填

      • getEventLogRules

        public EventLog[] getEventLogRules()
        Get windows事件日志采集
        Returns:
        EventLogRules windows事件日志采集

      • setEventLogRules

        public void setEventLogRules​(EventLog[] EventLogRules)
        Set windows事件日志采集
        Parameters:
        EventLogRules - windows事件日志采集