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

Class OAuth2Credentials.CookieNames.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Credentials.CookieNames.Builder>
io.envoyproxy.envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials.CookieNames.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OAuth2Credentials.CookieNamesOrBuilder, Cloneable
Enclosing class:
OAuth2Credentials.CookieNames
public static final class OAuth2Credentials.CookieNames.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Credentials.CookieNames.Builder> implements OAuth2Credentials.CookieNamesOrBuilder
 [#next-free-field: 8]
Protobuf type envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials.CookieNames

  • Method Details

    • 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.Builder<OAuth2Credentials.CookieNames.Builder>

    • clear

      public OAuth2Credentials.CookieNames.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Credentials.CookieNames.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Credentials.CookieNames.Builder>

    • getDefaultInstanceForType

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

    • build

      public OAuth2Credentials.CookieNames build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public OAuth2Credentials.CookieNames buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public OAuth2Credentials.CookieNames.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Credentials.CookieNames.Builder>

    • setField

      public OAuth2Credentials.CookieNames.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Credentials.CookieNames.Builder>

    • clearField

      public OAuth2Credentials.CookieNames.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Credentials.CookieNames.Builder>

    • clearOneof

      public OAuth2Credentials.CookieNames.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Credentials.CookieNames.Builder>

    • setRepeatedField

      public OAuth2Credentials.CookieNames.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Credentials.CookieNames.Builder>

    • addRepeatedField

      public OAuth2Credentials.CookieNames.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Credentials.CookieNames.Builder>

    • mergeFrom

      public OAuth2Credentials.CookieNames.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OAuth2Credentials.CookieNames.Builder>

    • mergeFrom

      public OAuth2Credentials.CookieNames.Builder mergeFrom(OAuth2Credentials.CookieNames other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Credentials.CookieNames.Builder>

    • mergeFrom

      public OAuth2Credentials.CookieNames.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OAuth2Credentials.CookieNames.Builder>
      Throws:
      IOException

    • getBearerToken

      public String getBearerToken()
       Cookie name to hold OAuth bearer token value. When the authentication server validates the
 client and returns an authorization token back to the OAuth filter, no matter what format
 that token is, if :ref:`forward_bearer_token <envoy_v3_api_field_extensions.filters.http.oauth2.v3.OAuth2Config.forward_bearer_token>`
 is set to true the filter will send over the bearer token as a cookie with this name to the
 upstream. Defaults to ``BearerToken``.
      string bearer_token = 1 [(.validate.rules) = { ... }
      Specified by:
      getBearerToken in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The bearerToken.

    • getBearerTokenBytes

      public com.google.protobuf.ByteString getBearerTokenBytes()
       Cookie name to hold OAuth bearer token value. When the authentication server validates the
 client and returns an authorization token back to the OAuth filter, no matter what format
 that token is, if :ref:`forward_bearer_token <envoy_v3_api_field_extensions.filters.http.oauth2.v3.OAuth2Config.forward_bearer_token>`
 is set to true the filter will send over the bearer token as a cookie with this name to the
 upstream. Defaults to ``BearerToken``.
      string bearer_token = 1 [(.validate.rules) = { ... }
      Specified by:
      getBearerTokenBytes in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The bytes for bearerToken.

    • setBearerToken

      public OAuth2Credentials.CookieNames.Builder setBearerToken(String value)
       Cookie name to hold OAuth bearer token value. When the authentication server validates the
 client and returns an authorization token back to the OAuth filter, no matter what format
 that token is, if :ref:`forward_bearer_token <envoy_v3_api_field_extensions.filters.http.oauth2.v3.OAuth2Config.forward_bearer_token>`
 is set to true the filter will send over the bearer token as a cookie with this name to the
 upstream. Defaults to ``BearerToken``.
      string bearer_token = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The bearerToken to set.
      Returns:
      This builder for chaining.

    • clearBearerToken

      public OAuth2Credentials.CookieNames.Builder clearBearerToken()
       Cookie name to hold OAuth bearer token value. When the authentication server validates the
 client and returns an authorization token back to the OAuth filter, no matter what format
 that token is, if :ref:`forward_bearer_token <envoy_v3_api_field_extensions.filters.http.oauth2.v3.OAuth2Config.forward_bearer_token>`
 is set to true the filter will send over the bearer token as a cookie with this name to the
 upstream. Defaults to ``BearerToken``.
      string bearer_token = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setBearerTokenBytes

      public OAuth2Credentials.CookieNames.Builder setBearerTokenBytes(com.google.protobuf.ByteString value)
       Cookie name to hold OAuth bearer token value. When the authentication server validates the
 client and returns an authorization token back to the OAuth filter, no matter what format
 that token is, if :ref:`forward_bearer_token <envoy_v3_api_field_extensions.filters.http.oauth2.v3.OAuth2Config.forward_bearer_token>`
 is set to true the filter will send over the bearer token as a cookie with this name to the
 upstream. Defaults to ``BearerToken``.
      string bearer_token = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for bearerToken to set.
      Returns:
      This builder for chaining.

    • getOauthHmac

      public String getOauthHmac()
       Cookie name to hold OAuth HMAC value. Defaults to ``OauthHMAC``.
      string oauth_hmac = 2 [(.validate.rules) = { ... }
      Specified by:
      getOauthHmac in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The oauthHmac.

    • getOauthHmacBytes

      public com.google.protobuf.ByteString getOauthHmacBytes()
       Cookie name to hold OAuth HMAC value. Defaults to ``OauthHMAC``.
      string oauth_hmac = 2 [(.validate.rules) = { ... }
      Specified by:
      getOauthHmacBytes in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The bytes for oauthHmac.

    • setOauthHmac

      public OAuth2Credentials.CookieNames.Builder setOauthHmac(String value)
       Cookie name to hold OAuth HMAC value. Defaults to ``OauthHMAC``.
      string oauth_hmac = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The oauthHmac to set.
      Returns:
      This builder for chaining.

    • clearOauthHmac

      public OAuth2Credentials.CookieNames.Builder clearOauthHmac()
       Cookie name to hold OAuth HMAC value. Defaults to ``OauthHMAC``.
      string oauth_hmac = 2 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setOauthHmacBytes

      public OAuth2Credentials.CookieNames.Builder setOauthHmacBytes(com.google.protobuf.ByteString value)
       Cookie name to hold OAuth HMAC value. Defaults to ``OauthHMAC``.
      string oauth_hmac = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for oauthHmac to set.
      Returns:
      This builder for chaining.

    • getOauthExpires

      public String getOauthExpires()
       Cookie name to hold OAuth expiry value. Defaults to ``OauthExpires``.
      string oauth_expires = 3 [(.validate.rules) = { ... }
      Specified by:
      getOauthExpires in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The oauthExpires.

    • getOauthExpiresBytes

      public com.google.protobuf.ByteString getOauthExpiresBytes()
       Cookie name to hold OAuth expiry value. Defaults to ``OauthExpires``.
      string oauth_expires = 3 [(.validate.rules) = { ... }
      Specified by:
      getOauthExpiresBytes in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The bytes for oauthExpires.

    • setOauthExpires

      public OAuth2Credentials.CookieNames.Builder setOauthExpires(String value)
       Cookie name to hold OAuth expiry value. Defaults to ``OauthExpires``.
      string oauth_expires = 3 [(.validate.rules) = { ... }
      Parameters:
      value - The oauthExpires to set.
      Returns:
      This builder for chaining.

    • clearOauthExpires

      public OAuth2Credentials.CookieNames.Builder clearOauthExpires()
       Cookie name to hold OAuth expiry value. Defaults to ``OauthExpires``.
      string oauth_expires = 3 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setOauthExpiresBytes

      public OAuth2Credentials.CookieNames.Builder setOauthExpiresBytes(com.google.protobuf.ByteString value)
       Cookie name to hold OAuth expiry value. Defaults to ``OauthExpires``.
      string oauth_expires = 3 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for oauthExpires to set.
      Returns:
      This builder for chaining.

    • getIdToken

      public String getIdToken()
       Cookie name to hold the id token. Defaults to ``IdToken``.
      string id_token = 4 [(.validate.rules) = { ... }
      Specified by:
      getIdToken in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The idToken.

    • getIdTokenBytes

      public com.google.protobuf.ByteString getIdTokenBytes()
       Cookie name to hold the id token. Defaults to ``IdToken``.
      string id_token = 4 [(.validate.rules) = { ... }
      Specified by:
      getIdTokenBytes in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The bytes for idToken.

    • setIdToken

      public OAuth2Credentials.CookieNames.Builder setIdToken(String value)
       Cookie name to hold the id token. Defaults to ``IdToken``.
      string id_token = 4 [(.validate.rules) = { ... }
      Parameters:
      value - The idToken to set.
      Returns:
      This builder for chaining.

    • clearIdToken

      public OAuth2Credentials.CookieNames.Builder clearIdToken()
       Cookie name to hold the id token. Defaults to ``IdToken``.
      string id_token = 4 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setIdTokenBytes

      public OAuth2Credentials.CookieNames.Builder setIdTokenBytes(com.google.protobuf.ByteString value)
       Cookie name to hold the id token. Defaults to ``IdToken``.
      string id_token = 4 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for idToken to set.
      Returns:
      This builder for chaining.

    • getRefreshToken

      public String getRefreshToken()
       Cookie name to hold the refresh token. Defaults to ``RefreshToken``.
      string refresh_token = 5 [(.validate.rules) = { ... }
      Specified by:
      getRefreshToken in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The refreshToken.

    • getRefreshTokenBytes

      public com.google.protobuf.ByteString getRefreshTokenBytes()
       Cookie name to hold the refresh token. Defaults to ``RefreshToken``.
      string refresh_token = 5 [(.validate.rules) = { ... }
      Specified by:
      getRefreshTokenBytes in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The bytes for refreshToken.

    • setRefreshToken

      public OAuth2Credentials.CookieNames.Builder setRefreshToken(String value)
       Cookie name to hold the refresh token. Defaults to ``RefreshToken``.
      string refresh_token = 5 [(.validate.rules) = { ... }
      Parameters:
      value - The refreshToken to set.
      Returns:
      This builder for chaining.

    • clearRefreshToken

      public OAuth2Credentials.CookieNames.Builder clearRefreshToken()
       Cookie name to hold the refresh token. Defaults to ``RefreshToken``.
      string refresh_token = 5 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setRefreshTokenBytes

      public OAuth2Credentials.CookieNames.Builder setRefreshTokenBytes(com.google.protobuf.ByteString value)
       Cookie name to hold the refresh token. Defaults to ``RefreshToken``.
      string refresh_token = 5 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for refreshToken to set.
      Returns:
      This builder for chaining.

    • getOauthNonce

      public String getOauthNonce()
       Cookie name to hold the nonce value. Defaults to ``OauthNonce``.
      string oauth_nonce = 6 [(.validate.rules) = { ... }
      Specified by:
      getOauthNonce in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The oauthNonce.

    • getOauthNonceBytes

      public com.google.protobuf.ByteString getOauthNonceBytes()
       Cookie name to hold the nonce value. Defaults to ``OauthNonce``.
      string oauth_nonce = 6 [(.validate.rules) = { ... }
      Specified by:
      getOauthNonceBytes in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The bytes for oauthNonce.

    • setOauthNonce

      public OAuth2Credentials.CookieNames.Builder setOauthNonce(String value)
       Cookie name to hold the nonce value. Defaults to ``OauthNonce``.
      string oauth_nonce = 6 [(.validate.rules) = { ... }
      Parameters:
      value - The oauthNonce to set.
      Returns:
      This builder for chaining.

    • clearOauthNonce

      public OAuth2Credentials.CookieNames.Builder clearOauthNonce()
       Cookie name to hold the nonce value. Defaults to ``OauthNonce``.
      string oauth_nonce = 6 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setOauthNonceBytes

      public OAuth2Credentials.CookieNames.Builder setOauthNonceBytes(com.google.protobuf.ByteString value)
       Cookie name to hold the nonce value. Defaults to ``OauthNonce``.
      string oauth_nonce = 6 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for oauthNonce to set.
      Returns:
      This builder for chaining.

    • getCodeVerifier

      public String getCodeVerifier()
       Cookie name to hold the PKCE code verifier. Defaults to ``OauthCodeVerifier``.
      string code_verifier = 7 [(.validate.rules) = { ... }
      Specified by:
      getCodeVerifier in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The codeVerifier.

    • getCodeVerifierBytes

      public com.google.protobuf.ByteString getCodeVerifierBytes()
       Cookie name to hold the PKCE code verifier. Defaults to ``OauthCodeVerifier``.
      string code_verifier = 7 [(.validate.rules) = { ... }
      Specified by:
      getCodeVerifierBytes in interface OAuth2Credentials.CookieNamesOrBuilder
      Returns:
      The bytes for codeVerifier.

    • setCodeVerifier

      public OAuth2Credentials.CookieNames.Builder setCodeVerifier(String value)
       Cookie name to hold the PKCE code verifier. Defaults to ``OauthCodeVerifier``.
      string code_verifier = 7 [(.validate.rules) = { ... }
      Parameters:
      value - The codeVerifier to set.
      Returns:
      This builder for chaining.

    • clearCodeVerifier

      public OAuth2Credentials.CookieNames.Builder clearCodeVerifier()
       Cookie name to hold the PKCE code verifier. Defaults to ``OauthCodeVerifier``.
      string code_verifier = 7 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setCodeVerifierBytes

      public OAuth2Credentials.CookieNames.Builder setCodeVerifierBytes(com.google.protobuf.ByteString value)
       Cookie name to hold the PKCE code verifier. Defaults to ``OauthCodeVerifier``.
      string code_verifier = 7 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for codeVerifier to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final OAuth2Credentials.CookieNames.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Credentials.CookieNames.Builder>

    • mergeUnknownFields

      public final OAuth2Credentials.CookieNames.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Credentials.CookieNames.Builder>