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

Interface ListObjectVersionsRequest.Builder

    • Method Detail

      • bucket

        ListObjectVersionsRequest.Builder bucket​(String bucket)

        The bucket name that contains the objects.

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

      • delimiter

        ListObjectVersionsRequest.Builder delimiter​(String delimiter)

        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.

        CommonPrefixes is filtered out from results if it is not lexicographically greater than the key-marker.

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

        CommonPrefixes is filtered out from results if it is not lexicographically greater than the key-marker.

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

      • encodingType

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

      • encodingType

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

      • keyMarker

        ListObjectVersionsRequest.Builder keyMarker​(String keyMarker)

        Specifies the key to start with when listing objects in a bucket.

        Parameters:
        keyMarker - Specifies the key to start with when listing objects in a bucket.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxKeys

        ListObjectVersionsRequest.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. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

        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. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • prefix

        ListObjectVersionsRequest.Builder prefix​(String prefix)

        Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way that you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

        Parameters:
        prefix - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way that you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • versionIdMarker

        ListObjectVersionsRequest.Builder versionIdMarker​(String versionIdMarker)

        Specifies the object version you want to start listing from.

        Parameters:
        versionIdMarker - Specifies the object version you want to start listing from.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • expectedBucketOwner

        ListObjectVersionsRequest.Builder expectedBucketOwner​(String expectedBucketOwner)

        The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

        Parameters:
        expectedBucketOwner - The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requestPayer

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

      • requestPayer

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

      • optionalObjectAttributesWithStrings

        ListObjectVersionsRequest.Builder optionalObjectAttributesWithStrings​(Collection<String> optionalObjectAttributes)

        Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

        Parameters:
        optionalObjectAttributes - Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionalObjectAttributesWithStrings

        ListObjectVersionsRequest.Builder optionalObjectAttributesWithStrings​(String... optionalObjectAttributes)

        Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

        Parameters:
        optionalObjectAttributes - Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionalObjectAttributes

        ListObjectVersionsRequest.Builder optionalObjectAttributes​(Collection<OptionalObjectAttributes> optionalObjectAttributes)

        Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

        Parameters:
        optionalObjectAttributes - Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionalObjectAttributes

        ListObjectVersionsRequest.Builder optionalObjectAttributes​(OptionalObjectAttributes... optionalObjectAttributes)

        Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

        Parameters:
        optionalObjectAttributes - Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.