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.sharedflows.html">sharedflows</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="apigee_v1.organizations.sharedflows.deployments.html">deployments()</a></code> 79</p> 80<p class="firstline">Returns the deployments Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="apigee_v1.organizations.sharedflows.revisions.html">revisions()</a></code> 84</p> 85<p class="firstline">Returns the revisions Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="#close">close()</a></code></p> 89<p class="firstline">Close httplib2 connections.</p> 90<p class="toc_element"> 91 <code><a href="#create">create(parent, action=None, body=None, name=None, x__xgafv=None)</a></code></p> 92<p class="firstline">Uploads a ZIP-formatted shared flow configuration bundle to an organization. If the shared flow already exists, this creates a new revision of it. If the shared flow does not exist, this creates it. Once imported, the shared flow revision must be deployed before it can be accessed at runtime. The size limit of a shared flow bundle is 15 MB.</p> 93<p class="toc_element"> 94 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 95<p class="firstline">Deletes a shared flow and all it's revisions. The shared flow must be undeployed before you can delete it.</p> 96<p class="toc_element"> 97 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 98<p class="firstline">Gets a shared flow by name, including a list of its revisions.</p> 99<p class="toc_element"> 100 <code><a href="#list">list(parent, includeMetaData=None, includeRevisions=None, x__xgafv=None)</a></code></p> 101<p class="firstline">Lists all shared flows in the organization.</p> 102<h3>Method Details</h3> 103<div class="method"> 104 <code class="details" id="close">close()</code> 105 <pre>Close httplib2 connections.</pre> 106</div> 107 108<div class="method"> 109 <code class="details" id="create">create(parent, action=None, body=None, name=None, x__xgafv=None)</code> 110 <pre>Uploads a ZIP-formatted shared flow configuration bundle to an organization. If the shared flow already exists, this creates a new revision of it. If the shared flow does not exist, this creates it. Once imported, the shared flow revision must be deployed before it can be accessed at runtime. The size limit of a shared flow bundle is 15 MB. 111 112Args: 113 parent: string, Required. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}` (required) 114 body: object, The request body. 115 The object takes the form of: 116 117{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. 118 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 119 "data": "A String", # The HTTP request/response body as raw binary. 120 "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. 121 { 122 "a_key": "", # Properties of the object. Contains field @type with type URL. 123 }, 124 ], 125} 126 127 action: string, Required. Must be set to either `import` or `validate`. 128 name: string, Required. The name to give the shared flow 129 x__xgafv: string, V1 error format. 130 Allowed values 131 1 - v1 error format 132 2 - v2 error format 133 134Returns: 135 An object of the form: 136 137 { # The metadata describing a shared flow revision. 138 "configurationVersion": { # Version of the API proxy configuration schema. Currently, only 4.0 is supported. # The version of the configuration schema to which this shared flow conforms. The only supported value currently is majorVersion 4 and minorVersion 0. This setting may be used in the future to enable evolution of the shared flow format. 139 "majorVersion": 42, # Major version of the API proxy configuration schema. 140 "minorVersion": 42, # Minor version of the API proxy configuration schema. 141 }, 142 "contextInfo": "A String", # A textual description of the shared flow revision. 143 "createdAt": "A String", # Time at which this shared flow revision was created, in milliseconds since epoch. 144 "description": "A String", # Description of the shared flow revision. 145 "displayName": "A String", # The human readable name of this shared flow. 146 "entityMetaDataAsProperties": { # A Key-Value map of metadata about this shared flow revision. 147 "a_key": "A String", 148 }, 149 "lastModifiedAt": "A String", # Time at which this shared flow revision was most recently modified, in milliseconds since epoch. 150 "name": "A String", # The resource ID of the parent shared flow. 151 "policies": [ # A list of policy names included in this shared flow revision. 152 "A String", 153 ], 154 "resourceFiles": { # List of resource files. # The resource files included in this shared flow revision. 155 "resourceFile": [ # List of resource files. 156 { # Metadata about a resource file. 157 "name": "A String", # ID of the resource file. 158 "type": "A String", # Resource file type. {{ resource_file_type }} 159 }, 160 ], 161 }, 162 "resources": [ # A list of the resources included in this shared flow revision formatted as "{type}://{name}". 163 "A String", 164 ], 165 "revision": "A String", # The resource ID of this revision. 166 "sharedFlows": [ # A list of the shared flow names included in this shared flow revision. 167 "A String", 168 ], 169 "type": "A String", # The string "Application" 170}</pre> 171</div> 172 173<div class="method"> 174 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 175 <pre>Deletes a shared flow and all it's revisions. The shared flow must be undeployed before you can delete it. 176 177Args: 178 name: string, Required. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` (required) 179 x__xgafv: string, V1 error format. 180 Allowed values 181 1 - v1 error format 182 2 - v2 error format 183 184Returns: 185 An object of the form: 186 187 { # The metadata describing a shared flow 188 "latestRevisionId": "A String", # The id of the most recently created revision for this shared flow. 189 "metaData": { # Metadata common to many entities in this API. # Metadata describing the shared flow. 190 "createdAt": "A String", # Time at which the API proxy was created, in milliseconds since epoch. 191 "lastModifiedAt": "A String", # Time at which the API proxy was most recently modified, in milliseconds since epoch. 192 "subType": "A String", # The type of entity described 193 }, 194 "name": "A String", # The ID of the shared flow. 195 "revision": [ # A list of revisions of this shared flow. 196 "A String", 197 ], 198}</pre> 199</div> 200 201<div class="method"> 202 <code class="details" id="get">get(name, x__xgafv=None)</code> 203 <pre>Gets a shared flow by name, including a list of its revisions. 204 205Args: 206 name: string, Required. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` (required) 207 x__xgafv: string, V1 error format. 208 Allowed values 209 1 - v1 error format 210 2 - v2 error format 211 212Returns: 213 An object of the form: 214 215 { # The metadata describing a shared flow 216 "latestRevisionId": "A String", # The id of the most recently created revision for this shared flow. 217 "metaData": { # Metadata common to many entities in this API. # Metadata describing the shared flow. 218 "createdAt": "A String", # Time at which the API proxy was created, in milliseconds since epoch. 219 "lastModifiedAt": "A String", # Time at which the API proxy was most recently modified, in milliseconds since epoch. 220 "subType": "A String", # The type of entity described 221 }, 222 "name": "A String", # The ID of the shared flow. 223 "revision": [ # A list of revisions of this shared flow. 224 "A String", 225 ], 226}</pre> 227</div> 228 229<div class="method"> 230 <code class="details" id="list">list(parent, includeMetaData=None, includeRevisions=None, x__xgafv=None)</code> 231 <pre>Lists all shared flows in the organization. 232 233Args: 234 parent: string, Required. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}` (required) 235 includeMetaData: boolean, Indicates whether to include shared flow metadata in the response. 236 includeRevisions: boolean, Indicates whether to include a list of revisions in the response. 237 x__xgafv: string, V1 error format. 238 Allowed values 239 1 - v1 error format 240 2 - v2 error format 241 242Returns: 243 An object of the form: 244 245 { 246 "sharedFlows": [ 247 { # The metadata describing a shared flow 248 "latestRevisionId": "A String", # The id of the most recently created revision for this shared flow. 249 "metaData": { # Metadata common to many entities in this API. # Metadata describing the shared flow. 250 "createdAt": "A String", # Time at which the API proxy was created, in milliseconds since epoch. 251 "lastModifiedAt": "A String", # Time at which the API proxy was most recently modified, in milliseconds since epoch. 252 "subType": "A String", # The type of entity described 253 }, 254 "name": "A String", # The ID of the shared flow. 255 "revision": [ # A list of revisions of this shared flow. 256 "A String", 257 ], 258 }, 259 ], 260}</pre> 261</div> 262 263</body></html>