Package software.amazon.awssdk.services.cognitoidentity.model

Class GetIdentityPoolRolesResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.cognitoidentity.model.CognitoIdentityResponse
software.amazon.awssdk.services.cognitoidentity.model.GetIdentityPoolRolesResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetIdentityPoolRolesResponse.Builder,GetIdentityPoolRolesResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetIdentityPoolRolesResponse extends CognitoIdentityResponse implements ToCopyableBuilder<GetIdentityPoolRolesResponse.Builder,GetIdentityPoolRolesResponse>

Returned in response to a successful GetIdentityPoolRoles operation.

  • Method Details

    • identityPoolId

      public final String identityPoolId()

      An identity pool ID in the format REGION:GUID.

      Returns:
      An identity pool ID in the format REGION:GUID.

    • hasRoles

      public final boolean hasRoles()
      For responses, this returns true if the service returned a value for the Roles 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.

    • roles

      public final Map<String,String> roles()

      The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.

      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 hasRoles() method.

      Returns:
      The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.

    • hasRoleMappings

      public final boolean hasRoleMappings()
      For responses, this returns true if the service returned a value for the RoleMappings 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.

    • roleMappings

      public final Map<String,RoleMapping> roleMappings()

      How users for a specific identity provider are to mapped to roles. This is a String-to-RoleMapping object map. The string identifies the identity provider, for example, graph.facebook.com or cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id.

      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 hasRoleMappings() method.

      Returns:
      How users for a specific identity provider are to mapped to roles. This is a String-to-RoleMapping object map. The string identifies the identity provider, for example, graph.facebook.com or cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id.

    • toBuilder

      public GetIdentityPoolRolesResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetIdentityPoolRolesResponse.Builder,GetIdentityPoolRolesResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static GetIdentityPoolRolesResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkResponse

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo