Package io.envoyproxy.envoy.type.metadata.v3

Interface MetadataKeyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
MetadataKey, MetadataKey.Builder
public interface MetadataKeyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getKey()
    The key name of the Metadata from which to retrieve the Struct.
    com.google.protobuf.ByteString
    getKeyBytes()
    The key name of the Metadata from which to retrieve the Struct.
    MetadataKey.PathSegment
    getPath(int index)
    The path used to retrieve a specific Value from the Struct.
    int
    getPathCount()
    The path used to retrieve a specific Value from the Struct.
    List<MetadataKey.PathSegment>
    getPathList()
    The path used to retrieve a specific Value from the Struct.
    MetadataKey.PathSegmentOrBuilder
    getPathOrBuilder(int index)
    The path used to retrieve a specific Value from the Struct.
    List<? extends MetadataKey.PathSegmentOrBuilder>
    getPathOrBuilderList()
    The path used to retrieve a specific Value from the Struct.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getKey

      String getKey()
       The key name of the Metadata from which to retrieve the Struct.
 This typically represents a builtin subsystem or custom extension.
      string key = 1 [(.validate.rules) = { ... }
      Returns:
      The key.

    • getKeyBytes

      com.google.protobuf.ByteString getKeyBytes()
       The key name of the Metadata from which to retrieve the Struct.
 This typically represents a builtin subsystem or custom extension.
      string key = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for key.

    • getPathList

      List<MetadataKey.PathSegment> getPathList()
       The path used to retrieve a specific Value from the Struct.
 This can be either a prefix or a full path, depending on the use case.
 For example, ``[prop, xyz]`` would retrieve a struct or ``[prop, foo]`` would retrieve a string
 in the example above.

 .. note::
   Since only key-type segments are supported, a path cannot specify a list
   unless the list is the last segment.
      repeated .envoy.type.metadata.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }

    • getPath

      MetadataKey.PathSegment getPath(int index)
       The path used to retrieve a specific Value from the Struct.
 This can be either a prefix or a full path, depending on the use case.
 For example, ``[prop, xyz]`` would retrieve a struct or ``[prop, foo]`` would retrieve a string
 in the example above.

 .. note::
   Since only key-type segments are supported, a path cannot specify a list
   unless the list is the last segment.
      repeated .envoy.type.metadata.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }

    • getPathCount

      int getPathCount()
       The path used to retrieve a specific Value from the Struct.
 This can be either a prefix or a full path, depending on the use case.
 For example, ``[prop, xyz]`` would retrieve a struct or ``[prop, foo]`` would retrieve a string
 in the example above.

 .. note::
   Since only key-type segments are supported, a path cannot specify a list
   unless the list is the last segment.
      repeated .envoy.type.metadata.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }

    • getPathOrBuilderList

      List<? extends MetadataKey.PathSegmentOrBuilder> getPathOrBuilderList()
       The path used to retrieve a specific Value from the Struct.
 This can be either a prefix or a full path, depending on the use case.
 For example, ``[prop, xyz]`` would retrieve a struct or ``[prop, foo]`` would retrieve a string
 in the example above.

 .. note::
   Since only key-type segments are supported, a path cannot specify a list
   unless the list is the last segment.
      repeated .envoy.type.metadata.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }

    • getPathOrBuilder

      MetadataKey.PathSegmentOrBuilder getPathOrBuilder(int index)
       The path used to retrieve a specific Value from the Struct.
 This can be either a prefix or a full path, depending on the use case.
 For example, ``[prop, xyz]`` would retrieve a struct or ``[prop, foo]`` would retrieve a string
 in the example above.

 .. note::
   Since only key-type segments are supported, a path cannot specify a list
   unless the list is the last segment.
      repeated .envoy.type.metadata.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }