UserSearchSummary (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.connect.model.UserSearchSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<UserSearchSummary.Builder,UserSearchSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class UserSearchSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UserSearchSummary.Builder,UserSearchSummary>

Information about the returned users.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UserSearchSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UserSearchSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the user.
`static UserSearchSummary.Builder`	`builder()`
`String`	`directoryUserId()` The directory identifier of the user.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSecurityProfileIds()` For responses, this returns true if the service returned a value for the SecurityProfileIds property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`hierarchyGroupId()` The identifier of the user's hierarchy group.
`String`	`id()` The identifier of the user's summary.
`UserIdentityInfoLite`	`identityInfo()` The user's first name and last name.
`UserPhoneConfig`	`phoneConfig()` Returns the value of the PhoneConfig property for this object.
`String`	`routingProfileId()` The identifier of the user's routing profile.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityProfileIds()` The identifiers of the user's security profiles.
`static Class<? extends UserSearchSummary.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` The tags used to organize, track, or control access for this resource.
`UserSearchSummary.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`username()` The name of the user.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the user.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the user.
  - directoryUserId
```
public final String directoryUserId()
```
    The directory identifier of the user.
    
    Returns:
    
    The directory identifier of the user.
  - hierarchyGroupId
```
public final String hierarchyGroupId()
```
    The identifier of the user's hierarchy group.
    
    Returns:
    
    The identifier of the user's hierarchy group.
  - id
```
public final String id()
```
    The identifier of the user's summary.
    
    Returns:
    
    The identifier of the user's summary.
  - identityInfo
```
public final UserIdentityInfoLite identityInfo()
```
    The user's first name and last name.
    
    Returns:
    
    The user's first name and last name.
  - phoneConfig
```
public final UserPhoneConfig phoneConfig()
```
    Returns the value of the PhoneConfig property for this object.
    
    Returns:
    
    The value of the PhoneConfig property for this object.
  - routingProfileId
```
public final String routingProfileId()
```
    The identifier of the user's routing profile.
    
    Returns:
    
    The identifier of the user's routing profile.
  - hasSecurityProfileIds
```
public final boolean hasSecurityProfileIds()
```
    For responses, this returns true if the service returned a value for the SecurityProfileIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - securityProfileIds
```
public final List<String> securityProfileIds()
```
    The identifiers of the user's security profiles.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityProfileIds() method.
    
    Returns:
    
    The identifiers of the user's security profiles.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final Map<String,String> tags()
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
  - username
```
public final String username()
```
    The name of the user.
    
    Returns:
    
    The name of the user.
  - toBuilder
```
public UserSearchSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UserSearchSummary.Builder,UserSearchSummary>
  - builder
```
public static UserSearchSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UserSearchSummary.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UserSearchSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

directoryUserId

hierarchyGroupId

id

identityInfo

phoneConfig

routingProfileId

hasSecurityProfileIds

securityProfileIds

hasTags

tags

username

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields