Package io.vertx.mutiny.ext.mongo

Class MongoGridFsClient

java.lang.Object
io.vertx.mutiny.ext.mongo.MongoGridFsClient
All Implemented Interfaces:
MutinyDelegate
public class MongoGridFsClient extends Object implements MutinyDelegate
NOTE: This class has been automatically generated from the original non Mutiny-ified interface.
See Also:
  • MongoGridFsClient

  • Field Details

  • Constructor Details

    • MongoGridFsClient

      public MongoGridFsClient(io.vertx.ext.mongo.MongoGridFsClient delegate)
      Create a new instance of MongoGridFsClient delegating to the given (non-null) instance of MongoGridFsClient.

    • MongoGridFsClient

      public MongoGridFsClient(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.mongo.MongoGridFsClient getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance

    • delete

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> delete(String id)
      Deletes a file by it's ID

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      id - the identifier of the file
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • MongoGridFsClient.delete(String)

    • deleteAndAwait

      public void deleteAndAwait(String id)
      Deletes a file by it's ID

      Unlike the bare Vert.x variant, this method returns a Void. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      id - the identifier of the file
      See Also:
      • MongoGridFsClient.delete(String)

    • deleteAndForget

      public MongoGridFsClient deleteAndForget(String id)
      Deletes a file by it's ID

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Parameters:
      id - the identifier of the file
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • MongoGridFsClient.delete(String)

    • downloadByFileName

      @CheckReturnValue public io.smallrye.mutiny.Uni<Long> downloadByFileName(WriteStream<io.vertx.core.buffer.Buffer> stream, String fileName)

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#downloadByFileName(WriteStream, String)

    • downloadByFileNameAndAwait

      public Long downloadByFileNameAndAwait(WriteStream<io.vertx.core.buffer.Buffer> stream, String fileName)

      Unlike the bare Vert.x variant, this method returns a Long. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Returns:
      The operation result
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#downloadByFileName(WriteStream, String)

    • downloadByFileNameAndForget

      public MongoGridFsClient downloadByFileNameAndForget(WriteStream<io.vertx.core.buffer.Buffer> stream, String fileName)

      Unlike the bare Vert.x variant, this method ignores the Long result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#downloadByFileName(WriteStream, String)

    • downloadByFileNameWithOptions

      @CheckReturnValue public io.smallrye.mutiny.Uni<Long> downloadByFileNameWithOptions(WriteStream<io.vertx.core.buffer.Buffer> stream, String fileName, io.vertx.ext.mongo.GridFsDownloadOptions options)

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#downloadByFileNameWithOptions(WriteStream, String, GridFsDownloadOptions)

    • downloadByFileNameWithOptionsAndAwait

      public Long downloadByFileNameWithOptionsAndAwait(WriteStream<io.vertx.core.buffer.Buffer> stream, String fileName, io.vertx.ext.mongo.GridFsDownloadOptions options)

      Unlike the bare Vert.x variant, this method returns a Long. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Returns:
      The operation result
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#downloadByFileNameWithOptions(WriteStream, String, GridFsDownloadOptions)

    • downloadByFileNameWithOptionsAndForget

      public MongoGridFsClient downloadByFileNameWithOptionsAndForget(WriteStream<io.vertx.core.buffer.Buffer> stream, String fileName, io.vertx.ext.mongo.GridFsDownloadOptions options)

      Unlike the bare Vert.x variant, this method ignores the Long result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#downloadByFileNameWithOptions(WriteStream, String, GridFsDownloadOptions)

    • downloadById

      @CheckReturnValue public io.smallrye.mutiny.Uni<Long> downloadById(WriteStream<io.vertx.core.buffer.Buffer> stream, String id)

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#downloadById(WriteStream, String)

    • downloadByIdAndAwait

      public Long downloadByIdAndAwait(WriteStream<io.vertx.core.buffer.Buffer> stream, String id)

      Unlike the bare Vert.x variant, this method returns a Long. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Returns:
      The operation result
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#downloadById(WriteStream, String)

    • downloadByIdAndForget

      public MongoGridFsClient downloadByIdAndForget(WriteStream<io.vertx.core.buffer.Buffer> stream, String id)

      Unlike the bare Vert.x variant, this method ignores the Long result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#downloadById(WriteStream, String)

    • downloadFile

      @CheckReturnValue public io.smallrye.mutiny.Uni<Long> downloadFile(String fileName)
      Downloads a file.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      fileName - the name of the file to download
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • MongoGridFsClient.downloadFile(String)

    • downloadFileAndAwait

      public Long downloadFileAndAwait(String fileName)
      Downloads a file.

      Unlike the bare Vert.x variant, this method returns a Long. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      fileName - the name of the file to download
      Returns:
      The operation result
      See Also:
      • MongoGridFsClient.downloadFile(String)

    • downloadFileAndForget

      public MongoGridFsClient downloadFileAndForget(String fileName)
      Downloads a file.

      Unlike the bare Vert.x variant, this method ignores the Long result or any failure.

      Parameters:
      fileName - the name of the file to download
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • MongoGridFsClient.downloadFile(String)

    • downloadFileAs

      @CheckReturnValue public io.smallrye.mutiny.Uni<Long> downloadFileAs(String fileName, String newFileName)
      Downloads a file and gives it a new name.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      fileName - the name of the file to download
      newFileName - the name the file should be saved as
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • MongoGridFsClient.downloadFileAs(String, String)

    • downloadFileAsAndAwait

      public Long downloadFileAsAndAwait(String fileName, String newFileName)
      Downloads a file and gives it a new name.

      Unlike the bare Vert.x variant, this method returns a Long. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      fileName - the name of the file to download
      newFileName - the name the file should be saved as
      Returns:
      The operation result
      See Also:
      • MongoGridFsClient.downloadFileAs(String, String)

    • downloadFileAsAndForget

      public MongoGridFsClient downloadFileAsAndForget(String fileName, String newFileName)
      Downloads a file and gives it a new name.

      Unlike the bare Vert.x variant, this method ignores the Long result or any failure.

      Parameters:
      fileName - the name of the file to download
      newFileName - the name the file should be saved as
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • MongoGridFsClient.downloadFileAs(String, String)

    • downloadFileByID

      @CheckReturnValue public io.smallrye.mutiny.Uni<Long> downloadFileByID(String id, String fileName)
      Downloads a file using the ID generated by GridFs.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      id - the GridFs Object ID of the file to download
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • MongoGridFsClient.downloadFileByID(String, String)

    • downloadFileByIDAndAwait

      public Long downloadFileByIDAndAwait(String id, String fileName)
      Downloads a file using the ID generated by GridFs.

      Unlike the bare Vert.x variant, this method returns a Long. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      id - the GridFs Object ID of the file to download
      Returns:
      The operation result
      See Also:
      • MongoGridFsClient.downloadFileByID(String, String)

    • downloadFileByIDAndForget

      public MongoGridFsClient downloadFileByIDAndForget(String id, String fileName)
      Downloads a file using the ID generated by GridFs.

      Unlike the bare Vert.x variant, this method ignores the Long result or any failure.

      Parameters:
      id - the GridFs Object ID of the file to download
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • MongoGridFsClient.downloadFileByID(String, String)

    • drop

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> drop()
      Drops the entire file bucket with all of its contents

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • MongoGridFsClient.drop()

    • dropAndAwait

      public void dropAndAwait()
      Drops the entire file bucket with all of its contents

      Unlike the bare Vert.x variant, this method returns a Void. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      See Also:
      • MongoGridFsClient.drop()

    • dropAndForget

      public MongoGridFsClient dropAndForget()
      Drops the entire file bucket with all of its contents

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • MongoGridFsClient.drop()

    • findAllIds

      @CheckReturnValue public io.smallrye.mutiny.Uni<List<String>> findAllIds()
      Finds all file ids in the bucket

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • MongoGridFsClient.findAllIds()

    • findAllIdsAndAwait

      public List<String> findAllIdsAndAwait()
      Finds all file ids in the bucket

      Unlike the bare Vert.x variant, this method returns a List<String>. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Returns:
      The operation result
      See Also:
      • MongoGridFsClient.findAllIds()

    • findAllIdsAndForget

      public MongoGridFsClient findAllIdsAndForget()
      Finds all file ids in the bucket

      Unlike the bare Vert.x variant, this method ignores the List<String> result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • MongoGridFsClient.findAllIds()

    • findIds

      @CheckReturnValue public io.smallrye.mutiny.Uni<List<String>> findIds(io.vertx.core.json.JsonObject query)
      Finds all file ids that match a query.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      query - a bson query expressed as json that will be used to match files
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • MongoGridFsClient.findIds(JsonObject)

    • findIdsAndAwait

      public List<String> findIdsAndAwait(io.vertx.core.json.JsonObject query)
      Finds all file ids that match a query.

      Unlike the bare Vert.x variant, this method returns a List<String>. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      query - a bson query expressed as json that will be used to match files
      Returns:
      The operation result
      See Also:
      • MongoGridFsClient.findIds(JsonObject)

    • findIdsAndForget

      public MongoGridFsClient findIdsAndForget(io.vertx.core.json.JsonObject query)
      Finds all file ids that match a query.

      Unlike the bare Vert.x variant, this method ignores the List<String> result or any failure.

      Parameters:
      query - a bson query expressed as json that will be used to match files
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • MongoGridFsClient.findIds(JsonObject)

    • uploadByFileName

      @CheckReturnValue public io.smallrye.mutiny.Uni<String> uploadByFileName(ReadStream<io.vertx.core.buffer.Buffer> stream, String fileName)

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#uploadByFileName(ReadStream, String)

    • uploadByFileNameAndAwait

      public String uploadByFileNameAndAwait(ReadStream<io.vertx.core.buffer.Buffer> stream, String fileName)

      Unlike the bare Vert.x variant, this method returns a String. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Returns:
      The operation result
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#uploadByFileName(ReadStream, String)

    • uploadByFileNameAndForget

      public MongoGridFsClient uploadByFileNameAndForget(ReadStream<io.vertx.core.buffer.Buffer> stream, String fileName)

      Unlike the bare Vert.x variant, this method ignores the String result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#uploadByFileName(ReadStream, String)

    • uploadByFileName

      @CheckReturnValue public io.smallrye.mutiny.Uni<String> uploadByFileName(Flow.Publisher<io.vertx.core.buffer.Buffer> stream, String fileName)

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#uploadByFileName(ReadStream, String)

    • uploadByFileNameAndAwait

      public String uploadByFileNameAndAwait(Flow.Publisher<io.vertx.core.buffer.Buffer> stream, String fileName)

      Unlike the bare Vert.x variant, this method returns a String. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Returns:
      The operation result
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#uploadByFileName(ReadStream, String)

    • uploadByFileNameAndForget

      public MongoGridFsClient uploadByFileNameAndForget(Flow.Publisher<io.vertx.core.buffer.Buffer> stream, String fileName)

      Unlike the bare Vert.x variant, this method ignores the String result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#uploadByFileName(ReadStream, String)

    • uploadByFileNameWithOptions

      @CheckReturnValue public io.smallrye.mutiny.Uni<String> uploadByFileNameWithOptions(ReadStream<io.vertx.core.buffer.Buffer> stream, String fileName, io.vertx.ext.mongo.GridFsUploadOptions options)

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#uploadByFileNameWithOptions(ReadStream, String, GridFsUploadOptions)

    • uploadByFileNameWithOptionsAndAwait

      public String uploadByFileNameWithOptionsAndAwait(ReadStream<io.vertx.core.buffer.Buffer> stream, String fileName, io.vertx.ext.mongo.GridFsUploadOptions options)

      Unlike the bare Vert.x variant, this method returns a String. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Returns:
      The operation result
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#uploadByFileNameWithOptions(ReadStream, String, GridFsUploadOptions)

    • uploadByFileNameWithOptionsAndForget

      public MongoGridFsClient uploadByFileNameWithOptionsAndForget(ReadStream<io.vertx.core.buffer.Buffer> stream, String fileName, io.vertx.ext.mongo.GridFsUploadOptions options)

      Unlike the bare Vert.x variant, this method ignores the String result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#uploadByFileNameWithOptions(ReadStream, String, GridFsUploadOptions)

    • uploadByFileNameWithOptions

      @CheckReturnValue public io.smallrye.mutiny.Uni<String> uploadByFileNameWithOptions(Flow.Publisher<io.vertx.core.buffer.Buffer> stream, String fileName, io.vertx.ext.mongo.GridFsUploadOptions options)

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#uploadByFileNameWithOptions(ReadStream, String, GridFsUploadOptions)

    • uploadByFileNameWithOptionsAndAwait

      public String uploadByFileNameWithOptionsAndAwait(Flow.Publisher<io.vertx.core.buffer.Buffer> stream, String fileName, io.vertx.ext.mongo.GridFsUploadOptions options)

      Unlike the bare Vert.x variant, this method returns a String. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Returns:
      The operation result
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#uploadByFileNameWithOptions(ReadStream, String, GridFsUploadOptions)

    • uploadByFileNameWithOptionsAndForget

      public MongoGridFsClient uploadByFileNameWithOptionsAndForget(Flow.Publisher<io.vertx.core.buffer.Buffer> stream, String fileName, io.vertx.ext.mongo.GridFsUploadOptions options)

      Unlike the bare Vert.x variant, this method ignores the String result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • io.vertx.ext.mongo.MongoGridFsClient#uploadByFileNameWithOptions(ReadStream, String, GridFsUploadOptions)

    • uploadFile

      @CheckReturnValue public io.smallrye.mutiny.Uni<String> uploadFile(String fileName)
      Upload a file to gridfs

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      fileName - the name of the file to store in gridfs
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • MongoGridFsClient.uploadFile(String)

    • uploadFileAndAwait

      public String uploadFileAndAwait(String fileName)
      Upload a file to gridfs

      Unlike the bare Vert.x variant, this method returns a String. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      fileName - the name of the file to store in gridfs
      Returns:
      The operation result
      See Also:
      • MongoGridFsClient.uploadFile(String)

    • uploadFileAndForget

      public MongoGridFsClient uploadFileAndForget(String fileName)
      Upload a file to gridfs

      Unlike the bare Vert.x variant, this method ignores the String result or any failure.

      Parameters:
      fileName - the name of the file to store in gridfs
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • MongoGridFsClient.uploadFile(String)

    • uploadFileWithOptions

      @CheckReturnValue public io.smallrye.mutiny.Uni<String> uploadFileWithOptions(String fileName, io.vertx.ext.mongo.GridFsUploadOptions options)
      Upload a file to gridfs with options

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      fileName - the name of the file to store in gridfs
      options - GridFsUploadOptions for specifying metadata and chunk size
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • MongoGridFsClient.uploadFileWithOptions(String, GridFsUploadOptions)

    • uploadFileWithOptionsAndAwait

      public String uploadFileWithOptionsAndAwait(String fileName, io.vertx.ext.mongo.GridFsUploadOptions options)
      Upload a file to gridfs with options

      Unlike the bare Vert.x variant, this method returns a String. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      fileName - the name of the file to store in gridfs
      options - GridFsUploadOptions for specifying metadata and chunk size
      Returns:
      The operation result
      See Also:
      • MongoGridFsClient.uploadFileWithOptions(String, GridFsUploadOptions)

    • uploadFileWithOptionsAndForget

      public MongoGridFsClient uploadFileWithOptionsAndForget(String fileName, io.vertx.ext.mongo.GridFsUploadOptions options)
      Upload a file to gridfs with options

      Unlike the bare Vert.x variant, this method ignores the String result or any failure.

      Parameters:
      fileName - the name of the file to store in gridfs
      options - GridFsUploadOptions for specifying metadata and chunk size
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • MongoGridFsClient.uploadFileWithOptions(String, GridFsUploadOptions)

    • readByFileName

      public ReadStream<io.vertx.core.buffer.Buffer> readByFileName(String fileName)
      Read file by name to ReadStream

    • readByFileNameWithOptions

      public ReadStream<io.vertx.core.buffer.Buffer> readByFileNameWithOptions(String fileName, io.vertx.ext.mongo.GridFsDownloadOptions options)
      Read file by name to ReadStream with options

    • readById

      public ReadStream<io.vertx.core.buffer.Buffer> readById(String id)
      Read file by id to ReadStream

    • close

      public void close()
      Close the client and release its resources

    • newInstance

      public static MongoGridFsClient newInstance(io.vertx.ext.mongo.MongoGridFsClient delegate)
      Creates a new instance of the MongoGridFsClient.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object