software.amazon.awssdk.services.cognitoidentityprovider.model.CreateGroupRequest Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.cognitoidentityprovider.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateGroupRequest extends CognitoIdentityProviderRequest implements
ToCopyableBuilder {
private static final SdkField GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GroupName").getter(getter(CreateGroupRequest::groupName)).setter(setter(Builder::groupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GroupName").build()).build();
private static final SdkField USER_POOL_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UserPoolId").getter(getter(CreateGroupRequest::userPoolId)).setter(setter(Builder::userPoolId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserPoolId").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(CreateGroupRequest::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RoleArn").getter(getter(CreateGroupRequest::roleArn)).setter(setter(Builder::roleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RoleArn").build()).build();
private static final SdkField PRECEDENCE_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("Precedence").getter(getter(CreateGroupRequest::precedence)).setter(setter(Builder::precedence))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Precedence").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(GROUP_NAME_FIELD,
USER_POOL_ID_FIELD, DESCRIPTION_FIELD, ROLE_ARN_FIELD, PRECEDENCE_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("GroupName", GROUP_NAME_FIELD);
put("UserPoolId", USER_POOL_ID_FIELD);
put("Description", DESCRIPTION_FIELD);
put("RoleArn", ROLE_ARN_FIELD);
put("Precedence", PRECEDENCE_FIELD);
}
});
private final String groupName;
private final String userPoolId;
private final String description;
private final String roleArn;
private final Integer precedence;
private CreateGroupRequest(BuilderImpl builder) {
super(builder);
this.groupName = builder.groupName;
this.userPoolId = builder.userPoolId;
this.description = builder.description;
this.roleArn = builder.roleArn;
this.precedence = builder.precedence;
}
/**
*
* The name of the group. Must be unique.
*
*
* @return The name of the group. Must be unique.
*/
public final String groupName() {
return groupName;
}
/**
*
* The user pool ID for the user pool.
*
*
* @return The user pool ID for the user pool.
*/
public final String userPoolId() {
return userPoolId;
}
/**
*
* A string containing the description of the group.
*
*
* @return A string containing the description of the group.
*/
public final String description() {
return description;
}
/**
*
* The role Amazon Resource Name (ARN) for the group.
*
*
* @return The role Amazon Resource Name (ARN) for the group.
*/
public final String roleArn() {
return roleArn;
}
/**
*
* A non-negative integer value that specifies the precedence of this group relative to the other groups that a user
* can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence
* values take precedence over groups with higher or null Precedence values. If a user belongs to two
* or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for
* the cognito:roles and cognito:preferred_role claims.
*
*
* Two groups can have the same Precedence value. If this happens, neither group takes precedence over
* the other. If two groups with the same Precedence have the same role ARN, that role is used in the
* cognito:preferred_role claim in tokens for users in each group. If the two groups have different
* role ARNs, the cognito:preferred_role claim isn't set in users' tokens.
*
*
* The default Precedence value is null. The maximum Precedence value is
* 2^31-1.
*
*
* @return A non-negative integer value that specifies the precedence of this group relative to the other groups
* that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower
* Precedence values take precedence over groups with higher or null Precedence
* values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose
* role ARN is given in the user's tokens for the cognito:roles and
* cognito:preferred_role claims.
*
* Two groups can have the same Precedence value. If this happens, neither group takes
* precedence over the other. If two groups with the same Precedence have the same role ARN,
* that role is used in the cognito:preferred_role claim in tokens for users in each group. If
* the two groups have different role ARNs, the cognito:preferred_role claim isn't set in
* users' tokens.
*
*
* The default Precedence value is null. The maximum Precedence value is
* 2^31-1.
*/
public final Integer precedence() {
return precedence;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(groupName());
hashCode = 31 * hashCode + Objects.hashCode(userPoolId());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(roleArn());
hashCode = 31 * hashCode + Objects.hashCode(precedence());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateGroupRequest)) {
return false;
}
CreateGroupRequest other = (CreateGroupRequest) obj;
return Objects.equals(groupName(), other.groupName()) && Objects.equals(userPoolId(), other.userPoolId())
&& Objects.equals(description(), other.description()) && Objects.equals(roleArn(), other.roleArn())
&& Objects.equals(precedence(), other.precedence());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("CreateGroupRequest").add("GroupName", groupName()).add("UserPoolId", userPoolId())
.add("Description", description()).add("RoleArn", roleArn()).add("Precedence", precedence()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "GroupName":
return Optional.ofNullable(clazz.cast(groupName()));
case "UserPoolId":
return Optional.ofNullable(clazz.cast(userPoolId()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "RoleArn":
return Optional.ofNullable(clazz.cast(roleArn()));
case "Precedence":
return Optional.ofNullable(clazz.cast(precedence()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateGroupRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The name of the group. Must be unique.
*
*
* @param groupName
* The name of the group. Must be unique.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groupName(String groupName);
/**
*
* The user pool ID for the user pool.
*
*
* @param userPoolId
* The user pool ID for the user pool.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userPoolId(String userPoolId);
/**
*
* A string containing the description of the group.
*
*
* @param description
* A string containing the description of the group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The role Amazon Resource Name (ARN) for the group.
*
*
* @param roleArn
* The role Amazon Resource Name (ARN) for the group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder roleArn(String roleArn);
/**
*
* A non-negative integer value that specifies the precedence of this group relative to the other groups that a
* user can belong to in the user pool. Zero is the highest precedence value. Groups with lower
* Precedence values take precedence over groups with higher or null Precedence
* values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role
* ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role
* claims.
*
*
* Two groups can have the same Precedence value. If this happens, neither group takes precedence
* over the other. If two groups with the same Precedence have the same role ARN, that role is used
* in the cognito:preferred_role claim in tokens for users in each group. If the two groups have
* different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.
*
*
* The default Precedence value is null. The maximum Precedence value is
* 2^31-1.
*
*
* @param precedence
* A non-negative integer value that specifies the precedence of this group relative to the other groups
* that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower
* Precedence values take precedence over groups with higher or null Precedence
* values. If a user belongs to two or more groups, it is the group with the lowest precedence value
* whose role ARN is given in the user's tokens for the cognito:roles and
* cognito:preferred_role claims.
*
* Two groups can have the same Precedence value. If this happens, neither group takes
* precedence over the other. If two groups with the same Precedence have the same role ARN,
* that role is used in the cognito:preferred_role claim in tokens for users in each group.
* If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in
* users' tokens.
*
*
* The default Precedence value is null. The maximum Precedence value is
* 2^31-1.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder precedence(Integer precedence);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CognitoIdentityProviderRequest.BuilderImpl implements Builder {
private String groupName;
private String userPoolId;
private String description;
private String roleArn;
private Integer precedence;
private BuilderImpl() {
}
private BuilderImpl(CreateGroupRequest model) {
super(model);
groupName(model.groupName);
userPoolId(model.userPoolId);
description(model.description);
roleArn(model.roleArn);
precedence(model.precedence);
}
public final String getGroupName() {
return groupName;
}
public final void setGroupName(String groupName) {
this.groupName = groupName;
}
@Override
public final Builder groupName(String groupName) {
this.groupName = groupName;
return this;
}
public final String getUserPoolId() {
return userPoolId;
}
public final void setUserPoolId(String userPoolId) {
this.userPoolId = userPoolId;
}
@Override
public final Builder userPoolId(String userPoolId) {
this.userPoolId = userPoolId;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final String getRoleArn() {
return roleArn;
}
public final void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
@Override
public final Builder roleArn(String roleArn) {
this.roleArn = roleArn;
return this;
}
public final Integer getPrecedence() {
return precedence;
}
public final void setPrecedence(Integer precedence) {
this.precedence = precedence;
}
@Override
public final Builder precedence(Integer precedence) {
this.precedence = precedence;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateGroupRequest build() {
return new CreateGroupRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}