HookConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.qbusiness.model.HookConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HookConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.

If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Custom document enrichment.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

HookConfiguration()

Constructors
Constructor and Description
`HookConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HookConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`DocumentAttributeCondition`	`getInvocationCondition()` The condition used for when a Lambda function should be invoked.
`String`	`getLambdaArn()` The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion.
`String`	`getRoleArn()` 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.
`String`	`getS3BucketName()` Stores the original, raw documents or the structured, parsed documents before and after altering them.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setInvocationCondition(DocumentAttributeCondition invocationCondition)` The condition used for when a Lambda function should be invoked.
`void`	`setLambdaArn(String lambdaArn)` The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion.
`void`	`setRoleArn(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.
`void`	`setS3BucketName(String s3BucketName)` Stores the original, raw documents or the structured, parsed documents before and after altering them.
`String`	`toString()` Returns a string representation of this object.
`HookConfiguration`	`withInvocationCondition(DocumentAttributeCondition invocationCondition)` The condition used for when a Lambda function should be invoked.
`HookConfiguration`	`withLambdaArn(String lambdaArn)` The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion.
`HookConfiguration`	`withRoleArn(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`	`withS3BucketName(String s3BucketName)` Stores the original, raw documents or the structured, parsed documents before and after altering them.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HookConfiguration
```
public HookConfiguration()
```
- Method Detail
  - setInvocationCondition
```
public void setInvocationCondition(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.
  - getInvocationCondition
```
public DocumentAttributeCondition getInvocationCondition()
```
    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:
    
    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.
  - withInvocationCondition
```
public HookConfiguration withInvocationCondition(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.
  - setLambdaArn
```
public void setLambdaArn(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).
  - getLambdaArn
```
public String getLambdaArn()
```
    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:
    
    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).
  - withLambdaArn
```
public HookConfiguration withLambdaArn(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.
  - setRoleArn
```
public void setRoleArn(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.
  - getRoleArn
```
public String getRoleArn()
```
    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:
    
    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.
  - withRoleArn
```
public HookConfiguration withRoleArn(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.
  - setS3BucketName
```
public void setS3BucketName(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.
  - getS3BucketName
```
public String getS3BucketName()
```
    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:
    
    Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
  - withS3BucketName
```
public HookConfiguration withS3BucketName(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public HookConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.711

Class HookConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HookConfiguration

Method Detail

setInvocationCondition

getInvocationCondition

withInvocationCondition

setLambdaArn

getLambdaArn

withLambdaArn

setRoleArn

getRoleArn

withRoleArn

setS3BucketName

getS3BucketName

withS3BucketName

toString

equals

hashCode

clone

marshall