Interface CheckDocumentAccessResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<CheckDocumentAccessResponse.Builder,CheckDocumentAccessResponse>, QBusinessResponse.Builder, SdkBuilder<CheckDocumentAccessResponse.Builder,CheckDocumentAccessResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
CheckDocumentAccessResponse
@Mutable @NotThreadSafe public static interface CheckDocumentAccessResponse.Builder extends QBusinessResponse.Builder, SdkPojo, CopyableBuilder<CheckDocumentAccessResponse.Builder,CheckDocumentAccessResponse>

  • Method Details

    • userGroups

      CheckDocumentAccessResponse.Builder userGroups(Collection<AssociatedGroup> userGroups)

      An array of groups the user is part of for the specified data source. Each group has a name and type.

      Parameters:
      userGroups - An array of groups the user is part of for the specified data source. Each group has a name and type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userGroups

      CheckDocumentAccessResponse.Builder userGroups(AssociatedGroup... userGroups)

      An array of groups the user is part of for the specified data source. Each group has a name and type.

      Parameters:
      userGroups - An array of groups the user is part of for the specified data source. Each group has a name and type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userGroups

      CheckDocumentAccessResponse.Builder userGroups(Consumer<AssociatedGroup.Builder>... userGroups)

      An array of groups the user is part of for the specified data source. Each group has a name and type.

      This is a convenience method that creates an instance of the AssociatedGroup.Builder avoiding the need to create one manually via AssociatedGroup.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userGroups(List<AssociatedGroup>).

      Parameters:
      userGroups - a consumer that will call methods on AssociatedGroup.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userAliases

      CheckDocumentAccessResponse.Builder userAliases(Collection<AssociatedUser> userAliases)

      An array of aliases associated with the user. This includes both global and local aliases, each with a name and type.

      Parameters:
      userAliases - An array of aliases associated with the user. This includes both global and local aliases, each with a name and type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userAliases

      CheckDocumentAccessResponse.Builder userAliases(AssociatedUser... userAliases)

      An array of aliases associated with the user. This includes both global and local aliases, each with a name and type.

      Parameters:
      userAliases - An array of aliases associated with the user. This includes both global and local aliases, each with a name and type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userAliases

      CheckDocumentAccessResponse.Builder userAliases(Consumer<AssociatedUser.Builder>... userAliases)

      An array of aliases associated with the user. This includes both global and local aliases, each with a name and type.

      This is a convenience method that creates an instance of the AssociatedUser.Builder avoiding the need to create one manually via AssociatedUser.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userAliases(List<AssociatedUser>).

      Parameters:
      userAliases - a consumer that will call methods on AssociatedUser.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • hasAccess

      CheckDocumentAccessResponse.Builder hasAccess(Boolean hasAccess)

      A boolean value indicating whether the specified user has access to the document, either direct access or transitive access via groups and aliases attached to the document.

      Parameters:
      hasAccess - A boolean value indicating whether the specified user has access to the document, either direct access or transitive access via groups and aliases attached to the document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentAcl

      CheckDocumentAccessResponse.Builder documentAcl(DocumentAcl documentAcl)

      The Access Control List (ACL) associated with the document. Includes allowlist and denylist conditions that determine user access.

      Parameters:
      documentAcl - The Access Control List (ACL) associated with the document. Includes allowlist and denylist conditions that determine user access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentAcl

      default CheckDocumentAccessResponse.Builder documentAcl(Consumer<DocumentAcl.Builder> documentAcl)

      The Access Control List (ACL) associated with the document. Includes allowlist and denylist conditions that determine user access.

      This is a convenience method that creates an instance of the DocumentAcl.Builder avoiding the need to create one manually via DocumentAcl.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentAcl(DocumentAcl).

      Parameters:
      documentAcl - a consumer that will call methods on DocumentAcl.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: