Class UserSearchSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<UserSearchSummary.Builder,
UserSearchSummary>
Information about the returned users.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the user.static UserSearchSummary.Builder
builder()
final String
The directory identifier of the user.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SecurityProfileIds property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The identifier of the user's hierarchy group.final String
id()
The identifier of the user's summary.final UserIdentityInfoLite
The user's first name and last name.final UserPhoneConfig
Returns the value of the PhoneConfig property for this object.final String
The identifier of the user's routing profile.The identifiers of the user's security profiles.static Class
<? extends UserSearchSummary.Builder> tags()
The tags used to organize, track, or control access for this resource.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
username()
The name of the user.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the user.
- Returns:
- The Amazon Resource Name (ARN) of the user.
-
directoryUserId
The directory identifier of the user.
- Returns:
- The directory identifier of the user.
-
hierarchyGroupId
The identifier of the user's hierarchy group.
- Returns:
- The identifier of the user's hierarchy group.
-
id
The identifier of the user's summary.
- Returns:
- The identifier of the user's summary.
-
identityInfo
The user's first name and last name.
- Returns:
- The user's first name and last name.
-
phoneConfig
Returns the value of the PhoneConfig property for this object.- Returns:
- The value of the PhoneConfig property for this object.
-
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 theisEmpty()
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
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 theisEmpty()
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
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
The name of the user.
- Returns:
- The name of the user.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UserSearchSummary.Builder,
UserSearchSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-