org.mule.modules.googlecloudstorage

Class GoogleCloudStorageConnector

java.lang.Object

org.mule.modules.googlecloudstorage.GoogleCloudStorageConnector

@Connector(name="google-cloud-storage",
           friendlyName="Google Cloud Storage",
           minMuleVersion="3.8")
 @RequiresEnterpriseLicense
public class GoogleCloudStorageConnector
extends Object

Constructor Summary

Constructors

Constructor and Description
GoogleCloudStorageConnector()

Method Summary

Modifier and Type	Method and Description
void	closeReadChannel(com.google.cloud.ReadChannel readChannel) Close a read channel
void	closeWriteChannel(com.google.cloud.WriteChannel writeChannel) Close a write channel
com.google.cloud.storage.Acl	createAcl(Object itemId, com.google.cloud.storage.Acl acl, AclSelector aclSelector) Create an ACL on a particular object(Blob, Bucket or Default) Access Control List Grant (ACL) read or write access to users for individual buckets or objects.
com.google.cloud.storage.Blob	createBlob(BlobInfoPojo blobInfo, List<com.google.cloud.storage.Storage.BlobTargetOption> blobTargetOption, InputStream data) Creates a Blob in a Bucket on Google Cloud Storage
com.google.cloud.storage.Bucket	createBucket(BucketInfoPojo bucketInfo, List<com.google.cloud.storage.Storage.BucketTargetOption> bucketTargetOptions) Creates a bucket on Google Cloud Storage
com.google.cloud.RestorableState<com.google.cloud.ReadChannel>	createReadRestorableState(com.google.cloud.ReadChannel readChannel) Create a restorable state for a read channel
com.google.cloud.RestorableState<com.google.cloud.WriteChannel>	createWriteRestorableState(com.google.cloud.WriteChannel writeChannel) Create a Write Restorable state
Boolean	deleteAcl(Object itemId, com.google.cloud.storage.Acl.Entity entity, AclSelector aclSelector) Delete an ACL for a particular object(Blob, Bucket or Default) Access Control List Grant (ACL) read or write access to users for individual buckets or objects.
Boolean	deleteBlob(BlobIdPojo blobId) Deletes a Blob from a Bucket on Google Cloud Storage
Boolean	deleteBucket(String bucketName, List<com.google.cloud.storage.Storage.BucketSourceOption> bucketSourceOptions) Deletes a bucket on Google Cloud Storage
InputStream	downloadBlob(String bucket, String blob, List<com.google.cloud.storage.Storage.BlobSourceOption> options) Download a particular blob
List<com.google.cloud.storage.Acl>	getAcl(Object itemId, AclSelector aclSelector) Get an ACL for a particular object(Blob, Bucket or Default) Access Control List (ACL) grant read or write access to users for individual buckets or objects.
com.google.cloud.storage.Blob	getBlob(BlobIdPojo blobId, List<com.google.cloud.storage.Storage.BlobGetOption> blobGetOptions) Retrieves Blob information from Google Cloud Storage
com.google.cloud.storage.Bucket	getBucket(String bucketName, List<com.google.cloud.storage.Storage.BucketGetOption> bucketGetOptions) Retrieves a Bucket from Google Cloud Storage
GoogleCloudStorageConnectionStrategy	getConfig()
List<com.google.cloud.storage.Blob>	listBlobs(String bucket, List<com.google.cloud.storage.Storage.BlobListOption> blobListOptions) List all blobs in a bucket
List<com.google.cloud.storage.Bucket>	listBuckets(List<com.google.cloud.storage.Storage.BucketListOption> bucketListOptions) Lists Buckets available on Google Cloud Storage
com.google.cloud.ReadChannel	openReadChannel(BlobIdPojo blobId, List<com.google.cloud.storage.Storage.BlobSourceOption> blobSourceOption) Open a read channel
com.google.cloud.WriteChannel	openWriteChannel(BlobInfoPojo blobInfo, List<BlobWriteOptionWrapper> options) Open a write channel
InputStream	readDataFromReadChannel(com.google.cloud.ReadChannel readChannel) Read data from a Read Channel
com.google.cloud.storage.Blob	relocateBlob(BlobIdPojo blobId, String targetBucket, String targetBlob) Relocate a blob from one bucket to another or/and one path to another
com.google.cloud.ReadChannel	restoreReadChannel(com.google.cloud.RestorableState<com.google.cloud.ReadChannel> restorableState) Restore a Read channel to a restorable state.
com.google.cloud.WriteChannel	restoreWriteChannel(com.google.cloud.RestorableState<com.google.cloud.WriteChannel> restorableState) Restore a write channel to a restorable state
void	setConfig(GoogleCloudStorageConnectionStrategy config)
URL	signBlob(com.google.cloud.storage.Blob blob, TimeUnit timeUnit, Long timeAmount, String keyPath) Generates a signed URL for a blob.
com.google.cloud.storage.Acl	updateAcl(Object itemId, com.google.cloud.storage.Acl acl, AclSelector aclSelector) Update an ACL for a particular object(Blob, Bucket or Default) Access Control List (ACL) grant read or write access to users for individual buckets or objects.
com.google.cloud.storage.Blob	updateBlob(com.google.cloud.storage.Blob blob, Map<String,String> updateData) Update/add blob Metadata
com.google.cloud.storage.Bucket	updateBucket(BucketInfoPojo bucketInfo, List<com.google.cloud.storage.Storage.BucketTargetOption> bucketTargetOptions) Updates a bucket on Google Cloud Storage
int	writeToChannel(com.google.cloud.WriteChannel writeChannel, InputStream data) Write to a Write Channel

