Class InlineDocumentEnrichmentConfiguration

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.InlineDocumentEnrichmentConfiguration

All Implemented Interfaces:

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

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

Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.

To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration .

For more information, see Custom document enrichment.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InlineDocumentEnrichmentConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static InlineDocumentEnrichmentConfiguration.Builder	builder()
final DocumentAttributeCondition	condition()	Returns the value of the Condition property for this object.
final DocumentContentOperator	documentContentOperator()	TRUE to delete content if the condition used for the target attribute is met.
final String	documentContentOperatorAsString()	TRUE to delete content if the condition used for the target attribute is met.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends InlineDocumentEnrichmentConfiguration.Builder>	serializableBuilderClass()
final DocumentAttributeTarget	target()	Returns the value of the Target property for this object.
InlineDocumentEnrichmentConfiguration.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

condition

public final DocumentAttributeCondition condition()

Returns the value of the Condition property for this object.

Returns:

The value of the Condition property for this object.

target

public final DocumentAttributeTarget target()

Returns the value of the Target property for this object.

Returns:

The value of the Target property for this object.

documentContentOperator

public final DocumentContentOperator documentContentOperator()

TRUE to delete content if the condition used for the target attribute is met.

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

Returns:

TRUE to delete content if the condition used for the target attribute is met.

See Also:

• DocumentContentOperator

documentContentOperatorAsString

public final String documentContentOperatorAsString()

TRUE to delete content if the condition used for the target attribute is met.

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

Returns:

TRUE to delete content if the condition used for the target attribute is met.

See Also:

• DocumentContentOperator

toBuilder

public InlineDocumentEnrichmentConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<InlineDocumentEnrichmentConfiguration.Builder,InlineDocumentEnrichmentConfiguration>

Returns:

a builder for type T

builder

public static InlineDocumentEnrichmentConfiguration.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.