UserSearchSummary (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UserSearchSummary
extends Object
implements Serializable, Cloneable, StructuredPojo

Information about the returned users.

See Also:: AWS API Documentation, 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(String key, String value)` Add a single Tags entry
`UserSearchSummary`	`clearTagsEntries()` Removes all the entries added into Tags.
`UserSearchSummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the user.
`String`	`getDirectoryUserId()` The directory identifier of the user.
`String`	`getHierarchyGroupId()` The identifier of the user's hierarchy group.
`String`	`getId()` The identifier of the user's summary.
`UserIdentityInfoLite`	`getIdentityInfo()` The user's first name and last name.
`UserPhoneConfig`	`getPhoneConfig()`
`String`	`getRoutingProfileId()` The identifier of the user's routing profile.
`List<String>`	`getSecurityProfileIds()` The identifiers of the user's security profiles.
`Map<String,String>`	`getTags()` The tags used to organize, track, or control access for this resource.
`String`	`getUsername()` The name of the user.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the user.
`void`	`setDirectoryUserId(String directoryUserId)` The directory identifier of the user.
`void`	`setHierarchyGroupId(String hierarchyGroupId)` The identifier of the user's hierarchy group.
`void`	`setId(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)`
`void`	`setRoutingProfileId(String routingProfileId)` The identifier of the user's routing profile.
`void`	`setSecurityProfileIds(Collection<String> securityProfileIds)` The identifiers of the user's security profiles.
`void`	`setTags(Map<String,String> tags)` The tags used to organize, track, or control access for this resource.
`void`	`setUsername(String username)` The name of the user.
`String`	`toString()` Returns a string representation of this object.
`UserSearchSummary`	`withArn(String arn)` The Amazon Resource Name (ARN) of the user.
`UserSearchSummary`	`withDirectoryUserId(String directoryUserId)` The directory identifier of the user.
`UserSearchSummary`	`withHierarchyGroupId(String hierarchyGroupId)` The identifier of the user's hierarchy group.
`UserSearchSummary`	`withId(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)`
`UserSearchSummary`	`withRoutingProfileId(String routingProfileId)` The identifier of the user's routing profile.
`UserSearchSummary`	`withSecurityProfileIds(Collection<String> securityProfileIds)` The identifiers of the user's security profiles.
`UserSearchSummary`	`withSecurityProfileIds(String... securityProfileIds)` The identifiers of the user's security profiles.
`UserSearchSummary`	`withTags(Map<String,String> tags)` The tags used to organize, track, or control access for this resource.
`UserSearchSummary`	`withUsername(String username)` The name of the user.

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

- Constructor Detail
  - UserSearchSummary
```
public UserSearchSummary()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the user.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the user.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the user.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the user.
  - withArn
```
public UserSearchSummary withArn(String arn)
```
    The Amazon Resource Name (ARN) of the user.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDirectoryUserId
```
public void setDirectoryUserId(String directoryUserId)
```
    The directory identifier of the user.
    
    Parameters:
    
    directoryUserId - The directory identifier of the user.
  - getDirectoryUserId
```
public String getDirectoryUserId()
```
    The directory identifier of the user.
    
    Returns:
    
    The directory identifier of the user.
  - withDirectoryUserId
```
public UserSearchSummary withDirectoryUserId(String directoryUserId)
```
    The directory identifier of the user.
    
    Parameters:
    
    directoryUserId - The directory identifier of the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHierarchyGroupId
```
public void setHierarchyGroupId(String hierarchyGroupId)
```
    The identifier of the user's hierarchy group.
    
    Parameters:
    
    hierarchyGroupId - The identifier of the user's hierarchy group.
  - getHierarchyGroupId
```
public String getHierarchyGroupId()
```
    The identifier of the user's hierarchy group.
    
    Returns:
    
    The identifier of the user's hierarchy group.
  - withHierarchyGroupId
```
public UserSearchSummary withHierarchyGroupId(String hierarchyGroupId)
```
    The identifier of the user's hierarchy group.
    
    Parameters:
    
    hierarchyGroupId - The identifier of the user's hierarchy group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    The identifier of the user's summary.
    
    Parameters:
    
    id - The identifier of the user's summary.
  - getId
```
public String getId()
```
    The identifier of the user's summary.
    
    Returns:
    
    The identifier of the user's summary.
  - withId
```
public UserSearchSummary withId(String id)
```
    The identifier of the user's summary.
    
    Parameters:
    
    id - The identifier of the user's summary.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdentityInfo
```
public void setIdentityInfo(UserIdentityInfoLite identityInfo)
```
    The user's first name and last name.
    
    Parameters:
    
    identityInfo - The user's first name and last name.
  - getIdentityInfo
```
public UserIdentityInfoLite getIdentityInfo()
```
    The user's first name and last name.
    
    Returns:
    
    The user's first name and last name.
  - withIdentityInfo
```
public UserSearchSummary withIdentityInfo(UserIdentityInfoLite identityInfo)
```
    The user's first name and last name.
    
    Parameters:
    
    identityInfo - The user's first name and last name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPhoneConfig
```
public void setPhoneConfig(UserPhoneConfig phoneConfig)
```
    Parameters:
    
    phoneConfig -
  - getPhoneConfig
```
public UserPhoneConfig getPhoneConfig()
```
    Returns:
  - withPhoneConfig
```
public UserSearchSummary withPhoneConfig(UserPhoneConfig phoneConfig)
```
    Parameters:
    
    phoneConfig -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoutingProfileId
```
public void setRoutingProfileId(String routingProfileId)
```
    The identifier of the user's routing profile.
    
    Parameters:
    
    routingProfileId - The identifier of the user's routing profile.
  - getRoutingProfileId
```
public String getRoutingProfileId()
```
    The identifier of the user's routing profile.
    
    Returns:
    
    The identifier of the user's routing profile.
  - withRoutingProfileId
```
public UserSearchSummary withRoutingProfileId(String routingProfileId)
```
    The identifier of the user's routing profile.
    
    Parameters:
    
    routingProfileId - The identifier of the user's routing profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSecurityProfileIds
```
public List<String> getSecurityProfileIds()
```
    The identifiers of the user's security profiles.
    
    Returns:
    
    The identifiers of the user's security profiles.
  - setSecurityProfileIds
```
public void setSecurityProfileIds(Collection<String> securityProfileIds)
```
    The identifiers of the user's security profiles.
    
    Parameters:
    
    securityProfileIds - The identifiers of the user's security profiles.
  - withSecurityProfileIds
```
public UserSearchSummary withSecurityProfileIds(String... securityProfileIds)
```
    The identifiers of the user's security profiles.
    
    NOTE: This method appends the values to the existing list (if any). Use setSecurityProfileIds(java.util.Collection) or withSecurityProfileIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    securityProfileIds - The identifiers of the user's security profiles.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSecurityProfileIds
```
public UserSearchSummary withSecurityProfileIds(Collection<String> securityProfileIds)
```
    The identifiers of the user's security profiles.
    
    Parameters:
    
    securityProfileIds - The identifiers of the user's security profiles.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,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(Map<String,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(Map<String,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"} }.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public UserSearchSummary addTagsEntry(String key,
                                      String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public UserSearchSummary clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUsername
```
public void setUsername(String username)
```
    The name of the user.
    
    Parameters:
    
    username - The name of the user.
  - getUsername
```
public String getUsername()
```
    The name of the user.
    
    Returns:
    
    The name of the user.
  - withUsername
```
public UserSearchSummary withUsername(String username)
```
    The name of the user.
    
    Parameters:
    
    username - The name of the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UserSearchSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.772

Class UserSearchSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserSearchSummary

Method Detail

setArn

getArn

withArn

setDirectoryUserId

getDirectoryUserId

withDirectoryUserId

setHierarchyGroupId

getHierarchyGroupId

withHierarchyGroupId

setId

getId

withId

setIdentityInfo

getIdentityInfo

withIdentityInfo

setPhoneConfig

getPhoneConfig

withPhoneConfig

setRoutingProfileId

getRoutingProfileId

withRoutingProfileId

getSecurityProfileIds

setSecurityProfileIds

withSecurityProfileIds

withSecurityProfileIds

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setUsername

getUsername

withUsername

toString

equals

hashCode

clone

marshall