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

Interface GenericOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Generic, Generic.Builder
public interface GenericOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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.
    boolean
    hasCredential()
    The SDS configuration for the credential that will be injected to the specified HTTP request header.

    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

    • hasCredential

      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) = { ... }
      Returns:
      Whether the credential field is set.

    • getCredential

      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) = { ... }
      Returns:
      The credential.

    • getCredentialOrBuilder

      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) = { ... }

    • getHeader

      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) = { ... }
      Returns:
      The header.

    • getHeaderBytes

      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) = { ... }
      Returns:
      The bytes for header.

    • getHeaderValuePrefix

      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;
      Returns:
      The headerValuePrefix.

    • getHeaderValuePrefixBytes

      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;
      Returns:
      The bytes for headerValuePrefix.