Package io.envoyproxy.envoy.type.matcher.v3

Class RegexMatcher.GoogleRE2

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.type.matcher.v3.RegexMatcher.GoogleRE2
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RegexMatcher.GoogleRE2OrBuilder, Serializable
Enclosing class:
RegexMatcher
public static final class RegexMatcher.GoogleRE2 extends com.google.protobuf.GeneratedMessage implements RegexMatcher.GoogleRE2OrBuilder
 Google's `RE2 <https://github.com/google/re2>`_ regex engine. The regex string must adhere to
 the documented `syntax <https://github.com/google/re2/wiki/Syntax>`_. The engine is designed
 to complete execution in linear time as well as limit the amount of memory used.

 Envoy supports program size checking via runtime. The runtime keys ``re2.max_program_size.error_level``
 and ``re2.max_program_size.warn_level`` can be set to integers as the maximum program size or
 complexity that a compiled regex can have before an exception is thrown or a warning is
 logged, respectively. ``re2.max_program_size.error_level`` defaults to 100, and
 ``re2.max_program_size.warn_level`` has no default if unset (will not check/log a warning).

 Envoy emits two stats for tracking the program size of regexes: the histogram ``re2.program_size``,
 which records the program size, and the counter ``re2.exceeded_warn_level``, which is incremented
 each time the program size exceeds the warn level threshold.
