Skip to main content

callbacks

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

Overview​

Namecallbacks
TypeResource
Idgoogle.workflowexecutions.callbacks

Fields​

The following fields are returned by SELECT queries:

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

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectprojectsId, locationsId, workflowsId, executionsIdpageSize, pageTokenReturns 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.

NameDatatypeDescription
executionsIdstring
locationsIdstring
projectsIdstring
workflowsIdstring
pageSizeinteger (int32)
pageTokenstring

SELECT examples​

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 }}'
;