Class DocumentAttributeTarget
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AttributeValueOperator
TRUE
to delete the existing target value for your specified target attribute key.final String
TRUE
to delete the existing target value for your specified target attribute key.builder()
final boolean
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 String
key()
The identifier of the target document attribute or metadata field.static Class
<? extends DocumentAttributeTarget.Builder> 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.final DocumentAttributeValue
value()
Returns the value of the Value property for this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
Returns the value of the Value property for this object.- Returns:
- The value of the Value property for this object.
-
attributeValueOperator
TRUE
to delete the existing target value for your specified target attribute key. You cannot create a target value and set this toTRUE
.If the service returns an enum value that is not available in the current SDK version,
attributeValueOperator
will returnAttributeValueOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromattributeValueOperatorAsString()
.- Returns:
TRUE
to delete the existing target value for your specified target attribute key. You cannot create a target value and set this toTRUE
.- See Also:
-
attributeValueOperatorAsString
TRUE
to delete the existing target value for your specified target attribute key. You cannot create a target value and set this toTRUE
.If the service returns an enum value that is not available in the current SDK version,
attributeValueOperator
will returnAttributeValueOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromattributeValueOperatorAsString()
.- Returns:
TRUE
to delete the existing target value for your specified target attribute key. You cannot create a target value and set this toTRUE
.- See Also:
-
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 interfaceToCopyableBuilder<DocumentAttributeTarget.Builder,
DocumentAttributeTarget> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-