Package io.envoyproxy.envoy.extensions.http.injected_credentials.generic.v3

Class Generic

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.http.injected_credentials.generic.v3.Generic
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GenericOrBuilder, Serializable
public final class Generic extends com.google.protobuf.GeneratedMessageV3 implements GenericOrBuilder
 Generic extension can be used to inject HTTP Basic Auth, Bearer Token, or any arbitrary credential
 into the proxied requests.
 The credential will be injected into the specified HTTP request header.
 Refer to [RFC 6750: The OAuth 2.0 Authorization Framework: Bearer Token Usage](https://www.rfc-editor.org/rfc/rfc6750) for details.
Protobuf type envoy.extensions.http.injected_credentials.generic.v3.Generic
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Generic.Builder
    Generic extension can be used to inject HTTP Basic Auth, Bearer Token, or any arbitrary credential into the proxied requests.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CREDENTIAL_FIELD_NUMBER
     
    static final int
    HEADER_FIELD_NUMBER
     
    static final int
    HEADER_VALUE_PREFIX_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    SdsSecretConfig
    getCredential()
    The SDS configuration for the credential that will be injected to the specified HTTP request header.
    SdsSecretConfigOrBuilder
    getCredentialOrBuilder()
    The SDS configuration for the credential that will be injected to the specified HTTP request header.
    static Generic
    getDefaultInstance()
     
    Generic
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getHeader()
    The header that will be injected to the HTTP request with the provided credential.
    com.google.protobuf.ByteString
    getHeaderBytes()
    The header that will be injected to the HTTP request with the provided credential.
    String
    getHeaderValuePrefix()
    The prefix to prepend to the credential value before injecting it into the header.
    com.google.protobuf.ByteString
    getHeaderValuePrefixBytes()
    The prefix to prepend to the credential value before injecting it into the header.
    com.google.protobuf.Parser<Generic>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasCredential()
    The SDS configuration for the credential that will be injected to the specified HTTP request header.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Generic.Builder
    newBuilder()
     
    static Generic.Builder
    newBuilder(Generic prototype)
     
    Generic.Builder
    newBuilderForType()
     
    protected Generic.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Generic
    parseDelimitedFrom(InputStream input)
     
    static Generic
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Generic
    parseFrom(byte[] data)
     
    static Generic
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Generic
    parseFrom(com.google.protobuf.ByteString data)
     
    static Generic
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Generic
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Generic
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Generic
    parseFrom(InputStream input)
     
    static Generic
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Generic
    parseFrom(ByteBuffer data)
     
    static Generic
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Generic>
    parser()
     
    Generic.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • CREDENTIAL_FIELD_NUMBER

      public static final int CREDENTIAL_FIELD_NUMBER
      See Also:

    • HEADER_FIELD_NUMBER

      public static final int HEADER_FIELD_NUMBER
      See Also:

    • HEADER_VALUE_PREFIX_FIELD_NUMBER

      public static final int HEADER_VALUE_PREFIX_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

    • hasCredential

      public boolean hasCredential()
       The SDS configuration for the credential that will be injected to the specified HTTP request header.
 It must be a generic secret.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig credential = 1 [(.validate.rules) = { ... }
      Specified by:
      hasCredential in interface GenericOrBuilder
      Returns:
      Whether the credential field is set.

    • getCredential

      public SdsSecretConfig getCredential()
       The SDS configuration for the credential that will be injected to the specified HTTP request header.
 It must be a generic secret.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig credential = 1 [(.validate.rules) = { ... }
      Specified by:
      getCredential in interface GenericOrBuilder
      Returns:
      The credential.

    • getCredentialOrBuilder

      public SdsSecretConfigOrBuilder getCredentialOrBuilder()
       The SDS configuration for the credential that will be injected to the specified HTTP request header.
 It must be a generic secret.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig credential = 1 [(.validate.rules) = { ... }
      Specified by:
      getCredentialOrBuilder in interface GenericOrBuilder

    • getHeader

      public String getHeader()
       The header that will be injected to the HTTP request with the provided credential.
 If not set, filter will default to: ``Authorization``
      string header = 2 [(.validate.rules) = { ... }
      Specified by:
      getHeader in interface GenericOrBuilder
      Returns:
      The header.

    • getHeaderBytes

      public com.google.protobuf.ByteString getHeaderBytes()
       The header that will be injected to the HTTP request with the provided credential.
 If not set, filter will default to: ``Authorization``
      string header = 2 [(.validate.rules) = { ... }
      Specified by:
      getHeaderBytes in interface GenericOrBuilder
      Returns:
      The bytes for header.

    • getHeaderValuePrefix

      public String getHeaderValuePrefix()
       The prefix to prepend to the credential value before injecting it into the header.
 This is useful for adding a scheme such as ``Bearer `` or ``Basic `` to the credential.
 For example, if the credential is ``xyz123`` and the prefix is ``Bearer ``, the
 final header value will be ``Bearer xyz123``.
 If not set, the raw credential value will be injected without any prefix.
      string header_value_prefix = 3;
      Specified by:
      getHeaderValuePrefix in interface GenericOrBuilder
      Returns:
      The headerValuePrefix.

    • getHeaderValuePrefixBytes

      public com.google.protobuf.ByteString getHeaderValuePrefixBytes()
       The prefix to prepend to the credential value before injecting it into the header.
 This is useful for adding a scheme such as ``Bearer `` or ``Basic `` to the credential.
 For example, if the credential is ``xyz123`` and the prefix is ``Bearer ``, the
 final header value will be ``Bearer xyz123``.
 If not set, the raw credential value will be injected without any prefix.
      string header_value_prefix = 3;
      Specified by:
      getHeaderValuePrefixBytes in interface GenericOrBuilder
      Returns:
      The bytes for headerValuePrefix.

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Generic parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Generic parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Generic parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Generic parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Generic parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Generic parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Generic parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Generic parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Generic parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Generic parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Generic parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Generic parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Generic.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Generic.Builder newBuilder()

    • newBuilder

      public static Generic.Builder newBuilder(Generic prototype)

    • toBuilder

      public Generic.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Generic.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Generic getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Generic> parser()

    • getParserForType

      public com.google.protobuf.Parser<Generic> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

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