Package io.envoyproxy.envoy.extensions.filters.http.json_to_metadata.v3

Interface JsonToMetadata.KeyValuePairOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
JsonToMetadata.KeyValuePair, JsonToMetadata.KeyValuePair.Builder
Enclosing class:
JsonToMetadata
public static interface JsonToMetadata.KeyValuePairOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getKey()
    The key to use within the namespace.
    com.google.protobuf.ByteString
    getKeyBytes()
    The key to use within the namespace.
    String
    getMetadataNamespace()
    The namespace — if this is empty, the filter's namespace will be used.
    com.google.protobuf.ByteString
    getMetadataNamespaceBytes()
    The namespace — if this is empty, the filter's namespace will be used.
    boolean
    getPreserveExistingMetadataValue()
    False if we want to overwrite the existing metadata value.
    JsonToMetadata.ValueType
    getType()
    The value's type — defaults to protobuf.Value.
    int
    getTypeValue()
    The value's type — defaults to protobuf.Value.
    com.google.protobuf.Value
    getValue()
    The value to pair with the given key.
    com.google.protobuf.ValueOrBuilder
    getValueOrBuilder()
    The value to pair with the given key.
    JsonToMetadata.KeyValuePair.ValueTypeCase
    getValueTypeCase()
     
    boolean
    hasValue()
    The value to pair with the given key.

    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

    • getMetadataNamespace

      String getMetadataNamespace()
       The namespace — if this is empty, the filter's namespace will be used.
      string metadata_namespace = 1;
      Returns:
      The metadataNamespace.

    • getMetadataNamespaceBytes

      com.google.protobuf.ByteString getMetadataNamespaceBytes()
       The namespace — if this is empty, the filter's namespace will be used.
      string metadata_namespace = 1;
      Returns:
      The bytes for metadataNamespace.

    • getKey

      String getKey()
       The key to use within the namespace.
      string key = 2 [(.validate.rules) = { ... }
      Returns:
      The key.

    • getKeyBytes

      com.google.protobuf.ByteString getKeyBytes()
       The key to use within the namespace.
      string key = 2 [(.validate.rules) = { ... }
      Returns:
      The bytes for key.

    • hasValue

      boolean hasValue()
       The value to pair with the given key.

 When used for on_present case, if value is non-empty it'll be used instead
 of the the value of the JSON key. If both are empty, the the value of the
 JSON key is used as-is.

 When used for on_missing/on_error case, a non-empty value
 must be provided.

 It ignores ValueType, i.e., not type casting.
      .google.protobuf.Value value = 3;
      Returns:
      Whether the value field is set.

    • getValue

      com.google.protobuf.Value getValue()
       The value to pair with the given key.

 When used for on_present case, if value is non-empty it'll be used instead
 of the the value of the JSON key. If both are empty, the the value of the
 JSON key is used as-is.

 When used for on_missing/on_error case, a non-empty value
 must be provided.

 It ignores ValueType, i.e., not type casting.
      .google.protobuf.Value value = 3;
      Returns:
      The value.

    • getValueOrBuilder

      com.google.protobuf.ValueOrBuilder getValueOrBuilder()
       The value to pair with the given key.

 When used for on_present case, if value is non-empty it'll be used instead
 of the the value of the JSON key. If both are empty, the the value of the
 JSON key is used as-is.

 When used for on_missing/on_error case, a non-empty value
 must be provided.

 It ignores ValueType, i.e., not type casting.
      .google.protobuf.Value value = 3;

    • getTypeValue

      int getTypeValue()
       The value's type — defaults to protobuf.Value.
      .envoy.extensions.filters.http.json_to_metadata.v3.JsonToMetadata.ValueType type = 4 [(.validate.rules) = { ... }
      Returns:
      The enum numeric value on the wire for type.

    • getType

      JsonToMetadata.ValueType getType()
       The value's type — defaults to protobuf.Value.
      .envoy.extensions.filters.http.json_to_metadata.v3.JsonToMetadata.ValueType type = 4 [(.validate.rules) = { ... }
      Returns:
      The type.

    • getPreserveExistingMetadataValue

      boolean getPreserveExistingMetadataValue()
       False if we want to overwrite the existing metadata value. Default to false.
      bool preserve_existing_metadata_value = 5;
      Returns:
      The preserveExistingMetadataValue.

    • getValueTypeCase

      JsonToMetadata.KeyValuePair.ValueTypeCase getValueTypeCase()