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

Interface ListObjectsV2Request.Builder

    • Method Detail

      • bucket

        ListObjectsV2Request.Builder bucket​(String bucket)

        Bucket name to list.

        When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

        When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

        Parameters:
        bucket - Bucket name to list.

        When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

        When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

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

      • delimiter

        ListObjectsV2Request.Builder delimiter​(String delimiter)

        A delimiter is a character that you use to group keys.

        Parameters:
        delimiter - A delimiter is a character that you use to group keys.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • encodingType

        ListObjectsV2Request.Builder encodingType​(String encodingType)

        Encoding type used by Amazon S3 to encode object keys in the response.

        Parameters:
        encodingType - Encoding type used by Amazon S3 to encode object keys in the response.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EncodingType, EncodingType

      • encodingType

        ListObjectsV2Request.Builder encodingType​(EncodingType encodingType)

        Encoding type used by Amazon S3 to encode object keys in the response.

        Parameters:
        encodingType - Encoding type used by Amazon S3 to encode object keys in the response.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EncodingType, EncodingType

      • maxKeys

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

      • prefix

        ListObjectsV2Request.Builder prefix​(String prefix)

        Limits the response to keys that begin with the specified prefix.

        Parameters:
        prefix - Limits the response to keys that begin with the specified prefix.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • continuationToken

        ListObjectsV2Request.Builder continuationToken​(String continuationToken)

        ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.

        Parameters:
        continuationToken - ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • fetchOwner

        ListObjectsV2Request.Builder fetchOwner​(Boolean fetchOwner)

        The owner field is not present in ListObjectsV2 by default. If you want to return the owner field with each key in the result, then set the FetchOwner field to true.

        Parameters:
        fetchOwner - The owner field is not present in ListObjectsV2 by default. If you want to return the owner field with each key in the result, then set the FetchOwner field to true.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startAfter

        ListObjectsV2Request.Builder startAfter​(String startAfter)

        StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

        Parameters:
        startAfter - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requestPayer

        ListObjectsV2Request.Builder requestPayer​(String requestPayer)

        Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

        Parameters:
        requestPayer - Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RequestPayer, RequestPayer

      • requestPayer

        ListObjectsV2Request.Builder requestPayer​(RequestPayer requestPayer)

        Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

        Parameters:
        requestPayer - Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RequestPayer, RequestPayer

      • expectedBucketOwner

        ListObjectsV2Request.Builder expectedBucketOwner​(String expectedBucketOwner)

        The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

        Parameters:
        expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, 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.

      • optionalObjectAttributesWithStrings

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

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

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

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