Package software.amazon.awssdk.services.identitystore.model

Class Group

java.lang.Object

software.amazon.awssdk.services.identitystore.model.Group

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Group.Builder,Group>

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

A group object that contains the metadata and attributes for a specified group.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Group.Builder

Method Summary

Modifier and Type	Method	Description
static Group.Builder	builder()
String	description()	A string containing a description of the specified group.
String	displayName()	The display name value for the group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<ExternalId>	externalIds()	A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	groupId()	The identifier for a group in the identity store.
boolean	hasExternalIds()	For responses, this returns true if the service returned a value for the ExternalIds property.
int	hashCode()
String	identityStoreId()	The globally unique identifier for the identity store.
List<SdkField<?>>	sdkFields()
static Class<? extends Group.Builder>	serializableBuilderClass()
Group.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

groupId

public final String groupId()

The identifier for a group in the identity store.

Returns:

The identifier for a group in the identity store.

displayName

public final String 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 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.

externalIds

public final List<ExternalId> 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

public final String description()

A string containing a description of the specified group.

Returns:

A string containing a description of the specified group.

identityStoreId

public final String identityStoreId()

The globally unique identifier for the identity store.

Returns:

The globally unique identifier for the identity store.

toBuilder

public Group.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Group.Builder,Group>

builder

public static Group.Builder builder()

serializableBuilderClass

public static Class<? extends Group.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