Package io.envoyproxy.envoy.config.rbac.v3

Class SourcedMetadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.rbac.v3.SourcedMetadata
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SourcedMetadataOrBuilder, Serializable
public final class SourcedMetadata extends com.google.protobuf.GeneratedMessageV3 implements SourcedMetadataOrBuilder
 SourcedMetadata enables matching against metadata from different sources in the request processing
 pipeline. It extends the base MetadataMatcher functionality by allowing specification of where the
 metadata should be sourced from, rather than only matching against dynamic metadata.

 The matcher can be configured to look up metadata from:

 * Dynamic metadata: Runtime metadata added by filters during request processing
 * Route metadata: Static metadata configured on the route entry
Protobuf type envoy.config.rbac.v3.SourcedMetadata
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SourcedMetadata.Builder
    SourcedMetadata enables matching against metadata from different sources in the request processing pipeline.

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

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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 final int
    METADATA_MATCHER_FIELD_NUMBER
     
    static final int
    METADATA_SOURCE_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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static SourcedMetadata
    getDefaultInstance()
     
    SourcedMetadata
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    MetadataMatcher
    getMetadataMatcher()
    Metadata matcher configuration that defines what metadata to match against.
    MetadataMatcherOrBuilder
    getMetadataMatcherOrBuilder()
    Metadata matcher configuration that defines what metadata to match against.
    MetadataSource
    getMetadataSource()
    Specifies which metadata source should be used for matching.
    int
    getMetadataSourceValue()
    Specifies which metadata source should be used for matching.
    com.google.protobuf.Parser<SourcedMetadata>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasMetadataMatcher()
    Metadata matcher configuration that defines what metadata to match against.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SourcedMetadata.Builder
    newBuilder()
     
    static SourcedMetadata.Builder
    newBuilder(SourcedMetadata prototype)
     
    SourcedMetadata.Builder
    newBuilderForType()
     
    protected SourcedMetadata.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static SourcedMetadata
    parseDelimitedFrom(InputStream input)
     
    static SourcedMetadata
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SourcedMetadata
    parseFrom(byte[] data)
     
    static SourcedMetadata
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SourcedMetadata
    parseFrom(com.google.protobuf.ByteString data)
     
    static SourcedMetadata
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SourcedMetadata
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SourcedMetadata
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SourcedMetadata
    parseFrom(InputStream input)
     
    static SourcedMetadata
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SourcedMetadata
    parseFrom(ByteBuffer data)
     
    static SourcedMetadata
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SourcedMetadata>
    parser()
     
    SourcedMetadata.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, 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

    • METADATA_MATCHER_FIELD_NUMBER

      public static final int METADATA_MATCHER_FIELD_NUMBER
      See Also:

    • METADATA_SOURCE_FIELD_NUMBER

      public static final int METADATA_SOURCE_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • hasMetadataMatcher

      public boolean hasMetadataMatcher()
       Metadata matcher configuration that defines what metadata to match against. This includes the filter name,
 metadata key path, and expected value.
      .envoy.type.matcher.v3.MetadataMatcher metadata_matcher = 1 [(.validate.rules) = { ... }
      Specified by:
      hasMetadataMatcher in interface SourcedMetadataOrBuilder
      Returns:
      Whether the metadataMatcher field is set.

    • getMetadataMatcher

      public MetadataMatcher getMetadataMatcher()
       Metadata matcher configuration that defines what metadata to match against. This includes the filter name,
 metadata key path, and expected value.
      .envoy.type.matcher.v3.MetadataMatcher metadata_matcher = 1 [(.validate.rules) = { ... }
      Specified by:
      getMetadataMatcher in interface SourcedMetadataOrBuilder
      Returns:
      The metadataMatcher.

    • getMetadataMatcherOrBuilder

      public MetadataMatcherOrBuilder getMetadataMatcherOrBuilder()
       Metadata matcher configuration that defines what metadata to match against. This includes the filter name,
 metadata key path, and expected value.
      .envoy.type.matcher.v3.MetadataMatcher metadata_matcher = 1 [(.validate.rules) = { ... }
      Specified by:
      getMetadataMatcherOrBuilder in interface SourcedMetadataOrBuilder

    • getMetadataSourceValue

      public int getMetadataSourceValue()
       Specifies which metadata source should be used for matching. If not set,
 defaults to DYNAMIC (dynamic metadata). Set to ROUTE to match against
 static metadata configured on the route entry.
      .envoy.config.rbac.v3.MetadataSource metadata_source = 2 [(.validate.rules) = { ... }
      Specified by:
      getMetadataSourceValue in interface SourcedMetadataOrBuilder
      Returns:
      The enum numeric value on the wire for metadataSource.

    • getMetadataSource

      public MetadataSource getMetadataSource()
       Specifies which metadata source should be used for matching. If not set,
 defaults to DYNAMIC (dynamic metadata). Set to ROUTE to match against
 static metadata configured on the route entry.
      .envoy.config.rbac.v3.MetadataSource metadata_source = 2 [(.validate.rules) = { ... }
      Specified by:
      getMetadataSource in interface SourcedMetadataOrBuilder
      Returns:
      The metadataSource.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SourcedMetadata.Builder newBuilder()

    • newBuilder

      public static SourcedMetadata.Builder newBuilder(SourcedMetadata prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SourcedMetadata getDefaultInstance()

    • parser

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

    • getParserForType

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