public static interface ListObjectsRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<ListObjectsRequest.Builder,ListObjectsRequest>
Modifier and Type | Method and Description |
---|---|
ListObjectsRequest.Builder |
bucket(String bucket)
The name of the bucket containing the objects.
|
ListObjectsRequest.Builder |
delimiter(String delimiter)
A delimiter is a character that you use to group keys.
|
ListObjectsRequest.Builder |
encodingType(EncodingType encodingType)
Sets the value of the EncodingType property for this object.
|
ListObjectsRequest.Builder |
encodingType(String encodingType)
Sets the value of the EncodingType property for this object.
|
ListObjectsRequest.Builder |
expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner.
|
ListObjectsRequest.Builder |
marker(String marker)
Marker is where you want Amazon S3 to start listing from.
|
ListObjectsRequest.Builder |
maxKeys(Integer maxKeys)
Sets the maximum number of keys returned in the response.
|
ListObjectsRequest.Builder |
optionalObjectAttributes(Collection<OptionalObjectAttributes> optionalObjectAttributes)
Specifies the optional fields that you want returned in the response.
|
ListObjectsRequest.Builder |
optionalObjectAttributes(OptionalObjectAttributes... optionalObjectAttributes)
Specifies the optional fields that you want returned in the response.
|
ListObjectsRequest.Builder |
optionalObjectAttributesWithStrings(Collection<String> optionalObjectAttributes)
Specifies the optional fields that you want returned in the response.
|
ListObjectsRequest.Builder |
optionalObjectAttributesWithStrings(String... optionalObjectAttributes)
Specifies the optional fields that you want returned in the response.
|
ListObjectsRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
ListObjectsRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
ListObjectsRequest.Builder |
prefix(String prefix)
Limits the response to keys that begin with the specified prefix.
|
ListObjectsRequest.Builder |
requestPayer(RequestPayer requestPayer)
Confirms that the requester knows that she or he will be charged for the list objects request.
|
ListObjectsRequest.Builder |
requestPayer(String requestPayer)
Confirms that the requester knows that she or he will be charged for the list objects request.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
ListObjectsRequest.Builder bucket(String bucket)
The name of the bucket containing the objects.
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 you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in
the Amazon S3 User Guide.
bucket
- The name of the bucket containing the objects.
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 you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs,
see What is S3 on
Outposts? in the Amazon S3 User Guide.
ListObjectsRequest.Builder delimiter(String delimiter)
A delimiter is a character that you use to group keys.
delimiter
- A delimiter is a character that you use to group keys.ListObjectsRequest.Builder encodingType(String encodingType)
encodingType
- The new value for the EncodingType property for this object.EncodingType
,
EncodingType
ListObjectsRequest.Builder encodingType(EncodingType encodingType)
encodingType
- The new value for the EncodingType property for this object.EncodingType
,
EncodingType
ListObjectsRequest.Builder marker(String marker)
Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.
marker
- Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this
specified key. Marker can be any key in the bucket.ListObjectsRequest.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.ListObjectsRequest.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.ListObjectsRequest.Builder requestPayer(String requestPayer)
Confirms that the requester knows that she or he will be charged for the list objects request. 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. Bucket
owners need not specify this parameter in their requests.RequestPayer
,
RequestPayer
ListObjectsRequest.Builder requestPayer(RequestPayer requestPayer)
Confirms that the requester knows that she or he will be charged for the list objects request. 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. Bucket
owners need not specify this parameter in their requests.RequestPayer
,
RequestPayer
ListObjectsRequest.Builder expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails
with the HTTP status code 403 Forbidden
(access denied).
expectedBucketOwner
- The account ID of the expected bucket owner. If the bucket is owned by a different account, the
request fails with the HTTP status code 403 Forbidden
(access denied).ListObjectsRequest.Builder optionalObjectAttributesWithStrings(Collection<String> optionalObjectAttributes)
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
optionalObjectAttributes
- Specifies the optional fields that you want returned in the response. Fields that you do not specify
are not returned.ListObjectsRequest.Builder optionalObjectAttributesWithStrings(String... optionalObjectAttributes)
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
optionalObjectAttributes
- Specifies the optional fields that you want returned in the response. Fields that you do not specify
are not returned.ListObjectsRequest.Builder optionalObjectAttributes(Collection<OptionalObjectAttributes> optionalObjectAttributes)
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
optionalObjectAttributes
- Specifies the optional fields that you want returned in the response. Fields that you do not specify
are not returned.ListObjectsRequest.Builder optionalObjectAttributes(OptionalObjectAttributes... optionalObjectAttributes)
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
optionalObjectAttributes
- Specifies the optional fields that you want returned in the response. Fields that you do not specify
are not returned.ListObjectsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
ListObjectsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2023. All rights reserved.