/* * Copyright 2018-2023 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.lexmodelsv2.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 CreateBotRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The name of the bot. The bot name must be unique in the account that creates the bot. *

*/ private String botName; /** *

* A description of the bot. It appears in lists to help you identify a particular bot. *

*/ private String description; /** *

* The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot. *

*/ private String roleArn; /** *

* Provides information on additional privacy protections Amazon Lex should use with the bot's data. *

*/ private DataPrivacy dataPrivacy; /** *

* The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot. *

*

* A user interaction remains active for the amount of time specified. If no conversation occurs during this time, * the session expires and Amazon Lex deletes any data provided before the timeout. *

*

* You can specify between 60 (1 minute) and 86,400 (24 hours) seconds. *

*/ private Integer idleSessionTTLInSeconds; /** *

* A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the * UpdateBot operation to update tags. To update tags, use the TagResource operation. *

*/ private java.util.Map botTags; /** *

* A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the * UpdateAlias operation to update tags. To update tags on the test alias, use the * TagResource operation. *

*/ private java.util.Map testBotAliasTags; /** *

* The type of a bot to create. *

*/ private String botType; /** *

* The list of bot members in a network to be created. *

*/ private java.util.List botMembers; /** *

* The name of the bot. The bot name must be unique in the account that creates the bot. *

* * @param botName * The name of the bot. The bot name must be unique in the account that creates the bot. */ public void setBotName(String botName) { this.botName = botName; } /** *

* The name of the bot. The bot name must be unique in the account that creates the bot. *

* * @return The name of the bot. The bot name must be unique in the account that creates the bot. */ public String getBotName() { return this.botName; } /** *

* The name of the bot. The bot name must be unique in the account that creates the bot. *

* * @param botName * The name of the bot. The bot name must be unique in the account that creates the bot. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateBotRequest withBotName(String botName) { setBotName(botName); return this; } /** *

* A description of the bot. It appears in lists to help you identify a particular bot. *

* * @param description * A description of the bot. It appears in lists to help you identify a particular bot. */ public void setDescription(String description) { this.description = description; } /** *

* A description of the bot. It appears in lists to help you identify a particular bot. *

* * @return A description of the bot. It appears in lists to help you identify a particular bot. */ public String getDescription() { return this.description; } /** *

* A description of the bot. It appears in lists to help you identify a particular bot. *

* * @param description * A description of the bot. It appears in lists to help you identify a particular bot. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateBotRequest withDescription(String description) { setDescription(description); return this; } /** *

* The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot. *

* * @param roleArn * The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot. */ public void setRoleArn(String roleArn) { this.roleArn = roleArn; } /** *

* The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot. *

* * @return The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot. */ public String getRoleArn() { return this.roleArn; } /** *

* The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot. *

* * @param roleArn * The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateBotRequest withRoleArn(String roleArn) { setRoleArn(roleArn); return this; } /** *

* Provides information on additional privacy protections Amazon Lex should use with the bot's data. *

* * @param dataPrivacy * Provides information on additional privacy protections Amazon Lex should use with the bot's data. */ public void setDataPrivacy(DataPrivacy dataPrivacy) { this.dataPrivacy = dataPrivacy; } /** *

* Provides information on additional privacy protections Amazon Lex should use with the bot's data. *

* * @return Provides information on additional privacy protections Amazon Lex should use with the bot's data. */ public DataPrivacy getDataPrivacy() { return this.dataPrivacy; } /** *

* Provides information on additional privacy protections Amazon Lex should use with the bot's data. *

* * @param dataPrivacy * Provides information on additional privacy protections Amazon Lex should use with the bot's data. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateBotRequest withDataPrivacy(DataPrivacy dataPrivacy) { setDataPrivacy(dataPrivacy); return this; } /** *

* The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot. *

*

* A user interaction remains active for the amount of time specified. If no conversation occurs during this time, * the session expires and Amazon Lex deletes any data provided before the timeout. *

*

* You can specify between 60 (1 minute) and 86,400 (24 hours) seconds. *

* * @param idleSessionTTLInSeconds * The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot. *

*

* A user interaction remains active for the amount of time specified. If no conversation occurs during this * time, the session expires and Amazon Lex deletes any data provided before the timeout. *

*

* You can specify between 60 (1 minute) and 86,400 (24 hours) seconds. */ public void setIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds) { this.idleSessionTTLInSeconds = idleSessionTTLInSeconds; } /** *

* The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot. *

*

* A user interaction remains active for the amount of time specified. If no conversation occurs during this time, * the session expires and Amazon Lex deletes any data provided before the timeout. *

*

* You can specify between 60 (1 minute) and 86,400 (24 hours) seconds. *

* * @return The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot. *

*

* A user interaction remains active for the amount of time specified. If no conversation occurs during this * time, the session expires and Amazon Lex deletes any data provided before the timeout. *

*

* You can specify between 60 (1 minute) and 86,400 (24 hours) seconds. */ public Integer getIdleSessionTTLInSeconds() { return this.idleSessionTTLInSeconds; } /** *

* The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot. *

*

* A user interaction remains active for the amount of time specified. If no conversation occurs during this time, * the session expires and Amazon Lex deletes any data provided before the timeout. *

*

* You can specify between 60 (1 minute) and 86,400 (24 hours) seconds. *

* * @param idleSessionTTLInSeconds * The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot. *

*

* A user interaction remains active for the amount of time specified. If no conversation occurs during this * time, the session expires and Amazon Lex deletes any data provided before the timeout. *

*

* You can specify between 60 (1 minute) and 86,400 (24 hours) seconds. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateBotRequest withIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds) { setIdleSessionTTLInSeconds(idleSessionTTLInSeconds); return this; } /** *

* A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the * UpdateBot operation to update tags. To update tags, use the TagResource operation. *

* * @return A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the * UpdateBot operation to update tags. To update tags, use the TagResource * operation. */ public java.util.Map getBotTags() { return botTags; } /** *

* A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the * UpdateBot operation to update tags. To update tags, use the TagResource operation. *

* * @param botTags * A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the * UpdateBot operation to update tags. To update tags, use the TagResource * operation. */ public void setBotTags(java.util.Map botTags) { this.botTags = botTags; } /** *

* A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the * UpdateBot operation to update tags. To update tags, use the TagResource operation. *

* * @param botTags * A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the * UpdateBot operation to update tags. To update tags, use the TagResource * operation. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateBotRequest withBotTags(java.util.Map botTags) { setBotTags(botTags); return this; } /** * Add a single BotTags entry * * @see CreateBotRequest#withBotTags * @returns a reference to this object so that method calls can be chained together. */ public CreateBotRequest addBotTagsEntry(String key, String value) { if (null == this.botTags) { this.botTags = new java.util.HashMap(); } if (this.botTags.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.botTags.put(key, value); return this; } /** * Removes all the entries added into BotTags. * * @return Returns a reference to this object so that method calls can be chained together. */ public CreateBotRequest clearBotTagsEntries() { this.botTags = null; return this; } /** *

* A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the * UpdateAlias operation to update tags. To update tags on the test alias, use the * TagResource operation. *

* * @return A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't * use the UpdateAlias operation to update tags. To update tags on the test alias, use the * TagResource operation. */ public java.util.Map getTestBotAliasTags() { return testBotAliasTags; } /** *

* A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the * UpdateAlias operation to update tags. To update tags on the test alias, use the * TagResource operation. *

* * @param testBotAliasTags * A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't * use the UpdateAlias operation to update tags. To update tags on the test alias, use the * TagResource operation. */ public void setTestBotAliasTags(java.util.Map testBotAliasTags) { this.testBotAliasTags = testBotAliasTags; } /** *

* A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the * UpdateAlias operation to update tags. To update tags on the test alias, use the * TagResource operation. *

* * @param testBotAliasTags * A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't * use the UpdateAlias operation to update tags. To update tags on the test alias, use the * TagResource operation. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateBotRequest withTestBotAliasTags(java.util.Map testBotAliasTags) { setTestBotAliasTags(testBotAliasTags); return this; } /** * Add a single TestBotAliasTags entry * * @see CreateBotRequest#withTestBotAliasTags * @returns a reference to this object so that method calls can be chained together. */ public CreateBotRequest addTestBotAliasTagsEntry(String key, String value) { if (null == this.testBotAliasTags) { this.testBotAliasTags = new java.util.HashMap(); } if (this.testBotAliasTags.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.testBotAliasTags.put(key, value); return this; } /** * Removes all the entries added into TestBotAliasTags. * * @return Returns a reference to this object so that method calls can be chained together. */ public CreateBotRequest clearTestBotAliasTagsEntries() { this.testBotAliasTags = null; return this; } /** *

* The type of a bot to create. *

* * @param botType * The type of a bot to create. * @see BotType */ public void setBotType(String botType) { this.botType = botType; } /** *

* The type of a bot to create. *

* * @return The type of a bot to create. * @see BotType */ public String getBotType() { return this.botType; } /** *

* The type of a bot to create. *

* * @param botType * The type of a bot to create. * @return Returns a reference to this object so that method calls can be chained together. * @see BotType */ public CreateBotRequest withBotType(String botType) { setBotType(botType); return this; } /** *

* The type of a bot to create. *

* * @param botType * The type of a bot to create. * @return Returns a reference to this object so that method calls can be chained together. * @see BotType */ public CreateBotRequest withBotType(BotType botType) { this.botType = botType.toString(); return this; } /** *

* The list of bot members in a network to be created. *

* * @return The list of bot members in a network to be created. */ public java.util.List getBotMembers() { return botMembers; } /** *

* The list of bot members in a network to be created. *

* * @param botMembers * The list of bot members in a network to be created. */ public void setBotMembers(java.util.Collection botMembers) { if (botMembers == null) { this.botMembers = null; return; } this.botMembers = new java.util.ArrayList(botMembers); } /** *

* The list of bot members in a network to be created. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setBotMembers(java.util.Collection)} or {@link #withBotMembers(java.util.Collection)} if you want to * override the existing values. *

* * @param botMembers * The list of bot members in a network to be created. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateBotRequest withBotMembers(BotMember... botMembers) { if (this.botMembers == null) { setBotMembers(new java.util.ArrayList(botMembers.length)); } for (BotMember ele : botMembers) { this.botMembers.add(ele); } return this; } /** *

* The list of bot members in a network to be created. *

* * @param botMembers * The list of bot members in a network to be created. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateBotRequest withBotMembers(java.util.Collection botMembers) { setBotMembers(botMembers); 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 (getBotName() != null) sb.append("BotName: ").append(getBotName()).append(","); if (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getRoleArn() != null) sb.append("RoleArn: ").append(getRoleArn()).append(","); if (getDataPrivacy() != null) sb.append("DataPrivacy: ").append(getDataPrivacy()).append(","); if (getIdleSessionTTLInSeconds() != null) sb.append("IdleSessionTTLInSeconds: ").append(getIdleSessionTTLInSeconds()).append(","); if (getBotTags() != null) sb.append("BotTags: ").append(getBotTags()).append(","); if (getTestBotAliasTags() != null) sb.append("TestBotAliasTags: ").append(getTestBotAliasTags()).append(","); if (getBotType() != null) sb.append("BotType: ").append(getBotType()).append(","); if (getBotMembers() != null) sb.append("BotMembers: ").append(getBotMembers()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateBotRequest == false) return false; CreateBotRequest other = (CreateBotRequest) obj; if (other.getBotName() == null ^ this.getBotName() == null) return false; if (other.getBotName() != null && other.getBotName().equals(this.getBotName()) == 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.getRoleArn() == null ^ this.getRoleArn() == null) return false; if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false) return false; if (other.getDataPrivacy() == null ^ this.getDataPrivacy() == null) return false; if (other.getDataPrivacy() != null && other.getDataPrivacy().equals(this.getDataPrivacy()) == false) return false; if (other.getIdleSessionTTLInSeconds() == null ^ this.getIdleSessionTTLInSeconds() == null) return false; if (other.getIdleSessionTTLInSeconds() != null && other.getIdleSessionTTLInSeconds().equals(this.getIdleSessionTTLInSeconds()) == false) return false; if (other.getBotTags() == null ^ this.getBotTags() == null) return false; if (other.getBotTags() != null && other.getBotTags().equals(this.getBotTags()) == false) return false; if (other.getTestBotAliasTags() == null ^ this.getTestBotAliasTags() == null) return false; if (other.getTestBotAliasTags() != null && other.getTestBotAliasTags().equals(this.getTestBotAliasTags()) == false) return false; if (other.getBotType() == null ^ this.getBotType() == null) return false; if (other.getBotType() != null && other.getBotType().equals(this.getBotType()) == false) return false; if (other.getBotMembers() == null ^ this.getBotMembers() == null) return false; if (other.getBotMembers() != null && other.getBotMembers().equals(this.getBotMembers()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getBotName() == null) ? 0 : getBotName().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode()); hashCode = prime * hashCode + ((getDataPrivacy() == null) ? 0 : getDataPrivacy().hashCode()); hashCode = prime * hashCode + ((getIdleSessionTTLInSeconds() == null) ? 0 : getIdleSessionTTLInSeconds().hashCode()); hashCode = prime * hashCode + ((getBotTags() == null) ? 0 : getBotTags().hashCode()); hashCode = prime * hashCode + ((getTestBotAliasTags() == null) ? 0 : getTestBotAliasTags().hashCode()); hashCode = prime * hashCode + ((getBotType() == null) ? 0 : getBotType().hashCode()); hashCode = prime * hashCode + ((getBotMembers() == null) ? 0 : getBotMembers().hashCode()); return hashCode; } @Override public CreateBotRequest clone() { return (CreateBotRequest) super.clone(); } }