DescribeBotResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Response
    - - software.amazon.awssdk.services.lexmodelsv2.model.DescribeBotResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeBotResponse.Builder,DescribeBotResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeBotResponse
extends LexModelsV2Response
implements ToCopyableBuilder<DescribeBotResponse.Builder,DescribeBotResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeBotResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`botId()` The unique identifier of the bot.
`List<BotMember>`	`botMembers()` The list of bots in the network that was described.
`String`	`botName()` The name of the bot.
`BotStatus`	`botStatus()` The current status of the bot.
`String`	`botStatusAsString()` The current status of the bot.
`BotType`	`botType()` The type of the bot that was described.
`String`	`botTypeAsString()` The type of the bot that was described.
`static DescribeBotResponse.Builder`	`builder()`
`Instant`	`creationDateTime()` A timestamp of the date and time that the bot was created.
`DataPrivacy`	`dataPrivacy()` Settings for managing data privacy of the bot and its conversations with users.
`String`	`description()` The description of the bot.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`failureReasons()` If the `botStatus` is `Failed`, this contains a list of reasons that the bot couldn't be built.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasBotMembers()` For responses, this returns true if the service returned a value for the BotMembers property.
`boolean`	`hasFailureReasons()` For responses, this returns true if the service returned a value for the FailureReasons property.
`int`	`hashCode()`
`Integer`	`idleSessionTTLInSeconds()` The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
`Instant`	`lastUpdatedDateTime()` A timestamp of the date and time that the bot was last updated.
`String`	`roleArn()` The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeBotResponse.Builder>`	`serializableBuilderClass()`
`DescribeBotResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Response
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
  - botId
```
public final String botId()
```
    The unique identifier of the bot.
    
    Returns:
    
    The unique identifier of the bot.
  - botName
```
public final String botName()
```
    The name of the bot.
    
    Returns:
    
    The name of the bot.
  - description
```
public final String description()
```
    The description of the bot.
    
    Returns:
    
    The description of the bot.
  - roleArn
```
public final String roleArn()
```
    The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
  - dataPrivacy
```
public final DataPrivacy dataPrivacy()
```
    Settings for managing data privacy of the bot and its conversations with users.
    
    Returns:
    
    Settings for managing data privacy of the bot and its conversations with users.
  - idleSessionTTLInSeconds
```
public final Integer idleSessionTTLInSeconds()
```
    The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
    
    Returns:
    
    The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
  - botStatus
```
public final BotStatus botStatus()
```
    The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.
    
    If the service returns an enum value that is not available in the current SDK version, botStatus will return BotStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from botStatusAsString().
    
    Returns:
    
    The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.
    
    See Also:
    
    BotStatus
  - botStatusAsString
```
public final String botStatusAsString()
```
    The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.
    
    If the service returns an enum value that is not available in the current SDK version, botStatus will return BotStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from botStatusAsString().
    
    Returns:
    
    The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.
    
    See Also:
    
    BotStatus
  - creationDateTime
```
public final Instant creationDateTime()
```
    A timestamp of the date and time that the bot was created.
    
    Returns:
    
    A timestamp of the date and time that the bot was created.
  - lastUpdatedDateTime
```
public final Instant lastUpdatedDateTime()
```
    A timestamp of the date and time that the bot was last updated.
    
    Returns:
    
    A timestamp of the date and time that the bot was last updated.
  - botType
```
public final BotType botType()
```
    The type of the bot that was described.
    
    If the service returns an enum value that is not available in the current SDK version, botType will return BotType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from botTypeAsString().
    
    Returns:
    
    The type of the bot that was described.
    
    See Also:
    
    BotType
  - botTypeAsString
```
public final String botTypeAsString()
```
    The type of the bot that was described.
    
    If the service returns an enum value that is not available in the current SDK version, botType will return BotType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from botTypeAsString().
    
    Returns:
    
    The type of the bot that was described.
    
    See Also:
    
    BotType
  - hasBotMembers
```
public final boolean hasBotMembers()
```
    For responses, this returns true if the service returned a value for the BotMembers 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.
  - botMembers
```
public final List<BotMember> botMembers()
```
    The list of bots in the network that was described.
    
    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 hasBotMembers() method.
    
    Returns:
    
    The list of bots in the network that was described.
  - hasFailureReasons
```
public final boolean hasFailureReasons()
```
    For responses, this returns true if the service returned a value for the FailureReasons 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.
  - failureReasons
```
public final List<String> failureReasons()
```
    If the botStatus is Failed, this contains a list of reasons that the bot couldn't be built.
    
    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 hasFailureReasons() method.
    
    Returns:
    
    If the botStatus is Failed, this contains a list of reasons that the bot couldn't be built.
  - toBuilder
```
public DescribeBotResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeBotResponse.Builder,DescribeBotResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeBotResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeBotResponse.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

Class DescribeBotResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Response

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

Methods inherited from class java.lang.Object

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

Method Detail

botId

botName

description

roleArn

dataPrivacy

idleSessionTTLInSeconds

botStatus

botStatusAsString

creationDateTime

lastUpdatedDateTime

botType

botTypeAsString

hasBotMembers

botMembers

hasFailureReasons

failureReasons

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields