flowhooks

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

Overview

Name	flowhooks
Type	Resource
Id	google.apigee.flowhooks

Fields

The following fields are returned by SELECT queries:

organizations_environments_flowhooks_get

Successful response

Name	Datatype	Description
continueOnError	boolean	Optional. 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.
description	string	Description of the flow hook.
flowHookPoint	string	Output only. Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
sharedFlow	string	Shared flow attached to this flow hook, or empty if there is none attached.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_environments_flowhooks_get	select	organizationsId, environmentsId, flowhooksId		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.
organizations_environments_flowhooks_attach_shared_flow_to_flow_hook	exec	organizationsId, environmentsId, flowhooksId		Attaches a shared flow to a flow hook.
organizations_environments_flowhooks_detach_shared_flow_from_flow_hook	exec	organizationsId, environmentsId, flowhooksId		Detaches a shared flow from a flow hook.

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
environmentsId	string
flowhooksId	string
organizationsId	string

SELECT examples

organizations_environments_flowhooks_get

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
continueOnError,
description,
flowHookPoint,
sharedFlow
FROM google.apigee.flowhooks
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND flowhooksId = '{{ flowhooksId }}' -- required;

Lifecycle Methods

organizations_environments_flowhooks_attach_shared_flow_to_flow_hook

Attaches a shared flow to a flow hook.

EXEC google.apigee.flowhooks.organizations_environments_flowhooks_attach_shared_flow_to_flow_hook 
@organizationsId='{{ organizationsId }}' --required, 
@environmentsId='{{ environmentsId }}' --required, 
@flowhooksId='{{ flowhooksId }}' --required 
@@json=
'{
"description": "{{ description }}", 
"sharedFlow": "{{ sharedFlow }}", 
"continueOnError": {{ continueOnError }}
}';

organizations_environments_flowhooks_detach_shared_flow_from_flow_hook

Detaches a shared flow from a flow hook.

EXEC google.apigee.flowhooks.organizations_environments_flowhooks_detach_shared_flow_from_flow_hook 
@organizationsId='{{ organizationsId }}' --required, 
@environmentsId='{{ environmentsId }}' --required, 
@flowhooksId='{{ flowhooksId }}' --required;