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

Class DocumentAttributeTarget

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.DocumentAttributeTarget

All Implemented Interfaces:

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

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

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.

For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q Business will then map your newly created document attribute to your index field.

You can also use this with DocumentAttributeCondition .

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentAttributeTarget.Builder

Method Summary

Modifier and Type	Method	Description
AttributeValueOperator	attributeValueOperator()	TRUE to delete the existing target value for your specified target attribute key.
String	attributeValueOperatorAsString()	TRUE to delete the existing target value for your specified target attribute key.
static DocumentAttributeTarget.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key()	The identifier of the target document attribute or metadata field.
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentAttributeTarget.Builder>	serializableBuilderClass()
DocumentAttributeTarget.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
DocumentAttributeValue	value()	Returns the value of the Value property for 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

key

public final String key()

The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

Returns:

The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

value

public final DocumentAttributeValue value()

Returns the value of the Value property for this object.

Returns:

The value of the Value property for this object.

attributeValueOperator

public final AttributeValueOperator attributeValueOperator()

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.

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

Returns:

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.

See Also:

AttributeValueOperator

attributeValueOperatorAsString

public final String attributeValueOperatorAsString()

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.

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

Returns:

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.

See Also:

AttributeValueOperator

toBuilder

public DocumentAttributeTarget.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentAttributeTarget.Builder,DocumentAttributeTarget>

builder

public static DocumentAttributeTarget.Builder builder()

serializableBuilderClass

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