Interface DocumentIdOptions.Builder

All Superinterfaces:

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

Enclosing class:

DocumentIdOptions

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

Method Summary

Modifier and Type	Method	Description
DocumentIdOptions.Builder	defaultDocumentIdFormat(String defaultDocumentIdFormat)	When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier.
DocumentIdOptions.Builder	defaultDocumentIdFormat(DefaultDocumentIdFormat defaultDocumentIdFormat)	When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

defaultDocumentIdFormat

DocumentIdOptions.Builder defaultDocumentIdFormat(String defaultDocumentIdFormat)

When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.

When the NO_DOCUMENT_ID option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.

Parameters:

defaultDocumentIdFormat - When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.

When the NO_DOCUMENT_ID option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.

Returns:

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

See Also:

• DefaultDocumentIdFormat
• DefaultDocumentIdFormat

defaultDocumentIdFormat

DocumentIdOptions.Builder defaultDocumentIdFormat(DefaultDocumentIdFormat defaultDocumentIdFormat)

When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.

When the NO_DOCUMENT_ID option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.

Parameters:

defaultDocumentIdFormat - When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.

When the NO_DOCUMENT_ID option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.

Returns:

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

See Also:

• DefaultDocumentIdFormat
• DefaultDocumentIdFormat