Class SearchAssociatedTranscriptsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Request
software.amazon.awssdk.services.lexmodelsv2.model.SearchAssociatedTranscriptsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SearchAssociatedTranscriptsRequest.Builder,SearchAssociatedTranscriptsRequest>
@Generated("software.amazon.awssdk:codegen") public final class SearchAssociatedTranscriptsRequest extends LexModelsV2Request implements ToCopyableBuilder<SearchAssociatedTranscriptsRequest.Builder,SearchAssociatedTranscriptsRequest>

  • Method Details

    • botId

      public final String botId()

      The unique identifier of the bot associated with the transcripts that you are searching.

      Returns:
      The unique identifier of the bot associated with the transcripts that you are searching.

    • botVersion

      public final String botVersion()

      The version of the bot containing the transcripts that you are searching.

      Returns:
      The version of the bot containing the transcripts that you are searching.

    • localeId

      public final String localeId()

      The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see Supported languages

      Returns:
      The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see Supported languages

    • botRecommendationId

      public final String botRecommendationId()

      The unique identifier of the bot recommendation associated with the transcripts to search.

      Returns:
      The unique identifier of the bot recommendation associated with the transcripts to search.

    • searchOrder

      public final SearchOrder searchOrder()

      How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

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

      Returns:
      How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
      See Also:

    • searchOrderAsString

      public final String searchOrderAsString()

      How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

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

      Returns:
      How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
      See Also:

    • hasFilters

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

    • filters

      public final List<AssociatedTranscriptFilter> filters()

      A list of filter objects.

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

      Returns:
      A list of filter objects.

    • maxResults

      public final Integer maxResults()

      The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

      Returns:
      The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

    • nextIndex

      public final Integer nextIndex()

      If the response from the SearchAssociatedTranscriptsRequest operation contains more results than specified in the maxResults parameter, an index is returned in the response. Use that index in the nextIndex parameter to return the next page of results.

      Returns:
      If the response from the SearchAssociatedTranscriptsRequest operation contains more results than specified in the maxResults parameter, an index is returned in the response. Use that index in the nextIndex parameter to return the next page of results.

    • toBuilder

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

    • builder

      public static SearchAssociatedTranscriptsRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.