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

Class KeySource.Builder

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

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

    • clear

      public KeySource.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<KeySource.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<KeySource.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public KeySource.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<KeySource.Builder>

    • setField

      public KeySource.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<KeySource.Builder>

    • clearField

      public KeySource.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<KeySource.Builder>

    • clearOneof

      public KeySource.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<KeySource.Builder>

    • setRepeatedField

      public KeySource.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<KeySource.Builder>

    • addRepeatedField

      public KeySource.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<KeySource.Builder>

    • mergeFrom

      public KeySource.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<KeySource.Builder>

    • mergeFrom

      public KeySource.Builder mergeFrom(KeySource other)

    • isInitialized

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

    • mergeFrom

      public KeySource.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<KeySource.Builder>
      Throws:
      IOException

    • getHeader

      public String getHeader()
       The header name to fetch the key. If multiple header values are present, the first one will be
 used. If the header value starts with 'Bearer ', this prefix will be stripped to get the
 key value.

 If set, takes precedence over ``query`` and ``cookie``.
      string header = 1 [(.validate.rules) = { ... }
      Specified by:
      getHeader in interface KeySourceOrBuilder
      Returns:
      The header.

    • getHeaderBytes

      public com.google.protobuf.ByteString getHeaderBytes()
       The header name to fetch the key. If multiple header values are present, the first one will be
 used. If the header value starts with 'Bearer ', this prefix will be stripped to get the
 key value.

 If set, takes precedence over ``query`` and ``cookie``.
      string header = 1 [(.validate.rules) = { ... }
      Specified by:
      getHeaderBytes in interface KeySourceOrBuilder
      Returns:
      The bytes for header.

    • setHeader

      public KeySource.Builder setHeader(String value)
       The header name to fetch the key. If multiple header values are present, the first one will be
 used. If the header value starts with 'Bearer ', this prefix will be stripped to get the
 key value.

 If set, takes precedence over ``query`` and ``cookie``.
      string header = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The header to set.
      Returns:
      This builder for chaining.

    • clearHeader

      public KeySource.Builder clearHeader()
       The header name to fetch the key. If multiple header values are present, the first one will be
 used. If the header value starts with 'Bearer ', this prefix will be stripped to get the
 key value.

 If set, takes precedence over ``query`` and ``cookie``.
      string header = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setHeaderBytes

      public KeySource.Builder setHeaderBytes(com.google.protobuf.ByteString value)
       The header name to fetch the key. If multiple header values are present, the first one will be
 used. If the header value starts with 'Bearer ', this prefix will be stripped to get the
 key value.

 If set, takes precedence over ``query`` and ``cookie``.
      string header = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for header to set.
      Returns:
      This builder for chaining.

    • getQuery

      public String getQuery()
       The query parameter name to fetch the key. If multiple query values are present, the first one
 will be used.

 The field will be used if ``header`` is not set. If set, takes precedence over ``cookie``.
      string query = 2 [(.validate.rules) = { ... }
      Specified by:
      getQuery in interface KeySourceOrBuilder
      Returns:
      The query.

    • getQueryBytes

      public com.google.protobuf.ByteString getQueryBytes()
       The query parameter name to fetch the key. If multiple query values are present, the first one
 will be used.

 The field will be used if ``header`` is not set. If set, takes precedence over ``cookie``.
      string query = 2 [(.validate.rules) = { ... }
      Specified by:
      getQueryBytes in interface KeySourceOrBuilder
      Returns:
      The bytes for query.

    • setQuery

      public KeySource.Builder setQuery(String value)
       The query parameter name to fetch the key. If multiple query values are present, the first one
 will be used.

 The field will be used if ``header`` is not set. If set, takes precedence over ``cookie``.
      string query = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The query to set.
      Returns:
      This builder for chaining.

    • clearQuery

      public KeySource.Builder clearQuery()
       The query parameter name to fetch the key. If multiple query values are present, the first one
 will be used.

 The field will be used if ``header`` is not set. If set, takes precedence over ``cookie``.
      string query = 2 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setQueryBytes

      public KeySource.Builder setQueryBytes(com.google.protobuf.ByteString value)
       The query parameter name to fetch the key. If multiple query values are present, the first one
 will be used.

 The field will be used if ``header`` is not set. If set, takes precedence over ``cookie``.
      string query = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for query to set.
      Returns:
      This builder for chaining.

    • getCookie

      public String getCookie()
       The cookie name to fetch the key.

 The field will be used if the ``header`` and ``query`` are not set.
      string cookie = 3 [(.validate.rules) = { ... }
      Specified by:
      getCookie in interface KeySourceOrBuilder
      Returns:
      The cookie.

    • getCookieBytes

      public com.google.protobuf.ByteString getCookieBytes()
       The cookie name to fetch the key.

 The field will be used if the ``header`` and ``query`` are not set.
      string cookie = 3 [(.validate.rules) = { ... }
      Specified by:
      getCookieBytes in interface KeySourceOrBuilder
      Returns:
      The bytes for cookie.

    • setCookie

      public KeySource.Builder setCookie(String value)
       The cookie name to fetch the key.

 The field will be used if the ``header`` and ``query`` are not set.
      string cookie = 3 [(.validate.rules) = { ... }
      Parameters:
      value - The cookie to set.
      Returns:
      This builder for chaining.

    • clearCookie

      public KeySource.Builder clearCookie()
       The cookie name to fetch the key.

 The field will be used if the ``header`` and ``query`` are not set.
      string cookie = 3 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setCookieBytes

      public KeySource.Builder setCookieBytes(com.google.protobuf.ByteString value)
       The cookie name to fetch the key.

 The field will be used if the ``header`` and ``query`` are not set.
      string cookie = 3 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for cookie to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final KeySource.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<KeySource.Builder>

    • mergeUnknownFields

      public final KeySource.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<KeySource.Builder>