@Generated(value="software.amazon.awssdk:codegen") public final class ListMultipartUploadsResponse extends S3Response implements ToCopyableBuilder<ListMultipartUploadsResponse.Builder,ListMultipartUploadsResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
ListMultipartUploadsResponse.Builder |
Modifier and Type | Method and Description |
---|---|
String |
bucket()
The name of the bucket to which the multipart upload was initiated.
|
static ListMultipartUploadsResponse.Builder |
builder() |
List<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. |
String |
delimiter()
Contains the delimiter you specified in the request.
|
EncodingType |
encodingType()
Encoding type used by Amazon S3 to encode object keys in the response.
|
String |
encodingTypeAsString()
Encoding type used by Amazon S3 to encode object keys in the response.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasCommonPrefixes()
For responses, this returns true if the service returned a value for the CommonPrefixes property.
|
int |
hashCode() |
boolean |
hasUploads()
For responses, this returns true if the service returned a value for the Uploads property.
|
Boolean |
isTruncated()
Indicates whether the returned list of multipart uploads is truncated.
|
String |
keyMarker()
The key at or after which the listing began.
|
Integer |
maxUploads()
Maximum number of multipart uploads that could have been included in the response.
|
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.
|
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. |
String |
prefix()
When a prefix is provided in the request, this field contains the specified prefix.
|
RequestCharged |
requestCharged()
Returns the value of the RequestCharged property for this object.
|
String |
requestChargedAsString()
Returns the value of the RequestCharged property for this object.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListMultipartUploadsResponse.Builder> |
serializableBuilderClass() |
ListMultipartUploadsResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
uploadIdMarker()
Upload ID after which listing began.
|
List<MultipartUpload> |
uploads()
Container for elements related to a particular multipart upload.
|
responseMetadata
sdkHttpResponse
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. Does not return the access point ARN or access point alias if used.
public final String keyMarker()
The key at or after which the listing began.
public final String uploadIdMarker()
Upload ID after which listing began.
public final 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.
public final 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.
public final 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.
public final 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.
upload-id-marker
request parameter in a subsequent request.public final Integer maxUploads()
Maximum number of multipart uploads that could have been included in the response.
public final 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.
public final boolean hasUploads()
isEmpty()
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.public final List<MultipartUpload> 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.
Upload
elements.public final boolean hasCommonPrefixes()
isEmpty()
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.public final List<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.
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.
CommonPrefixes
element. The distinct key prefixes are returned in the
Prefix
child element.public final EncodingType encodingType()
Encoding type used by Amazon S3 to encode object keys in the response.
If you specify 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
return EncodingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
encodingTypeAsString()
.
If you specify 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
.
EncodingType
public final String encodingTypeAsString()
Encoding type used by Amazon S3 to encode object keys in the response.
If you specify 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
return EncodingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
encodingTypeAsString()
.
If you specify 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
.
EncodingType
public final RequestCharged requestCharged()
If the service returns an enum value that is not available in the current SDK version, requestCharged
will return RequestCharged.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from requestChargedAsString()
.
RequestCharged
public final String requestChargedAsString()
If the service returns an enum value that is not available in the current SDK version, requestCharged
will return RequestCharged.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from requestChargedAsString()
.
RequestCharged
public ListMultipartUploadsResponse.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<ListMultipartUploadsResponse.Builder,ListMultipartUploadsResponse>
toBuilder
in class AwsResponse
public static ListMultipartUploadsResponse.Builder builder()
public static Class<? extends ListMultipartUploadsResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
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 SdkResponse
Copyright © 2023. All rights reserved.