software.amazon.awssdk.services.kendra.model

Interface DocumentInfo.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DocumentInfo.Builder,DocumentInfo>, SdkBuilder<DocumentInfo.Builder,DocumentInfo>, SdkPojo

Enclosing class:

DocumentInfo

public static interface DocumentInfo.Builder
extends SdkPojo, CopyableBuilder<DocumentInfo.Builder,DocumentInfo>

Method Summary

Modifier and Type	Method and Description
DocumentInfo.Builder	attributes(Collection<DocumentAttribute> attributes) Attributes that identify a specific version of a document to check.
DocumentInfo.Builder	attributes(Consumer<DocumentAttribute.Builder>... attributes) Attributes that identify a specific version of a document to check.
DocumentInfo.Builder	attributes(DocumentAttribute... attributes) Attributes that identify a specific version of a document to check.
DocumentInfo.Builder	documentId(String documentId) The identifier of the document.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

documentId

DocumentInfo.Builder documentId(String documentId)

The identifier of the document.

Parameters:

documentId - The identifier of the document.

Returns:

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

attributes

DocumentInfo.Builder attributes(Collection<DocumentAttribute> attributes)

Attributes that identify a specific version of a document to check.

The only valid attributes are:

• version

• datasourceId

• jobExecutionId

The attributes follow these rules:

• dataSourceId and jobExecutionId must be used together.

• version is ignored if dataSourceId and jobExecutionId are not provided.

• If dataSourceId and jobExecutionId are provided, but version is not, the version defaults to "0".

Parameters:

attributes - Attributes that identify a specific version of a document to check.

The only valid attributes are:

• version

• datasourceId

• jobExecutionId

The attributes follow these rules:

• dataSourceId and jobExecutionId must be used together.

• version is ignored if dataSourceId and jobExecutionId are not provided.

• If dataSourceId and jobExecutionId are provided, but version is not, the version defaults to "0".

Returns:

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

attributes

DocumentInfo.Builder attributes(DocumentAttribute... attributes)

Attributes that identify a specific version of a document to check.

The only valid attributes are:

• version

• datasourceId

• jobExecutionId

The attributes follow these rules:

• dataSourceId and jobExecutionId must be used together.

• version is ignored if dataSourceId and jobExecutionId are not provided.

• If dataSourceId and jobExecutionId are provided, but version is not, the version defaults to "0".

Parameters:

attributes - Attributes that identify a specific version of a document to check.

The only valid attributes are:

• version

• datasourceId

• jobExecutionId

The attributes follow these rules:

• dataSourceId and jobExecutionId must be used together.

• version is ignored if dataSourceId and jobExecutionId are not provided.

• If dataSourceId and jobExecutionId are provided, but version is not, the version defaults to "0".

Returns:

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

attributes

DocumentInfo.Builder attributes(Consumer<DocumentAttribute.Builder>... attributes)

Attributes that identify a specific version of a document to check.

The only valid attributes are:

• version

• datasourceId

• jobExecutionId

The attributes follow these rules:

• dataSourceId and jobExecutionId must be used together.

• version is ignored if dataSourceId and jobExecutionId are not provided.

• If dataSourceId and jobExecutionId are provided, but version is not, the version defaults to "0".

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #attributes(List).

Parameters:

attributes - a consumer that will call methods on DocumentAttribute.Builder

Returns:

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

See Also:

#attributes(java.util.Collection)