Package com.github.xds.type.matcher.v3

Class CelMatcher

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.github.xds.type.matcher.v3.CelMatcher
All Implemented Interfaces:
CelMatcherOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class CelMatcher extends com.google.protobuf.GeneratedMessage implements CelMatcherOrBuilder
 Performs a match by evaluating a `Common Expression Language
 <https://github.com/google/cel-spec>`_ (CEL) expression against the standardized set of
 :ref:`HTTP attributes <arch_overview_attributes>` specified via ``HttpAttributesCelMatchInput``.

 .. attention::

 The match is ``true``, iff the result of the evaluation is a bool AND true.
 In all other cases, the match is ``false``, including but not limited to: non-bool types,
 ``false``, ``null``,`` int(1)``, etc.
 In case CEL expression raises an error, the result of the evaluation is interpreted "no match".

 Refer to :ref:`Unified Matcher API <envoy_v3_api_msg_.xds.type.matcher.v3.Matcher>` documentation
 for usage details.

 [#comment:TODO(sergiitk): Link HttpAttributesMatchInput + usage example.]
 [#comment:TODO(sergiitk): When implemented, add the extension tag.]
Protobuf type xds.type.matcher.v3.CelMatcher
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CelMatcher.Builder
    Performs a match by evaluating a `Common Expression Language <https://github.com/google/cel-spec>`_ (CEL) expression against the standardized set of :ref:`HTTP attributes <arch_overview_attributes>` specified via ``HttpAttributesCelMatchInput``.

    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 CelMatcher
    DEFAULT_INSTANCE
     
    private Object
    description_
     
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    EXPR_MATCH_FIELD_NUMBER
     
    private CelExpression
    exprMatch_
     
    private byte
    memoizedIsInitialized
     
    private static final com.google.protobuf.Parser<CelMatcher>
    PARSER
     
    private static final long
    serialVersionUID
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, 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
    CelMatcher()
     
    private
    CelMatcher(com.google.protobuf.GeneratedMessage.Builder<?> builder)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static CelMatcher
    getDefaultInstance()
     
    CelMatcher
    getDefaultInstanceForType()
     
    String
    getDescription()
    Free-form description of the CEL AST, e.g.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    Free-form description of the CEL AST, e.g.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    CelExpression
    getExprMatch()
    Either parsed or checked representation of the CEL program.
    CelExpressionOrBuilder
    getExprMatchOrBuilder()
    Either parsed or checked representation of the CEL program.
    com.google.protobuf.Parser<CelMatcher>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasExprMatch()
    Either parsed or checked representation of the CEL program.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static CelMatcher.Builder
    newBuilder()
     
    static CelMatcher.Builder
    newBuilder(CelMatcher prototype)
     
    CelMatcher.Builder
    newBuilderForType()
     
    protected CelMatcher.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static CelMatcher
    parseDelimitedFrom(InputStream input)
     
    static CelMatcher
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CelMatcher
    parseFrom(byte[] data)
     
    static CelMatcher
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CelMatcher
    parseFrom(com.google.protobuf.ByteString data)
     
    static CelMatcher
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CelMatcher
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static CelMatcher
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CelMatcher
    parseFrom(InputStream input)
     
    static CelMatcher
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CelMatcher
    parseFrom(ByteBuffer data)
     
    static CelMatcher
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CelMatcher>
    parser()
     
    CelMatcher.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, 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, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • EXPR_MATCH_FIELD_NUMBER

      public static final int EXPR_MATCH_FIELD_NUMBER
      See Also:

    • exprMatch_

      private CelExpression exprMatch_

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • description_

      private volatile Object description_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final CelMatcher DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<CelMatcher> PARSER

  • Constructor Details

    • CelMatcher

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

    • CelMatcher

      private CelMatcher()

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • hasExprMatch

      public boolean hasExprMatch()
       Either parsed or checked representation of the CEL program.
      .xds.type.v3.CelExpression expr_match = 1 [(.validate.rules) = { ... }
      Specified by:
      hasExprMatch in interface CelMatcherOrBuilder
      Returns:
      Whether the exprMatch field is set.

    • getExprMatch

      public CelExpression getExprMatch()
       Either parsed or checked representation of the CEL program.
      .xds.type.v3.CelExpression expr_match = 1 [(.validate.rules) = { ... }
      Specified by:
      getExprMatch in interface CelMatcherOrBuilder
      Returns:
      The exprMatch.

    • getExprMatchOrBuilder

      public CelExpressionOrBuilder getExprMatchOrBuilder()
       Either parsed or checked representation of the CEL program.
      .xds.type.v3.CelExpression expr_match = 1 [(.validate.rules) = { ... }
      Specified by:
      getExprMatchOrBuilder in interface CelMatcherOrBuilder

    • getDescription

      public String getDescription()
       Free-form description of the CEL AST, e.g. the original expression text, to be
 used for debugging assistance.
      string description = 2;
      Specified by:
      getDescription in interface CelMatcherOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Free-form description of the CEL AST, e.g. the original expression text, to be
 used for debugging assistance.
      string description = 2;
      Specified by:
      getDescriptionBytes in interface CelMatcherOrBuilder
      Returns:
      The bytes for description.

    • 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 CelMatcher parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static CelMatcher parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static CelMatcher parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CelMatcher.Builder newBuilder()

    • newBuilder

      public static CelMatcher.Builder newBuilder(CelMatcher prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static CelMatcher getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<CelMatcher> 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 CelMatcher getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder