com.amazonaws.services.qconnect.model.AssistantData 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;
/**
*
* The assistant data.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AssistantData implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
*
*/
private String assistantArn;
/**
*
* The identifier of the Amazon Q in Connect assistant.
*
*/
private String assistantId;
/**
*
* The configuration information for the Amazon Q in Connect assistant capability.
*
*/
private AssistantCapabilityConfiguration capabilityConfiguration;
/**
*
* The description.
*
*/
private String description;
/**
*
* The configuration information for the Amazon Q in Connect assistant integration.
*
*/
private AssistantIntegrationConfiguration integrationConfiguration;
/**
*
* The name.
*
*/
private String name;
/**
*
* 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. To use Amazon Q in Connect with chat, the key policy must also allow
* kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the
* connect.amazonaws.com service principal.
*
*
* 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;
/**
*
* The status of the assistant.
*
*/
private String status;
/**
*
* The tags used to organize, track, or control access for this resource.
*
*/
private java.util.Map tags;
/**
*
* The type of assistant.
*
*/
private String type;
/**
*
* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
*
*
* @param assistantArn
* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
*/
public void setAssistantArn(String assistantArn) {
this.assistantArn = assistantArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
*
*
* @return The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
*/
public String getAssistantArn() {
return this.assistantArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
*
*
* @param assistantArn
* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AssistantData withAssistantArn(String assistantArn) {
setAssistantArn(assistantArn);
return this;
}
/**
*
* The identifier of the Amazon Q in Connect assistant.
*
*
* @param assistantId
* The identifier of the Amazon Q in Connect assistant.
*/
public void setAssistantId(String assistantId) {
this.assistantId = assistantId;
}
/**
*
* The identifier of the Amazon Q in Connect assistant.
*
*
* @return The identifier of the Amazon Q in Connect assistant.
*/
public String getAssistantId() {
return this.assistantId;
}
/**
*
* The identifier of the Amazon Q in Connect assistant.
*
*
* @param assistantId
* The identifier of the Amazon Q in Connect assistant.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AssistantData withAssistantId(String assistantId) {
setAssistantId(assistantId);
return this;
}
/**
*
* The configuration information for the Amazon Q in Connect assistant capability.
*
*
* @param capabilityConfiguration
* The configuration information for the Amazon Q in Connect assistant capability.
*/
public void setCapabilityConfiguration(AssistantCapabilityConfiguration capabilityConfiguration) {
this.capabilityConfiguration = capabilityConfiguration;
}
/**
*
* The configuration information for the Amazon Q in Connect assistant capability.
*
*
* @return The configuration information for the Amazon Q in Connect assistant capability.
*/
public AssistantCapabilityConfiguration getCapabilityConfiguration() {
return this.capabilityConfiguration;
}
/**
*
* The configuration information for the Amazon Q in Connect assistant capability.
*
*
* @param capabilityConfiguration
* The configuration information for the Amazon Q in Connect assistant capability.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AssistantData withCapabilityConfiguration(AssistantCapabilityConfiguration capabilityConfiguration) {
setCapabilityConfiguration(capabilityConfiguration);
return this;
}
/**
*
* The description.
*
*
* @param description
* The description.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description.
*
*
* @return The description.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description.
*
*
* @param description
* The description.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AssistantData withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The configuration information for the Amazon Q in Connect assistant integration.
*
*
* @param integrationConfiguration
* The configuration information for the Amazon Q in Connect assistant integration.
*/
public void setIntegrationConfiguration(AssistantIntegrationConfiguration integrationConfiguration) {
this.integrationConfiguration = integrationConfiguration;
}
/**
*
* The configuration information for the Amazon Q in Connect assistant integration.
*
*
* @return The configuration information for the Amazon Q in Connect assistant integration.
*/
public AssistantIntegrationConfiguration getIntegrationConfiguration() {
return this.integrationConfiguration;
}
/**
*
* The configuration information for the Amazon Q in Connect assistant integration.
*
*
* @param integrationConfiguration
* The configuration information for the Amazon Q in Connect assistant integration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AssistantData withIntegrationConfiguration(AssistantIntegrationConfiguration integrationConfiguration) {
setIntegrationConfiguration(integrationConfiguration);
return this;
}
/**
*
* The name.
*
*
* @param name
* The name.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name.
*
*
* @return The name.
*/
public String getName() {
return this.name;
}
/**
*
* The name.
*
*
* @param name
* The name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AssistantData withName(String name) {
setName(name);
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. To use Amazon Q in Connect with chat, the key policy must also allow
* kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the
* connect.amazonaws.com service principal.
*
*
* 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. To use Amazon Q in Connect with chat, the key policy must also allow
* kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions
* to the connect.amazonaws.com service principal.
*
*
* 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. To use Amazon Q in Connect with chat, the key policy must also allow
* kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the
* connect.amazonaws.com service principal.
*
*
* 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. To use Amazon Q in Connect with chat, the key policy must also allow
* kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions
* to the connect.amazonaws.com service principal.
*
*
* 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. To use Amazon Q in Connect with chat, the key policy must also allow
* kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the
* connect.amazonaws.com service principal.
*
*
* 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. To use Amazon Q in Connect with chat, the key policy must also allow
* kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions
* to the connect.amazonaws.com service principal.
*
*
* 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 AssistantData withServerSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration) {
setServerSideEncryptionConfiguration(serverSideEncryptionConfiguration);
return this;
}
/**
*
* The status of the assistant.
*
*
* @param status
* The status of the assistant.
* @see AssistantStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the assistant.
*
*
* @return The status of the assistant.
* @see AssistantStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the assistant.
*
*
* @param status
* The status of the assistant.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AssistantStatus
*/
public AssistantData withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The status of the assistant.
*
*
* @param status
* The status of the assistant.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AssistantStatus
*/
public AssistantData withStatus(AssistantStatus 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 AssistantData withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see AssistantData#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public AssistantData 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 AssistantData clearTagsEntries() {
this.tags = null;
return this;
}
/**
*
* The type of assistant.
*
*
* @param type
* The type of assistant.
* @see AssistantType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The type of assistant.
*
*
* @return The type of assistant.
* @see AssistantType
*/
public String getType() {
return this.type;
}
/**
*
* The type of assistant.
*
*
* @param type
* The type of assistant.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AssistantType
*/
public AssistantData withType(String type) {
setType(type);
return this;
}
/**
*
* The type of assistant.
*
*
* @param type
* The type of assistant.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AssistantType
*/
public AssistantData withType(AssistantType type) {
this.type = type.toString();
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 (getAssistantArn() != null)
sb.append("AssistantArn: ").append(getAssistantArn()).append(",");
if (getAssistantId() != null)
sb.append("AssistantId: ").append(getAssistantId()).append(",");
if (getCapabilityConfiguration() != null)
sb.append("CapabilityConfiguration: ").append(getCapabilityConfiguration()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getIntegrationConfiguration() != null)
sb.append("IntegrationConfiguration: ").append(getIntegrationConfiguration()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getServerSideEncryptionConfiguration() != null)
sb.append("ServerSideEncryptionConfiguration: ").append(getServerSideEncryptionConfiguration()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AssistantData == false)
return false;
AssistantData other = (AssistantData) obj;
if (other.getAssistantArn() == null ^ this.getAssistantArn() == null)
return false;
if (other.getAssistantArn() != null && other.getAssistantArn().equals(this.getAssistantArn()) == false)
return false;
if (other.getAssistantId() == null ^ this.getAssistantId() == null)
return false;
if (other.getAssistantId() != null && other.getAssistantId().equals(this.getAssistantId()) == false)
return false;
if (other.getCapabilityConfiguration() == null ^ this.getCapabilityConfiguration() == null)
return false;
if (other.getCapabilityConfiguration() != null && other.getCapabilityConfiguration().equals(this.getCapabilityConfiguration()) == 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.getIntegrationConfiguration() == null ^ this.getIntegrationConfiguration() == null)
return false;
if (other.getIntegrationConfiguration() != null && other.getIntegrationConfiguration().equals(this.getIntegrationConfiguration()) == 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.getServerSideEncryptionConfiguration() == null ^ this.getServerSideEncryptionConfiguration() == null)
return false;
if (other.getServerSideEncryptionConfiguration() != null
&& other.getServerSideEncryptionConfiguration().equals(this.getServerSideEncryptionConfiguration()) == 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;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAssistantArn() == null) ? 0 : getAssistantArn().hashCode());
hashCode = prime * hashCode + ((getAssistantId() == null) ? 0 : getAssistantId().hashCode());
hashCode = prime * hashCode + ((getCapabilityConfiguration() == null) ? 0 : getCapabilityConfiguration().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getIntegrationConfiguration() == null) ? 0 : getIntegrationConfiguration().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getServerSideEncryptionConfiguration() == null) ? 0 : getServerSideEncryptionConfiguration().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
return hashCode;
}
@Override
public AssistantData clone() {
try {
return (AssistantData) 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.AssistantDataMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}