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

Interface ListMultipartUploadsResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<ListMultipartUploadsResponse.Builder,ListMultipartUploadsResponse>, S3Response.Builder, SdkBuilder<ListMultipartUploadsResponse.Builder,ListMultipartUploadsResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

ListMultipartUploadsResponse

@Mutable
 @NotThreadSafe
public static interface ListMultipartUploadsResponse.Builder
extends S3Response.Builder, SdkPojo, CopyableBuilder<ListMultipartUploadsResponse.Builder,ListMultipartUploadsResponse>

Method Summary

Modifier and Type	Method and Description
ListMultipartUploadsResponse.Builder	bucket(String bucket) The name of the bucket to which the multipart upload was initiated.
ListMultipartUploadsResponse.Builder	commonPrefixes(Collection<CommonPrefix> commonPrefixes) If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element.
ListMultipartUploadsResponse.Builder	commonPrefixes(CommonPrefix... commonPrefixes) If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element.
ListMultipartUploadsResponse.Builder	commonPrefixes(Consumer<CommonPrefix.Builder>... commonPrefixes) If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element.
ListMultipartUploadsResponse.Builder	delimiter(String delimiter) Contains the delimiter you specified in the request.
ListMultipartUploadsResponse.Builder	encodingType(EncodingType encodingType) Encoding type used by Amazon S3 to encode object keys in the response.
ListMultipartUploadsResponse.Builder	encodingType(String encodingType) Encoding type used by Amazon S3 to encode object keys in the response.
ListMultipartUploadsResponse.Builder	isTruncated(Boolean isTruncated) Indicates whether the returned list of multipart uploads is truncated.
ListMultipartUploadsResponse.Builder	keyMarker(String keyMarker) The key at or after which the listing began.
ListMultipartUploadsResponse.Builder	maxUploads(Integer maxUploads) Maximum number of multipart uploads that could have been included in the response.
ListMultipartUploadsResponse.Builder	nextKeyMarker(String nextKeyMarker) When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.
ListMultipartUploadsResponse.Builder	nextUploadIdMarker(String nextUploadIdMarker) When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.
ListMultipartUploadsResponse.Builder	prefix(String prefix) When a prefix is provided in the request, this field contains the specified prefix.
ListMultipartUploadsResponse.Builder	requestCharged(RequestCharged requestCharged) Sets the value of the RequestCharged property for this object.
ListMultipartUploadsResponse.Builder	requestCharged(String requestCharged) Sets the value of the RequestCharged property for this object.
ListMultipartUploadsResponse.Builder	uploadIdMarker(String uploadIdMarker) Together with key-marker, specifies the multipart upload after which listing should begin.
ListMultipartUploadsResponse.Builder	uploads(Collection<MultipartUpload> uploads) Container for elements related to a particular multipart upload.
ListMultipartUploadsResponse.Builder	uploads(Consumer<MultipartUpload.Builder>... uploads) Container for elements related to a particular multipart upload.
ListMultipartUploadsResponse.Builder	uploads(MultipartUpload... uploads) Container for elements related to a particular multipart upload.

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

build, responseMetadata, responseMetadata

Methods inherited from interface com.ibm.cos.v2.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

ListMultipartUploadsResponse.Builder bucket(String bucket)

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

Parameters:

bucket - The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

Returns:

Returns a reference to this object so that method calls can be chained together.

keyMarker

ListMultipartUploadsResponse.Builder keyMarker(String keyMarker)

The key at or after which the listing began.

Parameters:

keyMarker - The key at or after which the listing began.

Returns:

Returns a reference to this object so that method calls can be chained together.

uploadIdMarker

ListMultipartUploadsResponse.Builder uploadIdMarker(String uploadIdMarker)

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

This functionality is not supported for directory buckets.

Parameters:

uploadIdMarker - Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

This functionality is not supported for directory buckets.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextKeyMarker

ListMultipartUploadsResponse.Builder nextKeyMarker(String nextKeyMarker)

When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

Parameters:

nextKeyMarker - When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

Returns:

Returns a reference to this object so that method calls can be chained together.

prefix

ListMultipartUploadsResponse.Builder prefix(String prefix)

When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

Parameters:

prefix - When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

Directory buckets - For directory buckets, only prefixes that end in a delimiter ( /) are supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

delimiter

ListMultipartUploadsResponse.Builder delimiter(String delimiter)

Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.

Directory buckets - For directory buckets, / is the only supported delimiter.

Parameters:

delimiter - Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.

Directory buckets - For directory buckets, / is the only supported delimiter.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextUploadIdMarker

ListMultipartUploadsResponse.Builder nextUploadIdMarker(String nextUploadIdMarker)

When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.

This functionality is not supported for directory buckets.

Parameters:

nextUploadIdMarker - When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.

This functionality is not supported for directory buckets.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxUploads

ListMultipartUploadsResponse.Builder maxUploads(Integer maxUploads)

Maximum number of multipart uploads that could have been included in the response.

Parameters:

maxUploads - Maximum number of multipart uploads that could have been included in the response.

Returns:

Returns a reference to this object so that method calls can be chained together.

isTruncated

ListMultipartUploadsResponse.Builder isTruncated(Boolean isTruncated)

Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.

Parameters:

isTruncated - Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.

Returns:

Returns a reference to this object so that method calls can be chained together.

uploads

ListMultipartUploadsResponse.Builder uploads(Collection<MultipartUpload> uploads)

Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

Parameters:

uploads - Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

Returns:

Returns a reference to this object so that method calls can be chained together.

uploads

ListMultipartUploadsResponse.Builder uploads(MultipartUpload... uploads)

Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

Parameters:

uploads - Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

Returns:

Returns a reference to this object so that method calls can be chained together.

uploads

ListMultipartUploadsResponse.Builder uploads(Consumer<MultipartUpload.Builder>... uploads)

Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

This is a convenience method that creates an instance of the MultipartUpload.Builder avoiding the need to create one manually via MultipartUpload.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #uploads(List).

Parameters:

uploads - a consumer that will call methods on MultipartUpload.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#uploads(java.util.Collection)

commonPrefixes

ListMultipartUploadsResponse.Builder commonPrefixes(Collection<CommonPrefix> commonPrefixes)

If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

Parameters:

commonPrefixes - If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

Directory buckets - For directory buckets, only prefixes that end in a delimiter ( /) are supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

commonPrefixes

ListMultipartUploadsResponse.Builder commonPrefixes(CommonPrefix... commonPrefixes)

If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

Parameters:

commonPrefixes - If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

Directory buckets - For directory buckets, only prefixes that end in a delimiter ( /) are supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

commonPrefixes

ListMultipartUploadsResponse.Builder commonPrefixes(Consumer<CommonPrefix.Builder>... commonPrefixes)

If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

This is a convenience method that creates an instance of the CommonPrefix.Builder avoiding the need to create one manually via CommonPrefix.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #commonPrefixes(List).

Parameters:

commonPrefixes - a consumer that will call methods on CommonPrefix.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#commonPrefixes(java.util.Collection)

encodingType

ListMultipartUploadsResponse.Builder encodingType(String encodingType)

Encoding type used by Amazon S3 to encode object keys in the response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

Parameters:

encodingType - Encoding type used by Amazon S3 to encode object keys in the response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncodingType, EncodingType

encodingType

ListMultipartUploadsResponse.Builder encodingType(EncodingType encodingType)

Encoding type used by Amazon S3 to encode object keys in the response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

Parameters:

encodingType - Encoding type used by Amazon S3 to encode object keys in the response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncodingType, EncodingType

requestCharged

ListMultipartUploadsResponse.Builder requestCharged(String requestCharged)

Sets the value of the RequestCharged property for this object.

Parameters:

requestCharged - The new value for the RequestCharged property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RequestCharged, RequestCharged

requestCharged

ListMultipartUploadsResponse.Builder requestCharged(RequestCharged requestCharged)

Sets the value of the RequestCharged property for this object.

Parameters:

requestCharged - The new value for the RequestCharged property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RequestCharged, RequestCharged