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

Class GcpAuthnFilterConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.gcp_authn.v3.GcpAuthnFilterConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GcpAuthnFilterConfigOrBuilder, Serializable
public final class GcpAuthnFilterConfig extends com.google.protobuf.GeneratedMessageV3 implements GcpAuthnFilterConfigOrBuilder
 Filter configuration.
 [#next-free-field: 7]
Protobuf type envoy.extensions.filters.http.gcp_authn.v3.GcpAuthnFilterConfig
See Also:

  • Field Details

    • HTTP_URI_FIELD_NUMBER

      public static final int HTTP_URI_FIELD_NUMBER
      See Also:

    • RETRY_POLICY_FIELD_NUMBER

      public static final int RETRY_POLICY_FIELD_NUMBER
      See Also:

    • CACHE_CONFIG_FIELD_NUMBER

      public static final int CACHE_CONFIG_FIELD_NUMBER
      See Also:

    • TOKEN_HEADER_FIELD_NUMBER

      public static final int TOKEN_HEADER_FIELD_NUMBER
      See Also:

    • CLUSTER_FIELD_NUMBER

      public static final int CLUSTER_FIELD_NUMBER
      See Also:

    • TIMEOUT_FIELD_NUMBER

      public static final int TIMEOUT_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

    • hasHttpUri

      @Deprecated public 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"];
      Specified by:
      hasHttpUri in interface GcpAuthnFilterConfigOrBuilder
      Returns:
      Whether the httpUri field is set.

    • getHttpUri

      @Deprecated public 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"];
      Specified by:
      getHttpUri in interface GcpAuthnFilterConfigOrBuilder
      Returns:
      The httpUri.

    • getHttpUriOrBuilder

      @Deprecated public 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"];
      Specified by:
      getHttpUriOrBuilder in interface GcpAuthnFilterConfigOrBuilder

    • hasRetryPolicy

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

    • getRetryPolicy

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

    • getRetryPolicyOrBuilder

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

    • hasCacheConfig

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

    • getCacheConfig

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

    • getCacheConfigOrBuilder

      public TokenCacheConfigOrBuilder getCacheConfigOrBuilder()
       Token cache configuration. This field is optional.
      .envoy.extensions.filters.http.gcp_authn.v3.TokenCacheConfig cache_config = 3;
      Specified by:
      getCacheConfigOrBuilder in interface GcpAuthnFilterConfigOrBuilder

    • hasTokenHeader

      public 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;
      Specified by:
      hasTokenHeader in interface GcpAuthnFilterConfigOrBuilder
      Returns:
      Whether the tokenHeader field is set.

    • getTokenHeader

      public 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;
      Specified by:
      getTokenHeader in interface GcpAuthnFilterConfigOrBuilder
      Returns:
      The tokenHeader.

    • getTokenHeaderOrBuilder

      public 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;
      Specified by:
      getTokenHeaderOrBuilder in interface GcpAuthnFilterConfigOrBuilder

    • getCluster

      public 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;
      Specified by:
      getCluster in interface GcpAuthnFilterConfigOrBuilder
      Returns:
      The cluster.

    • getClusterBytes

      public 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;
      Specified by:
      getClusterBytes in interface GcpAuthnFilterConfigOrBuilder
      Returns:
      The bytes for cluster.

    • hasTimeout

      public 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) = { ... }
      Specified by:
      hasTimeout in interface GcpAuthnFilterConfigOrBuilder
      Returns:
      Whether the timeout field is set.

    • getTimeout

      public 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) = { ... }
      Specified by:
      getTimeout in interface GcpAuthnFilterConfigOrBuilder
      Returns:
      The timeout.

    • getTimeoutOrBuilder

      public 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) = { ... }
      Specified by:
      getTimeoutOrBuilder in interface GcpAuthnFilterConfigOrBuilder

    • 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 GcpAuthnFilterConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static GcpAuthnFilterConfig.Builder newBuilder()

    • newBuilder

      public static GcpAuthnFilterConfig.Builder newBuilder(GcpAuthnFilterConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static GcpAuthnFilterConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<GcpAuthnFilterConfig> 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 GcpAuthnFilterConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder