GroupType (aws-android-sdk-cognitoidentityprovider 2.81.1 API)

java.lang.Object
- com.amazonaws.services.cognitoidentityprovider.model.GroupType

All Implemented Interfaces:

java.io.Serializable
```
public class GroupType
extends java.lang.Object
implements java.io.Serializable
```
The group type.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GroupType()

Constructors
Constructor and Description
`GroupType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.util.Date`	`getCreationDate()` The date and time, in ISO 8601 format, when the item was created.
`java.lang.String`	`getDescription()` A string containing the description of the group.
`java.lang.String`	`getGroupName()` The name of the group.
`java.util.Date`	`getLastModifiedDate()` The date and time, in ISO 8601 format, when the item was modified.
`java.lang.Integer`	`getPrecedence()` 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.
`java.lang.String`	`getRoleArn()` The role Amazon Resource Name (ARN) for the group.
`java.lang.String`	`getUserPoolId()` The user pool ID for the user pool.
`int`	`hashCode()`
`void`	`setCreationDate(java.util.Date creationDate)` The date and time, in ISO 8601 format, when the item was created.
`void`	`setDescription(java.lang.String description)` A string containing the description of the group.
`void`	`setGroupName(java.lang.String groupName)` The name of the group.
`void`	`setLastModifiedDate(java.util.Date lastModifiedDate)` The date and time, in ISO 8601 format, when the item was modified.
`void`	`setPrecedence(java.lang.Integer 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.
`void`	`setRoleArn(java.lang.String roleArn)` The role Amazon Resource Name (ARN) for the group.
`void`	`setUserPoolId(java.lang.String userPoolId)` The user pool ID for the user pool.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GroupType`	`withCreationDate(java.util.Date creationDate)` The date and time, in ISO 8601 format, when the item was created.
`GroupType`	`withDescription(java.lang.String description)` A string containing the description of the group.
`GroupType`	`withGroupName(java.lang.String groupName)` The name of the group.
`GroupType`	`withLastModifiedDate(java.util.Date lastModifiedDate)` The date and time, in ISO 8601 format, when the item was modified.
`GroupType`	`withPrecedence(java.lang.Integer 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.
`GroupType`	`withRoleArn(java.lang.String roleArn)` The role Amazon Resource Name (ARN) for the group.
`GroupType`	`withUserPoolId(java.lang.String userPoolId)` The user pool ID for the user pool.

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

- Constructor Detail
  - GroupType
```
public GroupType()
```
- Method Detail
  - getGroupName
```
public java.lang.String getGroupName()
```
    The name of the group.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Returns:
    
    The name of the group.
  - setGroupName
```
public void setGroupName(java.lang.String groupName)
```
    The name of the group.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    groupName -
    The name of the group.
  - withGroupName
```
public GroupType withGroupName(java.lang.String groupName)
```
    The name of the group.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    groupName -
    The name of the group.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserPoolId
```
public java.lang.String getUserPoolId()
```
    The user pool ID for the user pool.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Returns:
    
    The user pool ID for the user pool.
  - setUserPoolId
```
public void setUserPoolId(java.lang.String userPoolId)
```
    The user pool ID for the user pool.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID for the user pool.
  - withUserPoolId
```
public GroupType withUserPoolId(java.lang.String userPoolId)
```
    The user pool ID for the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID for the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDescription
```
public java.lang.String getDescription()
```
    A string containing the description of the group.
    
    Constraints:
    Length: - 2048
    
    Returns:
    
    A string containing the description of the group.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    A string containing the description of the group.
    
    Constraints:
    Length: - 2048
    
    Parameters:
    
    description -
    A string containing the description of the group.
  - withDescription
```
public GroupType withDescription(java.lang.String description)
```
    A string containing the description of the group.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 2048
    
    Parameters:
    
    description -
    A string containing the description of the group.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getRoleArn
```
public java.lang.String getRoleArn()
```
    The role Amazon Resource Name (ARN) for the group.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
    
    Returns:
    
    The role Amazon Resource Name (ARN) for the group.
  - setRoleArn
```
public void setRoleArn(java.lang.String roleArn)
```
    The role Amazon Resource Name (ARN) for the group.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
    
    Parameters:
    
    roleArn -
    The role Amazon Resource Name (ARN) for the group.
  - withRoleArn
```
public GroupType withRoleArn(java.lang.String roleArn)
```
    The role Amazon Resource Name (ARN) for the group.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
    
    Parameters:
    
    roleArn -
    The role Amazon Resource Name (ARN) for the group.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPrecedence
```
public java.lang.Integer getPrecedence()
```
    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 ornull 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.
    
    Constraints:
    Range: 0 -
    
    Returns:
    
    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 ornull 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.
  - setPrecedence
```
public void setPrecedence(java.lang.Integer 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 ornull 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.
    
    Constraints:
    Range: 0 -
    
    Parameters:
    
    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 ornull 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.
  - withPrecedence
```
public GroupType withPrecedence(java.lang.Integer 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 ornull 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 -
    
    Parameters:
    
    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 ornull 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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLastModifiedDate
```
public java.util.Date getLastModifiedDate()
```
    The date and time, in ISO 8601 format, when the item was modified.
    
    Returns:
    
    The date and time, in ISO 8601 format, when the item was modified.
  - setLastModifiedDate
```
public void setLastModifiedDate(java.util.Date lastModifiedDate)
```
    The date and time, in ISO 8601 format, when the item was modified.
    
    Parameters:
    
    lastModifiedDate -
    The date and time, in ISO 8601 format, when the item was modified.
  - withLastModifiedDate
```
public GroupType withLastModifiedDate(java.util.Date lastModifiedDate)
```
    The date and time, in ISO 8601 format, when the item was modified.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    lastModifiedDate -
    The date and time, in ISO 8601 format, when the item was modified.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCreationDate
```
public java.util.Date getCreationDate()
```
    The date and time, in ISO 8601 format, when the item was created.
    
    Returns:
    
    The date and time, in ISO 8601 format, when the item was created.
  - setCreationDate
```
public void setCreationDate(java.util.Date creationDate)
```
    The date and time, in ISO 8601 format, when the item was created.
    
    Parameters:
    
    creationDate -
    The date and time, in ISO 8601 format, when the item was created.
  - withCreationDate
```
public GroupType withCreationDate(java.util.Date creationDate)
```
    The date and time, in ISO 8601 format, when the item was created.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    creationDate -
    The date and time, in ISO 8601 format, when the item was created.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class GroupType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GroupType

Method Detail

getGroupName

setGroupName

withGroupName

getUserPoolId

setUserPoolId

withUserPoolId

getDescription

setDescription

withDescription

getRoleArn

setRoleArn

withRoleArn

getPrecedence

setPrecedence

withPrecedence

getLastModifiedDate

setLastModifiedDate

withLastModifiedDate

getCreationDate

setCreationDate

withCreationDate

toString

hashCode

equals