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:

  • Method Details

    • 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.

      Prefix search supports a maximum of 1,000 characters for the string.

      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.

      Prefix search supports a maximum of 1,000 characters for the string.

    • 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.

    • createdAt

      public final Instant createdAt()

      The date and time the group was created.

      Returns:
      The date and time the group was created.

    • updatedAt

      public final Instant updatedAt()

      The date and time the group was last updated.

      Returns:
      The date and time the group was last updated.

    • createdBy

      public final String createdBy()

      The identifier of the user or system that created the group.

      Returns:
      The identifier of the user or system that created the group.

    • updatedBy

      public final String updatedBy()

      The identifier of the user or system that last updated the group.

      Returns:
      The identifier of the user or system that last updated the 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()
      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 interface ToCopyableBuilder<Group.Builder,Group>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.