Class ProviderDescription

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

The details of a user pool identity provider (IdP), including name and type.

See Also:

  • Method Details

    • providerName

      public final String providerName()

      The name of the IdP, for example MySAMLProvider.

      Returns:
      The name of the IdP, for example MySAMLProvider.

    • providerType

      public final IdentityProviderTypeType providerType()

      The type of the provider, for example SAML. Amazon Cognito supports SAML 2.0, OIDC, and social IdPs. User pools list supported social IdPs by name in this response parameter: Facebook, Google, Login with Amazon, and Sign in with Apple.

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

      Returns:
      The type of the provider, for example SAML. Amazon Cognito supports SAML 2.0, OIDC, and social IdPs. User pools list supported social IdPs by name in this response parameter: Facebook, Google, Login with Amazon, and Sign in with Apple.
      See Also:

    • providerTypeAsString

      public final String providerTypeAsString()

      The type of the provider, for example SAML. Amazon Cognito supports SAML 2.0, OIDC, and social IdPs. User pools list supported social IdPs by name in this response parameter: Facebook, Google, Login with Amazon, and Sign in with Apple.

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

      Returns:
      The type of the provider, for example SAML. Amazon Cognito supports SAML 2.0, OIDC, and social IdPs. User pools list supported social IdPs by name in this response parameter: Facebook, Google, Login with Amazon, and Sign in with Apple.
      See Also:

    • lastModifiedDate

      public final Instant lastModifiedDate()

      The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

      Returns:
      The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

    • creationDate

      public final Instant creationDate()

      The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

      Returns:
      The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

    • toBuilder

      public ProviderDescription.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<ProviderDescription.Builder,ProviderDescription>
      Returns:
      a builder for type T

    • builder

      public static ProviderDescription.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ProviderDescription.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.