Interface ListObjectVersionsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListObjectVersionsRequest.Builder,ListObjectVersionsRequest>
,S3Request.Builder
,SdkBuilder<ListObjectVersionsRequest.Builder,ListObjectVersionsRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- ListObjectVersionsRequest
public static interface ListObjectVersionsRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<ListObjectVersionsRequest.Builder,ListObjectVersionsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ListObjectVersionsRequest.Builder
bucket(String bucket)
The bucket name that contains the objects.ListObjectVersionsRequest.Builder
delimiter(String delimiter)
A delimiter is a character that you specify to group keys.ListObjectVersionsRequest.Builder
encodingType(String encodingType)
Sets the value of the EncodingType property for this object.ListObjectVersionsRequest.Builder
encodingType(EncodingType encodingType)
Sets the value of the EncodingType property for this object.ListObjectVersionsRequest.Builder
expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner.ListObjectVersionsRequest.Builder
keyMarker(String keyMarker)
Specifies the key to start with when listing objects in a bucket.ListObjectVersionsRequest.Builder
maxKeys(Integer maxKeys)
Sets the maximum number of keys returned in the response.ListObjectVersionsRequest.Builder
optionalObjectAttributes(Collection<OptionalObjectAttributes> optionalObjectAttributes)
Specifies the optional fields that you want returned in the response.ListObjectVersionsRequest.Builder
optionalObjectAttributes(OptionalObjectAttributes... optionalObjectAttributes)
Specifies the optional fields that you want returned in the response.ListObjectVersionsRequest.Builder
optionalObjectAttributesWithStrings(String... optionalObjectAttributes)
Specifies the optional fields that you want returned in the response.ListObjectVersionsRequest.Builder
optionalObjectAttributesWithStrings(Collection<String> optionalObjectAttributes)
Specifies the optional fields that you want returned in the response.ListObjectVersionsRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListObjectVersionsRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListObjectVersionsRequest.Builder
prefix(String prefix)
Use this parameter to select only those keys that begin with the specified prefix.ListObjectVersionsRequest.Builder
requestPayer(String requestPayer)
Sets the value of the RequestPayer property for this object.ListObjectVersionsRequest.Builder
requestPayer(RequestPayer requestPayer)
Sets the value of the RequestPayer property for this object.ListObjectVersionsRequest.Builder
versionIdMarker(String versionIdMarker)
Specifies the object version you want to start listing from.-
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 Detail
-
bucket
ListObjectVersionsRequest.Builder bucket(String bucket)
The bucket name that contains the objects.
- Parameters:
bucket
- The bucket name that contains the objects.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
delimiter
ListObjectVersionsRequest.Builder delimiter(String delimiter)
A delimiter is a character that you specify to group keys. All keys that contain the same string between the
prefix
and the first occurrence of the delimiter are grouped under a single result element inCommonPrefixes
. These groups are counted as one result against themax-keys
limitation. These keys are not returned elsewhere in the response.- Parameters:
delimiter
- A delimiter is a character that you specify to group keys. All keys that contain the same string between theprefix
and the first occurrence of the delimiter are grouped under a single result element inCommonPrefixes
. These groups are counted as one result against themax-keys
limitation. These keys are not returned elsewhere in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encodingType
ListObjectVersionsRequest.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
ListObjectVersionsRequest.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
-
keyMarker
ListObjectVersionsRequest.Builder keyMarker(String keyMarker)
Specifies the key to start with when listing objects in a bucket.
- Parameters:
keyMarker
- Specifies the key to start with when listing objects in a bucket.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxKeys
ListObjectVersionsRequest.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. If additional keys satisfy the search criteria, but were not returned because
max-keys
was exceeded, the response contains<isTruncated>true</isTruncated>
. To return the additional keys, seekey-marker
andversion-id-marker
.- 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. If additional keys satisfy the search criteria, but were not returned becausemax-keys
was exceeded, the response contains<isTruncated>true</isTruncated>
. To return the additional keys, seekey-marker
andversion-id-marker
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
prefix
ListObjectVersionsRequest.Builder prefix(String prefix)
Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using
prefix
to make groups in the same way that you'd use a folder in a file system.) You can useprefix
withdelimiter
to roll up numerous objects into a single result underCommonPrefixes
.- Parameters:
prefix
- Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of usingprefix
to make groups in the same way that you'd use a folder in a file system.) You can useprefix
withdelimiter
to roll up numerous objects into a single result underCommonPrefixes
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
versionIdMarker
ListObjectVersionsRequest.Builder versionIdMarker(String versionIdMarker)
Specifies the object version you want to start listing from.
- Parameters:
versionIdMarker
- Specifies the object version you want to start listing from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
expectedBucketOwner
ListObjectVersionsRequest.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 code403 Forbidden
(access denied).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requestPayer
ListObjectVersionsRequest.Builder requestPayer(String requestPayer)
Sets the value of the RequestPayer property for this object.- Parameters:
requestPayer
- The new value for the RequestPayer property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RequestPayer
,RequestPayer
-
requestPayer
ListObjectVersionsRequest.Builder requestPayer(RequestPayer requestPayer)
Sets the value of the RequestPayer property for this object.- Parameters:
requestPayer
- The new value for the RequestPayer property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RequestPayer
,RequestPayer
-
optionalObjectAttributesWithStrings
ListObjectVersionsRequest.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
ListObjectVersionsRequest.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
ListObjectVersionsRequest.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
ListObjectVersionsRequest.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
ListObjectVersionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
ListObjectVersionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-