Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class AddCustomAttributesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.AddCustomAttributesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AddCustomAttributesRequest.Builder,AddCustomAttributesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class AddCustomAttributesRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<AddCustomAttributesRequest.Builder,AddCustomAttributesRequest>

Represents the request to add custom attributes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AddCustomAttributesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static AddCustomAttributesRequest.Builder	builder()
List<SchemaAttributeType>	customAttributes()	An array of custom attributes, such as Mutable and Name.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCustomAttributes()	For responses, this returns true if the service returned a value for the CustomAttributes property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends AddCustomAttributesRequest.Builder>	serializableBuilderClass()
AddCustomAttributesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userPoolId()	The user pool ID for the user pool where you want to add custom attributes.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

userPoolId

public final String userPoolId()

The user pool ID for the user pool where you want to add custom attributes.

Returns:

The user pool ID for the user pool where you want to add custom attributes.

hasCustomAttributes

public final boolean hasCustomAttributes()

For responses, this returns true if the service returned a value for the CustomAttributes 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.

customAttributes

public final List<SchemaAttributeType> customAttributes()

An array of custom attributes, such as Mutable and Name.

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

Returns:

An array of custom attributes, such as Mutable and Name.

toBuilder

public AddCustomAttributesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AddCustomAttributesRequest.Builder,AddCustomAttributesRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static AddCustomAttributesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo