Package com.mongodb.client.gridfs.model

Class GridFSUploadOptions

java.lang.Object

com.mongodb.client.gridfs.model.GridFSUploadOptions

public final class GridFSUploadOptions
extends Object

GridFS upload options Customizable options used when uploading files into GridFS

Since:

3.1

Constructor Summary

Constructors

Constructor	Description
GridFSUploadOptions()	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
GridFSUploadOptions	chunkSizeBytes(Integer chunkSizeBytes)	Sets the chunk size in bytes.
Integer	getChunkSizeBytes()	The number of bytes per chunk of this file.
Document	getMetadata()	Returns any user provided data for the 'metadata' field of the files collection document.
GridFSUploadOptions	metadata(Document metadata)	Sets metadata to stored alongside the filename in the files collection

Methods inherited from class java.lang.Object

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

Constructor Detail

GridFSUploadOptions

public GridFSUploadOptions()

Construct a new instance.

Method Detail

getChunkSizeBytes

@Nullable
public Integer getChunkSizeBytes()

The number of bytes per chunk of this file.

If no value has been set then, the chunkSizeBytes from the GridFSBucket will be used.

Returns:

number of bytes per chunk if set or null

chunkSizeBytes

public GridFSUploadOptions chunkSizeBytes(@Nullable
                                          Integer chunkSizeBytes)

Sets the chunk size in bytes.

Parameters:

chunkSizeBytes - the number of bytes per chunk for the uploaded file

Returns:

this

getMetadata

@Nullable
public Document getMetadata()

Returns any user provided data for the 'metadata' field of the files collection document.

Returns:

the user provided metadata for the file if set or null

metadata

public GridFSUploadOptions metadata(@Nullable
                                    Document metadata)

Sets metadata to stored alongside the filename in the files collection

Parameters:

metadata - the metadata to be stored

Returns:

this