Back to Genai Toolbox

cloud-storage-delete-bucket

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

1.2.01.4 KB
Original Source

About

A cloud-storage-delete-bucket tool deletes an empty Cloud Storage bucket. It does not delete objects first; if the bucket is not empty, Cloud Storage rejects the operation.

Compatible Sources

{{< compatible-sources >}}

Requirements

The Cloud Storage credentials must be able to delete the target bucket. The bucket must be empty before the tool is invoked.

Parameters

parametertyperequireddescription
bucketstringtrueName of the empty Cloud Storage bucket to delete.

Example

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

Output Format

The tool returns a JSON object with:

fieldtypedescription
bucketstringCloud Storage bucket that was deleted.
deletedbooleanWhether the bucket was deleted.

Reference

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