Class ListMultipartUploadsRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.s3.model.S3Request
-
- software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListMultipartUploadsRequest.Builder,ListMultipartUploadsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListMultipartUploadsRequest extends S3Request implements ToCopyableBuilder<ListMultipartUploadsRequest.Builder,ListMultipartUploadsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ListMultipartUploadsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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 withupload-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.RequestPayer
requestPayer()
Returns the value of the RequestPayer property for this object.String
requestPayerAsString()
Returns the value of the RequestPayer property for this object.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.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
bucket
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 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:
- 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 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.
-
delimiter
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 underCommonPrefixes
result element are not returned elsewhere in the response.- Returns:
- 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 underCommonPrefixes
result element are not returned elsewhere in the response.
-
encodingType
public final EncodingType encodingType()
Returns the value of the EncodingType property for this object.If the service returns an enum value that is not available in the current SDK version,
encodingType
will returnEncodingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencodingTypeAsString()
.- Returns:
- The value of the EncodingType property for this object.
- See Also:
EncodingType
-
encodingTypeAsString
public final String encodingTypeAsString()
Returns the value of the EncodingType property for this object.If the service returns an enum value that is not available in the current SDK version,
encodingType
will returnEncodingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencodingTypeAsString()
.- Returns:
- The value of the EncodingType property for this object.
- See Also:
EncodingType
-
keyMarker
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 specifiedkey-marker
will be included in the list.If
upload-id-marker
is specified, any multipart uploads for a key equal to thekey-marker
might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specifiedupload-id-marker
.- Returns:
- 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 specifiedkey-marker
will be included in the list.If
upload-id-marker
is specified, any multipart uploads for a key equal to thekey-marker
might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specifiedupload-id-marker
.
-
maxUploads
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.
- Returns:
- 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.
-
prefix
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 that you'd use a folder in a file system.)- Returns:
- 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 that you'd use a folder in a file system.)
-
uploadIdMarker
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
.- Returns:
- 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
.
-
expectedBucketOwner
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).- Returns:
- 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).
-
requestPayer
public final RequestPayer requestPayer()
Returns the value of the RequestPayer property for this object.If the service returns an enum value that is not available in the current SDK version,
requestPayer
will returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- The value of the RequestPayer property for this object.
- See Also:
RequestPayer
-
requestPayerAsString
public final String requestPayerAsString()
Returns the value of the RequestPayer property for this object.If the service returns an enum value that is not available in the current SDK version,
requestPayer
will returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- The value of the RequestPayer property for this object.
- See Also:
RequestPayer
-
toBuilder
public ListMultipartUploadsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListMultipartUploadsRequest.Builder,ListMultipartUploadsRequest>
- Specified by:
toBuilder
in classS3Request
-
builder
public static ListMultipartUploadsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListMultipartUploadsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-