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

Class OAuth2.ClientCredentials.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<OAuth2.ClientCredentials.Builder>
io.envoyproxy.envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.ClientCredentials.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OAuth2.ClientCredentialsOrBuilder, Cloneable
Enclosing class:
OAuth2.ClientCredentials
public static final class OAuth2.ClientCredentials.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<OAuth2.ClientCredentials.Builder> implements OAuth2.ClientCredentialsOrBuilder
 Credentials to authenticate client to the authorization server.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3) for details.
Protobuf type envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.ClientCredentials

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

    • clear

      public OAuth2.ClientCredentials.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<OAuth2.ClientCredentials.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<OAuth2.ClientCredentials.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public OAuth2.ClientCredentials.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<OAuth2.ClientCredentials.Builder>

    • setField

      public OAuth2.ClientCredentials.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<OAuth2.ClientCredentials.Builder>

    • clearField

      public OAuth2.ClientCredentials.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<OAuth2.ClientCredentials.Builder>

    • clearOneof

      public OAuth2.ClientCredentials.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<OAuth2.ClientCredentials.Builder>

    • setRepeatedField

      public OAuth2.ClientCredentials.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<OAuth2.ClientCredentials.Builder>

    • addRepeatedField

      public OAuth2.ClientCredentials.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<OAuth2.ClientCredentials.Builder>

    • mergeFrom

      public OAuth2.ClientCredentials.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<OAuth2.ClientCredentials.Builder>

    • mergeFrom

      public OAuth2.ClientCredentials.Builder mergeFrom(OAuth2.ClientCredentials other)

    • isInitialized

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

    • mergeFrom

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

    • getClientId

      public String getClientId()
       Client ID.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      string client_id = 1 [(.validate.rules) = { ... }
      Specified by:
      getClientId in interface OAuth2.ClientCredentialsOrBuilder
      Returns:
      The clientId.

    • getClientIdBytes

      public com.google.protobuf.ByteString getClientIdBytes()
       Client ID.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      string client_id = 1 [(.validate.rules) = { ... }
      Specified by:
      getClientIdBytes in interface OAuth2.ClientCredentialsOrBuilder
      Returns:
      The bytes for clientId.

    • setClientId

      public OAuth2.ClientCredentials.Builder setClientId(String value)
       Client ID.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      string client_id = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The clientId to set.
      Returns:
      This builder for chaining.

    • clearClientId

      public OAuth2.ClientCredentials.Builder clearClientId()
       Client ID.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      string client_id = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setClientIdBytes

      public OAuth2.ClientCredentials.Builder setClientIdBytes(com.google.protobuf.ByteString value)
       Client ID.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      string client_id = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for clientId to set.
      Returns:
      This builder for chaining.

    • hasClientSecret

      public boolean hasClientSecret()
       Client secret.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig client_secret = 2 [(.validate.rules) = { ... }
      Specified by:
      hasClientSecret in interface OAuth2.ClientCredentialsOrBuilder
      Returns:
      Whether the clientSecret field is set.

    • getClientSecret

      public SdsSecretConfig getClientSecret()
       Client secret.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig client_secret = 2 [(.validate.rules) = { ... }
      Specified by:
      getClientSecret in interface OAuth2.ClientCredentialsOrBuilder
      Returns:
      The clientSecret.

    • setClientSecret

      public OAuth2.ClientCredentials.Builder setClientSecret(SdsSecretConfig value)
       Client secret.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig client_secret = 2 [(.validate.rules) = { ... }

    • setClientSecret

      public OAuth2.ClientCredentials.Builder setClientSecret(SdsSecretConfig.Builder builderForValue)
       Client secret.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig client_secret = 2 [(.validate.rules) = { ... }

    • mergeClientSecret

      public OAuth2.ClientCredentials.Builder mergeClientSecret(SdsSecretConfig value)
       Client secret.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig client_secret = 2 [(.validate.rules) = { ... }

    • clearClientSecret

      public OAuth2.ClientCredentials.Builder clearClientSecret()
       Client secret.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig client_secret = 2 [(.validate.rules) = { ... }

    • getClientSecretBuilder

      public SdsSecretConfig.Builder getClientSecretBuilder()
       Client secret.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig client_secret = 2 [(.validate.rules) = { ... }

    • getClientSecretOrBuilder

      public SdsSecretConfigOrBuilder getClientSecretOrBuilder()
       Client secret.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig client_secret = 2 [(.validate.rules) = { ... }
      Specified by:
      getClientSecretOrBuilder in interface OAuth2.ClientCredentialsOrBuilder

    • getAuthTypeValue

      public int getAuthTypeValue()
       The method to use when sending credentials to the authorization server.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.AuthType auth_type = 3;
      Specified by:
      getAuthTypeValue in interface OAuth2.ClientCredentialsOrBuilder
      Returns:
      The enum numeric value on the wire for authType.

    • setAuthTypeValue

      public OAuth2.ClientCredentials.Builder setAuthTypeValue(int value)
       The method to use when sending credentials to the authorization server.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.AuthType auth_type = 3;
      Parameters:
      value - The enum numeric value on the wire for authType to set.
      Returns:
      This builder for chaining.

    • getAuthType

      public OAuth2.AuthType getAuthType()
       The method to use when sending credentials to the authorization server.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.AuthType auth_type = 3;
      Specified by:
      getAuthType in interface OAuth2.ClientCredentialsOrBuilder
      Returns:
      The authType.

    • setAuthType

      public OAuth2.ClientCredentials.Builder setAuthType(OAuth2.AuthType value)
       The method to use when sending credentials to the authorization server.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.AuthType auth_type = 3;
      Parameters:
      value - The authType to set.
      Returns:
      This builder for chaining.

    • clearAuthType

      public OAuth2.ClientCredentials.Builder clearAuthType()
       The method to use when sending credentials to the authorization server.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.AuthType auth_type = 3;
      Returns:
      This builder for chaining.

    • setUnknownFields

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

    • mergeUnknownFields

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