Interface ListItemsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListItemsRequest.Builder,ListItemsRequest>, MediaStoreDataRequest.Builder, SdkBuilder<ListItemsRequest.Builder,ListItemsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListItemsRequest
@Mutable @NotThreadSafe public static interface ListItemsRequest.Builder extends MediaStoreDataRequest.Builder, SdkPojo, CopyableBuilder<ListItemsRequest.Builder,ListItemsRequest>

  • Method Details

    • path

      ListItemsRequest.Builder path(String path)

      The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

      Parameters:
      path - The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListItemsRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to return per API request. For example, you submit a ListItems request with MaxResults set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value.

      If MaxResults is not included in the request, the service defaults to pagination with a maximum of 1,000 results per page.

      Parameters:
      maxResults - The maximum number of results to return per API request. For example, you submit a ListItems request with MaxResults set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value.

      If MaxResults is not included in the request, the service defaults to pagination with a maximum of 1,000 results per page.

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

    • nextToken

      ListItemsRequest.Builder nextToken(String nextToken)

      The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

      Tokens expire after 15 minutes.

      Parameters:
      nextToken - The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

      Tokens expire after 15 minutes.

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

    • overrideConfiguration

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

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