@Generated(value="software.amazon.awssdk:codegen") public final class ListPartsResponse extends S3Response implements ToCopyableBuilder<ListPartsResponse.Builder,ListPartsResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
ListPartsResponse.Builder |
Modifier and Type | Method and Description |
---|---|
Instant |
abortDate()
If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix
in the lifecycle rule matches the object name in the request, then the response includes this header indicating
when the initiated multipart upload will become eligible for abort operation.
|
String |
abortRuleId()
This header is returned along with the
x-amz-abort-date header. |
String |
bucket()
The name of the bucket to which the multipart upload was initiated.
|
static ListPartsResponse.Builder |
builder() |
ChecksumAlgorithm |
checksumAlgorithm()
The algorithm that was used to create a checksum of the object.
|
String |
checksumAlgorithmAsString()
The algorithm that was used to create a checksum of the object.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasParts()
For responses, this returns true if the service returned a value for the Parts property.
|
Initiator |
initiator()
Container element that identifies who initiated the multipart upload.
|
Boolean |
isTruncated()
Indicates whether the returned list of parts is truncated.
|
String |
key()
Object key for which the multipart upload was initiated.
|
Integer |
maxParts()
Maximum number of parts that were allowed in the response.
|
Integer |
nextPartNumberMarker()
When a list is truncated, this element specifies the last part in the list, as well as the value to use for the
part-number-marker request parameter in a subsequent request.
|
Owner |
owner()
Container element that identifies the object owner, after the object is created.
|
Integer |
partNumberMarker()
When a list is truncated, this element specifies the last part in the list, as well as the value to use for the
part-number-marker request parameter in a subsequent request.
|
List<Part> |
parts()
Container for elements related to a particular part.
|
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 ListPartsResponse.Builder> |
serializableBuilderClass() |
StorageClass |
storageClass()
Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.
|
String |
storageClassAsString()
Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.
|
ListPartsResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
uploadId()
Upload ID identifying the multipart upload whose parts are being listed.
|
responseMetadata
sdkHttpResponse
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final Instant abortDate()
If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
The response will also include the x-amz-abort-rule-id
header that will provide the ID of the
lifecycle configuration rule that defines this action.
The response will also include the x-amz-abort-rule-id
header that will provide the ID of
the lifecycle configuration rule that defines this action.
public final String abortRuleId()
This header is returned along with the x-amz-abort-date
header. It identifies applicable lifecycle
configuration rule that defines the action to abort incomplete multipart uploads.
x-amz-abort-date
header. It identifies applicable
lifecycle configuration rule that defines the action to abort incomplete multipart uploads.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 key()
Object key for which the multipart upload was initiated.
public final String uploadId()
Upload ID identifying the multipart upload whose parts are being listed.
public final Integer partNumberMarker()
When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.
public final Integer nextPartNumberMarker()
When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.
public final Integer maxParts()
Maximum number of parts that were allowed in the response.
public final Boolean isTruncated()
Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.
public final boolean hasParts()
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<Part> parts()
Container for elements related to a particular part. A response can contain zero or more Part
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 hasParts()
method.
Part
elements.public final Initiator initiator()
Container element that identifies who initiated the multipart upload. If the initiator is an Amazon Web Services
account, this element provides the same information as the Owner
element. If the initiator is an IAM
User, this element provides the user ARN and display name.
Owner
element. If the
initiator is an IAM User, this element provides the user ARN and display name.public final Owner owner()
Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.
public final StorageClass storageClass()
Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.
If the service returns an enum value that is not available in the current SDK version, storageClass
will
return StorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
storageClassAsString()
.
StorageClass
public final String storageClassAsString()
Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.
If the service returns an enum value that is not available in the current SDK version, storageClass
will
return StorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
storageClassAsString()
.
StorageClass
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 final ChecksumAlgorithm checksumAlgorithm()
The algorithm that was used to create a checksum of the object.
If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm
will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from checksumAlgorithmAsString()
.
ChecksumAlgorithm
public final String checksumAlgorithmAsString()
The algorithm that was used to create a checksum of the object.
If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm
will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from checksumAlgorithmAsString()
.
ChecksumAlgorithm
public ListPartsResponse.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<ListPartsResponse.Builder,ListPartsResponse>
toBuilder
in class AwsResponse
public static ListPartsResponse.Builder builder()
public static Class<? extends ListPartsResponse.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.