com.mongodb.client.gridfs.model.GridFSUploadOptions Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2008-present MongoDB, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.mongodb.client.gridfs.model;
import com.mongodb.lang.Nullable;
import org.bson.Document;
/**
* GridFS upload options
*
* Customizable options used when uploading files into GridFS
*
* @since 3.1
*/
public final class GridFSUploadOptions {
private Integer chunkSizeBytes;
private Document metadata;
/**
* Construct a new instance.
*/
public GridFSUploadOptions() {
}
/**
* The number of bytes per chunk of this file.
*
* If no value has been set then, the chunkSizeBytes from the GridFSBucket will be used.
*
* @return number of bytes per chunk if set or null
*/
@Nullable
public Integer getChunkSizeBytes() {
return chunkSizeBytes;
}
/**
* Sets the chunk size in bytes.
*
* @param chunkSizeBytes the number of bytes per chunk for the uploaded file
* @return this
*/
public GridFSUploadOptions chunkSizeBytes(@Nullable final Integer chunkSizeBytes) {
this.chunkSizeBytes = chunkSizeBytes;
return this;
}
/**
* Returns any user provided data for the 'metadata' field of the files collection document.
*
* @return the user provided metadata for the file if set or null
*/
@Nullable
public Document getMetadata() {
return metadata;
}
/**
* Sets metadata to stored alongside the filename in the files collection
*
* @param metadata the metadata to be stored
* @return this
*/
public GridFSUploadOptions metadata(@Nullable final Document metadata) {
this.metadata = metadata;
return this;
}
}