software.amazon.awssdk.services.firehose.model

Class DocumentIdOptions

java.lang.Object

software.amazon.awssdk.services.firehose.model.DocumentIdOptions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DocumentIdOptions.Builder,DocumentIdOptions>

@Generated(value="software.amazon.awssdk:codegen")
public final class DocumentIdOptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DocumentIdOptions.Builder,DocumentIdOptions>

Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DocumentIdOptions.Builder

Method Summary

Modifier and Type	Method and Description
static DocumentIdOptions.Builder	builder()
DefaultDocumentIdFormat	defaultDocumentIdFormat() When the FIREHOSE_DEFAULT option is chosen, Kinesis Data Firehose generates a unique document ID for each record based on a unique internal identifier.
String	defaultDocumentIdFormatAsString() When the FIREHOSE_DEFAULT option is chosen, Kinesis Data Firehose generates a unique document ID for each record based on a unique internal identifier.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentIdOptions.Builder>	serializableBuilderClass()
DocumentIdOptions.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

defaultDocumentIdFormat

public final DefaultDocumentIdFormat defaultDocumentIdFormat()

When the FIREHOSE_DEFAULT option is chosen, Kinesis Data 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, Kinesis Data 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.

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

Returns:

When the FIREHOSE_DEFAULT option is chosen, Kinesis Data 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, Kinesis Data 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.

See Also:

DefaultDocumentIdFormat

defaultDocumentIdFormatAsString

public final String defaultDocumentIdFormatAsString()

When the FIREHOSE_DEFAULT option is chosen, Kinesis Data 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, Kinesis Data 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.

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

Returns:

When the FIREHOSE_DEFAULT option is chosen, Kinesis Data 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, Kinesis Data 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.

See Also:

DefaultDocumentIdFormat

toBuilder

public DocumentIdOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentIdOptions.Builder,DocumentIdOptions>

builder

public static DocumentIdOptions.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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