Methods inherited from class java.lang.Object

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

Constructor Detail

GoogleCloudStorageConnector

public GoogleCloudStorageConnector()

Method Detail

createAcl

@Processor
public com.google.cloud.storage.Acl createAcl(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Item ID")
                                                         Object itemId,
                                                         @RefOnly
                                                         com.google.cloud.storage.Acl acl,
                                                         AclSelector aclSelector)
                                                  throws IncorrectSelectorException,
                                                         GoogleStorageApiException

Create an ACL on a particular object(Blob, Bucket or Default) Access Control List Grant (ACL) read or write access to users for individual buckets or objects.

Parameters:

itemId - The id of the object; BlobId if AclSelector is Blob, otherwise String containing bucket name.

acl - The ACL with the particular Role to be granted. Example: Acl.of(User.ofAllAuthenticatedUsers(), Role.OWNER); Valid Roles: OWNER, READER, WRITER

aclSelector - The the type of object onto which the ACL is created. Valid values: Blob, Bucket, Default

Returns:

ACL of the Object containing the read/write access privileges

Throws:

IncorrectSelectorException - When operation selected does not exist. Use AclSelector enum class to avoid any issue. Example: AclSelector.Blob Use AclSelector enum class to avoid any issue. Example: AclSelector.Blob

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes @see Google Cloud Storage error codes

getAcl

@Processor
public List<com.google.cloud.storage.Acl> getAcl(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Item ID")
                                                            Object itemId,
                                                            AclSelector aclSelector)
                                                     throws IncorrectSelectorException,
                                                            GoogleStorageApiException

Get an ACL for a particular object(Blob, Bucket or Default) Access Control List (ACL) grant read or write access to users for individual buckets or objects.

Parameters:

itemId - The id of the object; BlobId if AclSelector is Blob, otherwise String containing bucket name.

aclSelector - The the type of object onto which the ACL is created. Valid values: Blob, Bucket, Default

Returns:

list of ACLs assigned to the object

Throws:

IncorrectSelectorException - When operation selected does not exist. Use AclSelector enum class to avoid any issue. Example: AclSelector.Blob

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

updateAcl

@Processor
public com.google.cloud.storage.Acl updateAcl(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Item ID")
                                                         Object itemId,
                                                         @RefOnly
                                                         com.google.cloud.storage.Acl acl,
                                                         AclSelector aclSelector)
                                                  throws IncorrectSelectorException,
                                                         GoogleStorageApiException

Update an ACL for a particular object(Blob, Bucket or Default) Access Control List (ACL) grant read or write access to users for individual buckets or objects.

Parameters:

itemId - The id of the object; BlobId if AclSelector is Blob, otherwise String containing bucket name.

acl - The ACL with the particular Role to be granted. Example: Acl.of(User.ofAllAuthenticatedUsers(), Role.OWNER); Valid Roles: OWNER, READER, WRITER

aclSelector - The the type of object onto which the ACL is created. Valid values: Blob, Bucket, Default

Returns:

ACL of the Object

Throws:

IncorrectSelectorException - When operation selected does not exist. Use AclSelector enum class to avoid any issue. Example: AclSelector.Blob

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

deleteAcl

@Processor
public Boolean deleteAcl(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Item ID")
                                    Object itemId,
                                    @RefOnly
                                    com.google.cloud.storage.Acl.Entity entity,
                                    AclSelector aclSelector)
                             throws IncorrectSelectorException,
                                    GoogleStorageApiException

