Package com.github.xds.type.v3

Class CelExtractString

  • All Implemented Interfaces:
    CelExtractStringOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class CelExtractString
extends com.google.protobuf.GeneratedMessageV3
implements CelExtractStringOrBuilder
     Extracts a string 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>`.
 .. attention::
   Besides CEL evaluation raising an error explicitly, CEL program returning a type other than
   the ``string``, or not returning anything, are considered an error as well.
 [#comment:TODO(sergiitk): When implemented, add the extension tag.]
    Protobuf type xds.type.v3.CelExtractString
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CelExtractString.Builder
      Extracts a string 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>`. .. attention:: Besides CEL evaluation raising an error explicitly, CEL program returning a type other than the ``string``, or not returning anything, are considered an error as well.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DEFAULT_VALUE_FIELD_NUMBER  
      static int EXPR_EXTRACT_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Field Detail

      • EXPR_EXTRACT_FIELD_NUMBER

        public static final int EXPR_EXTRACT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEFAULT_VALUE_FIELD_NUMBER

        public static final int DEFAULT_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • hasExprExtract

        public boolean hasExprExtract()
         The CEL expression used to extract a string from the CEL environment.
 the "subject string") that should be replaced.
        .xds.type.v3.CelExpression expr_extract = 1 [(.validate.rules) = { ... }
        Specified by:
        hasExprExtract in interface CelExtractStringOrBuilder
        Returns:
        Whether the exprExtract field is set.

      • getExprExtract

        public CelExpression getExprExtract()
         The CEL expression used to extract a string from the CEL environment.
 the "subject string") that should be replaced.
        .xds.type.v3.CelExpression expr_extract = 1 [(.validate.rules) = { ... }
        Specified by:
        getExprExtract in interface CelExtractStringOrBuilder
        Returns:
        The exprExtract.

      • getExprExtractOrBuilder

        public CelExpressionOrBuilder getExprExtractOrBuilder()
         The CEL expression used to extract a string from the CEL environment.
 the "subject string") that should be replaced.
        .xds.type.v3.CelExpression expr_extract = 1 [(.validate.rules) = { ... }
        Specified by:
        getExprExtractOrBuilder in interface CelExtractStringOrBuilder

      • hasDefaultValue

        public boolean hasDefaultValue()
         If CEL expression evaluates to an error, this value is be returned to the caller.
 If not set, the error is propagated to the caller.
        .google.protobuf.StringValue default_value = 2;
        Specified by:
        hasDefaultValue in interface CelExtractStringOrBuilder
        Returns:
        Whether the defaultValue field is set.

      • getDefaultValue

        public com.google.protobuf.StringValue getDefaultValue()
         If CEL expression evaluates to an error, this value is be returned to the caller.
 If not set, the error is propagated to the caller.
        .google.protobuf.StringValue default_value = 2;
        Specified by:
        getDefaultValue in interface CelExtractStringOrBuilder
        Returns:
        The defaultValue.

      • getDefaultValueOrBuilder

        public com.google.protobuf.StringValueOrBuilder getDefaultValueOrBuilder()
         If CEL expression evaluates to an error, this value is be returned to the caller.
 If not set, the error is propagated to the caller.
        .google.protobuf.StringValue default_value = 2;
        Specified by:
        getDefaultValueOrBuilder in interface CelExtractStringOrBuilder

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected CelExtractString.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<CelExtractString> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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