Package software.amazon.awssdk.services.lexmodelbuilding.model

Class GetBotChannelAssociationResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.lexmodelbuilding.model.LexModelBuildingResponse

software.amazon.awssdk.services.lexmodelbuilding.model.GetBotChannelAssociationResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetBotChannelAssociationResponse.Builder,GetBotChannelAssociationResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetBotChannelAssociationResponse
extends LexModelBuildingResponse
implements ToCopyableBuilder<GetBotChannelAssociationResponse.Builder,GetBotChannelAssociationResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetBotChannelAssociationResponse.Builder

Method Summary

Modifier and Type	Method	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 that the messaging platform needs to communicate with the Amazon Lex bot.
String	botName()	The name of the Amazon Lex bot.
static GetBotChannelAssociationResponse.Builder	builder()
Instant	createdDate()	The date that the association between the bot and the channel was created.
String	description()	A description of the association between the bot and the channel.
boolean	equals(Object obj)
boolean	equalsBySdkFields(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)
boolean	hasBotConfiguration()	For responses, this returns true if the service returned a value for the BotConfiguration property.
int	hashCode()
String	name()	The name of the association between the bot and the channel.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetBotChannelAssociationResponse.Builder>	serializableBuilderClass()
ChannelStatus	status()	The status of the bot channel.
String	statusAsString()	The status of the bot channel.
GetBotChannelAssociationResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ChannelType	type()	The type of the messaging platform.
String	typeAsString()	The type of the messaging platform.

Methods inherited from class software.amazon.awssdk.services.lexmodelbuilding.model.LexModelBuildingResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

name

public final 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 final String description()

A description of the association between the bot and the channel.

Returns:

A description of the association between the bot and the channel.

botAlias

public final 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 final String botName()

The name of the Amazon Lex bot.

Returns:

The name of the Amazon Lex bot.

createdDate

public final Instant createdDate()

The date that the association between the bot and the channel was created.

Returns:

The date that the association between the bot and the channel was created.

type

public final ChannelType type()

The type of the 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:

The type of the messaging platform.

See Also:

ChannelType

typeAsString

public final String typeAsString()

The type of the 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:

The type of the messaging platform.

See Also:

ChannelType

hasBotConfiguration

public final boolean hasBotConfiguration()

For responses, this returns true if the service returned a value for the BotConfiguration 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.

botConfiguration

public final Map<String,String> botConfiguration()

Provides information that the messaging platform needs to communicate with the Amazon Lex bot.

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 hasBotConfiguration() method.

Returns:

Provides information that the messaging platform needs to communicate with the Amazon Lex bot.

status

public final 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 final 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 final 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 GetBotChannelAssociationResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetBotChannelAssociationResponse.Builder,GetBotChannelAssociationResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetBotChannelAssociationResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo