Skip to main content

flowhooks

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

Overview

Nameflowhooks
TypeResource
Idgoogle.apigee.flowhooks

Fields

NameDatatypeDescription
descriptionstringDescription of the flow hook.
continueOnErrorbooleanOptional. Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true.
flowHookPointstringOutput only. Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
sharedFlowstringShared flow attached to this flow hook, or empty if there is none attached.

Methods

NameAccessible byRequired ParamsDescription
organizations_environments_flowhooks_getSELECTenvironmentsId, flowhooksId, organizationsIdReturns the name of the shared flow attached to the specified flow hook. If there's no shared flow attached to the flow hook, the API does not return an error; it simply does not return a name in the response.
organizations_environments_flowhooks_attach_shared_flow_to_flow_hookEXECenvironmentsId, flowhooksId, organizationsIdAttaches a shared flow to a flow hook.
organizations_environments_flowhooks_detach_shared_flow_from_flow_hookEXECenvironmentsId, flowhooksId, organizationsIdDetaches a shared flow from a flow hook.

SELECT examples

Returns the name of the shared flow attached to the specified flow hook. If there's no shared flow attached to the flow hook, the API does not return an error; it simply does not return a name in the response.

SELECT
description,
continueOnError,
flowHookPoint,
sharedFlow
FROM google.apigee.flowhooks
WHERE environmentsId = '{{ environmentsId }}'
AND flowhooksId = '{{ flowhooksId }}'
AND organizationsId = '{{ organizationsId }}';