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

Interface ListMultipartUploadsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListMultipartUploadsRequest.Builder,ListMultipartUploadsRequest>, S3Request.Builder, SdkBuilder<ListMultipartUploadsRequest.Builder,ListMultipartUploadsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListMultipartUploadsRequest
public static interface ListMultipartUploadsRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<ListMultipartUploadsRequest.Builder,ListMultipartUploadsRequest>

  • Method Details

    • bucket

      ListMultipartUploadsRequest.Builder bucket(String bucket)

      The name of the bucket to which the multipart upload was initiated.

      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 - The name of the bucket to which the multipart upload was initiated.

      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

      ListMultipartUploadsRequest.Builder delimiter(String delimiter)

      Character you use to group keys.

      All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

      Parameters:
      delimiter - Character you use to group keys.

      All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

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

    • encodingType

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

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

    • keyMarker

      ListMultipartUploadsRequest.Builder keyMarker(String keyMarker)

      Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

      If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

      If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

      Parameters:
      keyMarker - Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

      If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

      If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

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

    • maxUploads

      ListMultipartUploadsRequest.Builder maxUploads(Integer maxUploads)

      Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.

      Parameters:
      maxUploads - Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • prefix

      ListMultipartUploadsRequest.Builder prefix(String prefix)

      Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping 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.)

      Parameters:
      prefix - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping 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.)
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • uploadIdMarker

      ListMultipartUploadsRequest.Builder uploadIdMarker(String uploadIdMarker)

      Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

      Parameters:
      uploadIdMarker - Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expectedBucketOwner

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

    • requestPayer

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

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

    • overrideConfiguration

      ListMultipartUploadsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListMultipartUploadsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.