1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.environments.html">environments</a> . <a href="apigee_v1.organizations.environments.flowhooks.html">flowhooks</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#attachSharedFlowToFlowHook">attachSharedFlowToFlowHook(name, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Attaches a shared flow to a flow hook.</p> 80<p class="toc_element"> 81 <code><a href="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#detachSharedFlowFromFlowHook">detachSharedFlowFromFlowHook(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Detaches a shared flow from a flow hook.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">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.</p> 89<h3>Method Details</h3> 90<div class="method"> 91 <code class="details" id="attachSharedFlowToFlowHook">attachSharedFlowToFlowHook(name, body=None, x__xgafv=None)</code> 92 <pre>Attaches a shared flow to a flow hook. 93 94Args: 95 name: string, Required. Name of the flow hook to which the shared flow should be attached in the following format: `organizations/{org}/environments/{env}/flowhooks/{flowhook}` (required) 96 body: object, The request body. 97 The object takes the form of: 98 99{ 100 "continueOnError": True or False, # 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`. 101 "description": "A String", # Description of the flow hook. 102 "flowHookPoint": "A String", # Output only. Where in the API call flow the flow hook is invoked. Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, or `PostTargetFlowHook`. 103 "sharedFlow": "A String", # Shared flow attached to this flow hook, or empty if there is none attached. 104} 105 106 x__xgafv: string, V1 error format. 107 Allowed values 108 1 - v1 error format 109 2 - v2 error format 110 111Returns: 112 An object of the form: 113 114 { 115 "continueOnError": True or False, # 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`. 116 "description": "A String", # Description of the flow hook. 117 "flowHookPoint": "A String", # Output only. Where in the API call flow the flow hook is invoked. Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, or `PostTargetFlowHook`. 118 "sharedFlow": "A String", # Shared flow attached to this flow hook, or empty if there is none attached. 119}</pre> 120</div> 121 122<div class="method"> 123 <code class="details" id="close">close()</code> 124 <pre>Close httplib2 connections.</pre> 125</div> 126 127<div class="method"> 128 <code class="details" id="detachSharedFlowFromFlowHook">detachSharedFlowFromFlowHook(name, x__xgafv=None)</code> 129 <pre>Detaches a shared flow from a flow hook. 130 131Args: 132 name: string, Required. Name of the flow hook to detach in the following format: `organizations/{org}/environments/{env}/flowhooks/{flowhook}` (required) 133 x__xgafv: string, V1 error format. 134 Allowed values 135 1 - v1 error format 136 2 - v2 error format 137 138Returns: 139 An object of the form: 140 141 { 142 "continueOnError": True or False, # 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`. 143 "description": "A String", # Description of the flow hook. 144 "flowHookPoint": "A String", # Output only. Where in the API call flow the flow hook is invoked. Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, or `PostTargetFlowHook`. 145 "sharedFlow": "A String", # Shared flow attached to this flow hook, or empty if there is none attached. 146}</pre> 147</div> 148 149<div class="method"> 150 <code class="details" id="get">get(name, x__xgafv=None)</code> 151 <pre>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. 152 153Args: 154 name: string, Required. Name of the flow hook in the following format: `organizations/{org}/environments/{env}/flowhooks/{flowhook}` (required) 155 x__xgafv: string, V1 error format. 156 Allowed values 157 1 - v1 error format 158 2 - v2 error format 159 160Returns: 161 An object of the form: 162 163 { 164 "continueOnError": True or False, # 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`. 165 "description": "A String", # Description of the flow hook. 166 "flowHookPoint": "A String", # Output only. Where in the API call flow the flow hook is invoked. Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, or `PostTargetFlowHook`. 167 "sharedFlow": "A String", # Shared flow attached to this flow hook, or empty if there is none attached. 168}</pre> 169</div> 170 171</body></html>