Class KafkaClusterSaslOAuthBearerAuthentication

java.lang.Object
software.amazon.awssdk.services.kafka.model.KafkaClusterSaslOAuthBearerAuthentication
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<KafkaClusterSaslOAuthBearerAuthentication.Builder,KafkaClusterSaslOAuthBearerAuthentication>
@Generated("software.amazon.awssdk:codegen") public final class KafkaClusterSaslOAuthBearerAuthentication extends Object implements SdkPojo, Serializable, ToCopyableBuilder<KafkaClusterSaslOAuthBearerAuthentication.Builder,KafkaClusterSaslOAuthBearerAuthentication>

Details for SASL/OAUTHBEARER client authentication.

See Also:

  • Method Details

    • tokenEndpointUrl

      public final String tokenEndpointUrl()

      The HTTPS URL of the OAuth token endpoint that vends OAuth Bearer tokens per RFC 6749.

      Returns:
      The HTTPS URL of the OAuth token endpoint that vends OAuth Bearer tokens per RFC 6749.

    • clientCredentials

      public final KafkaClusterOAuthClientCredentials clientCredentials()

      Details for SASL/OAUTHBEARER using standard client_credentials grant.

      Returns:
      Details for SASL/OAUTHBEARER using standard client_credentials grant.

    • iamJwtBearer

      public final KafkaClusterOAuthIamJwtBearer iamJwtBearer()

      Details for SASL/OAUTHBEARER using JWT Bearer assertion grant (RFC 7523).

      Returns:
      Details for SASL/OAUTHBEARER using JWT Bearer assertion grant (RFC 7523).

    • clientCredentialsAssertion

      public final KafkaClusterOAuthClientCredentialsAssertion clientCredentialsAssertion()

      Details for SASL/OAUTHBEARER using client credentials grant with JWT client assertion.

      Returns:
      Details for SASL/OAUTHBEARER using client credentials grant with JWT client assertion.

    • tokenEndpointAuthenticationMethod

      public final TokenEndpointAuthenticationMethod tokenEndpointAuthenticationMethod()

      How client credentials are sent to the identity provider. Valid values are POST, BASIC, or NONE.

      If the service returns an enum value that is not available in the current SDK version, tokenEndpointAuthenticationMethod will return TokenEndpointAuthenticationMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tokenEndpointAuthenticationMethodAsString().

      Returns:
      How client credentials are sent to the identity provider. Valid values are POST, BASIC, or NONE.
      See Also:

    • tokenEndpointAuthenticationMethodAsString

      public final String tokenEndpointAuthenticationMethodAsString()

      How client credentials are sent to the identity provider. Valid values are POST, BASIC, or NONE.

      If the service returns an enum value that is not available in the current SDK version, tokenEndpointAuthenticationMethod will return TokenEndpointAuthenticationMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tokenEndpointAuthenticationMethodAsString().

      Returns:
      How client credentials are sent to the identity provider. Valid values are POST, BASIC, or NONE.
      See Also:

    • scope

      public final String scope()

      OAuth scope to request.

      Returns:
      OAuth scope to request.

    • tokenEndpointTlsCertificateArn

      public final String tokenEndpointTlsCertificateArn()

      Secrets Manager ARN containing a custom CA certificate for the identity provider.

      Returns:
      Secrets Manager ARN containing a custom CA certificate for the identity provider.

    • toBuilder

      public KafkaClusterSaslOAuthBearerAuthentication.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<KafkaClusterSaslOAuthBearerAuthentication.Builder,KafkaClusterSaslOAuthBearerAuthentication>
      Returns:
      a builder for type T

    • builder

      public static KafkaClusterSaslOAuthBearerAuthentication.Builder builder()

    • serializableBuilderClass

      public static Class<? extends KafkaClusterSaslOAuthBearerAuthentication.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.