Delete an ACL for a particular object(Blob, Bucket or Default) Access Control List Grant (ACL) read or write access to users for individual buckets or objects.

Parameters:

itemId - The id of the object; BlobId if AclSelector is Blob, otherwise String containing bucket name.

entity - The entity to be deleted

aclSelector - The the type of object onto which the ACL is created. Valid values: Blob, Bucket, Default

Returns:

Whether the ACL was deleted.

Throws:

IncorrectSelectorException - When operation selected does not exist. Use AclSelector enum class to avoid any issue. Example: AclSelector.Blob

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

createBucket

@Processor
public com.google.cloud.storage.Bucket createBucket(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Bucket Info")
                                                               BucketInfoPojo bucketInfo,
                                                               @RefOnly @Optional @FriendlyName(value="Bucket Target Options")
                                                               List<com.google.cloud.storage.Storage.BucketTargetOption> bucketTargetOptions)
                                                        throws GoogleStorageApiException

Creates a bucket on Google Cloud Storage

Parameters:

bucketInfo - BucketInfoPojo

bucketTargetOptions - The bucket targeting options.

Returns:

The Bucket created.

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

deleteBucket

@Processor
public Boolean deleteBucket(@Default(value="#[payload]") @FriendlyName(value="Bucket Name")
                                       String bucketName,
                                       @RefOnly @Optional @FriendlyName(value="Bucket Source Options")
                                       List<com.google.cloud.storage.Storage.BucketSourceOption> bucketSourceOptions)
                                throws GoogleStorageApiException

Deletes a bucket on Google Cloud Storage

Parameters:

bucketName - The name of the bucket to be deleted.

bucketSourceOptions - The bucket sourcing options for deleting buckets. Example: BucketSourceOption.metagenerationMatch(long metageneration)

Returns:

true if bucket was deleted, false if it was not found

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

getBucket

@Processor
public com.google.cloud.storage.Bucket getBucket(@Default(value="#[payload]") @FriendlyName(value="Bucket Name")
                                                            String bucketName,
                                                            @RefOnly @Optional @FriendlyName(value="Bucket Options")
                                                            List<com.google.cloud.storage.Storage.BucketGetOption> bucketGetOptions)
                                                     throws GoogleStorageApiException

Retrieves a Bucket from Google Cloud Storage

Parameters:

bucketName - The name of the bucket

bucketGetOptions - The blob get options. Example: BucketGetOption.metagenerationMatch(long metageneration)

Returns:

The bucket that matches the criteria within the parameters

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

listBuckets

@Processor
public List<com.google.cloud.storage.Bucket> listBuckets(@RefOnly @Optional @FriendlyName(value="Bucket Options")
                                                                    List<com.google.cloud.storage.Storage.BucketListOption> bucketListOptions)
                                                             throws GoogleStorageApiException

Lists Buckets available on Google Cloud Storage

Parameters:

bucketListOptions - The bucket list options. Example: BucketListOption.pageSize(long pagesize) returns an option to specify the maximum number of buckets returned per page.

Returns:

The buckets that match the criteria within the parameters

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

updateBucket

@Processor
public com.google.cloud.storage.Bucket updateBucket(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Bucket Info")
                                                               BucketInfoPojo bucketInfo,
                                                               @RefOnly @Optional @FriendlyName(value="Bucket Target Options")
                                                               List<com.google.cloud.storage.Storage.BucketTargetOption> bucketTargetOptions)
                                                        throws GoogleStorageApiException

Updates a bucket on Google Cloud Storage

Parameters:

bucketInfo - BucketInfoPojo

bucketTargetOptions - The bucket target options. Example: BucketTargetOption.predefinedAcl(Acl acl) Returns an option for specifying bucket's predefined ACL configuration.

Returns:

The updated bucket

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

createBlob

@Processor
public com.google.cloud.storage.Blob createBlob(@RefOnly @FriendlyName(value="Blob Info")
                                                           BlobInfoPojo blobInfo,
                                                           @RefOnly @Optional @FriendlyName(value="Blob Target Options")
                                                           List<com.google.cloud.storage.Storage.BlobTargetOption> blobTargetOption,
                                                           @Default(value="#[payload]") @RefOnly @FriendlyName(value="Data")
                                                           InputStream data)
                                                    throws GoogleStorageApiException

Creates a Blob in a Bucket on Google Cloud Storage

Parameters:

blobInfo - BlobInfoPojo

blobTargetOption - The blob target options. Example: BlobTargetOption.doesNotExist() returns an option that causes an operation to succeed only if the target blob does not exist.

data - the data to be stored to the blob

Returns:

