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

Class ListObjectVersionsResponse

    • Method Detail

      • isTruncated

        public final Boolean isTruncated()

        A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request by using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.

        Returns:
        A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request by using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.

      • keyMarker

        public final String keyMarker()

        Marks the last key returned in a truncated response.

        Returns:
        Marks the last key returned in a truncated response.

      • versionIdMarker

        public final String versionIdMarker()

        Marks the last version of the key returned in a truncated response.

        Returns:
        Marks the last version of the key returned in a truncated response.

      • nextKeyMarker

        public final String nextKeyMarker()

        When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.

        Returns:
        When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.

      • nextVersionIdMarker

        public final String nextVersionIdMarker()

        When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.

        Returns:
        When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.

      • hasVersions

        public final boolean hasVersions()
        For responses, this returns true if the service returned a value for the Versions 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.

      • versions

        public final List<ObjectVersion> versions()

        Container for version information.

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

        Returns:
        Container for version information.

      • hasDeleteMarkers

        public final boolean hasDeleteMarkers()
        For responses, this returns true if the service returned a value for the DeleteMarkers 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.

      • deleteMarkers

        public final List<DeleteMarkerEntry> deleteMarkers()

        Container for an object that is a delete marker.

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

        Returns:
        Container for an object that is a delete marker.

      • name

        public final String name()

        The bucket name.

        Returns:
        The bucket name.

      • prefix

        public final String prefix()

        Selects objects that start with the value supplied by this parameter.

        Returns:
        Selects objects that start with the value supplied by this parameter.

      • delimiter

        public final String delimiter()

        The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

        Returns:
        The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

      • maxKeys

        public final Integer maxKeys()

        Specifies the maximum number of objects to return.

        Returns:
        Specifies the maximum number of objects to return.

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

        All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

        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:
        All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

      • encodingType

        public final EncodingType encodingType()

        Encoding type used by Amazon S3 to encode object key names in the XML 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:

        KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

        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 key names in the XML 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:

        KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

        See Also:
        EncodingType

      • encodingTypeAsString

        public final String encodingTypeAsString()

        Encoding type used by Amazon S3 to encode object key names in the XML 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:

        KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

        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 key names in the XML 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:

        KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

        See Also:
        EncodingType

      • 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