Class SessionDataSortBy

java.lang.Object
software.amazon.awssdk.services.lexmodelsv2.model.SessionDataSortBy
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SessionDataSortBy.Builder,SessionDataSortBy>
@Generated("software.amazon.awssdk:codegen") public final class SessionDataSortBy extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SessionDataSortBy.Builder,SessionDataSortBy>

An object specifying the measure and method by which to sort the session analytics data.

See Also:

  • Method Details

    • name

      public final AnalyticsSessionSortByName name()

      The measure by which to sort the session analytics data.

      • conversationStartTime – The date and time when the conversation began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

      • numberOfTurns – The number of turns that the session took.

      • conversationDurationSeconds – The duration of the conversation in seconds.

      If the service returns an enum value that is not available in the current SDK version, name will return AnalyticsSessionSortByName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

      Returns:
      The measure by which to sort the session analytics data.

      • conversationStartTime – The date and time when the conversation began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

      • numberOfTurns – The number of turns that the session took.

      • conversationDurationSeconds – The duration of the conversation in seconds.

      See Also:

    • nameAsString

      public final String nameAsString()

      The measure by which to sort the session analytics data.

      • conversationStartTime – The date and time when the conversation began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

      • numberOfTurns – The number of turns that the session took.

      • conversationDurationSeconds – The duration of the conversation in seconds.

      If the service returns an enum value that is not available in the current SDK version, name will return AnalyticsSessionSortByName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

      Returns:
      The measure by which to sort the session analytics data.

      • conversationStartTime – The date and time when the conversation began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

      • numberOfTurns – The number of turns that the session took.

      • conversationDurationSeconds – The duration of the conversation in seconds.

      See Also:

    • order

      public final AnalyticsSortOrder order()

      Specifies whether to sort the results in ascending or descending order.

      If the service returns an enum value that is not available in the current SDK version, order will return AnalyticsSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderAsString().

      Returns:
      Specifies whether to sort the results in ascending or descending order.
      See Also:

    • orderAsString

      public final String orderAsString()

      Specifies whether to sort the results in ascending or descending order.

      If the service returns an enum value that is not available in the current SDK version, order will return AnalyticsSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderAsString().

      Returns:
      Specifies whether to sort the results in ascending or descending order.
      See Also:

    • toBuilder

      public SessionDataSortBy.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<SessionDataSortBy.Builder,SessionDataSortBy>
      Returns:
      a builder for type T

    • builder

      public static SessionDataSortBy.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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