DescribeIdentityPoolResponse (AWS Java SDK :: Services :: Amazon Cognito Identity 2.16.60 API)

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeIdentityPoolResponse.Builder,DescribeIdentityPoolResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeIdentityPoolResponse
extends CognitoIdentityResponse
implements ToCopyableBuilder<DescribeIdentityPoolResponse.Builder,DescribeIdentityPoolResponse>

An object representing an Amazon Cognito identity pool.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeIdentityPoolResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeIdentityPoolResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`allowClassicFlow()` Enables or disables the Basic (Classic) authentication flow.
`Boolean`	`allowUnauthenticatedIdentities()` TRUE if the identity pool supports unauthenticated logins.
`static DescribeIdentityPoolResponse.Builder`	`builder()`
`List<CognitoIdentityProvider>`	`cognitoIdentityProviders()` A list representing an Amazon Cognito user pool and its client ID.
`String`	`developerProviderName()` The "domain" by which Cognito will refer to your users.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCognitoIdentityProviders()` Returns true if the CognitoIdentityProviders property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasIdentityPoolTags()` Returns true if the IdentityPoolTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasOpenIdConnectProviderARNs()` Returns true if the OpenIdConnectProviderARNs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSamlProviderARNs()` Returns true if the SamlProviderARNs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSupportedLoginProviders()` Returns true if the SupportedLoginProviders property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`identityPoolId()` An identity pool ID in the format REGION:GUID.
`String`	`identityPoolName()` A string that you provide.
`Map<String,String>`	`identityPoolTags()` The tags that are assigned to the identity pool.
`List<String>`	`openIdConnectProviderARNs()` The ARNs of the OpenID Connect providers.
`List<String>`	`samlProviderARNs()` An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeIdentityPoolResponse.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`supportedLoginProviders()` Optional key:value pairs mapping provider names to provider app IDs.
`DescribeIdentityPoolResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.cognitoidentity.model.CognitoIdentityResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - identityPoolId
```
public final String identityPoolId()
```
    An identity pool ID in the format REGION:GUID.
    
    Returns:
    
    An identity pool ID in the format REGION:GUID.
  - identityPoolName
```
public final String identityPoolName()
```
    A string that you provide.
    
    Returns:
    
    A string that you provide.
  - allowUnauthenticatedIdentities
```
public final Boolean allowUnauthenticatedIdentities()
```
    TRUE if the identity pool supports unauthenticated logins.
    
    Returns:
    
    TRUE if the identity pool supports unauthenticated logins.
  - allowClassicFlow
```
public final Boolean allowClassicFlow()
```
    Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
    
    Returns:
    
    Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
  - hasSupportedLoginProviders
```
public final boolean hasSupportedLoginProviders()
```
    Returns true if the SupportedLoginProviders property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - supportedLoginProviders
```
public final Map<String,String> supportedLoginProviders()
```
    Optional key:value pairs mapping provider names to provider app IDs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSupportedLoginProviders() to see if a value was sent in this field.
    
    Returns:
    
    Optional key:value pairs mapping provider names to provider app IDs.
  - developerProviderName
```
public final String developerProviderName()
```
    The "domain" by which Cognito will refer to your users.
    
    Returns:
    
    The "domain" by which Cognito will refer to your users.
  - hasOpenIdConnectProviderARNs
```
public final boolean hasOpenIdConnectProviderARNs()
```
    Returns true if the OpenIdConnectProviderARNs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - openIdConnectProviderARNs
```
public final List<String> openIdConnectProviderARNs()
```
    The ARNs of the OpenID Connect providers.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasOpenIdConnectProviderARNs() to see if a value was sent in this field.
    
    Returns:
    
    The ARNs of the OpenID Connect providers.
  - hasCognitoIdentityProviders
```
public final boolean hasCognitoIdentityProviders()
```
    Returns true if the CognitoIdentityProviders property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - cognitoIdentityProviders
```
public final List<CognitoIdentityProvider> cognitoIdentityProviders()
```
    A list representing an Amazon Cognito user pool and its client ID.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasCognitoIdentityProviders() to see if a value was sent in this field.
    
    Returns:
    
    A list representing an Amazon Cognito user pool and its client ID.
  - hasSamlProviderARNs
```
public final boolean hasSamlProviderARNs()
```
    Returns true if the SamlProviderARNs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - samlProviderARNs
```
public final List<String> samlProviderARNs()
```
    An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSamlProviderARNs() to see if a value was sent in this field.
    
    Returns:
    
    An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
  - hasIdentityPoolTags
```
public final boolean hasIdentityPoolTags()
```
    Returns true if the IdentityPoolTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - identityPoolTags
```
public final Map<String,String> identityPoolTags()
```
    The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasIdentityPoolTags() to see if a value was sent in this field.
    
    Returns:
    
    The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
  - toBuilder
```
public DescribeIdentityPoolResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeIdentityPoolResponse.Builder,DescribeIdentityPoolResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeIdentityPoolResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeIdentityPoolResponse.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

Class DescribeIdentityPoolResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.cognitoidentity.model.CognitoIdentityResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

identityPoolId

identityPoolName

allowUnauthenticatedIdentities

allowClassicFlow

hasSupportedLoginProviders

supportedLoginProviders

developerProviderName

hasOpenIdConnectProviderARNs

openIdConnectProviderARNs

hasCognitoIdentityProviders

cognitoIdentityProviders

hasSamlProviderARNs

samlProviderARNs

hasIdentityPoolTags

identityPoolTags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields