BotChannelAssociation (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.lexmodelbuilding.model.BotChannelAssociation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BotChannelAssociation.Builder,BotChannelAssociation>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class BotChannelAssociation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BotChannelAssociation.Builder,BotChannelAssociation>
```
Represents an association between an Amazon Lex bot and an external messaging platform.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface BotChannelAssociation.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BotChannelAssociation.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`botAlias()` An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
`Map<String,String>`	`botConfiguration()` Provides information necessary to communicate with the messaging platform.
`String`	`botName()` The name of the Amazon Lex bot to which this association is being made.
`static BotChannelAssociation.Builder`	`builder()`
`Instant`	`createdDate()` The date that the association between the Amazon Lex bot and the channel was created.
`String`	`description()` A text description of the association you are creating.
`boolean`	`equals(Object obj)`
`String`	`failureReason()` If `status` is `FAILED`, Amazon Lex provides the reason that it failed to create the association.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`name()` The name of the association between the bot and the channel.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends BotChannelAssociation.Builder>`	`serializableBuilderClass()`
`ChannelStatus`	`status()` The status of the bot channel.
`String`	`statusAsString()` The status of the bot channel.
`BotChannelAssociation.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`ChannelType`	`type()` Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.
`String`	`typeAsString()` Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - name
```
public String name()
```
    The name of the association between the bot and the channel.
    
    Returns:
    
    The name of the association between the bot and the channel.
  - description
```
public String description()
```
    A text description of the association you are creating.
    
    Returns:
    
    A text description of the association you are creating.
  - botAlias
```
public String botAlias()
```
    An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
    
    Returns:
    
    An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
  - botName
```
public String botName()
```
    The name of the Amazon Lex bot to which this association is being made.
    
    Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.
    
    Returns:
    
    The name of the Amazon Lex bot to which this association is being made.
    
    Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.
  - createdDate
```
public Instant createdDate()
```
    The date that the association between the Amazon Lex bot and the channel was created.
    
    Returns:
    
    The date that the association between the Amazon Lex bot and the channel was created.
  - type
```
public ChannelType type()
```
    Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ChannelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.
    
    See Also:
    
    ChannelType
  - typeAsString
```
public String typeAsString()
```
    Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ChannelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.
    
    See Also:
    
    ChannelType
  - botConfiguration
```
public Map<String,String> botConfiguration()
```
    Provides information necessary to communicate with the messaging platform.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Provides information necessary to communicate with the messaging platform.
  - status
```
public ChannelStatus status()
```
    The status of the bot channel.
    - CREATED - The channel has been created and is ready for use.
    - IN_PROGRESS - Channel creation is in progress.
    - FAILED - There was an error creating the channel. For information about the reason for the failure, see the failureReason field.
    If the service returns an enum value that is not available in the current SDK version, status will return ChannelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    The status of the bot channel.
    
    CREATED - The channel has been created and is ready for use.
    
    IN_PROGRESS - Channel creation is in progress.
    
    FAILED - There was an error creating the channel. For information about the reason for the failure, see the failureReason field.
    See Also:
    
    ChannelStatus
  - statusAsString
```
public String statusAsString()
```
    The status of the bot channel.
    - CREATED - The channel has been created and is ready for use.
    - IN_PROGRESS - Channel creation is in progress.
    - FAILED - There was an error creating the channel. For information about the reason for the failure, see the failureReason field.
    If the service returns an enum value that is not available in the current SDK version, status will return ChannelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    The status of the bot channel.
    
    CREATED - The channel has been created and is ready for use.
    
    IN_PROGRESS - Channel creation is in progress.
    
    FAILED - There was an error creating the channel. For information about the reason for the failure, see the failureReason field.
    See Also:
    
    ChannelStatus
  - failureReason
```
public String failureReason()
```
    If status is FAILED, Amazon Lex provides the reason that it failed to create the association.
    
    Returns:
    
    If status is FAILED, Amazon Lex provides the reason that it failed to create the association.
  - toBuilder
```
public BotChannelAssociation.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<BotChannelAssociation.Builder,BotChannelAssociation>
    
    Returns:
    
    a builder for type T
  - builder
```
public static BotChannelAssociation.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends BotChannelAssociation.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class BotChannelAssociation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

description

botAlias

botName

createdDate

type

typeAsString

botConfiguration

status

statusAsString

failureReason

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields