callbacks

Creates, updates, deletes, gets or lists a callbacks resource.

Overview

Name	callbacks
Type	Resource
Id	google.workflowexecutions.callbacks

Fields

The following fields are returned by SELECT queries:

list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the callback. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/callback/{callback}
availablePayloads	array	Output only. The payloads received by the callback that have not been processed by a waiting execution step.
method	string	Output only. The method accepted by the callback. For example: GET, POST, PUT.
waiters	string (int64)	Output only. Number of execution steps waiting on this callback.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	projectsId, locationsId, workflowsId, executionsId	pageSize, pageToken	Returns a list of active callbacks that belong to the execution with the given name. The returned callbacks are ordered by callback ID.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
executionsId	string
locationsId	string
projectsId	string
workflowsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

list

Returns a list of active callbacks that belong to the execution with the given name. The returned callbacks are ordered by callback ID.

SELECT
name,
availablePayloads,
method,
waiters
FROM google.workflowexecutions.callbacks
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND workflowsId = '{{ workflowsId }}' -- required
AND executionsId = '{{ executionsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';