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

Interface GcpAuthnFilterConfigOrBuilder

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

  • Method Details

    • hasHttpUri

      @Deprecated boolean hasHttpUri()
      Deprecated.
      envoy.extensions.filters.http.gcp_authn.v3.GcpAuthnFilterConfig.http_uri is deprecated. See envoy/extensions/filters/http/gcp_authn/v3/gcp_authn.proto;l=35
       The HTTP URI to fetch tokens from GCE Metadata Server(https://cloud.google.com/compute/docs/metadata/overview).
 The URL format is "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts/default/identity?audience=[AUDIENCE]"

 This field is deprecated because it does not match the API surface provided by the google auth libraries.
 Control planes should not attempt to override the metadata server URI.
 The cluster and timeout can be configured using the ``cluster`` and ``timeout`` fields instead.
 For backward compatibility, the cluster and timeout configured in this field will be used
 if the new ``cluster`` and ``timeout`` fields are not set.
      .envoy.config.core.v3.HttpUri http_uri = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      Whether the httpUri field is set.

    • getHttpUri

      @Deprecated HttpUri getHttpUri()
      Deprecated.
      envoy.extensions.filters.http.gcp_authn.v3.GcpAuthnFilterConfig.http_uri is deprecated. See envoy/extensions/filters/http/gcp_authn/v3/gcp_authn.proto;l=35
       The HTTP URI to fetch tokens from GCE Metadata Server(https://cloud.google.com/compute/docs/metadata/overview).
 The URL format is "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts/default/identity?audience=[AUDIENCE]"

 This field is deprecated because it does not match the API surface provided by the google auth libraries.
 Control planes should not attempt to override the metadata server URI.
 The cluster and timeout can be configured using the ``cluster`` and ``timeout`` fields instead.
 For backward compatibility, the cluster and timeout configured in this field will be used
 if the new ``cluster`` and ``timeout`` fields are not set.
      .envoy.config.core.v3.HttpUri http_uri = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      The httpUri.

    • getHttpUriOrBuilder

      @Deprecated HttpUriOrBuilder getHttpUriOrBuilder()
      Deprecated.
       The HTTP URI to fetch tokens from GCE Metadata Server(https://cloud.google.com/compute/docs/metadata/overview).
 The URL format is "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts/default/identity?audience=[AUDIENCE]"

 This field is deprecated because it does not match the API surface provided by the google auth libraries.
 Control planes should not attempt to override the metadata server URI.
 The cluster and timeout can be configured using the ``cluster`` and ``timeout`` fields instead.
 For backward compatibility, the cluster and timeout configured in this field will be used
 if the new ``cluster`` and ``timeout`` fields are not set.
      .envoy.config.core.v3.HttpUri http_uri = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

    • hasRetryPolicy

      boolean hasRetryPolicy()
       Retry policy for fetching tokens.
 Not supported by all data planes.
      .envoy.config.core.v3.RetryPolicy retry_policy = 2;
      Returns:
      Whether the retryPolicy field is set.

    • getRetryPolicy

      RetryPolicy getRetryPolicy()
       Retry policy for fetching tokens.
 Not supported by all data planes.
      .envoy.config.core.v3.RetryPolicy retry_policy = 2;
      Returns:
      The retryPolicy.

    • getRetryPolicyOrBuilder

      RetryPolicyOrBuilder getRetryPolicyOrBuilder()
       Retry policy for fetching tokens.
 Not supported by all data planes.
      .envoy.config.core.v3.RetryPolicy retry_policy = 2;

    • hasCacheConfig

      boolean hasCacheConfig()
       Token cache configuration. This field is optional.
      .envoy.extensions.filters.http.gcp_authn.v3.TokenCacheConfig cache_config = 3;
      Returns:
      Whether the cacheConfig field is set.

    • getCacheConfig

      TokenCacheConfig getCacheConfig()
       Token cache configuration. This field is optional.
      .envoy.extensions.filters.http.gcp_authn.v3.TokenCacheConfig cache_config = 3;
      Returns:
      The cacheConfig.

    • getCacheConfigOrBuilder

      TokenCacheConfigOrBuilder getCacheConfigOrBuilder()
       Token cache configuration. This field is optional.
      .envoy.extensions.filters.http.gcp_authn.v3.TokenCacheConfig cache_config = 3;

    • hasTokenHeader

      boolean hasTokenHeader()
       Request header location to extract the token. By default (i.e. if this field is not specified), the token
 is extracted to the Authorization HTTP header, in the format "Authorization: Bearer <token>".
 Not supported by all data planes.
      .envoy.extensions.filters.http.gcp_authn.v3.TokenHeader token_header = 4;
      Returns:
      Whether the tokenHeader field is set.

    • getTokenHeader

      TokenHeader getTokenHeader()
       Request header location to extract the token. By default (i.e. if this field is not specified), the token
 is extracted to the Authorization HTTP header, in the format "Authorization: Bearer <token>".
 Not supported by all data planes.
      .envoy.extensions.filters.http.gcp_authn.v3.TokenHeader token_header = 4;
      Returns:
      The tokenHeader.

    • getTokenHeaderOrBuilder

      TokenHeaderOrBuilder getTokenHeaderOrBuilder()
       Request header location to extract the token. By default (i.e. if this field is not specified), the token
 is extracted to the Authorization HTTP header, in the format "Authorization: Bearer <token>".
 Not supported by all data planes.
      .envoy.extensions.filters.http.gcp_authn.v3.TokenHeader token_header = 4;

    • getCluster

      String getCluster()
       Cluster to send traffic to the GCE metadata server. Not supported
 by all data planes; a data plane may instead have its own mechanism
 for contacting the metadata server.
      string cluster = 5;
      Returns:
      The cluster.

    • getClusterBytes

      com.google.protobuf.ByteString getClusterBytes()
       Cluster to send traffic to the GCE metadata server. Not supported
 by all data planes; a data plane may instead have its own mechanism
 for contacting the metadata server.
      string cluster = 5;
      Returns:
      The bytes for cluster.

    • hasTimeout

      boolean hasTimeout()
       Timeout for fetching the tokens from the GCE metadata server.
 Not supported by all data planes.
      .google.protobuf.Duration timeout = 6 [(.validate.rules) = { ... }
      Returns:
      Whether the timeout field is set.

    • getTimeout

      com.google.protobuf.Duration getTimeout()
       Timeout for fetching the tokens from the GCE metadata server.
 Not supported by all data planes.
      .google.protobuf.Duration timeout = 6 [(.validate.rules) = { ... }
      Returns:
      The timeout.

    • getTimeoutOrBuilder

      com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
       Timeout for fetching the tokens from the GCE metadata server.
 Not supported by all data planes.
      .google.protobuf.Duration timeout = 6 [(.validate.rules) = { ... }