software.amazon.awssdk.services.bedrockruntime.model.GuardrailContentBlock Maven / Gradle / Ivy
Show all versions of bedrockruntime 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.bedrockruntime.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
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.core.util.SdkAutoConstructList;
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;
/**
*
* The content block to be evaluated by the guardrail.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class GuardrailContentBlock implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TEXT_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("text")
.getter(getter(GuardrailContentBlock::text)).setter(setter(Builder::text)).constructor(GuardrailTextBlock::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("text").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TEXT_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("text", TEXT_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final GuardrailTextBlock text;
private final Type type;
private GuardrailContentBlock(BuilderImpl builder) {
this.text = builder.text;
this.type = builder.type;
}
/**
*
* Text within content block to be evaluated by the guardrail.
*
*
* @return Text within content block to be evaluated by the guardrail.
*/
public final GuardrailTextBlock text() {
return text;
}
@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(text());
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 GuardrailContentBlock)) {
return false;
}
GuardrailContentBlock other = (GuardrailContentBlock) obj;
return Objects.equals(text(), other.text());
}
/**
* 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("GuardrailContentBlock").add("Text", text()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "text":
return Optional.ofNullable(clazz.cast(text()));
default:
return Optional.empty();
}
}
/**
* Create an instance of this class with {@link #text()} initialized to the given value.
*
*
* Text within content block to be evaluated by the guardrail.
*
*
* @param text
* Text within content block to be evaluated by the guardrail.
*/
public static GuardrailContentBlock fromText(GuardrailTextBlock text) {
return builder().text(text).build();
}
/**
* Create an instance of this class with {@link #text()} initialized to the given value.
*
*
* Text within content block to be evaluated by the guardrail.
*
*
* @param text
* Text within content block to be evaluated by the guardrail.
*/
public static GuardrailContentBlock fromText(Consumer text) {
GuardrailTextBlock.Builder builder = GuardrailTextBlock.builder();
text.accept(builder);
return fromText(builder.build());
}
/**
* Retrieve an enum value representing which member of this object is populated.
*
* When this class is returned in a service response, this will be {@link Type#UNKNOWN_TO_SDK_VERSION} if the
* service returned a member that is only known to a newer SDK version.
*
* When this class is created directly in your code, this will be {@link Type#UNKNOWN_TO_SDK_VERSION} if zero
* members are set, and {@code null} if more than one member is set.
*/
public Type type() {
return type;
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((GuardrailContentBlock) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Text within content block to be evaluated by the guardrail.
*
*
* @param text
* Text within content block to be evaluated by the guardrail.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder text(GuardrailTextBlock text);
/**
*
* Text within content block to be evaluated by the guardrail.
*
* This is a convenience method that creates an instance of the {@link GuardrailTextBlock.Builder} avoiding the
* need to create one manually via {@link GuardrailTextBlock#builder()}.
*
*
* When the {@link Consumer} completes, {@link GuardrailTextBlock.Builder#build()} is called immediately and its
* result is passed to {@link #text(GuardrailTextBlock)}.
*
* @param text
* a consumer that will call methods on {@link GuardrailTextBlock.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #text(GuardrailTextBlock)
*/
default Builder text(Consumer text) {
return text(GuardrailTextBlock.builder().applyMutation(text).build());
}
}
static final class BuilderImpl implements Builder {
private GuardrailTextBlock text;
private Type type = Type.UNKNOWN_TO_SDK_VERSION;
private Set setTypes = EnumSet.noneOf(Type.class);
private BuilderImpl() {
}
private BuilderImpl(GuardrailContentBlock model) {
text(model.text);
}
public final GuardrailTextBlock.Builder getText() {
return text != null ? text.toBuilder() : null;
}
public final void setText(GuardrailTextBlock.BuilderImpl text) {
Object oldValue = this.text;
this.text = text != null ? text.build() : null;
handleUnionValueChange(Type.TEXT, oldValue, this.text);
}
@Override
public final Builder text(GuardrailTextBlock text) {
Object oldValue = this.text;
this.text = text;
handleUnionValueChange(Type.TEXT, oldValue, this.text);
return this;
}
@Override
public GuardrailContentBlock build() {
return new GuardrailContentBlock(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private final void handleUnionValueChange(Type type, Object oldValue, Object newValue) {
if (this.type == type || oldValue == newValue) {
return;
}
if (newValue == null || newValue instanceof SdkAutoConstructList || newValue instanceof SdkAutoConstructMap) {
setTypes.remove(type);
} else if (oldValue == null || oldValue instanceof SdkAutoConstructList || oldValue instanceof SdkAutoConstructMap) {
setTypes.add(type);
}
if (setTypes.size() == 1) {
this.type = setTypes.iterator().next();
} else if (setTypes.isEmpty()) {
this.type = Type.UNKNOWN_TO_SDK_VERSION;
} else {
this.type = null;
}
}
}
/**
* @see GuardrailContentBlock#type()
*/
public enum Type {
TEXT,
UNKNOWN_TO_SDK_VERSION
}
}