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,java.lang.Boolean>

@EachBean(value=GoogleCloudStorageConfiguration.class)
public class GoogleCloudStorageOperations
extends java.lang.Object
implements ObjectStorageOperations<com.google.cloud.storage.BlobInfo.Builder,com.google.cloud.storage.Blob,java.lang.Boolean>

Google Cloud implementation of ObjectStorageOperations.

Since:

1.0

Author:

Pavol Gressa

Constructor Summary

Constructors

Constructor and Description
GoogleCloudStorageOperations(GoogleCloudStorageConfiguration configuration, InputStreamMapper inputStreamMapper, com.google.cloud.storage.Storage storage) Constructor.

Method Summary

Modifier and Type	Method and Description
void	copy(java.lang.String sourceKey, java.lang.String destinationKey) Copies an object stored at sourceKey to destinationKey, within the same object storage (bucket/container).
protected com.google.cloud.storage.BlobInfo.Builder	createBlobInfoBuilder(UploadRequest uploadRequest)
java.lang.Boolean	delete(java.lang.String key) Deletes an object from the object storage.
boolean	exists(java.lang.String key) Checks whether an entry with the given key exists in the object storage.
java.util.Set<java.lang.String>	listObjects() Lists the objects that exist in the object storage.
java.util.Optional<GoogleCloudStorageEntry>	retrieve(java.lang.String key) Gets the object from object storage.
UploadResponse<com.google.cloud.storage.Blob>	upload(UploadRequest uploadRequest) Uploads an object to the object storage.
UploadResponse<com.google.cloud.storage.Blob>	upload(UploadRequest uploadRequest, java.util.function.Consumer<com.google.cloud.storage.BlobInfo.Builder> uploadRequestBuilder) Uploads an object to the object storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

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 Detail

upload

@NonNull
public UploadResponse<com.google.cloud.storage.Blob> upload(@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,java.lang.Boolean>

Parameters:

uploadRequest - the upload request

Returns:

the upload response

upload

@NonNull
public UploadResponse<com.google.cloud.storage.Blob> upload(@NonNull
                                                                     UploadRequest uploadRequest,
                                                                     @NonNull
                                                                     java.util.function.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,java.lang.Boolean>

Parameters:

uploadRequest - the upload request

uploadRequestBuilder - Upload request builder consumer

Returns:

the upload response

retrieve

@NonNull
public java.util.Optional<GoogleCloudStorageEntry> retrieve(@NonNull
                                                                     java.lang.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,java.lang.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 java.lang.Boolean delete(@NonNull
                                         java.lang.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,java.lang.Boolean>

Parameters:

key - object path in the format /foo/bar/file

Returns:

Cloud vendor-specific delete response.

exists

public boolean exists(@NonNull
                      java.lang.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,java.lang.Boolean>

Parameters:

key - object path in the format /foo/bar/file

Returns:

true if the entry exists, false otherwise.

listObjects

@NonNull
public java.util.Set<java.lang.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,java.lang.Boolean>

Returns:

a list of keys (paths) of the existing objects, if any, or an empty list otherwise.

copy

public void copy(@NonNull
                 java.lang.String sourceKey,
                 @NonNull
                 java.lang.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,java.lang.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
                                                                                   UploadRequest uploadRequest)

Parameters:

uploadRequest - Upload Request

Returns:

BlobInfo Builder