software.amazon.awssdk.services.qbusiness.model.StringAttributeBoostingConfiguration 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.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
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.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Provides information on boosting STRING type document attributes.
*
*
*
* For STRING and STRING_LIST type document attributes to be used for boosting on the console
* and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you
* haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console
* or the API.
*
*
*
* For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document
* attributes.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class StringAttributeBoostingConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField BOOSTING_LEVEL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("boostingLevel").getter(getter(StringAttributeBoostingConfiguration::boostingLevelAsString))
.setter(setter(Builder::boostingLevel))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("boostingLevel").build()).build();
private static final SdkField> ATTRIBUTE_VALUE_BOOSTING_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("attributeValueBoosting")
.getter(getter(StringAttributeBoostingConfiguration::attributeValueBoostingAsStrings))
.setter(setter(Builder::attributeValueBoostingWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("attributeValueBoosting").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(BOOSTING_LEVEL_FIELD,
ATTRIBUTE_VALUE_BOOSTING_FIELD));
private static final long serialVersionUID = 1L;
private final String boostingLevel;
private final Map attributeValueBoosting;
private StringAttributeBoostingConfiguration(BuilderImpl builder) {
this.boostingLevel = builder.boostingLevel;
this.attributeValueBoosting = builder.attributeValueBoosting;
}
/**
*
* Specifies how much a document attribute is boosted.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #boostingLevel}
* will return {@link DocumentAttributeBoostingLevel#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service
* is available from {@link #boostingLevelAsString}.
*
*
* @return Specifies how much a document attribute is boosted.
* @see DocumentAttributeBoostingLevel
*/
public final DocumentAttributeBoostingLevel boostingLevel() {
return DocumentAttributeBoostingLevel.fromValue(boostingLevel);
}
/**
*
* Specifies how much a document attribute is boosted.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #boostingLevel}
* will return {@link DocumentAttributeBoostingLevel#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service
* is available from {@link #boostingLevelAsString}.
*
*
* @return Specifies how much a document attribute is boosted.
* @see DocumentAttributeBoostingLevel
*/
public final String boostingLevelAsString() {
return boostingLevel;
}
/**
*
* Specifies specific values of a STRING type document attribute being boosted.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasAttributeValueBoosting} method.
*
*
* @return Specifies specific values of a STRING type document attribute being boosted.
*/
public final Map attributeValueBoosting() {
return StringAttributeValueBoostingCopier.copyStringToEnum(attributeValueBoosting);
}
/**
* For responses, this returns true if the service returned a value for the AttributeValueBoosting property. This
* DOES NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the
* property). This is useful because the SDK will never return a null collection or map, but you may need to
* differentiate between the service returning nothing (or null) and the service returning an empty collection or
* map. For requests, this returns true if a value for the property was specified in the request builder, and false
* if a value was not specified.
*/
public final boolean hasAttributeValueBoosting() {
return attributeValueBoosting != null && !(attributeValueBoosting instanceof SdkAutoConstructMap);
}
/**
*
* Specifies specific values of a STRING type document attribute being boosted.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasAttributeValueBoosting} method.
*
*
* @return Specifies specific values of a STRING type document attribute being boosted.
*/
public final Map attributeValueBoostingAsStrings() {
return attributeValueBoosting;
}
@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(boostingLevelAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasAttributeValueBoosting() ? attributeValueBoostingAsStrings() : null);
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 StringAttributeBoostingConfiguration)) {
return false;
}
StringAttributeBoostingConfiguration other = (StringAttributeBoostingConfiguration) obj;
return Objects.equals(boostingLevelAsString(), other.boostingLevelAsString())
&& hasAttributeValueBoosting() == other.hasAttributeValueBoosting()
&& Objects.equals(attributeValueBoostingAsStrings(), other.attributeValueBoostingAsStrings());
}
/**
* 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("StringAttributeBoostingConfiguration").add("BoostingLevel", boostingLevelAsString())
.add("AttributeValueBoosting", hasAttributeValueBoosting() ? attributeValueBoostingAsStrings() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "boostingLevel":
return Optional.ofNullable(clazz.cast(boostingLevelAsString()));
case "attributeValueBoosting":
return Optional.ofNullable(clazz.cast(attributeValueBoostingAsStrings()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((StringAttributeBoostingConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Specifies how much a document attribute is boosted.
*
*
* @param boostingLevel
* Specifies how much a document attribute is boosted.
* @see DocumentAttributeBoostingLevel
* @return Returns a reference to this object so that method calls can be chained together.
* @see DocumentAttributeBoostingLevel
*/
Builder boostingLevel(String boostingLevel);
/**
*
* Specifies how much a document attribute is boosted.
*
*
* @param boostingLevel
* Specifies how much a document attribute is boosted.
* @see DocumentAttributeBoostingLevel
* @return Returns a reference to this object so that method calls can be chained together.
* @see DocumentAttributeBoostingLevel
*/
Builder boostingLevel(DocumentAttributeBoostingLevel boostingLevel);
/**
*
* Specifies specific values of a STRING type document attribute being boosted.
*
*
* @param attributeValueBoosting
* Specifies specific values of a STRING type document attribute being boosted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributeValueBoostingWithStrings(Map attributeValueBoosting);
/**
*
* Specifies specific values of a STRING type document attribute being boosted.
*
*
* @param attributeValueBoosting
* Specifies specific values of a STRING type document attribute being boosted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributeValueBoosting(Map attributeValueBoosting);
}
static final class BuilderImpl implements Builder {
private String boostingLevel;
private Map attributeValueBoosting = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(StringAttributeBoostingConfiguration model) {
boostingLevel(model.boostingLevel);
attributeValueBoostingWithStrings(model.attributeValueBoosting);
}
public final String getBoostingLevel() {
return boostingLevel;
}
public final void setBoostingLevel(String boostingLevel) {
this.boostingLevel = boostingLevel;
}
@Override
public final Builder boostingLevel(String boostingLevel) {
this.boostingLevel = boostingLevel;
return this;
}
@Override
public final Builder boostingLevel(DocumentAttributeBoostingLevel boostingLevel) {
this.boostingLevel(boostingLevel == null ? null : boostingLevel.toString());
return this;
}
public final Map getAttributeValueBoosting() {
if (attributeValueBoosting instanceof SdkAutoConstructMap) {
return null;
}
return attributeValueBoosting;
}
public final void setAttributeValueBoosting(Map attributeValueBoosting) {
this.attributeValueBoosting = StringAttributeValueBoostingCopier.copy(attributeValueBoosting);
}
@Override
public final Builder attributeValueBoostingWithStrings(Map attributeValueBoosting) {
this.attributeValueBoosting = StringAttributeValueBoostingCopier.copy(attributeValueBoosting);
return this;
}
@Override
public final Builder attributeValueBoosting(Map attributeValueBoosting) {
this.attributeValueBoosting = StringAttributeValueBoostingCopier.copyEnumToString(attributeValueBoosting);
return this;
}
@Override
public StringAttributeBoostingConfiguration build() {
return new StringAttributeBoostingConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}