The documentation you are viewing is for Dapr v1.4 which is an older version of Dapr. For up-to-date documentation, see the latest version.

GCP Storage Bucket binding spec

Detailed documentation on the GCP Storage Bucket binding component

Component format

To setup GCP Storage Bucket binding create a component of type bindings.gcp.bucket. See this guide on how to create and apply a binding configuration.

kind: Component
  name: <NAME>
  namespace: <NAMESPACE>
  type: bindings.gcp.bucket
  version: v1
  - name: bucket
    value: mybucket
  - name: type
    value: service_account
  - name: project_id
    value: project_111
  - name: private_key_id
    value: *************
  - name: client_email
  - name: client_id
    value: '1111111111111111'
  - name: auth_uri
  - name: token_uri
  - name: auth_provider_x509_cert_url
  - name: client_x509_cert_url
  - name: private_key
    value: PRIVATE KEY

Spec metadata fields

Field Required Binding support Details Example
bucket Y Output The bucket name "mybucket"
type Y Output Tge GCP credentials type "service_account"
project_id Y Output GCP project id projectId
private_key_id Y Output GCP private key id "privateKeyId"
private_key Y Output GCP credentials private key. Replace with x509 cert 12345-12345
client_email Y Output GCP client email ""
client_id Y Output GCP client id 0123456789-0123456789
auth_uri Y Output Google account OAuth endpoint
token_uri Y Output Google account token uri
auth_provider_x509_cert_url Y Output GCP credentials cert url
client_x509_cert_url Y Output GCP credentials project x509 cert url<PROJECT_NAME>

Binding support

This component supports output binding with the following operations:

  • create

Create file

To perform a create operation, invoke the GCP Storage Bucket binding with a POST method and the following JSON body:

Note: by default, a random UUID is generated. See below for Metadata support to set the name

  "operation": "create",
  "data": "YOUR_CONTENT"


Save text to a random generated UUID file

On Windows, utilize cmd prompt (PowerShell has different escaping mechanism)

curl -d "{ \"operation\": \"create\", \"data\": \"Hello World\" }" http://localhost:<dapr-port>/v1.0/bindings/<binding-name>

curl -d '{ "operation": "create", "data": "Hello World" }' \
Save text to a specific file

curl -d "{ \"operation\": \"create\", \"data\": \"Hello World\", \"metadata\": { \"name\": \"my-test-file.txt\" } }" \

curl -d '{ "operation": "create", "data": "Hello World", "metadata": { "name": "my-test-file.txt" } }' \
Upload a file

To upload a file, pass the file contents as the data payload; you may want to encode this in e.g. Base64 for binary content.

Then you can upload it as you would normally:

curl -d "{ \"operation\": \"create\", \"data\": \"(YOUR_FILE_CONTENTS)\", \"metadata\": { \"name\": \"my-test-file.jpg\" } }" http://localhost:<dapr-port>/v1.0/bindings/<binding-name>

curl -d '{ "operation": "create", "data": "$(cat my-test-file.jpg)", "metadata": { "name": "my-test-file.jpg" } }' \

Last modified July 12, 2022 : update nav bar for v1.4 (#2641) (2db803e)