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

Class UpdateGroupRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateGroupRequest.Builder,UpdateGroupRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateGroupRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateGroupRequest.Builder	builder()
String	description()	A string containing the new description of the group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	groupName()	The name of the group.
int	hashCode()
Integer	precedence()	The new precedence value for the group.
String	roleArn()	The new role Amazon Resource Name (ARN) for the group.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateGroupRequest.Builder>	serializableBuilderClass()
UpdateGroupRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userPoolId()	The user pool ID for the user pool.

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

groupName

public final String groupName()

The name of the group.

Returns:

The name of the group.

userPoolId

public final String userPoolId()

The user pool ID for the user pool.

Returns:

The user pool ID for the user pool.

description

public final String description()

A string containing the new description of the group.

Returns:

A string containing the new description of the group.

roleArn

public final String roleArn()

The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

Returns:

The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

precedence

public final Integer precedence()

The new precedence value for the group. For more information about this parameter, see CreateGroup.

Returns:

The new precedence value for the group. For more information about this parameter, see CreateGroup.

toBuilder

public UpdateGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateGroupRequest.Builder,UpdateGroupRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static UpdateGroupRequest.Builder builder()

serializableBuilderClass

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