Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.
This method waits—the workflow execution is paused—until the operation is
complete, fails, or times out. The default timeout value is 1800
seconds (30
minutes) and can be changed to a maximum value of 31536000
seconds (one year)
for long-running operations using the connector_params
field. See the Connectors reference
.
The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors .
The polling policy for the long-running operation can be configured. To set the
connector-specific parameters ( connector_params
), refer to Invoke a connector call
.
Arguments
name
string
Required. The resource name of a TagKey to be deleted in the format tagKeys/123
. The TagKey cannot be a parent of any existing TagValues or it will not be deleted successfully.
etag
string
Optional. The etag known to the client for the expected state of the TagKey. This is to be used for optimistic concurrency.
validateOnly
boolean
Optional. Set as true to perform validations necessary for deletion, but not actually perform the action.
Raised exceptions
ConnectionError
HttpError
TimeoutError
TypeError
ValueError
OperationError
ResponseTypeError
Response
If successful, the response contains an instance of Operation
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation .
YAML
- delete : call : googleapis.cloudresourcemanager.v3.tagKeys.delete args : name : ... etag : ... validateOnly : ... result : deleteResult
JSON
[ { "delete" : { "call" : "googleapis.cloudresourcemanager.v3.tagKeys.delete" , "args" : { "name" : "..." , "etag" : "..." , "validateOnly" : "..." }, "result" : "deleteResult" } } ]
