software.amazon.awssdk.services.bedrockruntime.model.ContentBlockStart 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.List;
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;
/**
*
* Content block start information.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ContentBlockStart implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TOOL_USE_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("toolUse")
.getter(getter(ContentBlockStart::toolUse)).setter(setter(Builder::toolUse)).constructor(ToolUseBlockStart::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("toolUse").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TOOL_USE_FIELD));
private static final long serialVersionUID = 1L;
private final ToolUseBlockStart toolUse;
private final Type type;
private ContentBlockStart(BuilderImpl builder) {
this.toolUse = builder.toolUse;
this.type = builder.type;
}
/**
*
* Information about a tool that the model is requesting to use.
*
*
* @return Information about a tool that the model is requesting to use.
*/
public final ToolUseBlockStart toolUse() {
return toolUse;
}
@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(toolUse());
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 ContentBlockStart)) {
return false;
}
ContentBlockStart other = (ContentBlockStart) obj;
return Objects.equals(toolUse(), other.toolUse());
}
/**
* 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("ContentBlockStart").add("ToolUse", toolUse()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "toolUse":
return Optional.ofNullable(clazz.cast(toolUse()));
default:
return Optional.empty();
}
}
/**
* Create an instance of this class with {@link #toolUse()} initialized to the given value.
*
*
* Information about a tool that the model is requesting to use.
*
*
* @param toolUse
* Information about a tool that the model is requesting to use.
*/
public static ContentBlockStart fromToolUse(ToolUseBlockStart toolUse) {
return builder().toolUse(toolUse).build();
}
/**
* Create an instance of this class with {@link #toolUse()} initialized to the given value.
*
*
* Information about a tool that the model is requesting to use.
*
*
* @param toolUse
* Information about a tool that the model is requesting to use.
*/
public static ContentBlockStart fromToolUse(Consumer toolUse) {
ToolUseBlockStart.Builder builder = ToolUseBlockStart.builder();
toolUse.accept(builder);
return fromToolUse(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;
}
private static Function getter(Function g) {
return obj -> g.apply((ContentBlockStart) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Information about a tool that the model is requesting to use.
*
*
* @param toolUse
* Information about a tool that the model is requesting to use.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder toolUse(ToolUseBlockStart toolUse);
/**
*
* Information about a tool that the model is requesting to use.
*
* This is a convenience method that creates an instance of the {@link ToolUseBlockStart.Builder} avoiding the
* need to create one manually via {@link ToolUseBlockStart#builder()}.
*
*
* When the {@link Consumer} completes, {@link ToolUseBlockStart.Builder#build()} is called immediately and its
* result is passed to {@link #toolUse(ToolUseBlockStart)}.
*
* @param toolUse
* a consumer that will call methods on {@link ToolUseBlockStart.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #toolUse(ToolUseBlockStart)
*/
default Builder toolUse(Consumer toolUse) {
return toolUse(ToolUseBlockStart.builder().applyMutation(toolUse).build());
}
}
static final class BuilderImpl implements Builder {
private ToolUseBlockStart toolUse;
private Type type = Type.UNKNOWN_TO_SDK_VERSION;
private Set setTypes = EnumSet.noneOf(Type.class);
private BuilderImpl() {
}
private BuilderImpl(ContentBlockStart model) {
toolUse(model.toolUse);
}
public final ToolUseBlockStart.Builder getToolUse() {
return toolUse != null ? toolUse.toBuilder() : null;
}
public final void setToolUse(ToolUseBlockStart.BuilderImpl toolUse) {
Object oldValue = this.toolUse;
this.toolUse = toolUse != null ? toolUse.build() : null;
handleUnionValueChange(Type.TOOL_USE, oldValue, this.toolUse);
}
@Override
public final Builder toolUse(ToolUseBlockStart toolUse) {
Object oldValue = this.toolUse;
this.toolUse = toolUse;
handleUnionValueChange(Type.TOOL_USE, oldValue, this.toolUse);
return this;
}
@Override
public ContentBlockStart build() {
return new ContentBlockStart(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
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 ContentBlockStart#type()
*/
public enum Type {
TOOL_USE,
UNKNOWN_TO_SDK_VERSION
}
}