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

Class OAuth2Credentials.CookieNames.Builder

    • Method Detail

      • 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>

      • 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

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.