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

Class OAuth2Credentials.Builder

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

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public OAuth2Credentials.Builder mergeFrom(OAuth2Credentials 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.Builder>

    • mergeFrom

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

    • getTokenFormationCase

      public OAuth2Credentials.TokenFormationCase getTokenFormationCase()
      Specified by:
      getTokenFormationCase in interface OAuth2CredentialsOrBuilder

    • clearTokenFormation

      public OAuth2Credentials.Builder clearTokenFormation()

    • getClientId

      public String getClientId()
       The client_id to be used in the authorize calls. This value will be URL encoded when sent to the OAuth server.
      string client_id = 1 [(.validate.rules) = { ... }
      Specified by:
      getClientId in interface OAuth2CredentialsOrBuilder
      Returns:
      The clientId.

    • getClientIdBytes

      public com.google.protobuf.ByteString getClientIdBytes()
       The client_id to be used in the authorize calls. This value will be URL encoded when sent to the OAuth server.
      string client_id = 1 [(.validate.rules) = { ... }
      Specified by:
      getClientIdBytes in interface OAuth2CredentialsOrBuilder
      Returns:
      The bytes for clientId.

    • setClientId

      public OAuth2Credentials.Builder setClientId(String value)
       The client_id to be used in the authorize calls. This value will be URL encoded when sent to the OAuth server.
      string client_id = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The clientId to set.
      Returns:
      This builder for chaining.

    • clearClientId

      public OAuth2Credentials.Builder clearClientId()
       The client_id to be used in the authorize calls. This value will be URL encoded when sent to the OAuth server.
      string client_id = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setClientIdBytes

      public OAuth2Credentials.Builder setClientIdBytes(com.google.protobuf.ByteString value)
       The client_id to be used in the authorize calls. This value will be URL encoded when sent to the OAuth server.
      string client_id = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for clientId to set.
      Returns:
      This builder for chaining.

    • hasTokenSecret

      public boolean hasTokenSecret()
       The secret used to retrieve the access token. This value will be URL encoded when sent to the OAuth server.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig token_secret = 2 [(.validate.rules) = { ... }
      Specified by:
      hasTokenSecret in interface OAuth2CredentialsOrBuilder
      Returns:
      Whether the tokenSecret field is set.

    • getTokenSecret

      public SdsSecretConfig getTokenSecret()
       The secret used to retrieve the access token. This value will be URL encoded when sent to the OAuth server.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig token_secret = 2 [(.validate.rules) = { ... }
      Specified by:
      getTokenSecret in interface OAuth2CredentialsOrBuilder
      Returns:
      The tokenSecret.

    • setTokenSecret

      public OAuth2Credentials.Builder setTokenSecret(SdsSecretConfig value)
       The secret used to retrieve the access token. This value will be URL encoded when sent to the OAuth server.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig token_secret = 2 [(.validate.rules) = { ... }

    • setTokenSecret

      public OAuth2Credentials.Builder setTokenSecret(SdsSecretConfig.Builder builderForValue)
       The secret used to retrieve the access token. This value will be URL encoded when sent to the OAuth server.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig token_secret = 2 [(.validate.rules) = { ... }

    • mergeTokenSecret

      public OAuth2Credentials.Builder mergeTokenSecret(SdsSecretConfig value)
       The secret used to retrieve the access token. This value will be URL encoded when sent to the OAuth server.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig token_secret = 2 [(.validate.rules) = { ... }

    • clearTokenSecret

      public OAuth2Credentials.Builder clearTokenSecret()
       The secret used to retrieve the access token. This value will be URL encoded when sent to the OAuth server.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig token_secret = 2 [(.validate.rules) = { ... }

    • getTokenSecretBuilder

      public SdsSecretConfig.Builder getTokenSecretBuilder()
       The secret used to retrieve the access token. This value will be URL encoded when sent to the OAuth server.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig token_secret = 2 [(.validate.rules) = { ... }

    • getTokenSecretOrBuilder

      public SdsSecretConfigOrBuilder getTokenSecretOrBuilder()
       The secret used to retrieve the access token. This value will be URL encoded when sent to the OAuth server.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig token_secret = 2 [(.validate.rules) = { ... }
      Specified by:
      getTokenSecretOrBuilder in interface OAuth2CredentialsOrBuilder

    • hasHmacSecret

      public boolean hasHmacSecret()
       If present, the secret token will be a HMAC using the provided secret.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig hmac_secret = 3 [(.validate.rules) = { ... }
      Specified by:
      hasHmacSecret in interface OAuth2CredentialsOrBuilder
      Returns:
      Whether the hmacSecret field is set.

    • getHmacSecret

      public SdsSecretConfig getHmacSecret()
       If present, the secret token will be a HMAC using the provided secret.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig hmac_secret = 3 [(.validate.rules) = { ... }
      Specified by:
      getHmacSecret in interface OAuth2CredentialsOrBuilder
      Returns:
      The hmacSecret.

    • setHmacSecret

      public OAuth2Credentials.Builder setHmacSecret(SdsSecretConfig value)
       If present, the secret token will be a HMAC using the provided secret.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig hmac_secret = 3 [(.validate.rules) = { ... }

    • setHmacSecret

      public OAuth2Credentials.Builder setHmacSecret(SdsSecretConfig.Builder builderForValue)
       If present, the secret token will be a HMAC using the provided secret.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig hmac_secret = 3 [(.validate.rules) = { ... }

    • mergeHmacSecret

      public OAuth2Credentials.Builder mergeHmacSecret(SdsSecretConfig value)
       If present, the secret token will be a HMAC using the provided secret.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig hmac_secret = 3 [(.validate.rules) = { ... }

    • clearHmacSecret

      public OAuth2Credentials.Builder clearHmacSecret()
       If present, the secret token will be a HMAC using the provided secret.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig hmac_secret = 3 [(.validate.rules) = { ... }

    • getHmacSecretBuilder

      public SdsSecretConfig.Builder getHmacSecretBuilder()
       If present, the secret token will be a HMAC using the provided secret.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig hmac_secret = 3 [(.validate.rules) = { ... }

    • getHmacSecretOrBuilder

      public SdsSecretConfigOrBuilder getHmacSecretOrBuilder()
       If present, the secret token will be a HMAC using the provided secret.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig hmac_secret = 3 [(.validate.rules) = { ... }
      Specified by:
      getHmacSecretOrBuilder in interface OAuth2CredentialsOrBuilder

    • hasCookieNames

      public boolean hasCookieNames()
       The cookie names used in OAuth filters flow.
      .envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials.CookieNames cookie_names = 4;
      Specified by:
      hasCookieNames in interface OAuth2CredentialsOrBuilder
      Returns:
      Whether the cookieNames field is set.

    • getCookieNames

      public OAuth2Credentials.CookieNames getCookieNames()
       The cookie names used in OAuth filters flow.
      .envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials.CookieNames cookie_names = 4;
      Specified by:
      getCookieNames in interface OAuth2CredentialsOrBuilder
      Returns:
      The cookieNames.

    • setCookieNames

      public OAuth2Credentials.Builder setCookieNames(OAuth2Credentials.CookieNames value)
       The cookie names used in OAuth filters flow.
      .envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials.CookieNames cookie_names = 4;

    • setCookieNames

      public OAuth2Credentials.Builder setCookieNames(OAuth2Credentials.CookieNames.Builder builderForValue)
       The cookie names used in OAuth filters flow.
      .envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials.CookieNames cookie_names = 4;

    • mergeCookieNames

      public OAuth2Credentials.Builder mergeCookieNames(OAuth2Credentials.CookieNames value)
       The cookie names used in OAuth filters flow.
      .envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials.CookieNames cookie_names = 4;

    • clearCookieNames

      public OAuth2Credentials.Builder clearCookieNames()
       The cookie names used in OAuth filters flow.
      .envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials.CookieNames cookie_names = 4;

    • getCookieNamesBuilder

      public OAuth2Credentials.CookieNames.Builder getCookieNamesBuilder()
       The cookie names used in OAuth filters flow.
      .envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials.CookieNames cookie_names = 4;

    • getCookieNamesOrBuilder

      public OAuth2Credentials.CookieNamesOrBuilder getCookieNamesOrBuilder()
       The cookie names used in OAuth filters flow.
      .envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials.CookieNames cookie_names = 4;
      Specified by:
      getCookieNamesOrBuilder in interface OAuth2CredentialsOrBuilder

    • getCookieDomain

      public String getCookieDomain()
       The domain to set the cookie on. If not set, the cookie will default to the host of the request, not including the subdomains.
 This is useful when token cookies need to be shared across multiple subdomains.
      string cookie_domain = 5 [(.validate.rules) = { ... }
      Specified by:
      getCookieDomain in interface OAuth2CredentialsOrBuilder
      Returns:
      The cookieDomain.

    • getCookieDomainBytes

      public com.google.protobuf.ByteString getCookieDomainBytes()
       The domain to set the cookie on. If not set, the cookie will default to the host of the request, not including the subdomains.
 This is useful when token cookies need to be shared across multiple subdomains.
      string cookie_domain = 5 [(.validate.rules) = { ... }
      Specified by:
      getCookieDomainBytes in interface OAuth2CredentialsOrBuilder
      Returns:
      The bytes for cookieDomain.

    • setCookieDomain

      public OAuth2Credentials.Builder setCookieDomain(String value)
       The domain to set the cookie on. If not set, the cookie will default to the host of the request, not including the subdomains.
 This is useful when token cookies need to be shared across multiple subdomains.
      string cookie_domain = 5 [(.validate.rules) = { ... }
      Parameters:
      value - The cookieDomain to set.
      Returns:
      This builder for chaining.

    • clearCookieDomain

      public OAuth2Credentials.Builder clearCookieDomain()
       The domain to set the cookie on. If not set, the cookie will default to the host of the request, not including the subdomains.
 This is useful when token cookies need to be shared across multiple subdomains.
      string cookie_domain = 5 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setCookieDomainBytes

      public OAuth2Credentials.Builder setCookieDomainBytes(com.google.protobuf.ByteString value)
       The domain to set the cookie on. If not set, the cookie will default to the host of the request, not including the subdomains.
 This is useful when token cookies need to be shared across multiple subdomains.
      string cookie_domain = 5 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for cookieDomain to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

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

    • mergeUnknownFields

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