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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getKey()
      The key name of Metadata to retrieve the Struct from the metadata.
      com.google.protobuf.ByteString getKeyBytes()
      The key name of Metadata to retrieve the Struct from the metadata.
      MetadataKey.PathSegment getPath​(int index)
      The path to retrieve the Value from the Struct.
      int getPathCount()
      The path to retrieve the Value from the Struct.
      java.util.List<MetadataKey.PathSegment> getPathList()
      The path to retrieve the Value from the Struct.
      MetadataKey.PathSegmentOrBuilder getPathOrBuilder​(int index)
      The path to retrieve the Value from the Struct.
      java.util.List<? extends MetadataKey.PathSegmentOrBuilder> getPathOrBuilderList()
      The path to retrieve the 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 Detail

      • getKey

        java.lang.String getKey()
         The key name of Metadata to retrieve the Struct from the metadata.
         Typically, it 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 Metadata to retrieve the Struct from the metadata.
         Typically, it represents a builtin subsystem or custom extension.
         
        string key = 1 [(.validate.rules) = { ... }
        Returns:
        The bytes for key.
      • getPathList

        java.util.List<MetadataKey.PathSegment> getPathList()
         The path to retrieve the Value from the Struct. It can be a prefix or a full path,
         e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example,
         which depends on the particular scenario.
        
         Note: Due to that only the key type segment is supported, the path can not 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 to retrieve the Value from the Struct. It can be a prefix or a full path,
         e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example,
         which depends on the particular scenario.
        
         Note: Due to that only the key type segment is supported, the path can not 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 to retrieve the Value from the Struct. It can be a prefix or a full path,
         e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example,
         which depends on the particular scenario.
        
         Note: Due to that only the key type segment is supported, the path can not specify a list
         unless the list is the last segment.
         
        repeated .envoy.type.metadata.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
      • getPathOrBuilderList

        java.util.List<? extends MetadataKey.PathSegmentOrBuilder> getPathOrBuilderList()
         The path to retrieve the Value from the Struct. It can be a prefix or a full path,
         e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example,
         which depends on the particular scenario.
        
         Note: Due to that only the key type segment is supported, the path can not 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 to retrieve the Value from the Struct. It can be a prefix or a full path,
         e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example,
         which depends on the particular scenario.
        
         Note: Due to that only the key type segment is supported, the path can not specify a list
         unless the list is the last segment.
         
        repeated .envoy.type.metadata.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }