Google Sheets DeleteSpreadsheet

Google Sheets DeleteSpreadsheet

Certified

Delete a Google Spreadsheet

Deletes a spreadsheet by ID using a service account; calls Drive delete under the hood

yaml
type: io.kestra.plugin.googleworkspace.sheets.DeleteSpreadsheet

Deletes a spreadsheet in google workspace

yaml
         id: googleworkspace_sheets_delete
         namespace: company.team

         inputs:
           - id: serviceAccount
             type: STRING

         tasks:
           - id: delete_spreadsheet
             type: io.kestra.plugin.googleworkspace.sheets.DeleteSpreadsheet
             serviceAccount: "{{ inputs.serviceAccount }}"
             spreadsheetId: "xxxxxxxxxxxxxxxx"
Installation

Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:

kestractl plugins get io.kestra.plugin:plugin-googleworkspace --compatible-for $KESTRA_VERSION

For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.

For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.

Properties

Spreadsheet ID

ID of the spreadsheet to delete

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Default120

The read timeout for the request (in seconds)

SubTypestring
Default["https://www.googleapis.com/auth/spreadsheets"]

The GCP scopes to used

The GCP service account key

Deleted spreadsheet ID