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

Interface ListObjectsV2Response.Builder

    • Method Detail

      • isTruncated

        ListObjectsV2Response.Builder isTruncated​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • contents

        ListObjectsV2Response.Builder contents​(Collection<S3Object> contents)

        Metadata about each object returned.

        Parameters:
        contents - Metadata about each object returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • contents

        ListObjectsV2Response.Builder contents​(S3Object... contents)

        Metadata about each object returned.

        Parameters:
        contents - Metadata about each object returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        ListObjectsV2Response.Builder name​(String name)

        The bucket name.

        Parameters:
        name - The bucket name.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • prefix

        ListObjectsV2Response.Builder prefix​(String prefix)

        Keys that begin with the indicated prefix.

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

        Parameters:
        prefix - Keys that begin with the indicated prefix.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • delimiter

        ListObjectsV2Response.Builder delimiter​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • maxKeys

        ListObjectsV2Response.Builder maxKeys​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • commonPrefixes

        ListObjectsV2Response.Builder commonPrefixes​(Collection<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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • commonPrefixes

        ListObjectsV2Response.Builder commonPrefixes​(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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • commonPrefixes

        ListObjectsV2Response.Builder commonPrefixes​(Consumer<CommonPrefix.Builder>... 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.

        This is a convenience method that creates an instance of the CommonPrefix.Builder avoiding the need to create one manually via CommonPrefix.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #commonPrefixes(List).

        Parameters:
        commonPrefixes - a consumer that will call methods on CommonPrefix.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #commonPrefixes(java.util.Collection)

      • encodingType

        ListObjectsV2Response.Builder encodingType​(String 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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EncodingType, EncodingType

      • encodingType

        ListObjectsV2Response.Builder encodingType​(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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EncodingType, EncodingType

      • keyCount

        ListObjectsV2Response.Builder keyCount​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • continuationToken

        ListObjectsV2Response.Builder continuationToken​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextContinuationToken

        ListObjectsV2Response.Builder nextContinuationToken​(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

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • startAfter

        ListObjectsV2Response.Builder startAfter​(String startAfter)

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

        This functionality is not supported for directory buckets.

        Parameters:
        startAfter - If StartAfter was sent with the request, it is included in the response.

        This functionality is not supported for directory buckets.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requestCharged

        ListObjectsV2Response.Builder requestCharged​(String requestCharged)
        Sets the value of the RequestCharged property for this object.
        Parameters:
        requestCharged - The new value for the RequestCharged property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RequestCharged, RequestCharged

      • requestCharged

        ListObjectsV2Response.Builder requestCharged​(RequestCharged requestCharged)
        Sets the value of the RequestCharged property for this object.
        Parameters:
        requestCharged - The new value for the RequestCharged property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RequestCharged, RequestCharged