Class PrincipalGroup

java.lang.Object
software.amazon.awssdk.services.qbusiness.model.PrincipalGroup
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PrincipalGroup.Builder,PrincipalGroup>
@Generated("software.amazon.awssdk:codegen") public final class PrincipalGroup extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PrincipalGroup.Builder,PrincipalGroup>

Provides information about a group associated with the principal.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the group.

      Returns:
      The name of the group.

    • access

      public final ReadAccessType access()

      Provides information about whether to allow or deny access to the principal.

      If the service returns an enum value that is not available in the current SDK version, access will return ReadAccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accessAsString().

      Returns:
      Provides information about whether to allow or deny access to the principal.
      See Also:

    • accessAsString

      public final String accessAsString()

      Provides information about whether to allow or deny access to the principal.

      If the service returns an enum value that is not available in the current SDK version, access will return ReadAccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accessAsString().

      Returns:
      Provides information about whether to allow or deny access to the principal.
      See Also:

    • membershipType

      public final MembershipType membershipType()

      The type of group.

      If the service returns an enum value that is not available in the current SDK version, membershipType will return MembershipType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from membershipTypeAsString().

      Returns:
      The type of group.
      See Also:

    • membershipTypeAsString

      public final String membershipTypeAsString()

      The type of group.

      If the service returns an enum value that is not available in the current SDK version, membershipType will return MembershipType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from membershipTypeAsString().

      Returns:
      The type of group.
      See Also:

    • toBuilder

      public PrincipalGroup.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<PrincipalGroup.Builder,PrincipalGroup>
      Returns:
      a builder for type T

    • builder

      public static PrincipalGroup.Builder builder()

    • serializableBuilderClass

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