public static interface ListObjectsV2Request.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<ListObjectsV2Request.Builder,ListObjectsV2Request>
Modifier and Type | Method and Description |
---|---|
ListObjectsV2Request.Builder |
bucket(String bucket)
Bucket name to list.
|
ListObjectsV2Request.Builder |
continuationToken(String continuationToken)
ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token.
|
ListObjectsV2Request.Builder |
delimiter(String delimiter)
A delimiter is a character you use to group keys.
|
ListObjectsV2Request.Builder |
encodingType(EncodingType encodingType)
Encoding type used by Amazon S3 to encode object keys in the response.
|
ListObjectsV2Request.Builder |
encodingType(String encodingType)
Encoding type used by Amazon S3 to encode object keys in the response.
|
ListObjectsV2Request.Builder |
expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner.
|
ListObjectsV2Request.Builder |
fetchOwner(Boolean fetchOwner)
The owner field is not present in listV2 by default, if you want to return owner field with each key in the
result then set the fetch owner field to true.
|
ListObjectsV2Request.Builder |
maxKeys(Integer maxKeys)
Sets the maximum number of keys returned in the response.
|
ListObjectsV2Request.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
ListObjectsV2Request.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
ListObjectsV2Request.Builder |
prefix(String prefix)
Limits the response to keys that begin with the specified prefix.
|
ListObjectsV2Request.Builder |
requestPayer(RequestPayer requestPayer)
Confirms that the requester knows that she or he will be charged for the list objects request in V2 style.
|
ListObjectsV2Request.Builder |
requestPayer(String requestPayer)
Confirms that the requester knows that she or he will be charged for the list objects request in V2 style.
|
ListObjectsV2Request.Builder |
startAfter(String startAfter)
StartAfter is where you want Amazon S3 to start listing from.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
ListObjectsV2Request.Builder bucket(String bucket)
Bucket name to list.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.
bucket
- Bucket name to list.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.
ListObjectsV2Request.Builder delimiter(String delimiter)
A delimiter is a character you use to group keys.
delimiter
- A delimiter is a character you use to group keys.ListObjectsV2Request.Builder encodingType(String encodingType)
Encoding type used by Amazon S3 to encode object keys in the response.
encodingType
- Encoding type used by Amazon S3 to encode object keys in the response.EncodingType
,
EncodingType
ListObjectsV2Request.Builder encodingType(EncodingType encodingType)
Encoding type used by Amazon S3 to encode object keys in the response.
encodingType
- Encoding type used by Amazon S3 to encode object keys in the response.EncodingType
,
EncodingType
ListObjectsV2Request.Builder maxKeys(Integer maxKeys)
Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
maxKeys
- Sets the maximum number of keys returned in the response. By default the action returns up to 1,000
key names. The response might contain fewer keys but will never contain more.ListObjectsV2Request.Builder prefix(String prefix)
Limits the response to keys that begin with the specified prefix.
prefix
- Limits the response to keys that begin with the specified prefix.ListObjectsV2Request.Builder continuationToken(String continuationToken)
ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.
continuationToken
- ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token.
ContinuationToken is obfuscated and is not a real key.ListObjectsV2Request.Builder fetchOwner(Boolean fetchOwner)
The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true.
fetchOwner
- The owner field is not present in listV2 by default, if you want to return owner field with each key
in the result then set the fetch owner field to true.ListObjectsV2Request.Builder startAfter(String startAfter)
StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.
startAfter
- StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this
specified key. StartAfter can be any key in the bucket.ListObjectsV2Request.Builder requestPayer(String requestPayer)
Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
requestPayer
- Confirms that the requester knows that she or he will be charged for the list objects request in V2
style. Bucket owners need not specify this parameter in their requests.RequestPayer
,
RequestPayer
ListObjectsV2Request.Builder requestPayer(RequestPayer requestPayer)
Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
requestPayer
- Confirms that the requester knows that she or he will be charged for the list objects request in V2
style. Bucket owners need not specify this parameter in their requests.RequestPayer
,
RequestPayer
ListObjectsV2Request.Builder expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will
fail with an HTTP 403 (Access Denied)
error.
expectedBucketOwner
- The account ID of the expected bucket owner. If the bucket is owned by a different account, the
request will fail with an HTTP 403 (Access Denied)
error.ListObjectsV2Request.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
ListObjectsV2Request.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2022. All rights reserved.