Package software.amazon.awssdk.services.qbusiness.model

Interface HookConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

HookConfiguration

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

Method Summary

Modifier and Type	Method	Description
default HookConfiguration.Builder	invocationCondition(Consumer<DocumentAttributeCondition.Builder> invocationCondition)	The condition used for when a Lambda function should be invoked.
HookConfiguration.Builder	invocationCondition(DocumentAttributeCondition invocationCondition)	The condition used for when a Lambda function should be invoked.
HookConfiguration.Builder	lambdaArn(String lambdaArn)	The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion.
HookConfiguration.Builder	roleArn(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.
HookConfiguration.Builder	s3BucketName(String s3BucketName)	Stores the original, raw documents or the structured, parsed documents before and after altering them.

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, sdkFields

Method Detail

invocationCondition

HookConfiguration.Builder invocationCondition(DocumentAttributeCondition invocationCondition)

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

Parameters:

invocationCondition - The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

Returns:

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

invocationCondition

default HookConfiguration.Builder invocationCondition(Consumer<DocumentAttributeCondition.Builder> invocationCondition)

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to invocationCondition(DocumentAttributeCondition).

Parameters:

invocationCondition - a consumer that will call methods on DocumentAttributeCondition.Builder

Returns:

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

See Also:

invocationCondition(DocumentAttributeCondition)

lambdaArn

HookConfiguration.Builder lambdaArn(String lambdaArn)

The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).

Parameters:

lambdaArn - The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).

Returns:

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

s3BucketName

HookConfiguration.Builder s3BucketName(String s3BucketName)

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

Parameters:

s3BucketName - Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

Returns:

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

roleArn

HookConfiguration.Builder roleArn(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.

Parameters:

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.

Returns:

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