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>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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<GetBotChannelAssociationResponse.Builder,GetBotChannelAssociationResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

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