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

Class OAuth2.ClientCredentials

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.ClientCredentials
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OAuth2.ClientCredentialsOrBuilder, Serializable
Enclosing class:
OAuth2
public static final class OAuth2.ClientCredentials extends com.google.protobuf.GeneratedMessageV3 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
See Also:

  • Field Details

    • CLIENT_ID_FIELD_NUMBER

      public static final int CLIENT_ID_FIELD_NUMBER
      See Also:

    • CLIENT_SECRET_FIELD_NUMBER

      public static final int CLIENT_SECRET_FIELD_NUMBER
      See Also:

    • AUTH_TYPE_FIELD_NUMBER

      public static final int AUTH_TYPE_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

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

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

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

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

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static OAuth2.ClientCredentials parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OAuth2.ClientCredentials parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OAuth2.ClientCredentials parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OAuth2.ClientCredentials parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OAuth2.ClientCredentials parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OAuth2.ClientCredentials parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OAuth2.ClientCredentials parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OAuth2.ClientCredentials parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static OAuth2.ClientCredentials parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static OAuth2.ClientCredentials parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OAuth2.ClientCredentials parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OAuth2.ClientCredentials parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static OAuth2.ClientCredentials.Builder newBuilder()

    • newBuilder

      public static OAuth2.ClientCredentials.Builder newBuilder(OAuth2.ClientCredentials prototype)

    • toBuilder

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

    • newBuilderForType

      protected OAuth2.ClientCredentials.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static OAuth2.ClientCredentials getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<OAuth2.ClientCredentials> parser()

    • getParserForType

      public com.google.protobuf.Parser<OAuth2.ClientCredentials> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

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