Protobuf type envoy.type.matcher.v3.RegexMatcher.GoogleRE2
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RegexMatcher.GoogleRE2.Builder
    Google's `RE2 <https://github.com/google/re2>`_ regex engine.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private int
    bitField0_
     
    private static final RegexMatcher.GoogleRE2
    DEFAULT_INSTANCE
     
    static final int
    MAX_PROGRAM_SIZE_FIELD_NUMBER
     
    private com.google.protobuf.UInt32Value
    maxProgramSize_
     
    private byte
    memoizedIsInitialized
     
    private static final com.google.protobuf.Parser<RegexMatcher.GoogleRE2>
    PARSER
     
    private static final long
    serialVersionUID
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    GoogleRE2()
     
    private
    GoogleRE2(com.google.protobuf.GeneratedMessage.Builder<?> builder)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static RegexMatcher.GoogleRE2
    getDefaultInstance()
     
    RegexMatcher.GoogleRE2
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    com.google.protobuf.UInt32Value
    getMaxProgramSize()
    Deprecated.
    envoy.type.matcher.v3.RegexMatcher.GoogleRE2.max_program_size is deprecated.
    com.google.protobuf.UInt32ValueOrBuilder
    getMaxProgramSizeOrBuilder()
    Deprecated.
    com.google.protobuf.Parser<RegexMatcher.GoogleRE2>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasMaxProgramSize()
    Deprecated.
    envoy.type.matcher.v3.RegexMatcher.GoogleRE2.max_program_size is deprecated.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static RegexMatcher.GoogleRE2.Builder
    newBuilder()
     
    static RegexMatcher.GoogleRE2.Builder
    newBuilder(RegexMatcher.GoogleRE2 prototype)
     
    RegexMatcher.GoogleRE2.Builder
    newBuilderForType()
     
    protected RegexMatcher.GoogleRE2.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static RegexMatcher.GoogleRE2
    parseDelimitedFrom(InputStream input)
     
    static RegexMatcher.GoogleRE2
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RegexMatcher.GoogleRE2
    parseFrom(byte[] data)
     
    static RegexMatcher.GoogleRE2
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RegexMatcher.GoogleRE2
    parseFrom(com.google.protobuf.ByteString data)
     
    static RegexMatcher.GoogleRE2
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RegexMatcher.GoogleRE2
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RegexMatcher.GoogleRE2
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RegexMatcher.GoogleRE2
    parseFrom(InputStream input)
     
    static RegexMatcher.GoogleRE2
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RegexMatcher.GoogleRE2
    parseFrom(ByteBuffer data)
     
    static RegexMatcher.GoogleRE2
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RegexMatcher.GoogleRE2>
    parser()
     
    RegexMatcher.GoogleRE2.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • MAX_PROGRAM_SIZE_FIELD_NUMBER

      public static final int MAX_PROGRAM_SIZE_FIELD_NUMBER
      See Also:

    • maxProgramSize_

      private com.google.protobuf.UInt32Value maxProgramSize_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final RegexMatcher.GoogleRE2 DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<RegexMatcher.GoogleRE2> PARSER

  • Constructor Details

    • GoogleRE2

      private GoogleRE2(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • GoogleRE2

      private GoogleRE2()

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasMaxProgramSize

      @Deprecated public boolean hasMaxProgramSize()
      Deprecated.
      envoy.type.matcher.v3.RegexMatcher.GoogleRE2.max_program_size is deprecated. See envoy/type/matcher/v3/regex.proto;l=53
       This field controls the RE2 "program size" which is a rough estimate of how complex a
 compiled regex is to evaluate. A regex that has a program size greater than the configured
 value will fail to compile. In this case, the configured max program size can be increased
 or the regex can be simplified. If not specified, the default is 100.

 This field is deprecated; regexp validation should be performed on the management server
 instead of being done by each individual client.

 .. note::

 Although this field is deprecated, the program size will still be checked against the
 global ``re2.max_program_size.error_level`` runtime value.
      .google.protobuf.UInt32Value max_program_size = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      hasMaxProgramSize in interface RegexMatcher.GoogleRE2OrBuilder
      Returns:
      Whether the maxProgramSize field is set.

    • getMaxProgramSize

      @Deprecated public com.google.protobuf.UInt32Value getMaxProgramSize()
      Deprecated.
      envoy.type.matcher.v3.RegexMatcher.GoogleRE2.max_program_size is deprecated. See envoy/type/matcher/v3/regex.proto;l=53
       This field controls the RE2 "program size" which is a rough estimate of how complex a
 compiled regex is to evaluate. A regex that has a program size greater than the configured
 value will fail to compile. In this case, the configured max program size can be increased
 or the regex can be simplified. If not specified, the default is 100.

 This field is deprecated; regexp validation should be performed on the management server
 instead of being done by each individual client.

 .. note::

 Although this field is deprecated, the program size will still be checked against the
 global ``re2.max_program_size.error_level`` runtime value.
      .google.protobuf.UInt32Value max_program_size = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getMaxProgramSize in interface RegexMatcher.GoogleRE2OrBuilder
      Returns:
      The maxProgramSize.

    • getMaxProgramSizeOrBuilder

      @Deprecated public com.google.protobuf.UInt32ValueOrBuilder getMaxProgramSizeOrBuilder()
      Deprecated.
       This field controls the RE2 "program size" which is a rough estimate of how complex a
 compiled regex is to evaluate. A regex that has a program size greater than the configured
 value will fail to compile. In this case, the configured max program size can be increased
 or the regex can be simplified. If not specified, the default is 100.

 This field is deprecated; regexp validation should be performed on the management server
 instead of being done by each individual client.

 .. note::

 Although this field is deprecated, the program size will still be checked against the
 global ``re2.max_program_size.error_level`` runtime value.
      .google.protobuf.UInt32Value max_program_size = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getMaxProgramSizeOrBuilder in interface RegexMatcher.GoogleRE2OrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RegexMatcher.GoogleRE2 parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RegexMatcher.GoogleRE2 parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RegexMatcher.GoogleRE2 parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RegexMatcher.GoogleRE2 parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RegexMatcher.GoogleRE2 parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RegexMatcher.GoogleRE2 parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RegexMatcher.GoogleRE2 parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RegexMatcher.GoogleRE2 parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RegexMatcher.GoogleRE2 parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RegexMatcher.GoogleRE2 parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RegexMatcher.GoogleRE2 parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RegexMatcher.GoogleRE2 parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RegexMatcher.GoogleRE2.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RegexMatcher.GoogleRE2.Builder newBuilder()

    • newBuilder

      public static RegexMatcher.GoogleRE2.Builder newBuilder(RegexMatcher.GoogleRE2 prototype)

    • toBuilder

      public RegexMatcher.GoogleRE2.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RegexMatcher.GoogleRE2.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RegexMatcher.GoogleRE2 getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RegexMatcher.GoogleRE2> parser()

    • getParserForType

      public com.google.protobuf.Parser<RegexMatcher.GoogleRE2> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public RegexMatcher.GoogleRE2 getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder