software.amazon.awssdk.services.kendra.model

Class CustomDocumentEnrichmentConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.CustomDocumentEnrichmentConfiguration

All Implemented Interfaces:

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

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

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Customizing document metadata during the ingestion process.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CustomDocumentEnrichmentConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static CustomDocumentEnrichmentConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInlineConfigurations() For responses, this returns true if the service returned a value for the InlineConfigurations property.
List<InlineCustomDocumentEnrichmentConfiguration>	inlineConfigurations() Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
HookConfiguration	postExtractionHookConfiguration() Configuration information for invoking a Lambda function in Lambda on the structured documents with their metadata and text extracted.
HookConfiguration	preExtractionHookConfiguration() Configuration information for invoking a Lambda function in Lambda on the original or raw documents before extracting their metadata and text.
String	roleArn() The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.
List<SdkField<?>>	sdkFields()
static Class<? extends CustomDocumentEnrichmentConfiguration.Builder>	serializableBuilderClass()
CustomDocumentEnrichmentConfiguration.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

hasInlineConfigurations

public final boolean hasInlineConfigurations()

For responses, this returns true if the service returned a value for the InlineConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

inlineConfigurations

public final List<InlineCustomDocumentEnrichmentConfiguration> inlineConfigurations()

Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInlineConfigurations() method.

Returns:

Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.

preExtractionHookConfiguration

public final HookConfiguration preExtractionHookConfiguration()

Configuration information for invoking a Lambda function in Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation.

Returns:

Configuration information for invoking a Lambda function in Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation.

postExtractionHookConfiguration

public final HookConfiguration postExtractionHookConfiguration()

Configuration information for invoking a Lambda function in Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation.

Returns:

Configuration information for invoking a Lambda function in Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process. For more information, see IAM roles for Amazon Kendra.

Returns:

The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process. For more information, see IAM roles for Amazon Kendra.

toBuilder

public CustomDocumentEnrichmentConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CustomDocumentEnrichmentConfiguration.Builder,CustomDocumentEnrichmentConfiguration>

builder

public static CustomDocumentEnrichmentConfiguration.Builder builder()

serializableBuilderClass

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