software.amazon.awssdk.services.s3.model

Class ListMultipartUploadsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.s3.model.S3Response

software.amazon.awssdk.services.s3.model.ListMultipartUploadsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListMultipartUploadsResponse.Builder,ListMultipartUploadsResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListMultipartUploadsResponse
extends S3Response
implements ToCopyableBuilder<ListMultipartUploadsResponse.Builder,ListMultipartUploadsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListMultipartUploadsResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	bucket() Name of the bucket to which the multipart upload was initiated.
static ListMultipartUploadsResponse.Builder	builder()
List<CommonPrefix>	commonPrefixes()
String	delimiter()
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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
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()

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 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 String bucket()

Name of the bucket to which the multipart upload was initiated.

Returns:

Name of the bucket to which the multipart upload was initiated.

keyMarker

public String keyMarker()

The key at or after which the listing began.

Returns:

The key at or after which the listing began.

uploadIdMarker

public String uploadIdMarker()

Upload ID after which listing began.

Returns:

Upload ID after which listing began.

nextKeyMarker

public 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.

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

public 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.

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.

delimiter

public String delimiter()

Returns:

nextUploadIdMarker

public 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.

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.

maxUploads

public Integer 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

public 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.

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.

uploads

public List<MultipartUpload> uploads()

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

commonPrefixes

public List<CommonPrefix> commonPrefixes()

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

encodingType

public EncodingType encodingType()

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

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().

Returns:

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

See Also:

EncodingType

encodingTypeAsString

public String encodingTypeAsString()

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

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().

Returns:

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

See Also:

EncodingType

toBuilder

public ListMultipartUploadsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListMultipartUploadsResponse.Builder,ListMultipartUploadsResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static ListMultipartUploadsResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ListMultipartUploadsResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public 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.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo