software.amazon.awssdk.services.bedrockruntime.model.ToolSpecification Maven / Gradle / Ivy
/*
* 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.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 specification for the tool.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ToolSpecification implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(ToolSpecification::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(ToolSpecification::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField INPUT_SCHEMA_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("inputSchema")
.getter(getter(ToolSpecification::inputSchema)).setter(setter(Builder::inputSchema))
.constructor(ToolInputSchema::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("inputSchema").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, DESCRIPTION_FIELD,
INPUT_SCHEMA_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final String description;
private final ToolInputSchema inputSchema;
private ToolSpecification(BuilderImpl builder) {
this.name = builder.name;
this.description = builder.description;
this.inputSchema = builder.inputSchema;
}
/**
*
* The name for the tool.
*
*
* @return The name for the tool.
*/
public final String name() {
return name;
}
/**
*
* The description for the tool.
*
*
* @return The description for the tool.
*/
public final String description() {
return description;
}
/**
*
* The input schema for the tool in JSON format.
*
*
* @return The input schema for the tool in JSON format.
*/
public final ToolInputSchema inputSchema() {
return inputSchema;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(inputSchema());
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 ToolSpecification)) {
return false;
}
ToolSpecification other = (ToolSpecification) obj;
return Objects.equals(name(), other.name()) && Objects.equals(description(), other.description())
&& Objects.equals(inputSchema(), other.inputSchema());
}
/**
* 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("ToolSpecification").add("Name", name()).add("Description", description())
.add("InputSchema", inputSchema()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "inputSchema":
return Optional.ofNullable(clazz.cast(inputSchema()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ToolSpecification) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name for the tool.
*
*
* @param name
* The name for the tool.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The description for the tool.
*
*
* @param description
* The description for the tool.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The input schema for the tool in JSON format.
*
*
* @param inputSchema
* The input schema for the tool in JSON format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder inputSchema(ToolInputSchema inputSchema);
/**
*
* The input schema for the tool in JSON format.
*
* This is a convenience method that creates an instance of the {@link ToolInputSchema.Builder} avoiding the
* need to create one manually via {@link ToolInputSchema#builder()}.
*
*
* When the {@link Consumer} completes, {@link ToolInputSchema.Builder#build()} is called immediately and its
* result is passed to {@link #inputSchema(ToolInputSchema)}.
*
* @param inputSchema
* a consumer that will call methods on {@link ToolInputSchema.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #inputSchema(ToolInputSchema)
*/
default Builder inputSchema(Consumer inputSchema) {
return inputSchema(ToolInputSchema.builder().applyMutation(inputSchema).build());
}
}
static final class BuilderImpl implements Builder {
private String name;
private String description;
private ToolInputSchema inputSchema;
private BuilderImpl() {
}
private BuilderImpl(ToolSpecification model) {
name(model.name);
description(model.description);
inputSchema(model.inputSchema);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final ToolInputSchema.Builder getInputSchema() {
return inputSchema != null ? inputSchema.toBuilder() : null;
}
public final void setInputSchema(ToolInputSchema.BuilderImpl inputSchema) {
this.inputSchema = inputSchema != null ? inputSchema.build() : null;
}
@Override
public final Builder inputSchema(ToolInputSchema inputSchema) {
this.inputSchema = inputSchema;
return this;
}
@Override
public ToolSpecification build() {
return new ToolSpecification(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}