Package software.amazon.awssdk.services.s3.model

Class ListPartsResponse

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.ListPartsResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListPartsResponse.Builder,ListPartsResponse>
@Generated("software.amazon.awssdk:codegen") public final class ListPartsResponse extends S3Response implements ToCopyableBuilder<ListPartsResponse.Builder,ListPartsResponse>

  • Method Details

    • abortDate

      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.

      This functionality is not supported for directory buckets.

      Returns:
      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.

      This functionality is not supported for directory buckets.

    • abortRuleId

      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.

      This functionality is not supported for directory buckets.

      Returns:
      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.

      This functionality is not supported for directory buckets.

    • bucket

      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.

      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.

    • key

      public final String key()

      Object key for which the multipart upload was initiated.

      Returns:
      Object key for which the multipart upload was initiated.

    • uploadId

      public final String uploadId()

      Upload ID identifying the multipart upload whose parts are being listed.

      Returns:
      Upload ID identifying the multipart upload whose parts are being listed.

    • partNumberMarker

      public final Integer partNumberMarker()

      Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

      Returns:
      Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

    • nextPartNumberMarker

      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.

      Returns:
      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.

    • maxParts

      public final Integer maxParts()

      Maximum number of parts that were allowed in the response.

      Returns:
      Maximum number of parts that were allowed in the response.

    • isTruncated

      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.

      Returns:
      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.

    • hasParts

      public final boolean hasParts()
      For responses, this returns true if the service returned a value for the Parts property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • parts

      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.

      Returns:
      Container for elements related to a particular part. A response can contain zero or more Part elements.

    • initiator

      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.

      Returns:
      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

      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.

      Directory buckets - The bucket owner is returned as the object owner for all the parts.

      Returns:
      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.

      Directory buckets - The bucket owner is returned as the object owner for all the parts.

    • storageClass

      public final StorageClass storageClass()

      The class of storage used to store the uploaded object.

      Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

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

      Returns:
      The class of storage used to store the uploaded object.

      Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

      See Also:

    • storageClassAsString

      public final String storageClassAsString()

      The class of storage used to store the uploaded object.

      Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

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

      Returns:
      The class of storage used to store the uploaded object.

      Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

      See Also:

    • requestCharged

      public final RequestCharged 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 return RequestCharged.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestChargedAsString().

      Returns:
      The value of the RequestCharged property for this object.
      See Also:

    • requestChargedAsString

      public final String 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 return RequestCharged.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestChargedAsString().

      Returns:
      The value of the RequestCharged property for this object.
      See Also:

    • checksumAlgorithm

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

      Returns:
      The algorithm that was used to create a checksum of the object.
      See Also:

    • checksumAlgorithmAsString

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

      Returns:
      The algorithm that was used to create a checksum of the object.
      See Also:

    • toBuilder

      public ListPartsResponse.Builder 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 interface ToCopyableBuilder<ListPartsResponse.Builder,ListPartsResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static ListPartsResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.