Package software.amazon.awssdk.services.chatbot.model

Class ChimeWebhookConfiguration

java.lang.Object

software.amazon.awssdk.services.chatbot.model.ChimeWebhookConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ChimeWebhookConfiguration.Builder,ChimeWebhookConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class ChimeWebhookConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ChimeWebhookConfiguration.Builder,ChimeWebhookConfiguration>

An AWS Chatbot configuration for Amazon Chime.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ChimeWebhookConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static ChimeWebhookConfiguration.Builder	builder()
String	chatConfigurationArn()	The ARN of the ChimeWebhookConfiguration.
String	configurationName()	The name of the configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSnsTopicArns()	For responses, this returns true if the service returned a value for the SnsTopicArns property.
String	iamRoleArn()	The ARN of the IAM role that defines the permissions for AWS Chatbot.
String	loggingLevel()	Specifies the logging level for this configuration.
List<SdkField<?>>	sdkFields()
static Class<? extends ChimeWebhookConfiguration.Builder>	serializableBuilderClass()
List<String>	snsTopicArns()	The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
ChimeWebhookConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	webhookDescription()	Description of the webhook.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

webhookDescription

public final String 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.

Returns:

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.

chatConfigurationArn

public final String chatConfigurationArn()

The ARN of the ChimeWebhookConfiguration.

Returns:

The ARN of the ChimeWebhookConfiguration.

iamRoleArn

public final String 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.

Returns:

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.

hasSnsTopicArns

public final boolean hasSnsTopicArns()

For responses, this returns true if the service returned a value for the SnsTopicArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

snsTopicArns

public final List<String> snsTopicArns()

The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSnsTopicArns() method.

Returns:

The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

configurationName

public final String configurationName()

The name of the configuration.

Returns:

The name of the configuration.

loggingLevel

public final String 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.

Returns:

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.

toBuilder

public ChimeWebhookConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ChimeWebhookConfiguration.Builder,ChimeWebhookConfiguration>

builder

public static ChimeWebhookConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ChimeWebhookConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo