@Generated(value="software.amazon.awssdk:codegen") public final class ListMultipartUploadsRequest extends S3Request implements ToCopyableBuilder<ListMultipartUploadsRequest.Builder,ListMultipartUploadsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
ListMultipartUploadsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
bucket()
The name of the bucket to which the multipart upload was initiated.
|
static ListMultipartUploadsRequest.Builder |
builder() |
String |
delimiter()
Character you use to group keys.
|
EncodingType |
encodingType()
Returns the value of the EncodingType property for this object.
|
String |
encodingTypeAsString()
Returns the value of the EncodingType property for this object.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
expectedBucketOwner()
The account ID of the expected bucket owner.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
keyMarker()
Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.
|
Integer |
maxUploads()
Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body.
|
String |
prefix()
Lists in-progress uploads only for those keys that begin with the specified prefix.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListMultipartUploadsRequest.Builder> |
serializableBuilderClass() |
ListMultipartUploadsRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
uploadIdMarker()
Together with key-marker, specifies the multipart upload after which listing should begin.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String bucket()
The name of the bucket to which the multipart upload was initiated.
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 using 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 using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket
ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in
the Amazon S3 User Guide.
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 using 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 using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on
Outposts in the Amazon S3 User Guide.
public final String delimiter()
Character you use to group keys.
All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter
after the prefix are grouped under a single result element, CommonPrefixes
. If you don't specify the
prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under
CommonPrefixes
result element are not returned elsewhere in the response.
All keys that contain the same string between the prefix, if specified, and the first occurrence of the
delimiter after the prefix are grouped under a single result element, CommonPrefixes
. If you
don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that
are grouped under CommonPrefixes
result element are not returned elsewhere in the response.
public final EncodingType encodingType()
If the service returns an enum value that is not available in the current SDK version, encodingType
will
return EncodingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
encodingTypeAsString()
.
EncodingType
public final String encodingTypeAsString()
If the service returns an enum value that is not available in the current SDK version, encodingType
will
return EncodingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
encodingTypeAsString()
.
EncodingType
public final String keyMarker()
Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.
If upload-id-marker
is not specified, only the keys lexicographically greater than the specified
key-marker
will be included in the list.
If upload-id-marker
is specified, any multipart uploads for a key equal to the
key-marker
might also be included, provided those multipart uploads have upload IDs
lexicographically greater than the specified upload-id-marker
.
If upload-id-marker
is not specified, only the keys lexicographically greater than the
specified key-marker
will be included in the list.
If upload-id-marker
is specified, any multipart uploads for a key equal to the
key-marker
might also be included, provided those multipart uploads have upload IDs
lexicographically greater than the specified upload-id-marker
.
public final Integer maxUploads()
Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.
public final String prefix()
Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)
public final 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
.
upload-id-marker
.public final 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).
403 Forbidden
(access denied).public ListMultipartUploadsRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<ListMultipartUploadsRequest.Builder,ListMultipartUploadsRequest>
toBuilder
in class S3Request
public static ListMultipartUploadsRequest.Builder builder()
public static Class<? extends ListMultipartUploadsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2023. All rights reserved.