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

Class CookieConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<CookieConfig.Builder>
io.envoyproxy.envoy.extensions.filters.http.oauth2.v3.CookieConfig.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CookieConfigOrBuilder, Cloneable
Enclosing class:
CookieConfig
public static final class CookieConfig.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<CookieConfig.Builder> implements CookieConfigOrBuilder
 OAuth cookie configuration attributes.
Protobuf type envoy.extensions.filters.http.oauth2.v3.CookieConfig

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

    • clear

      public CookieConfig.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<CookieConfig.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<CookieConfig.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public CookieConfig.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<CookieConfig.Builder>

    • setField

      public CookieConfig.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<CookieConfig.Builder>

    • clearField

      public CookieConfig.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<CookieConfig.Builder>

    • clearOneof

      public CookieConfig.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<CookieConfig.Builder>

    • setRepeatedField

      public CookieConfig.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<CookieConfig.Builder>

    • addRepeatedField

      public CookieConfig.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<CookieConfig.Builder>

    • mergeFrom

      public CookieConfig.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<CookieConfig.Builder>

    • mergeFrom

      public CookieConfig.Builder mergeFrom(CookieConfig other)

    • isInitialized

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

    • mergeFrom

      public CookieConfig.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<CookieConfig.Builder>
      Throws:
      IOException

    • getSameSiteValue

      public int getSameSiteValue()
       The value used for the SameSite cookie attribute.
      .envoy.extensions.filters.http.oauth2.v3.CookieConfig.SameSite same_site = 1 [(.validate.rules) = { ... }
      Specified by:
      getSameSiteValue in interface CookieConfigOrBuilder
      Returns:
      The enum numeric value on the wire for sameSite.

    • setSameSiteValue

      public CookieConfig.Builder setSameSiteValue(int value)
       The value used for the SameSite cookie attribute.
      .envoy.extensions.filters.http.oauth2.v3.CookieConfig.SameSite same_site = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The enum numeric value on the wire for sameSite to set.
      Returns:
      This builder for chaining.

    • getSameSite

      public CookieConfig.SameSite getSameSite()
       The value used for the SameSite cookie attribute.
      .envoy.extensions.filters.http.oauth2.v3.CookieConfig.SameSite same_site = 1 [(.validate.rules) = { ... }
      Specified by:
      getSameSite in interface CookieConfigOrBuilder
      Returns:
      The sameSite.

    • setSameSite

      public CookieConfig.Builder setSameSite(CookieConfig.SameSite value)
       The value used for the SameSite cookie attribute.
      .envoy.extensions.filters.http.oauth2.v3.CookieConfig.SameSite same_site = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The sameSite to set.
      Returns:
      This builder for chaining.

    • clearSameSite

      public CookieConfig.Builder clearSameSite()
       The value used for the SameSite cookie attribute.
      .envoy.extensions.filters.http.oauth2.v3.CookieConfig.SameSite same_site = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • getPath

      public String getPath()
       The path attribute for the cookie.

 This controls the scope of the cookie and is useful for path-based routing scenarios
 where different logical boundaries or applications may operate with different OAuth2 clients.
 The CSRF cookie (nonce cookie) can be configured with a different path than session cookies
 to support flows where the callback URL is on a different path.

 If not specified, defaults to ``/``.
      string path = 2 [(.validate.rules) = { ... }
      Specified by:
      getPath in interface CookieConfigOrBuilder
      Returns:
      The path.

    • getPathBytes

      public com.google.protobuf.ByteString getPathBytes()
       The path attribute for the cookie.

 This controls the scope of the cookie and is useful for path-based routing scenarios
 where different logical boundaries or applications may operate with different OAuth2 clients.
 The CSRF cookie (nonce cookie) can be configured with a different path than session cookies
 to support flows where the callback URL is on a different path.

 If not specified, defaults to ``/``.
      string path = 2 [(.validate.rules) = { ... }
      Specified by:
      getPathBytes in interface CookieConfigOrBuilder
      Returns:
      The bytes for path.

    • setPath

      public CookieConfig.Builder setPath(String value)
       The path attribute for the cookie.

 This controls the scope of the cookie and is useful for path-based routing scenarios
 where different logical boundaries or applications may operate with different OAuth2 clients.
 The CSRF cookie (nonce cookie) can be configured with a different path than session cookies
 to support flows where the callback URL is on a different path.

 If not specified, defaults to ``/``.
      string path = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The path to set.
      Returns:
      This builder for chaining.

    • clearPath

      public CookieConfig.Builder clearPath()
       The path attribute for the cookie.

 This controls the scope of the cookie and is useful for path-based routing scenarios
 where different logical boundaries or applications may operate with different OAuth2 clients.
 The CSRF cookie (nonce cookie) can be configured with a different path than session cookies
 to support flows where the callback URL is on a different path.

 If not specified, defaults to ``/``.
      string path = 2 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setPathBytes

      public CookieConfig.Builder setPathBytes(com.google.protobuf.ByteString value)
       The path attribute for the cookie.

 This controls the scope of the cookie and is useful for path-based routing scenarios
 where different logical boundaries or applications may operate with different OAuth2 clients.
 The CSRF cookie (nonce cookie) can be configured with a different path than session cookies
 to support flows where the callback URL is on a different path.

 If not specified, defaults to ``/``.
      string path = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for path to set.
      Returns:
      This builder for chaining.

    • getPartitioned

      public boolean getPartitioned()
       If true, the ``Partitioned`` attribute will be set on the cookie.

 Modern browsers (Firefox, Chrome with third-party cookie deprecation) warn or block
 "foreign" cookies unless they carry the ``Partitioned`` attribute alongside ``SameSite=None; Secure``.
 When Envoy is used in a gateway/IdP flow that sets OAuth/OIDC cookies for a parent domain
 (e.g., ``Domain=.example.com``) while running on a different host, those cookies are
 considered third-party and will be rejected without ``Partitioned``.

 See `CHIPS <https://developers.google.com/privacy-sandbox/3pcd/chips>`_ for more information.

 Default is false.
      bool partitioned = 3;
      Specified by:
      getPartitioned in interface CookieConfigOrBuilder
      Returns:
      The partitioned.

    • setPartitioned

      public CookieConfig.Builder setPartitioned(boolean value)
       If true, the ``Partitioned`` attribute will be set on the cookie.

 Modern browsers (Firefox, Chrome with third-party cookie deprecation) warn or block
 "foreign" cookies unless they carry the ``Partitioned`` attribute alongside ``SameSite=None; Secure``.
 When Envoy is used in a gateway/IdP flow that sets OAuth/OIDC cookies for a parent domain
 (e.g., ``Domain=.example.com``) while running on a different host, those cookies are
 considered third-party and will be rejected without ``Partitioned``.

 See `CHIPS <https://developers.google.com/privacy-sandbox/3pcd/chips>`_ for more information.

 Default is false.
      bool partitioned = 3;
      Parameters:
      value - The partitioned to set.
      Returns:
      This builder for chaining.

    • clearPartitioned

      public CookieConfig.Builder clearPartitioned()
       If true, the ``Partitioned`` attribute will be set on the cookie.

 Modern browsers (Firefox, Chrome with third-party cookie deprecation) warn or block
 "foreign" cookies unless they carry the ``Partitioned`` attribute alongside ``SameSite=None; Secure``.
 When Envoy is used in a gateway/IdP flow that sets OAuth/OIDC cookies for a parent domain
 (e.g., ``Domain=.example.com``) while running on a different host, those cookies are
 considered third-party and will be rejected without ``Partitioned``.

 See `CHIPS <https://developers.google.com/privacy-sandbox/3pcd/chips>`_ for more information.

 Default is false.
      bool partitioned = 3;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final CookieConfig.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<CookieConfig.Builder>

    • mergeUnknownFields

      public final CookieConfig.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<CookieConfig.Builder>