Interface ListObjectsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListObjectsRequest.Builder,
,ListObjectsRequest> S3Request.Builder
,SdkBuilder<ListObjectsRequest.Builder,
,ListObjectsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListObjectsRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe name of the bucket containing the objects.A delimiter is a character that you use to group keys.encodingType
(String encodingType) Sets the value of the EncodingType property for this object.encodingType
(EncodingType encodingType) Sets the value of the EncodingType property for this object.expectedBucketOwner
(String expectedBucketOwner) The account ID of the expected bucket owner.Marker is where you want Amazon S3 to start listing from.Sets the maximum number of keys returned in the response.optionalObjectAttributes
(Collection<OptionalObjectAttributes> optionalObjectAttributes) Specifies the optional fields that you want returned in the response.optionalObjectAttributes
(OptionalObjectAttributes... optionalObjectAttributes) Specifies the optional fields that you want returned in the response.optionalObjectAttributesWithStrings
(String... optionalObjectAttributes) Specifies the optional fields that you want returned in the response.optionalObjectAttributesWithStrings
(Collection<String> optionalObjectAttributes) Specifies the optional fields that you want returned in the response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Limits the response to keys that begin with the specified prefix.requestPayer
(String requestPayer) Confirms that the requester knows that she or he will be charged for the list objects request.requestPayer
(RequestPayer requestPayer) Confirms that the requester knows that she or he will be charged for the list objects request.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.s3.model.S3Request.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
-
bucket
The name of the bucket containing the objects.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the formatbucket_base_name--az-id--x-s3
(for example,DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - 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.- Parameters:
bucket
- The name of the bucket containing the objects.Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the formatbucket_base_name--az-id--x-s3
(for example,DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
delimiter
A delimiter is a character that you use to group keys.
- Parameters:
delimiter
- A delimiter is a character that you use to group keys.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encodingType
Sets the value of the EncodingType property for this object.- Parameters:
encodingType
- The new value for the EncodingType property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
encodingType
Sets the value of the EncodingType property for this object.- Parameters:
encodingType
- The new value for the EncodingType property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
prefix
Limits the response to keys that begin with the specified prefix.
- Parameters:
prefix
- Limits the response to keys that begin with the specified prefix.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
expectedBucketOwner
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code
403 Forbidden
(access denied).- Parameters:
expectedBucketOwner
- The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code403 Forbidden
(access denied).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
optionalObjectAttributesWithStrings
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.
- Parameters:
optionalObjectAttributes
- Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
optionalObjectAttributesWithStrings
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
- Parameters:
optionalObjectAttributes
- Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
optionalObjectAttributes
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.
- Parameters:
optionalObjectAttributes
- Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
optionalObjectAttributes
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.
- Parameters:
optionalObjectAttributes
- Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListObjectsRequest.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
ListObjectsRequest.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.
-