Interface ListItemsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListItemsRequest.Builder,
,ListItemsRequest> MediaStoreDataRequest.Builder
,SdkBuilder<ListItemsRequest.Builder,
,ListItemsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListItemsRequest
-
Method Summary
Modifier and TypeMethodDescriptionmaxResults
(Integer maxResults) The maximum number of results to return per API request.The token that identifies which batch of results that you want to see.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The path in the container from which to retrieve items.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.mediastoredata.model.MediaStoreDataRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
The maximum number of results to return per API request. For example, you submit a
ListItems
request withMaxResults
set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns aNextToken
value that you can use to fetch the next batch of results.) The service might return fewer results than theMaxResults
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 aListItems
request withMaxResults
set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns aNextToken
value that you can use to fetch the next batch of results.) The service might return fewer results than theMaxResults
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
The token that identifies which batch of results that you want to see. For example, you submit a
ListItems
request withMaxResults
set at 500. The service returns the first batch of results (up to 500) and aNextToken
value. To see the next batch of results, you can submit theListItems
request a second time and specify theNextToken
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 aListItems
request withMaxResults
set at 500. The service returns the first batch of results (up to 500) and aNextToken
value. To see the next batch of results, you can submit theListItems
request a second time and specify theNextToken
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-