software.amazon.awssdk.services.qbusiness.model.DocumentAttributeCondition Maven / Gradle / Ivy
Show all versions of qbusiness Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.qbusiness.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q
* Business. You use this with
* DocumentAttributeTarget to apply the condition.
*
*
* For example, you can create the 'Department' target field and have it prefill department names associated with the
* documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains
* 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the
* document.
*
*
* 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 then will map your newly created metadata field to your index field.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DocumentAttributeCondition implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField KEY_FIELD = SdkField. builder(MarshallingType.STRING).memberName("key")
.getter(getter(DocumentAttributeCondition::key)).setter(setter(Builder::key))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("key").build()).build();
private static final SdkField OPERATOR_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("operator").getter(getter(DocumentAttributeCondition::operatorAsString))
.setter(setter(Builder::operator))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("operator").build()).build();
private static final SdkField VALUE_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("value")
.getter(getter(DocumentAttributeCondition::value)).setter(setter(Builder::value))
.constructor(DocumentAttributeValue::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("value").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(KEY_FIELD, OPERATOR_FIELD,
VALUE_FIELD));
private static final long serialVersionUID = 1L;
private final String key;
private final String operator;
private final DocumentAttributeValue value;
private DocumentAttributeCondition(BuilderImpl builder) {
this.key = builder.key;
this.operator = builder.operator;
this.value = builder.value;
}
/**
*
* The identifier of the document attribute used for the condition.
*
*
* For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs
* associated with the documents.
*
*
* Amazon Q Business currently doesn't support _document_body as an attribute key used for the
* condition.
*
*
* @return The identifier of the document attribute used for the condition.
*
* For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source
* URIs associated with the documents.
*
*
* Amazon Q Business currently doesn't support _document_body as an attribute key used for the
* condition.
*/
public final String key() {
return key;
}
/**
*
* The identifier of the document attribute used for the condition.
*
*
* For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs
* associated with the documents.
*
*
* Amazon Q Business currently does not support _document_body as an attribute key used for the
* condition.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #operator} will
* return {@link DocumentEnrichmentConditionOperator#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service
* is available from {@link #operatorAsString}.
*
*
* @return The identifier of the document attribute used for the condition.
*
* For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source
* URIs associated with the documents.
*
*
* Amazon Q Business currently does not support _document_body as an attribute key used for the
* condition.
* @see DocumentEnrichmentConditionOperator
*/
public final DocumentEnrichmentConditionOperator operator() {
return DocumentEnrichmentConditionOperator.fromValue(operator);
}
/**
*
* The identifier of the document attribute used for the condition.
*
*
* For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs
* associated with the documents.
*
*
* Amazon Q Business currently does not support _document_body as an attribute key used for the
* condition.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #operator} will
* return {@link DocumentEnrichmentConditionOperator#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service
* is available from {@link #operatorAsString}.
*
*
* @return The identifier of the document attribute used for the condition.
*
* For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source
* URIs associated with the documents.
*
*
* Amazon Q Business currently does not support _document_body as an attribute key used for the
* condition.
* @see DocumentEnrichmentConditionOperator
*/
public final String operatorAsString() {
return operator;
}
/**
* Returns the value of the Value property for this object.
*
* @return The value of the Value property for this object.
*/
public final DocumentAttributeValue value() {
return value;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(key());
hashCode = 31 * hashCode + Objects.hashCode(operatorAsString());
hashCode = 31 * hashCode + Objects.hashCode(value());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DocumentAttributeCondition)) {
return false;
}
DocumentAttributeCondition other = (DocumentAttributeCondition) obj;
return Objects.equals(key(), other.key()) && Objects.equals(operatorAsString(), other.operatorAsString())
&& Objects.equals(value(), other.value());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DocumentAttributeCondition").add("Key", key()).add("Operator", operatorAsString())
.add("Value", value()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "key":
return Optional.ofNullable(clazz.cast(key()));
case "operator":
return Optional.ofNullable(clazz.cast(operatorAsString()));
case "value":
return Optional.ofNullable(clazz.cast(value()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DocumentAttributeCondition) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The identifier of the document attribute used for the condition.
*
*
* For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source
* URIs associated with the documents.
*
*
* Amazon Q Business currently doesn't support _document_body as an attribute key used for the
* condition.
*
*
* @param key
* The identifier of the document attribute used for the condition.
*
* For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains
* source URIs associated with the documents.
*
*
* Amazon Q Business currently doesn't support _document_body as an attribute key used for
* the condition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder key(String key);
/**
*
* The identifier of the document attribute used for the condition.
*
*
* For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source
* URIs associated with the documents.
*
*
* Amazon Q Business currently does not support _document_body as an attribute key used for the
* condition.
*
*
* @param operator
* The identifier of the document attribute used for the condition.
*
* For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains
* source URIs associated with the documents.
*
*
* Amazon Q Business currently does not support _document_body as an attribute key used for
* the condition.
* @see DocumentEnrichmentConditionOperator
* @return Returns a reference to this object so that method calls can be chained together.
* @see DocumentEnrichmentConditionOperator
*/
Builder operator(String operator);
/**
*
* The identifier of the document attribute used for the condition.
*
*
* For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source
* URIs associated with the documents.
*
*
* Amazon Q Business currently does not support _document_body as an attribute key used for the
* condition.
*
*
* @param operator
* The identifier of the document attribute used for the condition.
*
* For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains
* source URIs associated with the documents.
*
*
* Amazon Q Business currently does not support _document_body as an attribute key used for
* the condition.
* @see DocumentEnrichmentConditionOperator
* @return Returns a reference to this object so that method calls can be chained together.
* @see DocumentEnrichmentConditionOperator
*/
Builder operator(DocumentEnrichmentConditionOperator operator);
/**
* Sets the value of the Value property for this object.
*
* @param value
* The new value for the Value property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder value(DocumentAttributeValue value);
/**
* Sets the value of the Value property for this object.
*
* This is a convenience method that creates an instance of the {@link DocumentAttributeValue.Builder} avoiding
* the need to create one manually via {@link DocumentAttributeValue#builder()}.
*
*
* When the {@link Consumer} completes, {@link DocumentAttributeValue.Builder#build()} is called immediately and
* its result is passed to {@link #value(DocumentAttributeValue)}.
*
* @param value
* a consumer that will call methods on {@link DocumentAttributeValue.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #value(DocumentAttributeValue)
*/
default Builder value(Consumer value) {
return value(DocumentAttributeValue.builder().applyMutation(value).build());
}
}
static final class BuilderImpl implements Builder {
private String key;
private String operator;
private DocumentAttributeValue value;
private BuilderImpl() {
}
private BuilderImpl(DocumentAttributeCondition model) {
key(model.key);
operator(model.operator);
value(model.value);
}
public final String getKey() {
return key;
}
public final void setKey(String key) {
this.key = key;
}
@Override
public final Builder key(String key) {
this.key = key;
return this;
}
public final String getOperator() {
return operator;
}
public final void setOperator(String operator) {
this.operator = operator;
}
@Override
public final Builder operator(String operator) {
this.operator = operator;
return this;
}
@Override
public final Builder operator(DocumentEnrichmentConditionOperator operator) {
this.operator(operator == null ? null : operator.toString());
return this;
}
public final DocumentAttributeValue.Builder getValue() {
return value != null ? value.toBuilder() : null;
}
public final void setValue(DocumentAttributeValue.BuilderImpl value) {
this.value = value != null ? value.build() : null;
}
@Override
public final Builder value(DocumentAttributeValue value) {
this.value = value;
return this;
}
@Override
public DocumentAttributeCondition build() {
return new DocumentAttributeCondition(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}