Class MediaHttpUploader (2.6.0)

Media HTTP Uploader, with support for both direct and resumable media uploads. Documentation is available here.

For resumable uploads, when the media content length is known, if the provided InputStream has InputStream#markSupported as false then it is wrapped in an BufferedInputStream to support the InputStream#mark and InputStream#reset methods required for handling server errors. If the media content length is unknown then each chunk is stored temporarily in memory. This is required to determine when the last chunk is reached.

See #setDisableGZipContent(boolean) for information on when content is gzipped and how to control that behavior.

Back-off is disabled by default. To enable it for an abnormal HTTP response and an I/O exception you should call HttpRequest#setUnsuccessfulResponseHandler with a new HttpBackOffUnsuccessfulResponseHandler instance and HttpRequest#setIOExceptionHandler with HttpBackOffIOExceptionHandler.

Upgrade warning: in prior version 1.14 exponential back-off was enabled by default for an abnormal HTTP response and there was a regular retry (without back-off) when I/O exception was thrown. Starting with version 1.15 back-off is disabled and there is no retry on I/O exception by default.

Upgrade warning: in prior version 1.16 #serverErrorCallback was public but starting with version 1.17 it has been removed from the public API, and changed to be package private.

Implementation is not thread-safe.

Upload content type header.

Upload content length header.

Default maximum number of bytes that will be uploaded to the server in any single HTTP request (set to 10 MB).

Minimum number of bytes that can be uploaded to the server (set to 256KB).

Construct the MediaHttpUploader.

The input stream received by calling AbstractInputStreamContent#getInputStream is closed when the upload process is successfully completed. For resumable uploads, when the media content length is known, if the input stream has InputStream#markSupported as false then it is wrapped in an BufferedInputStream to support the InputStream#mark and InputStream#reset methods required for handling server errors. If the media content length is unknown then each chunk is stored temporarily in memory. This is required to determine when the last chunk is reached.

Returns the maximum size of individual chunks that will get uploaded by single HTTP requests. The default value is #DEFAULT_CHUNK_SIZE.

Returns whether to disable GZip compression of HTTP content.

Returns the HTTP headers used for the initiation request.

Returns the HTTP method used for the initiation request.

The default value is HttpMethods#POST.

Returns the HTTP content of the media to be uploaded.

Returns HTTP content metadata for the media request or null for none.

Gets the total number of bytes the server received so far or 0 for direct uploads when the content length is not known.

Gets the upload progress denoting the percentage of bytes that have been uploaded, represented between 0.0 (0%) and 1.0 (100%).

Do not use if the specified AbstractInputStreamContent has no content length specified. Instead, consider using #getNumBytesUploaded to denote progress.

Returns the progress listener to send progress notifications to or null for none.

Returns the sleeper.

Returns the transport to use for requests.

Gets the current upload state of the uploader.

Returns whether direct media upload is enabled or disabled. If value is set to true then a direct upload will be done where the whole media content is uploaded in a single request. If value is set to false then the upload uses the resumable media upload protocol to upload in data chunks. Defaults to false.

Sets the maximum size of individual chunks that will get uploaded by single HTTP requests. The default value is #DEFAULT_CHUNK_SIZE.

The minimum allowable value is #MINIMUM_CHUNK_SIZE and the specified chunk size must be a multiple of #MINIMUM_CHUNK_SIZE.

Sets whether direct media upload is enabled or disabled.

If value is set to true then a direct upload will be done where the whole media content is uploaded in a single request. If value is set to false then the upload uses the resumable media upload protocol to upload in data chunks.

Direct upload is recommended if the content size falls below a certain minimum limit. This is because there's minimum block write size for some Google APIs, so if the resumable request fails in the space of that first block, the client will have to restart from the beginning anyway.

Defaults to false.

Sets whether to disable GZip compression of HTTP content.

By default it is false.

If #setDisableGZipContent(boolean) is set to false (the default value) then content is gzipped for direct media upload and resumable media uploads when content length is not known. Due to a current limitation, content is not gzipped for resumable media uploads when content length is known; this limitation will be removed in the future.

Sets the HTTP headers used for the initiation request.

Sets the HTTP method used for the initiation request.

Can only be HttpMethods#POST (for media upload) or HttpMethods#PUT (for media update). The default value is HttpMethods#POST.

Sets HTTP content metadata for the media request or null for none.

Sets the progress listener to send progress notifications to or null for none.

Sets the sleeper. The default value is Sleeper#DEFAULT.

Executes a direct media upload or resumable media upload conforming to the specifications listed here.

This method is not reentrant. A new instance of MediaHttpUploader must be instantiated before upload called be called again.

If an error is encountered during the request execution the caller is responsible for parsing the response correctly. For example for JSON errors:

 if (!response.isSuccessStatusCode()) {
   throw GoogleJsonResponseException.from(jsonFactory, response);
 }
 

Callers should call HttpResponse#disconnect when the returned HTTP response object is no longer needed. However, HttpResponse#disconnect does not have to be called if the response stream is properly closed. Example usage:

 HttpResponse response = batch.upload(initiationRequestUrl);
 try {
   // process the HTTP response object
 } finally {
   response.disconnect();
 }