Interface ListItemsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListItemsRequest.Builder,ListItemsRequest>,MediaStoreDataRequest.Builder,SdkBuilder<ListItemsRequest.Builder,ListItemsRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- ListItemsRequest
public static interface ListItemsRequest.Builder extends MediaStoreDataRequest.Builder, SdkPojo, CopyableBuilder<ListItemsRequest.Builder,ListItemsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ListItemsRequest.BuildermaxResults(Integer maxResults)The maximum number of results to return per API request.ListItemsRequest.BuildernextToken(String nextToken)The token that identifies which batch of results that you want to see.ListItemsRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)ListItemsRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)ListItemsRequest.Builderpath(String path)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, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
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
ListItemsrequest withMaxResultsset at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns aNextTokenvalue that you can use to fetch the next batch of results.) The service might return fewer results than theMaxResultsvalue.If
MaxResultsis 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 aListItemsrequest withMaxResultsset at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns aNextTokenvalue that you can use to fetch the next batch of results.) The service might return fewer results than theMaxResultsvalue.If
MaxResultsis 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
ListItemsrequest withMaxResultsset at 500. The service returns the first batch of results (up to 500) and aNextTokenvalue. To see the next batch of results, you can submit theListItemsrequest a second time and specify theNextTokenvalue.Tokens expire after 15 minutes.
- Parameters:
nextToken- The token that identifies which batch of results that you want to see. For example, you submit aListItemsrequest withMaxResultsset at 500. The service returns the first batch of results (up to 500) and aNextTokenvalue. To see the next batch of results, you can submit theListItemsrequest a second time and specify theNextTokenvalue.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)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
ListItemsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-