com.ibm.cos.v2.services.s3.model

Interface ListObjectsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListObjectsRequest.Builder,ListObjectsRequest>, S3Request.Builder, SdkBuilder<ListObjectsRequest.Builder,ListObjectsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListObjectsRequest

@Mutable
 @NotThreadSafe
public static interface ListObjectsRequest.Builder
extends S3Request.Builder, SdkPojo, CopyableBuilder<ListObjectsRequest.Builder,ListObjectsRequest>

Method Summary

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) Add an optional request override configuration.
ListObjectsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
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.

Methods inherited from interface com.ibm.cos.v2.services.s3.model.S3Request.Builder

build

Methods inherited from interface com.ibm.cos.v2.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface com.ibm.cos.v2.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface com.ibm.cos.v2.utils.builder.CopyableBuilder

copy

Methods inherited from interface com.ibm.cos.v2.utils.builder.SdkBuilder

applyMutation, build

Method Detail

bucket

ListObjectsRequest.Builder bucket(String 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-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-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 for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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.

Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, 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-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-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 for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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.

Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, 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

ListObjectsRequest.Builder delimiter(String 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

ListObjectsRequest.Builder encodingType(String 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, EncodingType

encodingType

ListObjectsRequest.Builder encodingType(EncodingType 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, EncodingType

marker

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.

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

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.

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

ListObjectsRequest.Builder prefix(String 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

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.

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, 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.

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, RequestPayer

expectedBucketOwner

ListObjectsRequest.Builder expectedBucketOwner(String 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 code 403 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

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.

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 interface AwsRequest.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 interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.