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

Class ListObjectsV2Response

    • Method Detail

      • isTruncated

        public final Boolean isTruncated()

        Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.

        Returns:
        Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.

      • hasContents

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

      • contents

        public final List<S3Object> contents()

        Metadata about each object returned.

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

        Returns:
        Metadata about each object returned.

      • name

        public final String name()

        The bucket name.

        Returns:
        The bucket name.

      • prefix

        public final String prefix()

        Keys that begin with the indicated prefix.

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

        Returns:
        Keys that begin with the indicated prefix.

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

      • delimiter

        public final String delimiter()

        Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

        Directory buckets - For directory buckets, / is the only supported delimiter.

        Returns:
        Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

        Directory buckets - For directory buckets, / is the only supported delimiter.

      • maxKeys

        public final Integer maxKeys()

        Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

        Returns:
        Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

      • 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 (up to 1,000) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.

        A response can contain CommonPrefixes only if you specify a delimiter.

        CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.

        CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

        For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

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

        • Directory buckets - When you query ListObjectsV2 with a delimiter during in-progress multipart uploads, the CommonPrefixes response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.

        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 (up to 1,000) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.

        A response can contain CommonPrefixes only if you specify a delimiter.

        CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.

        CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

        For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

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

        • Directory buckets - When you query ListObjectsV2 with a delimiter during in-progress multipart uploads, the CommonPrefixes response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.

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

        Delimiter, Prefix, Key, and StartAfter.

        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:

        Delimiter, Prefix, Key, and StartAfter.

        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:

        Delimiter, Prefix, Key, and StartAfter.

        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:

        Delimiter, Prefix, Key, and StartAfter.

        See Also:
        EncodingType

      • keyCount

        public final Integer keyCount()

        KeyCount is the number of keys returned with this request. KeyCount will always be less than or equal to the MaxKeys field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.

        Returns:
        KeyCount is the number of keys returned with this request. KeyCount will always be less than or equal to the MaxKeys field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.

      • continuationToken

        public final String continuationToken()

        If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response. You can use this ContinuationToken for pagination of the list results.

        Returns:
        If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response. You can use this ContinuationToken for pagination of the list results.

      • nextContinuationToken

        public final String nextContinuationToken()

        NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key

        Returns:
        NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key

      • startAfter

        public final String startAfter()

        If StartAfter was sent with the request, it is included in the response.

        This functionality is not supported for directory buckets.

        Returns:
        If StartAfter was sent with the request, it is included in the response.

        This functionality is not supported for directory buckets.

      • 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