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

Interface ListIntentsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListIntentsRequest.Builder,ListIntentsRequest>, LexModelsV2Request.Builder, SdkBuilder<ListIntentsRequest.Builder,ListIntentsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListIntentsRequest
public static interface ListIntentsRequest.Builder extends LexModelsV2Request.Builder, SdkPojo, CopyableBuilder<ListIntentsRequest.Builder,ListIntentsRequest>

  • Method Details

    • botId

      ListIntentsRequest.Builder botId(String botId)

      The unique identifier of the bot that contains the intent.

      Parameters:
      botId - The unique identifier of the bot that contains the intent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • botVersion

      ListIntentsRequest.Builder botVersion(String botVersion)

      The version of the bot that contains the intent.

      Parameters:
      botVersion - The version of the bot that contains the intent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • localeId

      ListIntentsRequest.Builder localeId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • sortBy

      ListIntentsRequest.Builder sortBy(IntentSortBy sortBy)

      Determines the sort order for the response from the ListIntents operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.

      Parameters:
      sortBy - Determines the sort order for the response from the ListIntents operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortBy

      default ListIntentsRequest.Builder sortBy(Consumer<IntentSortBy.Builder> sortBy)

      Determines the sort order for the response from the ListIntents operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.

      This is a convenience method that creates an instance of the IntentSortBy.Builder avoiding the need to create one manually via IntentSortBy.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sortBy(IntentSortBy).

      Parameters:
      sortBy - a consumer that will call methods on IntentSortBy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • filters

      ListIntentsRequest.Builder filters(Collection<IntentFilter> filters)

      Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.

      Parameters:
      filters - Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      ListIntentsRequest.Builder filters(IntentFilter... filters)

      Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.

      Parameters:
      filters - Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      ListIntentsRequest.Builder filters(Consumer<IntentFilter.Builder>... filters)

      Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.

      This is a convenience method that creates an instance of the IntentFilter.Builder avoiding the need to create one manually via IntentFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<IntentFilter>).

      Parameters:
      filters - a consumer that will call methods on IntentFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      ListIntentsRequest.Builder maxResults(Integer maxResults)

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

      Parameters:
      maxResults - The maximum number of 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:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListIntentsRequest.Builder nextToken(String nextToken)

      If the response from the ListIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response.

      Use the returned token in the nextToken parameter of a ListIntents request to return the next page of results. For a complete set of results, call the ListIntents operation until the nextToken returned in the response is null.

      Parameters:
      nextToken - If the response from the ListIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response.

      Use the returned token in the nextToken parameter of a ListIntents request to return the next page of results. For a complete set of results, call the ListIntents operation until the nextToken returned in the response is null.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListIntentsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListIntentsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.