• Home
• com.amazonaws
• aws-java-sdk-bedrockagent
• 1.12.780
• source code
• AgentKnowledgeBaseSummary.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.amazonaws.services.bedrockagent.model.AgentKnowledgeBaseSummary Maven / Gradle / Ivy

/*
 * Copyright 2019-2024 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 com.amazonaws.services.bedrockagent.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * 

 * Contains details about a knowledge base associated with an agent.
 * 
 * 
 * @see AWS API Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AgentKnowledgeBaseSummary implements Serializable, Cloneable, StructuredPojo {

    /**
     * 

     * The description of the knowledge base associated with an agent.
     * 
     */
    private String description;
    /**
     * 

     * The unique identifier of the knowledge base associated with an agent.
     * 
     */
    private String knowledgeBaseId;
    /**
     * 

     * Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent
     * request.
     * 
     */
    private String knowledgeBaseState;
    /**
     * 

     * The time at which the knowledge base associated with an agent was last updated.
     * 
     */
    private java.util.Date updatedAt;

    /**
     * 

     * The description of the knowledge base associated with an agent.
     * 
     * 
     * @param description
     *        The description of the knowledge base associated with an agent.
     */

    public void setDescription(String description) {
        this.description = description;
    }

    /**
     * 

     * The description of the knowledge base associated with an agent.
     * 
     * 
     * @return The description of the knowledge base associated with an agent.
     */

    public String getDescription() {
        return this.description;
    }

    /**
     * 

     * The description of the knowledge base associated with an agent.
     * 
     * 
     * @param description
     *        The description of the knowledge base associated with an agent.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public AgentKnowledgeBaseSummary withDescription(String description) {
        setDescription(description);
        return this;
    }

    /**
     * 

     * The unique identifier of the knowledge base associated with an agent.
     * 
     * 
     * @param knowledgeBaseId
     *        The unique identifier of the knowledge base associated with an agent.
     */

    public void setKnowledgeBaseId(String knowledgeBaseId) {
        this.knowledgeBaseId = knowledgeBaseId;
    }

    /**
     * 

     * The unique identifier of the knowledge base associated with an agent.
     * 
     * 
     * @return The unique identifier of the knowledge base associated with an agent.
     */

    public String getKnowledgeBaseId() {
        return this.knowledgeBaseId;
    }

    /**
     * 

     * The unique identifier of the knowledge base associated with an agent.
     * 
     * 
     * @param knowledgeBaseId
     *        The unique identifier of the knowledge base associated with an agent.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public AgentKnowledgeBaseSummary withKnowledgeBaseId(String knowledgeBaseId) {
        setKnowledgeBaseId(knowledgeBaseId);
        return this;
    }

    /**
     * 

     * Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent
     * request.
     * 
     * 
     * @param knowledgeBaseState
     *        Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
     * @see KnowledgeBaseState
     */

    public void setKnowledgeBaseState(String knowledgeBaseState) {
        this.knowledgeBaseState = knowledgeBaseState;
    }

    /**
     * 

     * Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent
     * request.
     * 
     * 
     * @return Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
     * @see KnowledgeBaseState
     */

    public String getKnowledgeBaseState() {
        return this.knowledgeBaseState;
    }

    /**
     * 

     * Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent
     * request.
     * 
     * 
     * @param knowledgeBaseState
     *        Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see KnowledgeBaseState
     */

    public AgentKnowledgeBaseSummary withKnowledgeBaseState(String knowledgeBaseState) {
        setKnowledgeBaseState(knowledgeBaseState);
        return this;
    }

    /**
     * 

     * Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent
     * request.
     * 
     * 
     * @param knowledgeBaseState
     *        Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see KnowledgeBaseState
     */

    public AgentKnowledgeBaseSummary withKnowledgeBaseState(KnowledgeBaseState knowledgeBaseState) {
        this.knowledgeBaseState = knowledgeBaseState.toString();
        return this;
    }

    /**
     * 

     * The time at which the knowledge base associated with an agent was last updated.
     * 
     * 
     * @param updatedAt
     *        The time at which the knowledge base associated with an agent was last updated.
     */

    public void setUpdatedAt(java.util.Date updatedAt) {
        this.updatedAt = updatedAt;
    }

    /**
     * 

     * The time at which the knowledge base associated with an agent was last updated.
     * 
     * 
     * @return The time at which the knowledge base associated with an agent was last updated.
     */

    public java.util.Date getUpdatedAt() {
        return this.updatedAt;
    }

    /**
     * 

     * The time at which the knowledge base associated with an agent was last updated.
     * 
     * 
     * @param updatedAt
     *        The time at which the knowledge base associated with an agent was last updated.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public AgentKnowledgeBaseSummary withUpdatedAt(java.util.Date updatedAt) {
        setUpdatedAt(updatedAt);
        return this;
    }

    /**
     * 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.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getDescription() != null)
            sb.append("Description: ").append(getDescription()).append(",");
        if (getKnowledgeBaseId() != null)
            sb.append("KnowledgeBaseId: ").append(getKnowledgeBaseId()).append(",");
        if (getKnowledgeBaseState() != null)
            sb.append("KnowledgeBaseState: ").append(getKnowledgeBaseState()).append(",");
        if (getUpdatedAt() != null)
            sb.append("UpdatedAt: ").append(getUpdatedAt());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof AgentKnowledgeBaseSummary == false)
            return false;
        AgentKnowledgeBaseSummary other = (AgentKnowledgeBaseSummary) obj;
        if (other.getDescription() == null ^ this.getDescription() == null)
            return false;
        if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
            return false;
        if (other.getKnowledgeBaseId() == null ^ this.getKnowledgeBaseId() == null)
            return false;
        if (other.getKnowledgeBaseId() != null && other.getKnowledgeBaseId().equals(this.getKnowledgeBaseId()) == false)
            return false;
        if (other.getKnowledgeBaseState() == null ^ this.getKnowledgeBaseState() == null)
            return false;
        if (other.getKnowledgeBaseState() != null && other.getKnowledgeBaseState().equals(this.getKnowledgeBaseState()) == false)
            return false;
        if (other.getUpdatedAt() == null ^ this.getUpdatedAt() == null)
            return false;
        if (other.getUpdatedAt() != null && other.getUpdatedAt().equals(this.getUpdatedAt()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
        hashCode = prime * hashCode + ((getKnowledgeBaseId() == null) ? 0 : getKnowledgeBaseId().hashCode());
        hashCode = prime * hashCode + ((getKnowledgeBaseState() == null) ? 0 : getKnowledgeBaseState().hashCode());
        hashCode = prime * hashCode + ((getUpdatedAt() == null) ? 0 : getUpdatedAt().hashCode());
        return hashCode;
    }

    @Override
    public AgentKnowledgeBaseSummary clone() {
        try {
            return (AgentKnowledgeBaseSummary) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

    @com.amazonaws.annotation.SdkInternalApi
    @Override
    public void marshall(ProtocolMarshaller protocolMarshaller) {
        com.amazonaws.services.bedrockagent.model.transform.AgentKnowledgeBaseSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}