UserSearchSummary (aws-android-sdk-connect 2.81.1 API)

java.lang.Object
- com.amazonaws.services.connect.model.UserSearchSummary

All Implemented Interfaces:

java.io.Serializable
```
public class UserSearchSummary
extends java.lang.Object
implements java.io.Serializable
```
Information about the returned users.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

UserSearchSummary()

Constructors
Constructor and Description
`UserSearchSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserSearchSummary`	`addTagsEntry(java.lang.String key, java.lang.String value)` The tags used to organize, track, or control access for this resource.
`UserSearchSummary`	`clearTagsEntries()` Removes all the entries added into Tags.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getArn()` The Amazon Resource Name (ARN) of the user.
`java.lang.String`	`getDirectoryUserId()` The directory identifier of the user.
`java.lang.String`	`getHierarchyGroupId()` The identifier of the user's hierarchy group.
`java.lang.String`	`getId()` The identifier of the user's summary.
`UserIdentityInfoLite`	`getIdentityInfo()` The user's first name and last name.
`UserPhoneConfig`	`getPhoneConfig()` Contains information about the phone configuration settings for a user.
`java.lang.String`	`getRoutingProfileId()` The identifier of the user's routing profile.
`java.util.List<java.lang.String>`	`getSecurityProfileIds()` The identifiers of the user's security profiles.
`java.util.Map<java.lang.String,java.lang.String>`	`getTags()` The tags used to organize, track, or control access for this resource.
`java.lang.String`	`getUsername()` The name of the user.
`int`	`hashCode()`
`void`	`setArn(java.lang.String arn)` The Amazon Resource Name (ARN) of the user.
`void`	`setDirectoryUserId(java.lang.String directoryUserId)` The directory identifier of the user.
`void`	`setHierarchyGroupId(java.lang.String hierarchyGroupId)` The identifier of the user's hierarchy group.
`void`	`setId(java.lang.String id)` The identifier of the user's summary.
`void`	`setIdentityInfo(UserIdentityInfoLite identityInfo)` The user's first name and last name.
`void`	`setPhoneConfig(UserPhoneConfig phoneConfig)` Contains information about the phone configuration settings for a user.
`void`	`setRoutingProfileId(java.lang.String routingProfileId)` The identifier of the user's routing profile.
`void`	`setSecurityProfileIds(java.util.Collection<java.lang.String> securityProfileIds)` The identifiers of the user's security profiles.
`void`	`setTags(java.util.Map<java.lang.String,java.lang.String> tags)` The tags used to organize, track, or control access for this resource.
`void`	`setUsername(java.lang.String username)` The name of the user.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UserSearchSummary`	`withArn(java.lang.String arn)` The Amazon Resource Name (ARN) of the user.
`UserSearchSummary`	`withDirectoryUserId(java.lang.String directoryUserId)` The directory identifier of the user.
`UserSearchSummary`	`withHierarchyGroupId(java.lang.String hierarchyGroupId)` The identifier of the user's hierarchy group.
`UserSearchSummary`	`withId(java.lang.String id)` The identifier of the user's summary.
`UserSearchSummary`	`withIdentityInfo(UserIdentityInfoLite identityInfo)` The user's first name and last name.
`UserSearchSummary`	`withPhoneConfig(UserPhoneConfig phoneConfig)` Contains information about the phone configuration settings for a user.
`UserSearchSummary`	`withRoutingProfileId(java.lang.String routingProfileId)` The identifier of the user's routing profile.
`UserSearchSummary`	`withSecurityProfileIds(java.util.Collection<java.lang.String> securityProfileIds)` The identifiers of the user's security profiles.
`UserSearchSummary`	`withSecurityProfileIds(java.lang.String... securityProfileIds)` The identifiers of the user's security profiles.
`UserSearchSummary`	`withTags(java.util.Map<java.lang.String,java.lang.String> tags)` The tags used to organize, track, or control access for this resource.
`UserSearchSummary`	`withUsername(java.lang.String username)` The name of the user.

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

- Constructor Detail
  - UserSearchSummary
```
public UserSearchSummary()
```
- Method Detail
  - getArn
```
public java.lang.String getArn()
```
    The Amazon Resource Name (ARN) of the user.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the user.
  - setArn
```
public void setArn(java.lang.String arn)
```
    The Amazon Resource Name (ARN) of the user.
    
    Parameters:
    
    arn -
    The Amazon Resource Name (ARN) of the user.
  - withArn
```
public UserSearchSummary withArn(java.lang.String arn)
```
    The Amazon Resource Name (ARN) of the user.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    arn -
    The Amazon Resource Name (ARN) of the user.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDirectoryUserId
```
public java.lang.String getDirectoryUserId()
```
    The directory identifier of the user.
    
    Returns:
    
    The directory identifier of the user.
  - setDirectoryUserId
```
public void setDirectoryUserId(java.lang.String directoryUserId)
```
    The directory identifier of the user.
    
    Parameters:
    
    directoryUserId -
    The directory identifier of the user.
  - withDirectoryUserId
```
public UserSearchSummary withDirectoryUserId(java.lang.String directoryUserId)
```
    The directory identifier of the user.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    directoryUserId -
    The directory identifier of the user.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getHierarchyGroupId
```
public java.lang.String getHierarchyGroupId()
```
    The identifier of the user's hierarchy group.
    
    Returns:
    
    The identifier of the user's hierarchy group.
  - setHierarchyGroupId
```
public void setHierarchyGroupId(java.lang.String hierarchyGroupId)
```
    The identifier of the user's hierarchy group.
    
    Parameters:
    
    hierarchyGroupId -
    The identifier of the user's hierarchy group.
  - withHierarchyGroupId
```
public UserSearchSummary withHierarchyGroupId(java.lang.String hierarchyGroupId)
```
    The identifier of the user's hierarchy group.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    hierarchyGroupId -
    The identifier of the user's hierarchy group.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getId
```
public java.lang.String getId()
```
    The identifier of the user's summary.
    
    Returns:
    
    The identifier of the user's summary.
  - setId
```
public void setId(java.lang.String id)
```
    The identifier of the user's summary.
    
    Parameters:
    
    id -
    The identifier of the user's summary.
  - withId
```
public UserSearchSummary withId(java.lang.String id)
```
    The identifier of the user's summary.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    id -
    The identifier of the user's summary.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getIdentityInfo
```
public UserIdentityInfoLite getIdentityInfo()
```
    The user's first name and last name.
    
    Returns:
    
    The user's first name and last name.
  - setIdentityInfo
```
public void setIdentityInfo(UserIdentityInfoLite identityInfo)
```
    The user's first name and last name.
    
    Parameters:
    
    identityInfo -
    The user's first name and last name.
  - withIdentityInfo
```
public UserSearchSummary withIdentityInfo(UserIdentityInfoLite identityInfo)
```
    The user's first name and last name.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    identityInfo -
    The user's first name and last name.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPhoneConfig
```
public UserPhoneConfig getPhoneConfig()
```
    Contains information about the phone configuration settings for a user.
    
    Returns:
    
    Contains information about the phone configuration settings for a user.
  - setPhoneConfig
```
public void setPhoneConfig(UserPhoneConfig phoneConfig)
```
    Contains information about the phone configuration settings for a user.
    
    Parameters:
    
    phoneConfig -
    Contains information about the phone configuration settings for a user.
  - withPhoneConfig
```
public UserSearchSummary withPhoneConfig(UserPhoneConfig phoneConfig)
```
    Contains information about the phone configuration settings for a user.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    phoneConfig -
    Contains information about the phone configuration settings for a user.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getRoutingProfileId
```
public java.lang.String getRoutingProfileId()
```
    The identifier of the user's routing profile.
    
    Returns:
    
    The identifier of the user's routing profile.
  - setRoutingProfileId
```
public void setRoutingProfileId(java.lang.String routingProfileId)
```
    The identifier of the user's routing profile.
    
    Parameters:
    
    routingProfileId -
    The identifier of the user's routing profile.
  - withRoutingProfileId
```
public UserSearchSummary withRoutingProfileId(java.lang.String routingProfileId)
```
    The identifier of the user's routing profile.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    routingProfileId -
    The identifier of the user's routing profile.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSecurityProfileIds
```
public java.util.List<java.lang.String> getSecurityProfileIds()
```
    The identifiers of the user's security profiles.
    
    Returns:
    
    The identifiers of the user's security profiles.
  - setSecurityProfileIds
```
public void setSecurityProfileIds(java.util.Collection<java.lang.String> securityProfileIds)
```
    The identifiers of the user's security profiles.
    
    Parameters:
    
    securityProfileIds -
    The identifiers of the user's security profiles.
  - withSecurityProfileIds
```
public UserSearchSummary withSecurityProfileIds(java.lang.String... securityProfileIds)
```
    The identifiers of the user's security profiles.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    securityProfileIds -
    The identifiers of the user's security profiles.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withSecurityProfileIds
```
public UserSearchSummary withSecurityProfileIds(java.util.Collection<java.lang.String> securityProfileIds)
```
    The identifiers of the user's security profiles.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    securityProfileIds -
    The identifiers of the user's security profiles.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTags
```
public java.util.Map<java.lang.String,java.lang.String> getTags()
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns:
    
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
  - setTags
```
public void setTags(java.util.Map<java.lang.String,java.lang.String> tags)
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Parameters:
    
    tags -
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
  - withTags
```
public UserSearchSummary withTags(java.util.Map<java.lang.String,java.lang.String> tags)
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    tags -
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addTagsEntry
```
public UserSearchSummary addTagsEntry(java.lang.String key,
                                      java.lang.String value)
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    The method adds a new key-value pair into Tags parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into Tags.
    
    value - The corresponding value of the entry to be added into Tags.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearTagsEntries
```
public UserSearchSummary clearTagsEntries()
```
    Removes all the entries added into Tags.
    Returns a reference to this object so that method calls can be chained together.
  - getUsername
```
public java.lang.String getUsername()
```
    The name of the user.
    
    Constraints:
    Length: 1 - 100
    
    Returns:
    
    The name of the user.
  - setUsername
```
public void setUsername(java.lang.String username)
```
    The name of the user.
    
    Constraints:
    Length: 1 - 100
    
    Parameters:
    
    username -
    The name of the user.
  - withUsername
```
public UserSearchSummary withUsername(java.lang.String username)
```
    The name of the user.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 100
    
    Parameters:
    
    username -
    The name of the user.
    
    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 UserSearchSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserSearchSummary

Method Detail

getArn

setArn

withArn

getDirectoryUserId

setDirectoryUserId

withDirectoryUserId

getHierarchyGroupId

setHierarchyGroupId

withHierarchyGroupId

getId

setId

withId

getIdentityInfo

setIdentityInfo

withIdentityInfo

getPhoneConfig

setPhoneConfig

withPhoneConfig

getRoutingProfileId

setRoutingProfileId

withRoutingProfileId

getSecurityProfileIds

setSecurityProfileIds

withSecurityProfileIds

withSecurityProfileIds

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

getUsername

setUsername

withUsername

toString

hashCode

equals