Class GetSessionResponse

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

@Generated("software.amazon.awssdk:codegen") public final class GetSessionResponse extends LexRuntimeResponse implements ToCopyableBuilder<GetSessionResponse.Builder,GetSessionResponse>
  • Method Details

    • hasRecentIntentSummaryView

      public final boolean hasRecentIntentSummaryView()
      For responses, this returns true if the service returned a value for the RecentIntentSummaryView 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.
    • recentIntentSummaryView

      public final List<IntentSummary> recentIntentSummaryView()

      An array of information about the intents used in the session. The array can contain a maximum of three summaries. If more than three intents are used in the session, the recentIntentSummaryView operation contains information about the last three intents used.

      If you set the checkpointLabelFilter parameter in the request, the array contains only the intents with the specified label.

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

      Returns:
      An array of information about the intents used in the session. The array can contain a maximum of three summaries. If more than three intents are used in the session, the recentIntentSummaryView operation contains information about the last three intents used.

      If you set the checkpointLabelFilter parameter in the request, the array contains only the intents with the specified label.

    • hasSessionAttributes

      public final boolean hasSessionAttributes()
      For responses, this returns true if the service returned a value for the SessionAttributes 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.
    • sessionAttributes

      public final Map<String,String> sessionAttributes()

      Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

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

      Returns:
      Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.
    • sessionId

      public final String sessionId()

      A unique identifier for the session.

      Returns:
      A unique identifier for the session.
    • dialogAction

      public final DialogAction dialogAction()

      Describes the current state of the bot.

      Returns:
      Describes the current state of the bot.
    • hasActiveContexts

      public final boolean hasActiveContexts()
      For responses, this returns true if the service returned a value for the ActiveContexts 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.
    • activeContexts

      public final List<ActiveContext> activeContexts()

      A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the PostContent, PostText, or PutSession operation.

      You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.

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

      Returns:
      A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the PostContent, PostText, or PutSession operation.

      You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.

    • toBuilder

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

      public static GetSessionResponse.Builder builder()
    • serializableBuilderClass

      public static Class<? extends GetSessionResponse.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.