com.amazonaws.services.qconnect.model.KnowledgeBaseSummary Maven / Gradle / Ivy
Show all versions of aws-java-sdk-qconnect Show documentation
/*
* 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.qconnect.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Summary information about the knowledge base.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class KnowledgeBaseSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The description of the knowledge base.
*
*/
private String description;
/**
*
* The Amazon Resource Name (ARN) of the knowledge base.
*
*/
private String knowledgeBaseArn;
/**
*
* The identifier of the knowledge base.
*
*/
private String knowledgeBaseId;
/**
*
* The type of knowledge base.
*
*/
private String knowledgeBaseType;
/**
*
* The name of the knowledge base.
*
*/
private String name;
/**
*
* Information about how to render the content.
*
*/
private RenderingConfiguration renderingConfiguration;
/**
*
* The configuration information for the customer managed key used for encryption.
*
*
* This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey,
* kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to
* invoke Amazon Q in Connect.
*
*
* For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your
* instance.
*
*/
private ServerSideEncryptionConfiguration serverSideEncryptionConfiguration;
/**
*
* Configuration information about the external data source.
*
*/
private SourceConfiguration sourceConfiguration;
/**
*
* The status of the knowledge base summary.
*
*/
private String status;
/**
*
* The tags used to organize, track, or control access for this resource.
*
*/
private java.util.Map tags;
/**
*
* The description of the knowledge base.
*
*
* @param description
* The description of the knowledge base.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description of the knowledge base.
*
*
* @return The description of the knowledge base.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description of the knowledge base.
*
*
* @param description
* The description of the knowledge base.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KnowledgeBaseSummary withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the knowledge base.
*
*
* @param knowledgeBaseArn
* The Amazon Resource Name (ARN) of the knowledge base.
*/
public void setKnowledgeBaseArn(String knowledgeBaseArn) {
this.knowledgeBaseArn = knowledgeBaseArn;
}
/**
*
* The Amazon Resource Name (ARN) of the knowledge base.
*
*
* @return The Amazon Resource Name (ARN) of the knowledge base.
*/
public String getKnowledgeBaseArn() {
return this.knowledgeBaseArn;
}
/**
*
* The Amazon Resource Name (ARN) of the knowledge base.
*
*
* @param knowledgeBaseArn
* The Amazon Resource Name (ARN) of the knowledge base.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KnowledgeBaseSummary withKnowledgeBaseArn(String knowledgeBaseArn) {
setKnowledgeBaseArn(knowledgeBaseArn);
return this;
}
/**
*
* The identifier of the knowledge base.
*
*
* @param knowledgeBaseId
* The identifier of the knowledge base.
*/
public void setKnowledgeBaseId(String knowledgeBaseId) {
this.knowledgeBaseId = knowledgeBaseId;
}
/**
*
* The identifier of the knowledge base.
*
*
* @return The identifier of the knowledge base.
*/
public String getKnowledgeBaseId() {
return this.knowledgeBaseId;
}
/**
*
* The identifier of the knowledge base.
*
*
* @param knowledgeBaseId
* The identifier of the knowledge base.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KnowledgeBaseSummary withKnowledgeBaseId(String knowledgeBaseId) {
setKnowledgeBaseId(knowledgeBaseId);
return this;
}
/**
*
* The type of knowledge base.
*
*
* @param knowledgeBaseType
* The type of knowledge base.
* @see KnowledgeBaseType
*/
public void setKnowledgeBaseType(String knowledgeBaseType) {
this.knowledgeBaseType = knowledgeBaseType;
}
/**
*
* The type of knowledge base.
*
*
* @return The type of knowledge base.
* @see KnowledgeBaseType
*/
public String getKnowledgeBaseType() {
return this.knowledgeBaseType;
}
/**
*
* The type of knowledge base.
*
*
* @param knowledgeBaseType
* The type of knowledge base.
* @return Returns a reference to this object so that method calls can be chained together.
* @see KnowledgeBaseType
*/
public KnowledgeBaseSummary withKnowledgeBaseType(String knowledgeBaseType) {
setKnowledgeBaseType(knowledgeBaseType);
return this;
}
/**
*
* The type of knowledge base.
*
*
* @param knowledgeBaseType
* The type of knowledge base.
* @return Returns a reference to this object so that method calls can be chained together.
* @see KnowledgeBaseType
*/
public KnowledgeBaseSummary withKnowledgeBaseType(KnowledgeBaseType knowledgeBaseType) {
this.knowledgeBaseType = knowledgeBaseType.toString();
return this;
}
/**
*
* The name of the knowledge base.
*
*
* @param name
* The name of the knowledge base.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the knowledge base.
*
*
* @return The name of the knowledge base.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the knowledge base.
*
*
* @param name
* The name of the knowledge base.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KnowledgeBaseSummary withName(String name) {
setName(name);
return this;
}
/**
*
* Information about how to render the content.
*
*
* @param renderingConfiguration
* Information about how to render the content.
*/
public void setRenderingConfiguration(RenderingConfiguration renderingConfiguration) {
this.renderingConfiguration = renderingConfiguration;
}
/**
*
* Information about how to render the content.
*
*
* @return Information about how to render the content.
*/
public RenderingConfiguration getRenderingConfiguration() {
return this.renderingConfiguration;
}
/**
*
* Information about how to render the content.
*
*
* @param renderingConfiguration
* Information about how to render the content.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KnowledgeBaseSummary withRenderingConfiguration(RenderingConfiguration renderingConfiguration) {
setRenderingConfiguration(renderingConfiguration);
return this;
}
/**
*
* The configuration information for the customer managed key used for encryption.
*
*
* This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey,
* kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to
* invoke Amazon Q in Connect.
*
*
* For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your
* instance.
*
*
* @param serverSideEncryptionConfiguration
* The configuration information for the customer managed key used for encryption.
*
* This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey,
* kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the
* key to invoke Amazon Q in Connect.
*
*
* For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for
* your instance.
*/
public void setServerSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration) {
this.serverSideEncryptionConfiguration = serverSideEncryptionConfiguration;
}
/**
*
* The configuration information for the customer managed key used for encryption.
*
*
* This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey,
* kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to
* invoke Amazon Q in Connect.
*
*
* For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your
* instance.
*
*
* @return The configuration information for the customer managed key used for encryption.
*
* This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey,
* kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the
* key to invoke Amazon Q in Connect.
*
*
* For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for
* your instance.
*/
public ServerSideEncryptionConfiguration getServerSideEncryptionConfiguration() {
return this.serverSideEncryptionConfiguration;
}
/**
*
* The configuration information for the customer managed key used for encryption.
*
*
* This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey,
* kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to
* invoke Amazon Q in Connect.
*
*
* For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your
* instance.
*
*
* @param serverSideEncryptionConfiguration
* The configuration information for the customer managed key used for encryption.
*
* This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey,
* kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the
* key to invoke Amazon Q in Connect.
*
*
* For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for
* your instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KnowledgeBaseSummary withServerSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration) {
setServerSideEncryptionConfiguration(serverSideEncryptionConfiguration);
return this;
}
/**
*
* Configuration information about the external data source.
*
*
* @param sourceConfiguration
* Configuration information about the external data source.
*/
public void setSourceConfiguration(SourceConfiguration sourceConfiguration) {
this.sourceConfiguration = sourceConfiguration;
}
/**
*
* Configuration information about the external data source.
*
*
* @return Configuration information about the external data source.
*/
public SourceConfiguration getSourceConfiguration() {
return this.sourceConfiguration;
}
/**
*
* Configuration information about the external data source.
*
*
* @param sourceConfiguration
* Configuration information about the external data source.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KnowledgeBaseSummary withSourceConfiguration(SourceConfiguration sourceConfiguration) {
setSourceConfiguration(sourceConfiguration);
return this;
}
/**
*
* The status of the knowledge base summary.
*
*
* @param status
* The status of the knowledge base summary.
* @see KnowledgeBaseStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the knowledge base summary.
*
*
* @return The status of the knowledge base summary.
* @see KnowledgeBaseStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the knowledge base summary.
*
*
* @param status
* The status of the knowledge base summary.
* @return Returns a reference to this object so that method calls can be chained together.
* @see KnowledgeBaseStatus
*/
public KnowledgeBaseSummary withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The status of the knowledge base summary.
*
*
* @param status
* The status of the knowledge base summary.
* @return Returns a reference to this object so that method calls can be chained together.
* @see KnowledgeBaseStatus
*/
public KnowledgeBaseSummary withStatus(KnowledgeBaseStatus status) {
this.status = status.toString();
return this;
}
/**
*
* The tags used to organize, track, or control access for this resource.
*
*
* @return The tags used to organize, track, or control access for this resource.
*/
public java.util.Map getTags() {
return tags;
}
/**
*
* The tags used to organize, track, or control access for this resource.
*
*
* @param tags
* The tags used to organize, track, or control access for this resource.
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* The tags used to organize, track, or control access for this resource.
*
*
* @param tags
* The tags used to organize, track, or control access for this resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KnowledgeBaseSummary withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see KnowledgeBaseSummary#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public KnowledgeBaseSummary addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap();
}
if (this.tags.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.tags.put(key, value);
return this;
}
/**
* Removes all the entries added into Tags.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KnowledgeBaseSummary clearTagsEntries() {
this.tags = null;
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 (getKnowledgeBaseArn() != null)
sb.append("KnowledgeBaseArn: ").append(getKnowledgeBaseArn()).append(",");
if (getKnowledgeBaseId() != null)
sb.append("KnowledgeBaseId: ").append(getKnowledgeBaseId()).append(",");
if (getKnowledgeBaseType() != null)
sb.append("KnowledgeBaseType: ").append(getKnowledgeBaseType()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getRenderingConfiguration() != null)
sb.append("RenderingConfiguration: ").append(getRenderingConfiguration()).append(",");
if (getServerSideEncryptionConfiguration() != null)
sb.append("ServerSideEncryptionConfiguration: ").append(getServerSideEncryptionConfiguration()).append(",");
if (getSourceConfiguration() != null)
sb.append("SourceConfiguration: ").append(getSourceConfiguration()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof KnowledgeBaseSummary == false)
return false;
KnowledgeBaseSummary other = (KnowledgeBaseSummary) obj;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getKnowledgeBaseArn() == null ^ this.getKnowledgeBaseArn() == null)
return false;
if (other.getKnowledgeBaseArn() != null && other.getKnowledgeBaseArn().equals(this.getKnowledgeBaseArn()) == 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.getKnowledgeBaseType() == null ^ this.getKnowledgeBaseType() == null)
return false;
if (other.getKnowledgeBaseType() != null && other.getKnowledgeBaseType().equals(this.getKnowledgeBaseType()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getRenderingConfiguration() == null ^ this.getRenderingConfiguration() == null)
return false;
if (other.getRenderingConfiguration() != null && other.getRenderingConfiguration().equals(this.getRenderingConfiguration()) == false)
return false;
if (other.getServerSideEncryptionConfiguration() == null ^ this.getServerSideEncryptionConfiguration() == null)
return false;
if (other.getServerSideEncryptionConfiguration() != null
&& other.getServerSideEncryptionConfiguration().equals(this.getServerSideEncryptionConfiguration()) == false)
return false;
if (other.getSourceConfiguration() == null ^ this.getSourceConfiguration() == null)
return false;
if (other.getSourceConfiguration() != null && other.getSourceConfiguration().equals(this.getSourceConfiguration()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == 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 + ((getKnowledgeBaseArn() == null) ? 0 : getKnowledgeBaseArn().hashCode());
hashCode = prime * hashCode + ((getKnowledgeBaseId() == null) ? 0 : getKnowledgeBaseId().hashCode());
hashCode = prime * hashCode + ((getKnowledgeBaseType() == null) ? 0 : getKnowledgeBaseType().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getRenderingConfiguration() == null) ? 0 : getRenderingConfiguration().hashCode());
hashCode = prime * hashCode + ((getServerSideEncryptionConfiguration() == null) ? 0 : getServerSideEncryptionConfiguration().hashCode());
hashCode = prime * hashCode + ((getSourceConfiguration() == null) ? 0 : getSourceConfiguration().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public KnowledgeBaseSummary clone() {
try {
return (KnowledgeBaseSummary) 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.qconnect.model.transform.KnowledgeBaseSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}