The created blob

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

deleteBlob

@Processor
public Boolean deleteBlob(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Blob ID")
                                     BlobIdPojo blobId)
                              throws GoogleStorageApiException

Deletes a Blob from a Bucket on Google Cloud Storage

Parameters:

blobId - BlobIdPojo

Returns:

Whether the blob has been deleted

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

getBlob

@Processor
public com.google.cloud.storage.Blob getBlob(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Blob ID")
                                                        BlobIdPojo blobId,
                                                        @RefOnly @Optional @FriendlyName(value="Blob Options")
                                                        List<com.google.cloud.storage.Storage.BlobGetOption> blobGetOptions)
                                                 throws GoogleStorageApiException

Retrieves Blob information from Google Cloud Storage

Parameters:

blobId - BlobIdPojo

blobGetOptions - The blob get options. Example: BlobGetOption.fields(BlobField... fields) returns an option to specify the blob's fields to be returned

Returns:

The blob retrieved

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

signBlob

@Processor
public URL signBlob(@RefOnly @Default(value="#[payload]")
                               com.google.cloud.storage.Blob blob,
                               @RefOnly @FriendlyName(value="Time Unit")
                               TimeUnit timeUnit,
                               @FriendlyName(value="Time Amount")
                               Long timeAmount,
                               @Optional @FriendlyName(value="Key Path")
                               String keyPath)
                        throws GoogleStorageApiException,
                               IOException

Generates a signed URL for a blob. If you have a blob that you want to allow access to for a fixed amount of time, you can use this method to generate a URL that is only valid within a certain time period. This is particularly useful if you don't want publicly accessible blobs, but also don't want to require users to explicitly log in. Signing a URL requires a service account signer.

Parameters:

blob - the blob to be signed

timeUnit - the time unit of the time amount

timeAmount - the time amount

keyPath - the path to the Key containing the service account info .json that will be used for signing the blob

Returns:

The signed URL

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

IOException

relocateBlob

@Processor
public com.google.cloud.storage.Blob relocateBlob(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Blob ID")
                                                             BlobIdPojo blobId,
                                                             @FriendlyName(value="Target Bucket")
                                                             String targetBucket,
                                                             @FriendlyName(value="Target Blob")
                                                             String targetBlob)
                                                      throws GoogleStorageApiException

Relocate a blob from one bucket to another or/and one path to another

Parameters:

blobId - BlobIdPojo

targetBucket - the name of the target bucket

targetBlob - the name of the target blob

Returns:

The relocated blob

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

updateBlob

@Processor
public com.google.cloud.storage.Blob updateBlob(@RefOnly @Default(value="#[payload]")
                                                           com.google.cloud.storage.Blob blob,
                                                           @RefOnly @FriendlyName(value="Data to Update")
                                                           Map<String,String> updateData)
                                                    throws GoogleStorageApiException

Update/add blob Metadata

Parameters:

blob - The blob to be updated

updateData - The metadata to be updated

Returns:

The updated blob

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

listBlobs

@Processor
public List<com.google.cloud.storage.Blob> listBlobs(@Default(value="#[payload]") @FriendlyName(value="Bucket Name")
                                                                String bucket,
                                                                @Optional @RefOnly @FriendlyName(value="Blob Options")
                                                                List<com.google.cloud.storage.Storage.BlobListOption> blobListOptions)
                                                         throws GoogleStorageApiException

List all blobs in a bucket

Parameters:

bucket - The name of the bucket

blobListOptions - The blob list options. Example: BlobListOption.pageSize(long pageSize) Returns an option to specify the maximum number of blobs returned per page.

Returns:

The list of blobs within the bucket

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

downloadBlob

@Processor
public InputStream downloadBlob(String bucket,
                                           @Default(value="#[payload]")
                                           String blob,
                                           @RefOnly @Optional @FriendlyName(value="Blob Source Options")
                                           List<com.google.cloud.storage.Storage.BlobSourceOption> options)
                                    throws GoogleStorageApiException

Download a particular blob

Parameters:

bucket - the name of the bucket which will be downloaded

blob - the name of the blob which will be downloaded

options - The blob source options. Example: BlobSourceOption.generationMatch() Returns an option for blob's data generation match. If this option is used the request will fail if blob's generation does not match. The generation value to compare with the actual blob's generation is taken from a source BlobId

Returns:

The inputStream

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

openReadChannel

@Processor
public com.google.cloud.ReadChannel openReadChannel(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Blob ID")
                                                               BlobIdPojo blobId,
                                                               @RefOnly @Optional @FriendlyName(value="Blob Source Options")
                                                               List<com.google.cloud.storage.Storage.BlobSourceOption> blobSourceOption)
                                                        throws GoogleStorageApiException

