Package software.amazon.awssdk.services.verifiedpermissions.model

Class IdentitySourceDetails

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

A structure that contains configuration of the identity source.

This data type is used as a response parameter for the CreateIdentitySource operation.

See Also:

  • Method Details

    • hasClientIds

      public final boolean hasClientIds()
      For responses, this returns true if the service returned a value for the ClientIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • clientIds

      public final List<String> clientIds()

      The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasClientIds() method.

      Returns:
      The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.

    • userPoolArn

      public final String userPoolArn()

      The Amazon Resource Name (ARN) of the Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.

    • discoveryUrl

      public final String discoveryUrl()

      The well-known URL that points to this user pool's OIDC discovery endpoint. This is a URL string in the following format. This URL replaces the placeholders for both the Amazon Web Services Region and the user pool identifier with those appropriate for this user pool.

      https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration

      Returns:
      The well-known URL that points to this user pool's OIDC discovery endpoint. This is a URL string in the following format. This URL replaces the placeholders for both the Amazon Web Services Region and the user pool identifier with those appropriate for this user pool.

      https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration

    • openIdIssuer

      public final OpenIdIssuer openIdIssuer()

      A string that identifies the type of OIDC service represented by this identity source.

      At this time, the only valid value is cognito.

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

      Returns:
      A string that identifies the type of OIDC service represented by this identity source.

      At this time, the only valid value is cognito.

      See Also:

    • openIdIssuerAsString

      public final String openIdIssuerAsString()

      A string that identifies the type of OIDC service represented by this identity source.

      At this time, the only valid value is cognito.

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

      Returns:
      A string that identifies the type of OIDC service represented by this identity source.

      At this time, the only valid value is cognito.

      See Also:

    • toBuilder

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

    • builder

      public static IdentitySourceDetails.Builder builder()

    • serializableBuilderClass

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