/* * Copyright 2018-2023 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 com.amazonaws.services.cognitoidp.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateGroupRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The name of the group. Must be unique. *

*/ private String groupName; /** *

* The user pool ID for the user pool. *

*/ private String userPoolId; /** *

* A string containing the description of the group. *

*/ private String description; /** *

* The role Amazon Resource Name (ARN) for the group. *

*/ private 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. *

*/ private Integer precedence; /** *

* The name of the group. Must be unique. *

* * @param groupName * The name of the group. Must be unique. */ public void setGroupName(String groupName) { this.groupName = groupName; } /** *

* The name of the group. Must be unique. *

* * @return The name of the group. Must be unique. */ public String getGroupName() { return this.groupName; } /** *

* 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. */ public CreateGroupRequest withGroupName(String groupName) { setGroupName(groupName); return this; } /** *

* The user pool ID for the user pool. *

* * @param userPoolId * The user pool ID for the user pool. */ public void setUserPoolId(String userPoolId) { this.userPoolId = userPoolId; } /** *

* The user pool ID for the user pool. *

* * @return The user pool ID for the user pool. */ public String getUserPoolId() { return this.userPoolId; } /** *

* 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. */ public CreateGroupRequest withUserPoolId(String userPoolId) { setUserPoolId(userPoolId); return this; } /** *

* A string containing the description of the group. *

* * @param description * A string containing the description of the group. */ public void setDescription(String description) { this.description = description; } /** *

* A string containing the description of the group. *

* * @return A string containing the description of the group. */ public String getDescription() { return this.description; } /** *

* 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. */ public CreateGroupRequest withDescription(String description) { setDescription(description); return this; } /** *

* The role Amazon Resource Name (ARN) for the group. *

* * @param roleArn * The role Amazon Resource Name (ARN) for the group. */ public void setRoleArn(String roleArn) { this.roleArn = roleArn; } /** *

* The role Amazon Resource Name (ARN) for the group. *

* * @return The role Amazon Resource Name (ARN) for the group. */ public String getRoleArn() { return this.roleArn; } /** *

* 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. */ public CreateGroupRequest withRoleArn(String roleArn) { setRoleArn(roleArn); return this; } /** *

* 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. */ public void setPrecedence(Integer precedence) { this.precedence = 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 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 Integer getPrecedence() { return this.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. *

* * @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. */ public CreateGroupRequest withPrecedence(Integer precedence) { setPrecedence(precedence); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getGroupName() != null) sb.append("GroupName: ").append(getGroupName()).append(","); if (getUserPoolId() != null) sb.append("UserPoolId: ").append(getUserPoolId()).append(","); if (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getRoleArn() != null) sb.append("RoleArn: ").append(getRoleArn()).append(","); if (getPrecedence() != null) sb.append("Precedence: ").append(getPrecedence()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateGroupRequest == false) return false; CreateGroupRequest other = (CreateGroupRequest) obj; if (other.getGroupName() == null ^ this.getGroupName() == null) return false; if (other.getGroupName() != null && other.getGroupName().equals(this.getGroupName()) == false) return false; if (other.getUserPoolId() == null ^ this.getUserPoolId() == null) return false; if (other.getUserPoolId() != null && other.getUserPoolId().equals(this.getUserPoolId()) == false) return false; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getRoleArn() == null ^ this.getRoleArn() == null) return false; if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false) return false; if (other.getPrecedence() == null ^ this.getPrecedence() == null) return false; if (other.getPrecedence() != null && other.getPrecedence().equals(this.getPrecedence()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getGroupName() == null) ? 0 : getGroupName().hashCode()); hashCode = prime * hashCode + ((getUserPoolId() == null) ? 0 : getUserPoolId().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode()); hashCode = prime * hashCode + ((getPrecedence() == null) ? 0 : getPrecedence().hashCode()); return hashCode; } @Override public CreateGroupRequest clone() { return (CreateGroupRequest) super.clone(); } }