com.mongodb.reactivestreams.client.gridfs

Interface GridFSUploadStream

All Superinterfaces:

AsyncOutputStream

public interface GridFSUploadStream
extends AsyncOutputStream

A GridFS OutputStream for uploading data into GridFS

Provides the id for the file to be uploaded as well as the write methods of a AsyncOutputStream

Since:

1.3

Method Summary

Methods

Modifier and Type	Method and Description
org.reactivestreams.Publisher<Success>	abort() Aborts the upload and deletes any data.
org.bson.BsonValue	getId() The BsonValue id for this file.
org.bson.types.ObjectId	getObjectId() Gets the ObjectId for the file to be uploaded Throws a MongoGridFSException if the file id is not an ObjectId.

Methods inherited from interface com.mongodb.reactivestreams.client.gridfs.AsyncOutputStream

close, write

Method Detail

getObjectId

org.bson.types.ObjectId getObjectId()

Gets the ObjectId for the file to be uploaded Throws a MongoGridFSException if the file id is not an ObjectId.

Returns:

the ObjectId for the file to be uploaded

getId

org.bson.BsonValue getId()

The BsonValue id for this file.

Returns:

the id for this file

abort

org.reactivestreams.Publisher<Success> abort()

Aborts the upload and deletes any data.

Returns:

a publisher with a single element, signifying the abort and cleanup has finished