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

Class Forwarding.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Forwarding.Builder>
io.envoyproxy.envoy.extensions.filters.http.api_key_auth.v3.Forwarding.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ForwardingOrBuilder, Cloneable
Enclosing class:
Forwarding
public static final class Forwarding.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Forwarding.Builder> implements ForwardingOrBuilder
Protobuf type envoy.extensions.filters.http.api_key_auth.v3.Forwarding

  • Method Summary

    Modifier and Type
    Method
    Description
    Forwarding.Builder
    addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    Forwarding
    build()
     
    Forwarding
    buildPartial()
     
    Forwarding.Builder
    clear()
     
    Forwarding.Builder
    clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
     
    Forwarding.Builder
    clearHeader()
    The header name in which to store the client information.
    Forwarding.Builder
    clearHideCredentials()
    If true, remove the API key from the request before forwarding upstream.
    Forwarding.Builder
    clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
     
    Forwarding.Builder
    clone()
     
    Forwarding
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    String
    getHeader()
    The header name in which to store the client information.
    com.google.protobuf.ByteString
    getHeaderBytes()
    The header name in which to store the client information.
    boolean
    getHideCredentials()
    If true, remove the API key from the request before forwarding upstream.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    Forwarding.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    Forwarding.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    Forwarding.Builder
    mergeFrom(Forwarding other)
     
    final Forwarding.Builder
    mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     
    Forwarding.Builder
    setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    Forwarding.Builder
    setHeader(String value)
    The header name in which to store the client information.
    Forwarding.Builder
    setHeaderBytes(com.google.protobuf.ByteString value)
    The header name in which to store the client information.
    Forwarding.Builder
    setHideCredentials(boolean value)
    If true, remove the API key from the request before forwarding upstream.
    Forwarding.Builder
    setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
     
    final Forwarding.Builder
    setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

    getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • 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.Builder<Forwarding.Builder>

    • clear

      public Forwarding.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<Forwarding.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Forwarding.Builder>

    • getDefaultInstanceForType

      public Forwarding getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Forwarding build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Forwarding buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public Forwarding.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<Forwarding.Builder>

    • setField

      public Forwarding.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<Forwarding.Builder>

    • clearField

      public Forwarding.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Forwarding.Builder>

    • clearOneof

      public Forwarding.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Forwarding.Builder>

    • setRepeatedField

      public Forwarding.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Forwarding.Builder>

    • addRepeatedField

      public Forwarding.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Forwarding.Builder>

    • mergeFrom

      public Forwarding.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Forwarding.Builder>

    • mergeFrom

      public Forwarding.Builder mergeFrom(Forwarding other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Forwarding.Builder>

    • mergeFrom

      public Forwarding.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Forwarding.Builder>
      Throws:
      IOException

    • getHeader

      public String getHeader()
       The header name in which to store the client information. If this field is non-empty,
 the client string associated with the matched credential will be injected into
 the request before forwarding upstream.
      string header = 1 [(.validate.rules) = { ... }
      Specified by:
      getHeader in interface ForwardingOrBuilder
      Returns:
      The header.

    • getHeaderBytes

      public com.google.protobuf.ByteString getHeaderBytes()
       The header name in which to store the client information. If this field is non-empty,
 the client string associated with the matched credential will be injected into
 the request before forwarding upstream.
      string header = 1 [(.validate.rules) = { ... }
      Specified by:
      getHeaderBytes in interface ForwardingOrBuilder
      Returns:
      The bytes for header.

    • setHeader

      public Forwarding.Builder setHeader(String value)
       The header name in which to store the client information. If this field is non-empty,
 the client string associated with the matched credential will be injected into
 the request before forwarding upstream.
      string header = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The header to set.
      Returns:
      This builder for chaining.

    • clearHeader

      public Forwarding.Builder clearHeader()
       The header name in which to store the client information. If this field is non-empty,
 the client string associated with the matched credential will be injected into
 the request before forwarding upstream.
      string header = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setHeaderBytes

      public Forwarding.Builder setHeaderBytes(com.google.protobuf.ByteString value)
       The header name in which to store the client information. If this field is non-empty,
 the client string associated with the matched credential will be injected into
 the request before forwarding upstream.
      string header = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for header to set.
      Returns:
      This builder for chaining.

    • getHideCredentials

      public boolean getHideCredentials()
       If true, remove the API key from the request before forwarding upstream.

 This applies to all configured key sources: ``header``, ``query``, and ``cookie``.
      bool hide_credentials = 2;
      Specified by:
      getHideCredentials in interface ForwardingOrBuilder
      Returns:
      The hideCredentials.

    • setHideCredentials

      public Forwarding.Builder setHideCredentials(boolean value)
       If true, remove the API key from the request before forwarding upstream.

 This applies to all configured key sources: ``header``, ``query``, and ``cookie``.
      bool hide_credentials = 2;
      Parameters:
      value - The hideCredentials to set.
      Returns:
      This builder for chaining.

    • clearHideCredentials

      public Forwarding.Builder clearHideCredentials()
       If true, remove the API key from the request before forwarding upstream.

 This applies to all configured key sources: ``header``, ``query``, and ``cookie``.
      bool hide_credentials = 2;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final Forwarding.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Forwarding.Builder>

    • mergeUnknownFields

      public final Forwarding.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Forwarding.Builder>