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

Interface CredentialInjectorOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getAllowRequestWithoutCredential()
    Whether to send the request to upstream if the credential is not present or if the credential injection to the request fails.
    TypedExtensionConfig
    getCredential()
    The credential to inject into the proxied requests [#extension-category: envoy.http.injected_credentials]
    TypedExtensionConfigOrBuilder
    getCredentialOrBuilder()
    The credential to inject into the proxied requests [#extension-category: envoy.http.injected_credentials]
    boolean
    getOverwrite()
    Whether to overwrite the value or not if the injected headers already exist.
    boolean
    hasCredential()
    The credential to inject into the proxied requests [#extension-category: envoy.http.injected_credentials]

    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

    • getOverwrite

      boolean getOverwrite()
       Whether to overwrite the value or not if the injected headers already exist.
 Value defaults to false.
      bool overwrite = 1;
      Returns:
      The overwrite.

    • getAllowRequestWithoutCredential

      boolean getAllowRequestWithoutCredential()
       Whether to send the request to upstream if the credential is not present or if the credential injection
 to the request fails.

 By default, a request will fail with ``401 Unauthorized`` if the
 credential is not present or the injection of the credential to the request fails.
 If set to true, the request will be sent to upstream without the credential.
      bool allow_request_without_credential = 2;
      Returns:
      The allowRequestWithoutCredential.

    • hasCredential

      boolean hasCredential()
       The credential to inject into the proxied requests
 [#extension-category: envoy.http.injected_credentials]
      .envoy.config.core.v3.TypedExtensionConfig credential = 3 [(.validate.rules) = { ... }
      Returns:
      Whether the credential field is set.

    • getCredential

      TypedExtensionConfig getCredential()
       The credential to inject into the proxied requests
 [#extension-category: envoy.http.injected_credentials]
      .envoy.config.core.v3.TypedExtensionConfig credential = 3 [(.validate.rules) = { ... }
      Returns:
      The credential.

    • getCredentialOrBuilder

      TypedExtensionConfigOrBuilder getCredentialOrBuilder()
       The credential to inject into the proxied requests
 [#extension-category: envoy.http.injected_credentials]
      .envoy.config.core.v3.TypedExtensionConfig credential = 3 [(.validate.rules) = { ... }