com.amazonaws.services.chatbot.model.ChimeWebhookConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-chatbot Show documentation
Show all versions of aws-java-sdk-chatbot Show documentation
The AWS Java SDK for chatbot module holds the client classes that are used for communicating with chatbot Service
/*
* 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.chatbot.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
* An AWS Chatbot configuration for Amazon Chime.
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ChimeWebhookConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
* Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for
* more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
*/
private String webhookDescription;
/** The ARN of the ChimeWebhookConfiguration. */
private String chatConfigurationArn;
/**
* The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS
* Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
*/
private String iamRoleArn;
/** The ARNs of the SNS topics that deliver notifications to AWS Chatbot. */
private java.util.List snsTopicArns;
/** The name of the configuration. */
private String configurationName;
/**
* Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon
* CloudWatch Logs.Logging levels include ERROR, INFO, or NONE.
*/
private String loggingLevel;
/** A list of tags applied to the configuration. */
private java.util.List tags;
/**
* Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for
* more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
*
* @param webhookDescription
* Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup
* tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
*/
public void setWebhookDescription(String webhookDescription) {
this.webhookDescription = webhookDescription;
}
/**
* Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for
* more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
*
* @return Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup
* tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
*/
public String getWebhookDescription() {
return this.webhookDescription;
}
/**
* Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for
* more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
*
* @param webhookDescription
* Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup
* tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChimeWebhookConfiguration withWebhookDescription(String webhookDescription) {
setWebhookDescription(webhookDescription);
return this;
}
/**
* The ARN of the ChimeWebhookConfiguration.
*
* @param chatConfigurationArn
* The ARN of the ChimeWebhookConfiguration.
*/
public void setChatConfigurationArn(String chatConfigurationArn) {
this.chatConfigurationArn = chatConfigurationArn;
}
/**
* The ARN of the ChimeWebhookConfiguration.
*
* @return The ARN of the ChimeWebhookConfiguration.
*/
public String getChatConfigurationArn() {
return this.chatConfigurationArn;
}
/**
* The ARN of the ChimeWebhookConfiguration.
*
* @param chatConfigurationArn
* The ARN of the ChimeWebhookConfiguration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChimeWebhookConfiguration withChatConfigurationArn(String chatConfigurationArn) {
setChatConfigurationArn(chatConfigurationArn);
return this;
}
/**
* The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS
* Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
*
* @param iamRoleArn
* The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS
* Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS
* Chatbot.
*/
public void setIamRoleArn(String iamRoleArn) {
this.iamRoleArn = iamRoleArn;
}
/**
* The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS
* Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
*
* @return The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that
* AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for
* AWS Chatbot.
*/
public String getIamRoleArn() {
return this.iamRoleArn;
}
/**
* The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS
* Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
*
* @param iamRoleArn
* The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS
* Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS
* Chatbot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChimeWebhookConfiguration withIamRoleArn(String iamRoleArn) {
setIamRoleArn(iamRoleArn);
return this;
}
/**
* The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
*
* @return The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
*/
public java.util.List getSnsTopicArns() {
return snsTopicArns;
}
/**
* The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
*
* @param snsTopicArns
* The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
*/
public void setSnsTopicArns(java.util.Collection snsTopicArns) {
if (snsTopicArns == null) {
this.snsTopicArns = null;
return;
}
this.snsTopicArns = new java.util.ArrayList(snsTopicArns);
}
/**
* The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSnsTopicArns(java.util.Collection)} or {@link #withSnsTopicArns(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param snsTopicArns
* The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChimeWebhookConfiguration withSnsTopicArns(String... snsTopicArns) {
if (this.snsTopicArns == null) {
setSnsTopicArns(new java.util.ArrayList(snsTopicArns.length));
}
for (String ele : snsTopicArns) {
this.snsTopicArns.add(ele);
}
return this;
}
/**
* The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
*
* @param snsTopicArns
* The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChimeWebhookConfiguration withSnsTopicArns(java.util.Collection snsTopicArns) {
setSnsTopicArns(snsTopicArns);
return this;
}
/**
* The name of the configuration.
*
* @param configurationName
* The name of the configuration.
*/
public void setConfigurationName(String configurationName) {
this.configurationName = configurationName;
}
/**
* The name of the configuration.
*
* @return The name of the configuration.
*/
public String getConfigurationName() {
return this.configurationName;
}
/**
* The name of the configuration.
*
* @param configurationName
* The name of the configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChimeWebhookConfiguration withConfigurationName(String configurationName) {
setConfigurationName(configurationName);
return this;
}
/**
* Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon
* CloudWatch Logs.Logging levels include ERROR, INFO, or NONE.
*
* @param loggingLevel
* Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon
* CloudWatch Logs.Logging levels include ERROR, INFO, or NONE.
*/
public void setLoggingLevel(String loggingLevel) {
this.loggingLevel = loggingLevel;
}
/**
* Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon
* CloudWatch Logs.Logging levels include ERROR, INFO, or NONE.
*
* @return Specifies the logging level for this configuration. This property affects the log entries pushed to
* Amazon CloudWatch Logs.Logging levels include ERROR, INFO, or NONE.
*/
public String getLoggingLevel() {
return this.loggingLevel;
}
/**
* Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon
* CloudWatch Logs.Logging levels include ERROR, INFO, or NONE.
*
* @param loggingLevel
* Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon
* CloudWatch Logs.Logging levels include ERROR, INFO, or NONE.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChimeWebhookConfiguration withLoggingLevel(String loggingLevel) {
setLoggingLevel(loggingLevel);
return this;
}
/**
* A list of tags applied to the configuration.
*
* @return A list of tags applied to the configuration.
*/
public java.util.List getTags() {
return tags;
}
/**
* A list of tags applied to the configuration.
*
* @param tags
* A list of tags applied to the configuration.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
* A list of tags applied to the configuration.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* A list of tags applied to the configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChimeWebhookConfiguration withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
* A list of tags applied to the configuration.
*
* @param tags
* A list of tags applied to the configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChimeWebhookConfiguration withTags(java.util.Collection tags) {
setTags(tags);
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 (getWebhookDescription() != null)
sb.append("WebhookDescription: ").append(getWebhookDescription()).append(",");
if (getChatConfigurationArn() != null)
sb.append("ChatConfigurationArn: ").append(getChatConfigurationArn()).append(",");
if (getIamRoleArn() != null)
sb.append("IamRoleArn: ").append(getIamRoleArn()).append(",");
if (getSnsTopicArns() != null)
sb.append("SnsTopicArns: ").append(getSnsTopicArns()).append(",");
if (getConfigurationName() != null)
sb.append("ConfigurationName: ").append(getConfigurationName()).append(",");
if (getLoggingLevel() != null)
sb.append("LoggingLevel: ").append(getLoggingLevel()).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 ChimeWebhookConfiguration == false)
return false;
ChimeWebhookConfiguration other = (ChimeWebhookConfiguration) obj;
if (other.getWebhookDescription() == null ^ this.getWebhookDescription() == null)
return false;
if (other.getWebhookDescription() != null && other.getWebhookDescription().equals(this.getWebhookDescription()) == false)
return false;
if (other.getChatConfigurationArn() == null ^ this.getChatConfigurationArn() == null)
return false;
if (other.getChatConfigurationArn() != null && other.getChatConfigurationArn().equals(this.getChatConfigurationArn()) == false)
return false;
if (other.getIamRoleArn() == null ^ this.getIamRoleArn() == null)
return false;
if (other.getIamRoleArn() != null && other.getIamRoleArn().equals(this.getIamRoleArn()) == false)
return false;
if (other.getSnsTopicArns() == null ^ this.getSnsTopicArns() == null)
return false;
if (other.getSnsTopicArns() != null && other.getSnsTopicArns().equals(this.getSnsTopicArns()) == false)
return false;
if (other.getConfigurationName() == null ^ this.getConfigurationName() == null)
return false;
if (other.getConfigurationName() != null && other.getConfigurationName().equals(this.getConfigurationName()) == false)
return false;
if (other.getLoggingLevel() == null ^ this.getLoggingLevel() == null)
return false;
if (other.getLoggingLevel() != null && other.getLoggingLevel().equals(this.getLoggingLevel()) == 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 + ((getWebhookDescription() == null) ? 0 : getWebhookDescription().hashCode());
hashCode = prime * hashCode + ((getChatConfigurationArn() == null) ? 0 : getChatConfigurationArn().hashCode());
hashCode = prime * hashCode + ((getIamRoleArn() == null) ? 0 : getIamRoleArn().hashCode());
hashCode = prime * hashCode + ((getSnsTopicArns() == null) ? 0 : getSnsTopicArns().hashCode());
hashCode = prime * hashCode + ((getConfigurationName() == null) ? 0 : getConfigurationName().hashCode());
hashCode = prime * hashCode + ((getLoggingLevel() == null) ? 0 : getLoggingLevel().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public ChimeWebhookConfiguration clone() {
try {
return (ChimeWebhookConfiguration) 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.chatbot.model.transform.ChimeWebhookConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy