Interface ListDocumentsResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<ListDocumentsResponse.Builder,ListDocumentsResponse>, QBusinessResponse.Builder, SdkBuilder<ListDocumentsResponse.Builder,ListDocumentsResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

ListDocumentsResponse

@Mutable
@NotThreadSafe
public static interface ListDocumentsResponse.Builder
extends QBusinessResponse.Builder, SdkPojo, CopyableBuilder<ListDocumentsResponse.Builder,ListDocumentsResponse>

Method Summary

Modifier and Type	Method	Description
ListDocumentsResponse.Builder	documentDetailList(Collection<DocumentDetails> documentDetailList)	A list of document details.
ListDocumentsResponse.Builder	documentDetailList(Consumer<DocumentDetails.Builder>... documentDetailList)	A list of document details.
ListDocumentsResponse.Builder	documentDetailList(DocumentDetails... documentDetailList)	A list of document details.
ListDocumentsResponse.Builder	nextToken(String nextToken)	If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.qbusiness.model.QBusinessResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

documentDetailList

ListDocumentsResponse.Builder documentDetailList(Collection<DocumentDetails> documentDetailList)

A list of document details.

Parameters:

documentDetailList - A list of document details.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentDetailList

ListDocumentsResponse.Builder documentDetailList(DocumentDetails... documentDetailList)

A list of document details.

Parameters:

documentDetailList - A list of document details.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentDetailList

ListDocumentsResponse.Builder documentDetailList(Consumer<DocumentDetails.Builder>... documentDetailList)

A list of document details.

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

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

Parameters:

documentDetailList - a consumer that will call methods on DocumentDetails.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• documentDetailList(java.util.Collection<DocumentDetails>)

nextToken

ListDocumentsResponse.Builder nextToken(String nextToken)

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

Parameters:

nextToken - If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

Returns:

Returns a reference to this object so that method calls can be chained together.