Class ListMultipartUploadsResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListMultipartUploadsResponse.Builder,
ListMultipartUploadsResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
bucket()
The name of the bucket to which the multipart upload was initiated.builder()
final List
<CommonPrefix> If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in aCommonPrefixes
element.final String
Contains the delimiter you specified in the request.final EncodingType
Encoding type used by Amazon S3 to encode object keys in the response.final String
Encoding type used by Amazon S3 to encode object keys in the response.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the CommonPrefixes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Uploads property.final Boolean
Indicates whether the returned list of multipart uploads is truncated.final String
The key at or after which the listing began.final Integer
Maximum number of multipart uploads that could have been included in the response.final String
When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.final String
When a list is truncated, this element specifies the value that should be used for theupload-id-marker
request parameter in a subsequent request.final String
prefix()
When a prefix is provided in the request, this field contains the specified prefix.final RequestCharged
Returns the value of the RequestCharged property for this object.final String
Returns the value of the RequestCharged property for this object.static Class
<? extends ListMultipartUploadsResponse.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
Together with key-marker, specifies the multipart upload after which listing should begin.final List
<MultipartUpload> uploads()
Container for elements related to a particular multipart upload.Methods inherited from class software.amazon.awssdk.services.s3.model.S3Response
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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:
- 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.
-
keyMarker
The key at or after which the listing began.
- Returns:
- The key at or after which the listing began.
-
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:
- 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.
-
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:
- When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.
-
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:
- 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.
-
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:
- 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.
-
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:
- 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.
-
maxUploads
Maximum number of multipart uploads that could have been included in the response.
- Returns:
- Maximum number of multipart uploads that could have been included in the response.
-
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:
- 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.
-
hasUploads
public final boolean hasUploads()For responses, this returns true if the service returned a value for the Uploads property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
uploads
Container for elements related to a particular multipart upload. A response can contain zero or more
Upload
elements.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasUploads()
method.- Returns:
- Container for elements related to a particular multipart upload. A response can contain zero or more
Upload
elements.
-
hasCommonPrefixes
public final boolean hasCommonPrefixes()For responses, this returns true if the service returned a value for the CommonPrefixes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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 thePrefix
child element.Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCommonPrefixes()
method.- Returns:
- 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 thePrefix
child element.Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported.
-
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
.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:
- 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
. - See Also:
-
encodingTypeAsString
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
.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:
- 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
. - See Also:
-
requestCharged
Returns the value of the RequestCharged property for this object.If the service returns an enum value that is not available in the current SDK version,
requestCharged
will returnRequestCharged.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestChargedAsString()
.- Returns:
- The value of the RequestCharged property for this object.
- See Also:
-
requestChargedAsString
Returns the value of the RequestCharged property for this object.If the service returns an enum value that is not available in the current SDK version,
requestCharged
will returnRequestCharged.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestChargedAsString()
.- Returns:
- The value of the RequestCharged property for this object.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListMultipartUploadsResponse.Builder,
ListMultipartUploadsResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-