Method: googleapis.workflowexecutions.v1.projects.locations.workflows.executions.deleteExecutionHistory

Deletes all step entries for an execution.

Arguments

Parameters
name

string

Required. Name of the execution for which step entries should be deleted. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response will be empty.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- deleteExecutionHistory:
    call: googleapis.workflowexecutions.v1.projects.locations.workflows.executions.deleteExecutionHistory
    args:
        name: ...
    result: deleteExecutionHistoryResult

JSON

[
  {
    "deleteExecutionHistory": {
      "call": "googleapis.workflowexecutions.v1.projects.locations.workflows.executions.deleteExecutionHistory",
      "args": {
        "name": "..."
      },
      "result": "deleteExecutionHistoryResult"
    }
  }
]