Package com.google.cloud.storage

Class MultipartUploadClient

java.lang.Object

com.google.cloud.storage.MultipartUploadClient

@InternalExtensionOnly
public abstract class MultipartUploadClient
extends Object

A client for interacting with Google Cloud Storage's Multipart Upload API.

It provides alow-level interface for creating and managing multipart uploads.

Since:

2.60.0

See Also:

• Multipart Uploads

Method Summary

Modifier and Type	Method	Description
abstract AbortMultipartUploadResponse	abortMultipartUpload(AbortMultipartUploadRequest request)	Aborts a multipart upload.
abstract CompleteMultipartUploadResponse	completeMultipartUpload(CompleteMultipartUploadRequest request)	Completes a multipart upload.
static MultipartUploadClient	create(MultipartUploadSettings config)	Creates a new instance of MultipartUploadClient.
abstract CreateMultipartUploadResponse	createMultipartUpload(CreateMultipartUploadRequest request)	Creates a new multipart upload.
abstract ListMultipartUploadsResponse	listMultipartUploads(ListMultipartUploadsRequest request)	Lists all multipart uploads in a bucket.
abstract ListPartsResponse	listParts(ListPartsRequest listPartsRequest)	Lists the parts that have been uploaded for a specific multipart upload.
abstract UploadPartResponse	uploadPart(UploadPartRequest request, RequestBody requestBody)	Uploads a part in a multipart upload.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

createMultipartUpload

public abstract CreateMultipartUploadResponse createMultipartUpload(CreateMultipartUploadRequest request)

Creates a new multipart upload.

Parameters:

request - The request object containing the details for creating the multipart upload.

Returns:

A CreateMultipartUploadResponse object containing the upload ID.

Since:

2.60.0

listParts

public abstract ListPartsResponse listParts(ListPartsRequest listPartsRequest)

Lists the parts that have been uploaded for a specific multipart upload.

Parameters:

listPartsRequest - The request object containing the details for listing the parts.

Returns:

A ListPartsResponse object containing the list of parts.

Since:

2.60.0

abortMultipartUpload

public abstract AbortMultipartUploadResponse abortMultipartUpload(AbortMultipartUploadRequest request)

Aborts a multipart upload.

Parameters:

request - The request object containing the details for aborting the multipart upload.

Returns:

An AbortMultipartUploadResponse object.

Since:

2.60.0

completeMultipartUpload

public abstract CompleteMultipartUploadResponse completeMultipartUpload(CompleteMultipartUploadRequest request)

Completes a multipart upload.

Parameters:

request - The request object containing the details for completing the multipart upload.

Returns:

A CompleteMultipartUploadResponse object containing information about the completed upload.

Since:

2.60.0

uploadPart

public abstract UploadPartResponse uploadPart(UploadPartRequest request,
 RequestBody requestBody)

Uploads a part in a multipart upload.

Parameters:

request - The request object containing the details for uploading the part.

requestBody - The content of the part to upload.

Returns:

An UploadPartResponse object containing the ETag of the uploaded part.

Since:

2.60.0

listMultipartUploads

public abstract ListMultipartUploadsResponse listMultipartUploads(ListMultipartUploadsRequest request)

Lists all multipart uploads in a bucket.

Parameters:

request - The request object containing the details for listing the multipart uploads.

Returns:

A ListMultipartUploadsResponse object containing the list of multipart uploads.

Since:

2.61.0

create

public static MultipartUploadClient create(MultipartUploadSettings config)

Creates a new instance of MultipartUploadClient.

Parameters:

config - The configuration for the client.

Returns:

A new MultipartUploadClient instance.

Since:

2.60.0