software.amazon.awssdk.services.bedrockagent.model.AgentKnowledgeBase Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of bedrockagent Show documentation
Show all versions of bedrockagent Show documentation
The AWS Java SDK for Bedrock Agent module holds the client classes that are used for
communicating with Bedrock Agent.
/*
* 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.bedrockagent.model;
import java.io.Serializable;
import java.time.Instant;
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.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.TimestampFormatTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains details about a knowledge base that is associated with an agent.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AgentKnowledgeBase implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField AGENT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("agentId").getter(getter(AgentKnowledgeBase::agentId)).setter(setter(Builder::agentId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("agentId").build()).build();
private static final SdkField AGENT_VERSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("agentVersion").getter(getter(AgentKnowledgeBase::agentVersion)).setter(setter(Builder::agentVersion))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("agentVersion").build()).build();
private static final SdkField CREATED_AT_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("createdAt")
.getter(getter(AgentKnowledgeBase::createdAt))
.setter(setter(Builder::createdAt))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("createdAt").build(),
TimestampFormatTrait.create(TimestampFormatTrait.Format.ISO_8601)).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(AgentKnowledgeBase::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField KNOWLEDGE_BASE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("knowledgeBaseId").getter(getter(AgentKnowledgeBase::knowledgeBaseId))
.setter(setter(Builder::knowledgeBaseId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("knowledgeBaseId").build()).build();
private static final SdkField KNOWLEDGE_BASE_STATE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("knowledgeBaseState").getter(getter(AgentKnowledgeBase::knowledgeBaseStateAsString))
.setter(setter(Builder::knowledgeBaseState))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("knowledgeBaseState").build())
.build();
private static final SdkField UPDATED_AT_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("updatedAt")
.getter(getter(AgentKnowledgeBase::updatedAt))
.setter(setter(Builder::updatedAt))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("updatedAt").build(),
TimestampFormatTrait.create(TimestampFormatTrait.Format.ISO_8601)).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AGENT_ID_FIELD,
AGENT_VERSION_FIELD, CREATED_AT_FIELD, DESCRIPTION_FIELD, KNOWLEDGE_BASE_ID_FIELD, KNOWLEDGE_BASE_STATE_FIELD,
UPDATED_AT_FIELD));
private static final long serialVersionUID = 1L;
private final String agentId;
private final String agentVersion;
private final Instant createdAt;
private final String description;
private final String knowledgeBaseId;
private final String knowledgeBaseState;
private final Instant updatedAt;
private AgentKnowledgeBase(BuilderImpl builder) {
this.agentId = builder.agentId;
this.agentVersion = builder.agentVersion;
this.createdAt = builder.createdAt;
this.description = builder.description;
this.knowledgeBaseId = builder.knowledgeBaseId;
this.knowledgeBaseState = builder.knowledgeBaseState;
this.updatedAt = builder.updatedAt;
}
/**
*
* The unique identifier of the agent with which the knowledge base is associated.
*
*
* @return The unique identifier of the agent with which the knowledge base is associated.
*/
public final String agentId() {
return agentId;
}
/**
*
* The version of the agent with which the knowledge base is associated.
*
*
* @return The version of the agent with which the knowledge base is associated.
*/
public final String agentVersion() {
return agentVersion;
}
/**
*
* The time at which the association between the agent and the knowledge base was created.
*
*
* @return The time at which the association between the agent and the knowledge base was created.
*/
public final Instant createdAt() {
return createdAt;
}
/**
*
* The description of the association between the agent and the knowledge base.
*
*
* @return The description of the association between the agent and the knowledge base.
*/
public final String description() {
return description;
}
/**
*
* The unique identifier of the association between the agent and the knowledge base.
*
*
* @return The unique identifier of the association between the agent and the knowledge base.
*/
public final String knowledgeBaseId() {
return knowledgeBaseId;
}
/**
*
* Specifies whether to use the knowledge base or not when sending an InvokeAgent
* request.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #knowledgeBaseState} will return {@link KnowledgeBaseState#UNKNOWN_TO_SDK_VERSION}. The raw value returned
* by the service is available from {@link #knowledgeBaseStateAsString}.
*
*
* @return Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
* @see KnowledgeBaseState
*/
public final KnowledgeBaseState knowledgeBaseState() {
return KnowledgeBaseState.fromValue(knowledgeBaseState);
}
/**
*
* Specifies whether to use the knowledge base or not when sending an InvokeAgent
* request.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #knowledgeBaseState} will return {@link KnowledgeBaseState#UNKNOWN_TO_SDK_VERSION}. The raw value returned
* by the service is available from {@link #knowledgeBaseStateAsString}.
*
*
* @return Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
* @see KnowledgeBaseState
*/
public final String knowledgeBaseStateAsString() {
return knowledgeBaseState;
}
/**
*
* The time at which the association between the agent and the knowledge base was last updated.
*
*
* @return The time at which the association between the agent and the knowledge base was last updated.
*/
public final Instant updatedAt() {
return updatedAt;
}
@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(agentId());
hashCode = 31 * hashCode + Objects.hashCode(agentVersion());
hashCode = 31 * hashCode + Objects.hashCode(createdAt());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(knowledgeBaseId());
hashCode = 31 * hashCode + Objects.hashCode(knowledgeBaseStateAsString());
hashCode = 31 * hashCode + Objects.hashCode(updatedAt());
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 AgentKnowledgeBase)) {
return false;
}
AgentKnowledgeBase other = (AgentKnowledgeBase) obj;
return Objects.equals(agentId(), other.agentId()) && Objects.equals(agentVersion(), other.agentVersion())
&& Objects.equals(createdAt(), other.createdAt()) && Objects.equals(description(), other.description())
&& Objects.equals(knowledgeBaseId(), other.knowledgeBaseId())
&& Objects.equals(knowledgeBaseStateAsString(), other.knowledgeBaseStateAsString())
&& Objects.equals(updatedAt(), other.updatedAt());
}
/**
* 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("AgentKnowledgeBase").add("AgentId", agentId()).add("AgentVersion", agentVersion())
.add("CreatedAt", createdAt()).add("Description", description()).add("KnowledgeBaseId", knowledgeBaseId())
.add("KnowledgeBaseState", knowledgeBaseStateAsString()).add("UpdatedAt", updatedAt()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "agentId":
return Optional.ofNullable(clazz.cast(agentId()));
case "agentVersion":
return Optional.ofNullable(clazz.cast(agentVersion()));
case "createdAt":
return Optional.ofNullable(clazz.cast(createdAt()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "knowledgeBaseId":
return Optional.ofNullable(clazz.cast(knowledgeBaseId()));
case "knowledgeBaseState":
return Optional.ofNullable(clazz.cast(knowledgeBaseStateAsString()));
case "updatedAt":
return Optional.ofNullable(clazz.cast(updatedAt()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AgentKnowledgeBase) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The unique identifier of the agent with which the knowledge base is associated.
*
*
* @param agentId
* The unique identifier of the agent with which the knowledge base is associated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder agentId(String agentId);
/**
*
* The version of the agent with which the knowledge base is associated.
*
*
* @param agentVersion
* The version of the agent with which the knowledge base is associated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder agentVersion(String agentVersion);
/**
*
* The time at which the association between the agent and the knowledge base was created.
*
*
* @param createdAt
* The time at which the association between the agent and the knowledge base was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createdAt(Instant createdAt);
/**
*
* The description of the association between the agent and the knowledge base.
*
*
* @param description
* The description of the association between the agent and the knowledge base.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The unique identifier of the association between the agent and the knowledge base.
*
*
* @param knowledgeBaseId
* The unique identifier of the association between the agent and the knowledge base.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder knowledgeBaseId(String knowledgeBaseId);
/**
*
* Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
*
*
* @param knowledgeBaseState
* Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
* @see KnowledgeBaseState
* @return Returns a reference to this object so that method calls can be chained together.
* @see KnowledgeBaseState
*/
Builder knowledgeBaseState(String knowledgeBaseState);
/**
*
* Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
*
*
* @param knowledgeBaseState
* Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
* @see KnowledgeBaseState
* @return Returns a reference to this object so that method calls can be chained together.
* @see KnowledgeBaseState
*/
Builder knowledgeBaseState(KnowledgeBaseState knowledgeBaseState);
/**
*
* The time at which the association between the agent and the knowledge base was last updated.
*
*
* @param updatedAt
* The time at which the association between the agent and the knowledge base was last updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder updatedAt(Instant updatedAt);
}
static final class BuilderImpl implements Builder {
private String agentId;
private String agentVersion;
private Instant createdAt;
private String description;
private String knowledgeBaseId;
private String knowledgeBaseState;
private Instant updatedAt;
private BuilderImpl() {
}
private BuilderImpl(AgentKnowledgeBase model) {
agentId(model.agentId);
agentVersion(model.agentVersion);
createdAt(model.createdAt);
description(model.description);
knowledgeBaseId(model.knowledgeBaseId);
knowledgeBaseState(model.knowledgeBaseState);
updatedAt(model.updatedAt);
}
public final String getAgentId() {
return agentId;
}
public final void setAgentId(String agentId) {
this.agentId = agentId;
}
@Override
public final Builder agentId(String agentId) {
this.agentId = agentId;
return this;
}
public final String getAgentVersion() {
return agentVersion;
}
public final void setAgentVersion(String agentVersion) {
this.agentVersion = agentVersion;
}
@Override
public final Builder agentVersion(String agentVersion) {
this.agentVersion = agentVersion;
return this;
}
public final Instant getCreatedAt() {
return createdAt;
}
public final void setCreatedAt(Instant createdAt) {
this.createdAt = createdAt;
}
@Override
public final Builder createdAt(Instant createdAt) {
this.createdAt = createdAt;
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 String getKnowledgeBaseId() {
return knowledgeBaseId;
}
public final void setKnowledgeBaseId(String knowledgeBaseId) {
this.knowledgeBaseId = knowledgeBaseId;
}
@Override
public final Builder knowledgeBaseId(String knowledgeBaseId) {
this.knowledgeBaseId = knowledgeBaseId;
return this;
}
public final String getKnowledgeBaseState() {
return knowledgeBaseState;
}
public final void setKnowledgeBaseState(String knowledgeBaseState) {
this.knowledgeBaseState = knowledgeBaseState;
}
@Override
public final Builder knowledgeBaseState(String knowledgeBaseState) {
this.knowledgeBaseState = knowledgeBaseState;
return this;
}
@Override
public final Builder knowledgeBaseState(KnowledgeBaseState knowledgeBaseState) {
this.knowledgeBaseState(knowledgeBaseState == null ? null : knowledgeBaseState.toString());
return this;
}
public final Instant getUpdatedAt() {
return updatedAt;
}
public final void setUpdatedAt(Instant updatedAt) {
this.updatedAt = updatedAt;
}
@Override
public final Builder updatedAt(Instant updatedAt) {
this.updatedAt = updatedAt;
return this;
}
@Override
public AgentKnowledgeBase build() {
return new AgentKnowledgeBase(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy