The Google Cloud Storage connector lets you connect to a Google Cloud Storage and perform file transfer operations.
Before using the Cloud Storage connector, do the following tasks:
roles/secretmanager.viewerroles/secretmanager.secretAccessorroles/storage.adminA service account is a special type of Google account intended to represent a non-human user that needs to authenticate and be authorized to access data in Google APIs. If you don't have a service account, you must create a service account. The connector and the service account must belong to the same project. For more information, see Creating a service account.
secretmanager.googleapis.com (Secret Manager API)connectors.googleapis.com (Connectors API)To understand how to enable services, see Enabling services.
If these services or permissions have not been enabled for your project previously, you are prompted to enable them when configuring the connector.
A connection is specific to a data source. It means that if you have many data sources, you must create a separate connection for each data source. To create a connection, do the following:
For the list of all the supported regions, see Locations.
Connection names must meet the following criteria:
Error.
A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.
All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.
However, it is possible that a connector doesn't support or have any entities, in which case the
Entities list will be empty.
Selecting an entity from the available list, generates a list of
operations available for the entity. For a detailed description of the operations, see the Connectors task's
entity operations.
However, if a connector doesn't support any of the entity operations, such unsupported
operations aren't listed in the Operations list.
Actions list will be empty.
The Google Cloud Storage connector can process a maximum of 10 transactions per second, per node, and throttles any transactions beyond this limit. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.
For information on the limits applicable to Integration Connectors, see Limits.
The Google Cloud Storage connection supports the following actions:
The following table describes the input parameters of the DownloadObject action.
| Parameter name | Required | Data type | Description |
|---|---|---|---|
| Bucket | Yes | String | Bucket name where the object to be downloaded is present. |
| ObjectFilePath | No | String | Name of the object that should be downloaded. If not specified, all
the objects from the specified bucket will be downloaded.
If the object to download is present in a child folder of a bucket, you must
provide the full path of such object. For example, to download |
| HasBytes | No | Boolean | Whether to download content as bytes. The valid values are true or false.
If set to true, the content is downloaded as a Base64 encoded string.
By default, the |
| UpdatedEndDate | No | Date | The end date range to download objects. If not specified, objects
will be downloaded from the specified UpdatedStartDate until the present day. |
| UpdatedStartDate | No | Date | The start of the date range to download objects. If not specified, objects
will be downloaded from the beginning of the time until the UpdatedEndDate. |
For examples on how to configure the DownloadObject action, see Examples.
The following table describes the input parameters of the UploadObject action.
| Parameter name | Required | Data type | Description |
|---|---|---|---|
| Bucket | Yes | String | Bucket name where the object will be uploaded. |
| FolderPath | No | String | The path to the folder where the object should be uploaded. |
| ContentBytes | No | String | Content to upload in the form of bytes (Base64 encoded string). |
| HasBytes | No | Boolean | Whether to upload content as bytes. Valid values; true or false.
If set to true, the content you want to upload should be a Base64 encoded string.
By default, the |
| Content | Yes | String | The content to be uploaded. |
| ObjectName | No | String | Name of the object that will be uploaded. |
For examples on how to configure the UploadObject action, see Examples.
The following table describes the input parameters of the CopyObject action.
| Parameter name | Required | Data type | Description |
|---|---|---|---|
| BucketSource | Yes | String | Bucket name from which you want to copy the object. |
| ObjectSource | Yes | String | Full path of the folder where you want to copy the object. |
| BucketDestination | Yes | String | Bucket name to which you want to copy the object. |
| ObjectDestination | No | String | Full path of the destination including the object name. If you don't specify any object name, the name of the source object is retained. |
For examples on how to configure the CopyObject action, see Examples.
The following table describes the input parameters of the MoveObject action.
| Parameter name | Required | Data type | Description |
|---|---|---|---|
| BucketSource | Yes | String | Bucket name from which you want to move the object. |
| ObjectSource | Yes | String | Full path of the folder where you want to move the object. |
| BucketDestination | Yes | String | Bucket name to which you want to move the object. |
| ObjectDestination | No | String | Full path of the destination including the object name. If you don't specify any object name, the name of the source object is retained. |
The following table describes the input parameters of the DeleteObject action.
| Parameter name | Required | Data type | Description |
|---|---|---|---|
| BucketSource | Yes | String | Bucket name where the object to be deleted is present. |
| ObjectSource | Yes | String | Name of the object that you want to delete. |
| Generation | No | Double | Version of the object to delete. If present, deletes the specified revision of the object as opposed to the latest version, which is the default behaviour. |
| IfGenerationMatch | No | Double | Makes the delete operation conditional on whether the object's current generation matches the given
value. Setting this value to |
| IfGenerationNotMatch | No | Double | Makes the delete operation conditional on whether the object's current generation does not match the
given value. If no live object exists, the precondition fails. Setting this value to
0 makes the operation succeed only if there is a live version of the object. |
| IfMetagenerationMatch | No | Double | Makes the delete operation conditional on whether the object's current metageneration matches the specified value. |
| IfMetagenerationNotMatch | No | Double | Makes the delete operation conditional on whether the object's current metageneration does not match the specified value. |
The following table describes the input parameters of the SignURL action which
creates a signed URL for the specified object.
| Parameter name | Required | Data type | Description |
|---|---|---|---|
| Bucket | Yes | String | The bucket name where the object resides. |
| Object | Yes | String | The name of the object to generate the SignedURL for. |
| RequestMethod | No | String | The method that the signed request will use. The default value is GET. |
| Location | No | String | Location of the specified bucket. The default value is auto. |
| ActiveDateTime | No | String | The dateTime when the SignedURL will become active. If not specified the current dateTime will be used. |
| Query | No | String | The query string that must be included when using the SignedURL, if not specified no query string will be used. |
| CustomHeaders | No | String | A comma separated list of name=value of the headers to use with the SignedURL, if not specified not custom headers will be used. |
| ExpiresIn | Yes | String | The expiration time for the SignedURL it should be in the format: 1d2h3m4s, the maximum value is 7d0h0m0s. |
| HMAC Access ID | Yes | String | The HMAC access ID. For information, see HMAC keys. |
| HMAC Secret | Yes | String | The HMAC secret. |
This examples in this section describe the following operations:
The following table lists the sample scenarios and the corresponding configuration in the Connectors task:
| Task | Configuration |
|---|---|
| List all objects |
This lists all the objects in all the buckets. The objects are listed in
the |
| List all objects in a bucket |
|
| List objects using the LIKE filter for name |
|
| List all buckets |
|
| Download an object |
This example downloads the |
| Download a binary object |
The steps to download a binary object are the same as downloading a regular object as
previously described. Additionally, you must specify the { "Bucket": "bucket-test-01", "ObjectFilePath": "image01.png", "HasBytes" : true } If the download is successful, the output in the { "Success": "true", "ContentBytes": "SGVsbG8gdGVzdCE\u003d" } By default, the If the file, contains special characters, such as ä, Ø, Thành, do the following:
|
| Upload a binary object to a bucket |
This example creates the |
| Upload an object to a bucket |
This example creates the |
| Upload an object to a folder |
This example creates the |
| Copy an object |
This example copies the If the copy is successful, the output in the { "Success": "true" } |
| Move an object |
This example moves the If the copy is successful, the output in the { "Success": "true" } |
| Delete an object |
This example deletes the If the copy is successful, the output in the { "Success": "true" } |
| Create a signed URL for an object |
This example creates a signed URL for the {
"Success": "true",
"SignURL": "https://storage.googleapis.com/example-bucket/cat.jpeg?X-Goog-Algorithm=
GOOG4-RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount.com
%2F20181026%2Fus-central1%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T18
1309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f16
9edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa849
6def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dc
c1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c2058
0e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a
66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823
a29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b13344703
2ea7abedc098d2eb14a7"
} |
UploadObject action. You can upload only a single file.You can use the Terraform resource to create a new connection.
To learn how to apply or remove a Terraform configuration, see Basic Terraform commands.
To view a sample terraform template for connection creation, see sample template.
When creating this connection by using Terraform, you must set the following variables in your Terraform configuration file:
| Parameter name | Data type | Required | Description |
|---|---|---|---|
| project_id | STRING | True | The ID of the Google Cloud project where the data resides. |
After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-06-09 UTC.