Package software.amazon.awssdk.services.lexmodelsv2.model

Class ListBuiltInIntentsRequest

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.ListBuiltInIntentsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListBuiltInIntentsRequest.Builder,ListBuiltInIntentsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListBuiltInIntentsRequest extends LexModelsV2Request implements ToCopyableBuilder<ListBuiltInIntentsRequest.Builder,ListBuiltInIntentsRequest>

  • Method Details

    • localeId

      public final String localeId()

      The identifier of the language and locale of the intents to list. 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 intents to list. The string must match one of the supported locales. For more information, see Supported languages.

    • sortBy

      public final BuiltInIntentSortBy sortBy()

      Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.

      Returns:
      Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.

    • maxResults

      public final Integer maxResults()

      The maximum number of built-in intents 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 built-in intents 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.

    • nextToken

      public final String nextToken()

      If the response from the ListBuiltInIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

      Returns:
      If the response from the ListBuiltInIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

    • toBuilder

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

    • builder

      public static ListBuiltInIntentsRequest.Builder builder()

    • serializableBuilderClass

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