Class Group
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Group.Builder,
Group>
A group object that contains the metadata and attributes for a specified group.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Group.Builder
builder()
final String
A string containing a description of the specified group.final String
The display name value for the group.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<ExternalId> A list ofExternalId
objects that contains the identifiers issued to this resource by an external identity provider.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final String
groupId()
The identifier for a group in the identity store.final boolean
For responses, this returns true if the service returned a value for the ExternalIds property.final int
hashCode()
final String
The globally unique identifier for the identity store.static Class
<? extends Group.Builder> 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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
groupId
The identifier for a group in the identity store.
- Returns:
- The identifier for a group in the identity store.
-
displayName
The display name value for the group. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.
- Returns:
- The display name value for the group. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.
-
hasExternalIds
public final boolean hasExternalIds()For responses, this returns true if the service returned a value for the ExternalIds 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. -
externalIds
A list of
ExternalId
objects that contains the identifiers issued to this resource by an external identity provider.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
hasExternalIds()
method.- Returns:
- A list of
ExternalId
objects that contains the identifiers issued to this resource by an external identity provider.
-
description
A string containing a description of the specified group.
- Returns:
- A string containing a description of the specified group.
-
identityStoreId
The globally unique identifier for the identity store.
- Returns:
- The globally unique identifier for the identity store.
-
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<Group.Builder,
Group> - 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
-