Package io.envoyproxy.envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3

Interface HeaderToMetadata.RuleOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
HeaderToMetadata.Rule, HeaderToMetadata.Rule.Builder
Enclosing class:
HeaderToMetadata
public static interface HeaderToMetadata.RuleOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getHeader()
    Specifies that a match will be performed on the value of a header.
    com.google.protobuf.ByteString
    getHeaderBytes()
    Specifies that a match will be performed on the value of a header.
    HeaderToMetadata.KeyValuePair
    getOnMissing()
    If the header is not present, apply this metadata KeyValuePair.
    HeaderToMetadata.KeyValuePairOrBuilder
    getOnMissingOrBuilder()
    If the header is not present, apply this metadata KeyValuePair.
    HeaderToMetadata.KeyValuePair
    getOnPresent()
    If the header is present, apply this metadata KeyValuePair.
    HeaderToMetadata.KeyValuePairOrBuilder
    getOnPresentOrBuilder()
    If the header is present, apply this metadata KeyValuePair.
    boolean
    getRemove()
    Whether or not to remove the header after a rule is applied.
    boolean
    hasOnMissing()
    If the header is not present, apply this metadata KeyValuePair.
    boolean
    hasOnPresent()
    If the header is present, apply this metadata KeyValuePair.

    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

    • getHeader

      String getHeader()
       Specifies that a match will be performed on the value of a header.

 The header to be extracted.
      string header = 1 [(.validate.rules) = { ... }
      Returns:
      The header.

    • getHeaderBytes

      com.google.protobuf.ByteString getHeaderBytes()
       Specifies that a match will be performed on the value of a header.

 The header to be extracted.
      string header = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for header.

    • hasOnPresent

      boolean hasOnPresent()
       If the header is present, apply this metadata KeyValuePair.

 If the value in the KeyValuePair is non-empty, it'll be used instead
 of the header value.
      .envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_present = 2;
      Returns:
      Whether the onPresent field is set.

    • getOnPresent

      HeaderToMetadata.KeyValuePair getOnPresent()
       If the header is present, apply this metadata KeyValuePair.

 If the value in the KeyValuePair is non-empty, it'll be used instead
 of the header value.
      .envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_present = 2;
      Returns:
      The onPresent.

    • getOnPresentOrBuilder

      HeaderToMetadata.KeyValuePairOrBuilder getOnPresentOrBuilder()
       If the header is present, apply this metadata KeyValuePair.

 If the value in the KeyValuePair is non-empty, it'll be used instead
 of the header value.
      .envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_present = 2;

    • hasOnMissing

      boolean hasOnMissing()
       If the header is not present, apply this metadata KeyValuePair.

 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing header value.
      .envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_missing = 3;
      Returns:
      Whether the onMissing field is set.

    • getOnMissing

      HeaderToMetadata.KeyValuePair getOnMissing()
       If the header is not present, apply this metadata KeyValuePair.

 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing header value.
      .envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_missing = 3;
      Returns:
      The onMissing.

    • getOnMissingOrBuilder

      HeaderToMetadata.KeyValuePairOrBuilder getOnMissingOrBuilder()
       If the header is not present, apply this metadata KeyValuePair.

 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing header value.
      .envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_missing = 3;

    • getRemove

      boolean getRemove()
       Whether or not to remove the header after a rule is applied.

 This prevents headers from leaking.
      bool remove = 4;
      Returns:
      The remove.