Open a read channel

Parameters:

blobId - BlobIdPojo

blobSourceOption - The blob source option Example: BlobSourceOption.generationMatch() Returns an option for blob's data generation match. If this option is used the request will fail if blob's generation does not match. The generation value to compare with the actual blob's generation is taken from a source BlobId

Returns:

The created read channel

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

createReadRestorableState

@Processor
public com.google.cloud.RestorableState<com.google.cloud.ReadChannel> createReadRestorableState(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Read Channel")
                                                                                                           com.google.cloud.ReadChannel readChannel)
                                                                                                    throws GoogleStorageApiException

Create a restorable state for a read channel

Parameters:

readChannel - The read channel for which the Restorable State will be created

Returns:

The created restorable state

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

readDataFromReadChannel

@Processor
public InputStream readDataFromReadChannel(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Read Channel")
                                                      com.google.cloud.ReadChannel readChannel)
                                               throws GoogleStorageApiException

Read data from a Read Channel

Parameters:

readChannel - The read channel from which data would be read

Returns:

The input stream from the Read Channel

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

closeReadChannel

@Processor
public void closeReadChannel(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Read Channel")
                                        com.google.cloud.ReadChannel readChannel)
                                 throws GoogleStorageApiException

Close a read channel

Parameters:

readChannel - The ReadChannel to be closed.

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

restoreReadChannel

@Processor
public com.google.cloud.ReadChannel restoreReadChannel(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Restorable State")
                                                                  com.google.cloud.RestorableState<com.google.cloud.ReadChannel> restorableState)
                                                           throws GoogleStorageApiException

Restore a Read channel to a restorable state.

Parameters:

restorableState - The state into which to restore the read channel.

Returns:

The restored ReadChannel

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

openWriteChannel

@Processor
public com.google.cloud.WriteChannel openWriteChannel(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Blob Info")
                                                                 BlobInfoPojo blobInfo,
                                                                 @Optional @RefOnly
                                                                 List<BlobWriteOptionWrapper> options)
                                                          throws GoogleStorageApiException

Open a write channel

Parameters:

blobInfo - BlobInfoPojo

options - BlobWriteOptionWrapper BlobWriteOptionWrapper allows Anypoint Studio to use datasense for this BlobWriteOption. Example: new BlobWriteOptionWrapper(BlobWriteOption.doesNotExist()) returns an option that causes an operation to succeed only if the target blob does not exist.

Returns:

The created write channel

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

createWriteRestorableState

@Processor
public com.google.cloud.RestorableState<com.google.cloud.WriteChannel> createWriteRestorableState(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Write Channel")
                                                                                                             com.google.cloud.WriteChannel writeChannel)
                                                                                                      throws GoogleStorageApiException

Create a Write Restorable state

Parameters:

writeChannel - The write channel for which the restorable state should be created for.

Returns:

The restorable state that can later be used to restore the blob into.

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

writeToChannel

@Processor
public int writeToChannel(@RefOnly @FriendlyName(value="Write Channel")
                                     com.google.cloud.WriteChannel writeChannel,
                                     @RefOnly @Default(value="#[payload]")
                                     InputStream data)
                              throws IOException,
                                     GoogleStorageApiException

Write to a Write Channel

Parameters:

writeChannel - The write channel that data will be written into.

data - The data to be written as an InputStream.

Returns:

The number of bytes written

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

IOException

closeWriteChannel

@Processor
public void closeWriteChannel(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Write Channel")
                                         com.google.cloud.WriteChannel writeChannel)
                                  throws IOException,
                                         GoogleStorageApiException

Close a write channel

Parameters:

writeChannel - The write channel to be closed.

Throws:

IOException - When the channel cannot be closed.

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

restoreWriteChannel

@Processor
public com.google.cloud.WriteChannel restoreWriteChannel(@RefOnly @Default(value="#[payload]") @FriendlyName(value="Restorable State")
                                                                    com.google.cloud.RestorableState<com.google.cloud.WriteChannel> restorableState)
                                                             throws GoogleStorageApiException

Restore a write channel to a restorable state

Parameters:

restorableState - The restorable state created before

Returns:

The write channel restored to the restorable state

Throws:

GoogleStorageApiException - When any exception is incurred during the operation. @see Google Cloud Storage error codes

getConfig

public GoogleCloudStorageConnectionStrategy getConfig()

setConfig

public void setConfig(GoogleCloudStorageConnectionStrategy config)