Back to Genai Toolbox

cloud-storage-create-bucket

docs/en/integrations/cloud-storage/tools/cloud-storage-create-bucket.md

1.2.01.9 KB
Original Source

About

A cloud-storage-create-bucket tool creates a new Cloud Storage bucket in the project configured on the Cloud Storage source. Use it when an agent needs to provision a bucket before writing objects or building a data workflow.

Compatible Sources

{{< compatible-sources >}}

Requirements

The Cloud Storage credentials must be able to create buckets in the configured project. Bucket names are globally unique and must satisfy Cloud Storage bucket naming rules.

Parameters

parametertyperequireddescription
bucketstringtrueName of the Cloud Storage bucket to create.
locationstringfalseLocation for the bucket, e.g. "US", "EU", or "us-central1". Omit to use the Cloud Storage service default.
uniform_bucket_level_accessbooleanfalseWhether to enable uniform bucket-level access on the bucket. Defaults to false.

Example

yaml
kind: tool
name: create_bucket
type: cloud-storage-create-bucket
source: my-gcs-source
description: Use this tool to create Cloud Storage buckets.

Output Format

The tool returns a JSON object with:

fieldtypedescription
bucketstringCloud Storage bucket that was created.
createdbooleanWhether the bucket was created.
metadataobjectBucket metadata returned by the Cloud Storage API.

Reference

fieldtyperequireddescription
typestringtrueMust be "cloud-storage-create-bucket".
sourcestringtrueName of the Cloud Storage source to create buckets from.
descriptionstringtrueDescription of the tool that is passed to the LLM.