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

Class ListMultipartUploadsResponse

    • Method Detail

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

      • keyMarker

        public final String keyMarker()

        The key at or after which the listing began.

        Returns:
        The key at or after which the listing began.

      • uploadIdMarker

        public final String 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

        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.

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

        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

        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.

        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

        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.

        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

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

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

      • uploads

        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.

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

      • commonPrefixes

        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.

        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 the Prefix child element.

        Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

      • encodingType

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

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

      • encodingTypeAsString

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

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

      • 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:
        RequestCharged

      • 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:
        RequestCharged

      • 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