Package io.micronaut.objectstorage.googlecloud

Class GoogleCloudStorageOperations

java.lang.Object
io.micronaut.objectstorage.googlecloud.GoogleCloudStorageOperations
All Implemented Interfaces:
ObjectStorageOperations<com.google.cloud.storage.BlobInfo.Builder,com.google.cloud.storage.Blob,Boolean>
@EachBean(GoogleCloudStorageConfiguration.class) @Requires(condition=ToggeableCondition.class) @Requires(beans=GoogleCloudStorageConfiguration.class) public class GoogleCloudStorageOperations extends Object implements ObjectStorageOperations<com.google.cloud.storage.BlobInfo.Builder,com.google.cloud.storage.Blob,Boolean>
Google Cloud implementation of ObjectStorageOperations.
Since:
1.0
Author:
Pavol Gressa

  • Constructor Details

    • GoogleCloudStorageOperations

      public GoogleCloudStorageOperations(@Parameter GoogleCloudStorageConfiguration configuration, InputStreamMapper inputStreamMapper, com.google.cloud.storage.Storage storage)
      Constructor.
      Parameters:
      configuration - Google Storage Configuration
      inputStreamMapper - Input Stream Mapper
      storage - Interface for Google Cloud Storage

  • Method Details

    • upload

      @NonNull public @NonNull UploadResponse<com.google.cloud.storage.Blob> upload(@NonNull @NonNull UploadRequest uploadRequest)
      Description copied from interface: ObjectStorageOperations
      Uploads an object to the object storage. If there is an existing entry, it will be updated.
      Specified by:
      upload in interface ObjectStorageOperations<com.google.cloud.storage.BlobInfo.Builder,com.google.cloud.storage.Blob,Boolean>
      Parameters:
      uploadRequest - the upload request
      Returns:
      the upload response

    • upload

      @NonNull public @NonNull UploadResponse<com.google.cloud.storage.Blob> upload(@NonNull @NonNull UploadRequest uploadRequest, @NonNull @NonNull Consumer<com.google.cloud.storage.BlobInfo.Builder> uploadRequestBuilder)
      Description copied from interface: ObjectStorageOperations
      Uploads an object to the object storage. If there is an existing entry, it will be updated.
      Specified by:
      upload in interface ObjectStorageOperations<com.google.cloud.storage.BlobInfo.Builder,com.google.cloud.storage.Blob,Boolean>
      Parameters:
      uploadRequest - the upload request
      uploadRequestBuilder - Upload request builder consumer
      Returns:
      the upload response

    • retrieve

      @NonNull public @NonNull Optional<GoogleCloudStorageEntry> retrieve(@NonNull @NonNull String key)
      Description copied from interface: ObjectStorageOperations
      Gets the object from object storage.
      Specified by:
      retrieve in interface ObjectStorageOperations<com.google.cloud.storage.BlobInfo.Builder,com.google.cloud.storage.Blob,Boolean>
      Parameters:
      key - the object path in the format /foo/bar/file
      Returns:
      the object, or empty optional if the object does not exist

    • delete

      @NonNull public @NonNull Boolean delete(@NonNull @NonNull String key)
      Description copied from interface: ObjectStorageOperations
      Deletes an object from the object storage.
      Specified by:
      delete in interface ObjectStorageOperations<com.google.cloud.storage.BlobInfo.Builder,com.google.cloud.storage.Blob,Boolean>
      Parameters:
      key - object path in the format /foo/bar/file
      Returns:
      Cloud vendor-specific delete response.

    • exists

      public boolean exists(@NonNull @NonNull String key)
      Description copied from interface: ObjectStorageOperations
      Checks whether an entry with the given key exists in the object storage.
      Specified by:
      exists in interface ObjectStorageOperations<com.google.cloud.storage.BlobInfo.Builder,com.google.cloud.storage.Blob,Boolean>
      Parameters:
      key - object path in the format /foo/bar/file
      Returns:
      true if the entry exists, false otherwise.

    • listObjects

      @NonNull public @NonNull Set<String> listObjects()
      Description copied from interface: ObjectStorageOperations
      Lists the objects that exist in the object storage.
      Specified by:
      listObjects in interface ObjectStorageOperations<com.google.cloud.storage.BlobInfo.Builder,com.google.cloud.storage.Blob,Boolean>
      Returns:
      a list of keys (paths) of the existing objects, if any, or an empty list otherwise.

    • copy

      public void copy(@NonNull @NonNull String sourceKey, @NonNull @NonNull String destinationKey)
      Description copied from interface: ObjectStorageOperations
      Copies an object stored at sourceKey to destinationKey, within the same object storage (bucket/container). If the destination exists, it will be overwritten.
      Specified by:
      copy in interface ObjectStorageOperations<com.google.cloud.storage.BlobInfo.Builder,com.google.cloud.storage.Blob,Boolean>
      Parameters:
      sourceKey - the key of the source object
      destinationKey - the key of the destination object

    • createBlobInfoBuilder

      @NonNull protected com.google.cloud.storage.BlobInfo.Builder createBlobInfoBuilder(@NonNull @NonNull UploadRequest uploadRequest)
      Parameters:
      uploadRequest - Upload Request
      Returns:
      BlobInfo Builder