Package software.amazon.awssdk.services.robomaker.model

Interface ListRobotsRequest.Builder

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

  • Method Details

    • nextToken

      ListRobotsRequest.Builder nextToken(String nextToken)

      If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobots again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

      Parameters:
      nextToken - If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobots again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListRobotsRequest.Builder maxResults(Integer maxResults)

      When this parameter is used, ListRobots only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobots request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListRobots returns up to 200 results and a nextToken value if applicable.

      Parameters:
      maxResults - When this parameter is used, ListRobots only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobots request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListRobots returns up to 200 results and a nextToken value if applicable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      ListRobotsRequest.Builder filters(Collection<Filter> filters)

      Optional filters to limit results.

      The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available.

      Parameters:
      filters - Optional filters to limit results.

      The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available.

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

    • filters

      ListRobotsRequest.Builder filters(Filter... filters)

      Optional filters to limit results.

      The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available.

      Parameters:
      filters - Optional filters to limit results.

      The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available.

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

    • filters

      ListRobotsRequest.Builder filters(Consumer<Filter.Builder>... filters)

      Optional filters to limit results.

      The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available.

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

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

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

    • overrideConfiguration

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

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