com.amazonaws.services.connectwisdom.model.QuickResponseSummary Maven / Gradle / Ivy
Show all versions of aws-java-sdk-connectwisdom 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.connectwisdom.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The summary information about the quick response.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class QuickResponseSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
* Chat.
*
*/
private java.util.List channels;
/**
*
* The media type of the quick response content.
*
*
* -
*
* Use application/x.quickresponse;format=plain for quick response written in plain text.
*
*
* -
*
* Use application/x.quickresponse;format=markdown for quick response written in richtext.
*
*
*
*/
private String contentType;
/**
*
* The timestamp when the quick response was created.
*
*/
private java.util.Date createdTime;
/**
*
* The description of the quick response.
*
*/
private String description;
/**
*
* Whether the quick response is active.
*
*/
private Boolean isActive;
/**
*
* The Amazon Resource Name (ARN) of the knowledge base.
*
*/
private String knowledgeBaseArn;
/**
*
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing
* Wisdom Content resource to it.
*
*/
private String knowledgeBaseId;
/**
*
* The Amazon Resource Name (ARN) of the user who last updated the quick response data.
*
*/
private String lastModifiedBy;
/**
*
* The timestamp when the quick response summary was last modified.
*
*/
private java.util.Date lastModifiedTime;
/**
*
* The name of the quick response.
*
*/
private String name;
/**
*
* The Amazon Resource Name (ARN) of the quick response.
*
*/
private String quickResponseArn;
/**
*
* The identifier of the quick response.
*
*/
private String quickResponseId;
/**
*
* The resource status of the quick response.
*
*/
private String status;
/**
*
* The tags used to organize, track, or control access for this resource.
*
*/
private java.util.Map tags;
/**
*
* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
* Chat.
*
*
* @return The Amazon Connect contact channels this quick response applies to. The supported contact channel types
* include Chat.
*/
public java.util.List getChannels() {
return channels;
}
/**
*
* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
* Chat.
*
*
* @param channels
* The Amazon Connect contact channels this quick response applies to. The supported contact channel types
* include Chat.
*/
public void setChannels(java.util.Collection channels) {
if (channels == null) {
this.channels = null;
return;
}
this.channels = new java.util.ArrayList(channels);
}
/**
*
* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
* Chat.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setChannels(java.util.Collection)} or {@link #withChannels(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param channels
* The Amazon Connect contact channels this quick response applies to. The supported contact channel types
* include Chat.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuickResponseSummary withChannels(String... channels) {
if (this.channels == null) {
setChannels(new java.util.ArrayList(channels.length));
}
for (String ele : channels) {
this.channels.add(ele);
}
return this;
}
/**
*
* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
* Chat.
*
*
* @param channels
* The Amazon Connect contact channels this quick response applies to. The supported contact channel types
* include Chat.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuickResponseSummary withChannels(java.util.Collection channels) {
setChannels(channels);
return this;
}
/**
*
* The media type of the quick response content.
*
*
* -
*
* Use application/x.quickresponse;format=plain for quick response written in plain text.
*
*
* -
*
* Use application/x.quickresponse;format=markdown for quick response written in richtext.
*
*
*
*
* @param contentType
* The media type of the quick response content.
*
* -
*
* Use application/x.quickresponse;format=plain for quick response written in plain text.
*
*
* -
*
* Use application/x.quickresponse;format=markdown for quick response written in richtext.
*
*
*/
public void setContentType(String contentType) {
this.contentType = contentType;
}
/**
*
* The media type of the quick response content.
*
*
* -
*
* Use application/x.quickresponse;format=plain for quick response written in plain text.
*
*
* -
*
* Use application/x.quickresponse;format=markdown for quick response written in richtext.
*
*
*
*
* @return The media type of the quick response content.
*
* -
*
* Use application/x.quickresponse;format=plain for quick response written in plain text.
*
*
* -
*
* Use application/x.quickresponse;format=markdown for quick response written in richtext.
*
*
*/
public String getContentType() {
return this.contentType;
}
/**
*
* The media type of the quick response content.
*
*
* -
*
* Use application/x.quickresponse;format=plain for quick response written in plain text.
*
*
* -
*
* Use application/x.quickresponse;format=markdown for quick response written in richtext.
*
*
*
*
* @param contentType
* The media type of the quick response content.
*
* -
*
* Use application/x.quickresponse;format=plain for quick response written in plain text.
*
*
* -
*
* Use application/x.quickresponse;format=markdown for quick response written in richtext.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuickResponseSummary withContentType(String contentType) {
setContentType(contentType);
return this;
}
/**
*
* The timestamp when the quick response was created.
*
*
* @param createdTime
* The timestamp when the quick response was created.
*/
public void setCreatedTime(java.util.Date createdTime) {
this.createdTime = createdTime;
}
/**
*
* The timestamp when the quick response was created.
*
*
* @return The timestamp when the quick response was created.
*/
public java.util.Date getCreatedTime() {
return this.createdTime;
}
/**
*
* The timestamp when the quick response was created.
*
*
* @param createdTime
* The timestamp when the quick response was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuickResponseSummary withCreatedTime(java.util.Date createdTime) {
setCreatedTime(createdTime);
return this;
}
/**
*
* The description of the quick response.
*
*
* @param description
* The description of the quick response.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description of the quick response.
*
*
* @return The description of the quick response.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description of the quick response.
*
*
* @param description
* The description of the quick response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuickResponseSummary withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* Whether the quick response is active.
*
*
* @param isActive
* Whether the quick response is active.
*/
public void setIsActive(Boolean isActive) {
this.isActive = isActive;
}
/**
*
* Whether the quick response is active.
*
*
* @return Whether the quick response is active.
*/
public Boolean getIsActive() {
return this.isActive;
}
/**
*
* Whether the quick response is active.
*
*
* @param isActive
* Whether the quick response is active.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuickResponseSummary withIsActive(Boolean isActive) {
setIsActive(isActive);
return this;
}
/**
*
* Whether the quick response is active.
*
*
* @return Whether the quick response is active.
*/
public Boolean isActive() {
return this.isActive;
}
/**
*
* 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 QuickResponseSummary withKnowledgeBaseArn(String knowledgeBaseArn) {
setKnowledgeBaseArn(knowledgeBaseArn);
return this;
}
/**
*
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing
* Wisdom Content resource to it.
*
*
* @param knowledgeBaseId
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're
* storing Wisdom Content resource to it.
*/
public void setKnowledgeBaseId(String knowledgeBaseId) {
this.knowledgeBaseId = knowledgeBaseId;
}
/**
*
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing
* Wisdom Content resource to it.
*
*
* @return The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're
* storing Wisdom Content resource to it.
*/
public String getKnowledgeBaseId() {
return this.knowledgeBaseId;
}
/**
*
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing
* Wisdom Content resource to it.
*
*
* @param knowledgeBaseId
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're
* storing Wisdom Content resource to it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuickResponseSummary withKnowledgeBaseId(String knowledgeBaseId) {
setKnowledgeBaseId(knowledgeBaseId);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the user who last updated the quick response data.
*
*
* @param lastModifiedBy
* The Amazon Resource Name (ARN) of the user who last updated the quick response data.
*/
public void setLastModifiedBy(String lastModifiedBy) {
this.lastModifiedBy = lastModifiedBy;
}
/**
*
* The Amazon Resource Name (ARN) of the user who last updated the quick response data.
*
*
* @return The Amazon Resource Name (ARN) of the user who last updated the quick response data.
*/
public String getLastModifiedBy() {
return this.lastModifiedBy;
}
/**
*
* The Amazon Resource Name (ARN) of the user who last updated the quick response data.
*
*
* @param lastModifiedBy
* The Amazon Resource Name (ARN) of the user who last updated the quick response data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuickResponseSummary withLastModifiedBy(String lastModifiedBy) {
setLastModifiedBy(lastModifiedBy);
return this;
}
/**
*
* The timestamp when the quick response summary was last modified.
*
*
* @param lastModifiedTime
* The timestamp when the quick response summary was last modified.
*/
public void setLastModifiedTime(java.util.Date lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
}
/**
*
* The timestamp when the quick response summary was last modified.
*
*
* @return The timestamp when the quick response summary was last modified.
*/
public java.util.Date getLastModifiedTime() {
return this.lastModifiedTime;
}
/**
*
* The timestamp when the quick response summary was last modified.
*
*
* @param lastModifiedTime
* The timestamp when the quick response summary was last modified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuickResponseSummary withLastModifiedTime(java.util.Date lastModifiedTime) {
setLastModifiedTime(lastModifiedTime);
return this;
}
/**
*
* The name of the quick response.
*
*
* @param name
* The name of the quick response.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the quick response.
*
*
* @return The name of the quick response.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the quick response.
*
*
* @param name
* The name of the quick response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuickResponseSummary withName(String name) {
setName(name);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the quick response.
*
*
* @param quickResponseArn
* The Amazon Resource Name (ARN) of the quick response.
*/
public void setQuickResponseArn(String quickResponseArn) {
this.quickResponseArn = quickResponseArn;
}
/**
*
* The Amazon Resource Name (ARN) of the quick response.
*
*
* @return The Amazon Resource Name (ARN) of the quick response.
*/
public String getQuickResponseArn() {
return this.quickResponseArn;
}
/**
*
* The Amazon Resource Name (ARN) of the quick response.
*
*
* @param quickResponseArn
* The Amazon Resource Name (ARN) of the quick response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuickResponseSummary withQuickResponseArn(String quickResponseArn) {
setQuickResponseArn(quickResponseArn);
return this;
}
/**
*
* The identifier of the quick response.
*
*
* @param quickResponseId
* The identifier of the quick response.
*/
public void setQuickResponseId(String quickResponseId) {
this.quickResponseId = quickResponseId;
}
/**
*
* The identifier of the quick response.
*
*
* @return The identifier of the quick response.
*/
public String getQuickResponseId() {
return this.quickResponseId;
}
/**
*
* The identifier of the quick response.
*
*
* @param quickResponseId
* The identifier of the quick response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuickResponseSummary withQuickResponseId(String quickResponseId) {
setQuickResponseId(quickResponseId);
return this;
}
/**
*
* The resource status of the quick response.
*
*
* @param status
* The resource status of the quick response.
* @see QuickResponseStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The resource status of the quick response.
*
*
* @return The resource status of the quick response.
* @see QuickResponseStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The resource status of the quick response.
*
*
* @param status
* The resource status of the quick response.
* @return Returns a reference to this object so that method calls can be chained together.
* @see QuickResponseStatus
*/
public QuickResponseSummary withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The resource status of the quick response.
*
*
* @param status
* The resource status of the quick response.
* @return Returns a reference to this object so that method calls can be chained together.
* @see QuickResponseStatus
*/
public QuickResponseSummary withStatus(QuickResponseStatus 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 QuickResponseSummary withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see QuickResponseSummary#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public QuickResponseSummary 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 QuickResponseSummary 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 (getChannels() != null)
sb.append("Channels: ").append("***Sensitive Data Redacted***").append(",");
if (getContentType() != null)
sb.append("ContentType: ").append(getContentType()).append(",");
if (getCreatedTime() != null)
sb.append("CreatedTime: ").append(getCreatedTime()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getIsActive() != null)
sb.append("IsActive: ").append(getIsActive()).append(",");
if (getKnowledgeBaseArn() != null)
sb.append("KnowledgeBaseArn: ").append(getKnowledgeBaseArn()).append(",");
if (getKnowledgeBaseId() != null)
sb.append("KnowledgeBaseId: ").append(getKnowledgeBaseId()).append(",");
if (getLastModifiedBy() != null)
sb.append("LastModifiedBy: ").append(getLastModifiedBy()).append(",");
if (getLastModifiedTime() != null)
sb.append("LastModifiedTime: ").append(getLastModifiedTime()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getQuickResponseArn() != null)
sb.append("QuickResponseArn: ").append(getQuickResponseArn()).append(",");
if (getQuickResponseId() != null)
sb.append("QuickResponseId: ").append(getQuickResponseId()).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 QuickResponseSummary == false)
return false;
QuickResponseSummary other = (QuickResponseSummary) obj;
if (other.getChannels() == null ^ this.getChannels() == null)
return false;
if (other.getChannels() != null && other.getChannels().equals(this.getChannels()) == false)
return false;
if (other.getContentType() == null ^ this.getContentType() == null)
return false;
if (other.getContentType() != null && other.getContentType().equals(this.getContentType()) == false)
return false;
if (other.getCreatedTime() == null ^ this.getCreatedTime() == null)
return false;
if (other.getCreatedTime() != null && other.getCreatedTime().equals(this.getCreatedTime()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getIsActive() == null ^ this.getIsActive() == null)
return false;
if (other.getIsActive() != null && other.getIsActive().equals(this.getIsActive()) == 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.getLastModifiedBy() == null ^ this.getLastModifiedBy() == null)
return false;
if (other.getLastModifiedBy() != null && other.getLastModifiedBy().equals(this.getLastModifiedBy()) == false)
return false;
if (other.getLastModifiedTime() == null ^ this.getLastModifiedTime() == null)
return false;
if (other.getLastModifiedTime() != null && other.getLastModifiedTime().equals(this.getLastModifiedTime()) == 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.getQuickResponseArn() == null ^ this.getQuickResponseArn() == null)
return false;
if (other.getQuickResponseArn() != null && other.getQuickResponseArn().equals(this.getQuickResponseArn()) == false)
return false;
if (other.getQuickResponseId() == null ^ this.getQuickResponseId() == null)
return false;
if (other.getQuickResponseId() != null && other.getQuickResponseId().equals(this.getQuickResponseId()) == 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 + ((getChannels() == null) ? 0 : getChannels().hashCode());
hashCode = prime * hashCode + ((getContentType() == null) ? 0 : getContentType().hashCode());
hashCode = prime * hashCode + ((getCreatedTime() == null) ? 0 : getCreatedTime().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getIsActive() == null) ? 0 : getIsActive().hashCode());
hashCode = prime * hashCode + ((getKnowledgeBaseArn() == null) ? 0 : getKnowledgeBaseArn().hashCode());
hashCode = prime * hashCode + ((getKnowledgeBaseId() == null) ? 0 : getKnowledgeBaseId().hashCode());
hashCode = prime * hashCode + ((getLastModifiedBy() == null) ? 0 : getLastModifiedBy().hashCode());
hashCode = prime * hashCode + ((getLastModifiedTime() == null) ? 0 : getLastModifiedTime().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getQuickResponseArn() == null) ? 0 : getQuickResponseArn().hashCode());
hashCode = prime * hashCode + ((getQuickResponseId() == null) ? 0 : getQuickResponseId().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public QuickResponseSummary clone() {
try {
return (QuickResponseSummary) 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.connectwisdom.model.transform.QuickResponseSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}