Cloud Storage Client - Class WriteStream (1.37.0)

Reference documentation and code samples for the Cloud Storage Client class WriteStream.

A Stream implementation that uploads in chunks to a provided uploader when we reach a certain chunkSize. Upon close, we will upload the remaining chunk.

Namespace

Google \ Cloud \ Storage

Methods

__construct

Create a new WriteStream instance

Parameters
NameDescription
uploader Google\Cloud\Core\Upload\AbstractUploader

The uploader to use.

options array

Configuration options.

↳ chunkSize int

The size of the buffer above which we attempt to upload data

close

Close the stream. Uploads any remaining data.

write

Write to the stream. If we pass the chunkable size, upload the available chunk.

Parameter
NameDescription
data string

Data to write

Returns
TypeDescription
intThe number of bytes written

setUploader

Set the uploader for this class. You may need to set this after initialization if the uploader depends on this stream.

Parameter
NameDescription
uploader Google\Cloud\Core\Upload\AbstractUploader

The new uploader to use.