Interface ListBotsRequest.Builder

    • Method Detail

      • sortBy

        ListBotsRequest.Builder sortBy​(BotSortBy sortBy)

        Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.

        Parameters:
        sortBy - Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • filters

        ListBotsRequest.Builder filters​(Collection<BotFilter> filters)

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

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

        ListBotsRequest.Builder filters​(BotFilter... filters)

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

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

        ListBotsRequest.Builder filters​(Consumer<BotFilter.Builder>... filters)

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

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

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

        Parameters:
        filters - a consumer that will call methods on BotFilter.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #filters(java.util.Collection)
      • maxResults

        ListBotsRequest.Builder maxResults​(Integer maxResults)

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

        Parameters:
        maxResults - The maximum number of bots to return in each page of results. If there are fewer results than the maximum 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

        ListBotsRequest.Builder nextToken​(String nextToken)

        If the response from the ListBots 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 ListBots request to return the next page of results. For a complete set of results, call the ListBots operation until the nextToken returned in the response is null.

        Parameters:
        nextToken - If the response from the ListBots 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 ListBots request to return the next page of results. For a complete set of results, call the ListBots 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.