Package com.mongodb.client.gridfs.model
Class GridFSUploadOptions
- java.lang.Object
-
- com.mongodb.client.gridfs.model.GridFSUploadOptions
-
@Deprecated(since="2021-05-27") public final class GridFSUploadOptions extends Object
Deprecated.Usage of this API is not supported in AEM as a Cloud Service.GridFS upload options Customizable options used when uploading files into GridFS- Since:
- 3.1
-
-
Constructor Summary
Constructors Constructor Description GridFSUploadOptions()
Deprecated.Construct a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description GridFSUploadOptions
chunkSizeBytes(Integer chunkSizeBytes)
Deprecated.Sets the chunk size in bytes.Integer
getChunkSizeBytes()
Deprecated.The number of bytes per chunk of this file.Document
getMetadata()
Deprecated.Returns any user provided data for the 'metadata' field of the files collection document.GridFSUploadOptions
metadata(Document metadata)
Deprecated.Sets metadata to stored alongside the filename in the files collection
-
-
-
Method Detail
-
getChunkSizeBytes
@Nullable public Integer getChunkSizeBytes()
Deprecated.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)
Deprecated.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()
Deprecated.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)
Deprecated.Sets metadata to stored alongside the filename in the files collection- Parameters:
metadata
- the metadata to be stored- Returns:
- this
-
-