com.amazonaws.services.qconnect.model.CreateAssistantRequest 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.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateAssistantRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
* the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with
* idempotent APIs.
*
*/
private String clientToken;
/**
*
* The description of the assistant.
*
*/
private String description;
/**
*
* The name of the assistant.
*
*/
private String name;
/**
*
* The configuration information for the customer managed key used for encryption.
*
*
* The customer managed 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 tags used to organize, track, or control access for this resource.
*
*/
private java.util.Map tags;
/**
*
* The type of assistant.
*
*/
private String type;
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
* the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with
* idempotent APIs.
*
*
* @param clientToken
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
* provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries
* safe with idempotent APIs.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
* the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with
* idempotent APIs.
*
*
* @return A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
* provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see
* Making
* retries safe with idempotent APIs.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
* the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with
* idempotent APIs.
*
*
* @param clientToken
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
* provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries
* safe with idempotent APIs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAssistantRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* The description of the assistant.
*
*
* @param description
* The description of the assistant.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description of the assistant.
*
*
* @return The description of the assistant.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description of the assistant.
*
*
* @param description
* The description of the assistant.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAssistantRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The name of the assistant.
*
*
* @param name
* The name of the assistant.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the assistant.
*
*
* @return The name of the assistant.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the assistant.
*
*
* @param name
* The name of the assistant.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAssistantRequest withName(String name) {
setName(name);
return this;
}
/**
*
* The configuration information for the customer managed key used for encryption.
*
*
* The customer managed 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.
*
* The customer managed 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.
*
*
* The customer managed 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.
*
* The customer managed 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.
*
*
* The customer managed 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.
*
* The customer managed 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 CreateAssistantRequest withServerSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration) {
setServerSideEncryptionConfiguration(serverSideEncryptionConfiguration);
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 CreateAssistantRequest withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see CreateAssistantRequest#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public CreateAssistantRequest 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 CreateAssistantRequest 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 CreateAssistantRequest 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 CreateAssistantRequest 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 (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getServerSideEncryptionConfiguration() != null)
sb.append("ServerSideEncryptionConfiguration: ").append(getServerSideEncryptionConfiguration()).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 CreateAssistantRequest == false)
return false;
CreateAssistantRequest other = (CreateAssistantRequest) obj;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == 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.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.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 + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getServerSideEncryptionConfiguration() == null) ? 0 : getServerSideEncryptionConfiguration().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
return hashCode;
}
@Override
public CreateAssistantRequest clone() {
return (CreateAssistantRequest) super.clone();
}
}