Class DocumentAclCondition

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

Represents a condition in the document's ACL, specifying access rules for users and groups.

See Also:

  • Method Details

    • memberRelation

      public final MemberRelation memberRelation()

      The logical relation between members in the condition, determining how multiple user or group conditions are combined.

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

      Returns:
      The logical relation between members in the condition, determining how multiple user or group conditions are combined.
      See Also:

    • memberRelationAsString

      public final String memberRelationAsString()

      The logical relation between members in the condition, determining how multiple user or group conditions are combined.

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

      Returns:
      The logical relation between members in the condition, determining how multiple user or group conditions are combined.
      See Also:

    • hasUsers

      public final boolean hasUsers()
      For responses, this returns true if the service returned a value for the Users 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.

    • users

      public final List<DocumentAclUser> users()

      An array of user identifiers that this condition applies to. Users listed here are subject to the access rule defined by this condition.

      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 hasUsers() method.

      Returns:
      An array of user identifiers that this condition applies to. Users listed here are subject to the access rule defined by this condition.

    • hasGroups

      public final boolean hasGroups()
      For responses, this returns true if the service returned a value for the Groups 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.

    • groups

      public final List<DocumentAclGroup> groups()

      An array of group identifiers that this condition applies to. Groups listed here are subject to the access rule defined by this condition.

      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 hasGroups() method.

      Returns:
      An array of group identifiers that this condition applies to. Groups listed here are subject to the access rule defined by this condition.

    • toBuilder

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

    • builder

      public static DocumentAclCondition.Builder builder()

    • serializableBuilderClass

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