1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="apigee_v1.organizations.sharedflows.deployments.html">deployments()</a></code>
</p>
<p class="firstline">Returns the deployments Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.sharedflows.revisions.html">revisions()</a></code>
</p>
<p class="firstline">Returns the revisions Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, action=None, body=None, name=None, space=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a shared flow and all it's revisions. The shared flow must be undeployed before you can delete it.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a shared flow by name, including a list of its revisions.</p>
<p class="toc_element">
<code><a href="#list">list(parent, includeMetaData=None, includeRevisions=None, space=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all shared flows in the organization. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).</p>
<p class="toc_element">
<code><a href="#move">move(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Moves an shared flow to a different space.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, action=None, body=None, name=None, space=None, x__xgafv=None)</code>
<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.
Args:
parent: string, Required. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
body: object, The request body.
The object takes the form of:
{ # 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.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
}
action: string, Required. Must be set to either `import` or `validate`.
name: string, Required. The name to give the shared flow
space: string, Optional. The ID of the space to associated with this shared flow. Any IAM policies applied to the space will affect access to this shared flow. Note that this field is only respected when creating a new shared flow. It has no effect when creating a new revision for an existing shared flow.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The metadata describing a shared flow revision.
"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.
"majorVersion": 42, # Major version of the API proxy configuration schema.
"minorVersion": 42, # Minor version of the API proxy configuration schema.
},
"contextInfo": "A String", # A textual description of the shared flow revision.
"createdAt": "A String", # Time at which this shared flow revision was created, in milliseconds since epoch.
"description": "A String", # Description of the shared flow revision.
"displayName": "A String", # The human readable name of this shared flow.
"entityMetaDataAsProperties": { # A Key-Value map of metadata about this shared flow revision.
"a_key": "A String",
},
"lastModifiedAt": "A String", # Time at which this shared flow revision was most recently modified, in milliseconds since epoch.
"name": "A String", # The resource ID of the parent shared flow.
"policies": [ # A list of policy names included in this shared flow revision.
"A String",
],
"resourceFiles": { # List of resource files. # The resource files included in this shared flow revision.
"resourceFile": [ # List of resource files.
{ # Metadata about a resource file.
"name": "A String", # ID of the resource file.
"type": "A String", # Resource file type. {{ resource_file_type }}
},
],
},
"resources": [ # A list of the resources included in this shared flow revision formatted as "{type}://{name}".
"A String",
],
"revision": "A String", # The resource ID of this revision.
"sharedFlows": [ # A list of the shared flow names included in this shared flow revision.
"A String",
],
"type": "A String", # The string "Application"
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a shared flow and all it's revisions. The shared flow must be undeployed before you can delete it.
Args:
name: string, Required. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The metadata describing a shared flow
"latestRevisionId": "A String", # The id of the most recently created revision for this shared flow.
"metaData": { # Metadata common to many entities in this API. # Metadata describing the shared flow.
"createdAt": "A String", # Time at which the API proxy was created, in milliseconds since epoch.
"lastModifiedAt": "A String", # Time at which the API proxy was most recently modified, in milliseconds since epoch.
"subType": "A String", # The type of entity described
},
"name": "A String", # The ID of the shared flow.
"revision": [ # A list of revisions of this shared flow.
"A String",
],
"space": "A String", # Optional. The ID of the space associated with this shared flow. Any IAM policies applied to the space will control access to this shared flow. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a shared flow by name, including a list of its revisions.
Args:
name: string, Required. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The metadata describing a shared flow
"latestRevisionId": "A String", # The id of the most recently created revision for this shared flow.
"metaData": { # Metadata common to many entities in this API. # Metadata describing the shared flow.
"createdAt": "A String", # Time at which the API proxy was created, in milliseconds since epoch.
"lastModifiedAt": "A String", # Time at which the API proxy was most recently modified, in milliseconds since epoch.
"subType": "A String", # The type of entity described
},
"name": "A String", # The ID of the shared flow.
"revision": [ # A list of revisions of this shared flow.
"A String",
],
"space": "A String", # Optional. The ID of the space associated with this shared flow. Any IAM policies applied to the space will control access to this shared flow. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, includeMetaData=None, includeRevisions=None, space=None, x__xgafv=None)</code>
<pre>Lists all shared flows in the organization. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
Args:
parent: string, Required. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
includeMetaData: boolean, Indicates whether to include shared flow metadata in the response.
includeRevisions: boolean, Indicates whether to include a list of revisions in the response.
space: string, Optional. The space ID used to filter the list of shared flows (optional). If unspecified, all shared flows in the organization will be listed. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"sharedFlows": [
{ # The metadata describing a shared flow
"latestRevisionId": "A String", # The id of the most recently created revision for this shared flow.
"metaData": { # Metadata common to many entities in this API. # Metadata describing the shared flow.
"createdAt": "A String", # Time at which the API proxy was created, in milliseconds since epoch.
"lastModifiedAt": "A String", # Time at which the API proxy was most recently modified, in milliseconds since epoch.
"subType": "A String", # The type of entity described
},
"name": "A String", # The ID of the shared flow.
"revision": [ # A list of revisions of this shared flow.
"A String",
],
"space": "A String", # Optional. The ID of the space associated with this shared flow. Any IAM policies applied to the space will control access to this shared flow. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="move">move(name, body=None, x__xgafv=None)</code>
<pre>Moves an shared flow to a different space.
Args:
name: string, Required. Shared Flow to move in the following format: `organizations/{org}/sharedflows/{shared_flow}` (required)
body: object, The request body.
The object takes the form of:
{ # Moves a Shared Flow to a different space.
"space": "A String", # Optional. Resource ID of the space to move the shared flow to. If unspecified, the shared flow will be moved to the organization level.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The metadata describing a shared flow
"latestRevisionId": "A String", # The id of the most recently created revision for this shared flow.
"metaData": { # Metadata common to many entities in this API. # Metadata describing the shared flow.
"createdAt": "A String", # Time at which the API proxy was created, in milliseconds since epoch.
"lastModifiedAt": "A String", # Time at which the API proxy was most recently modified, in milliseconds since epoch.
"subType": "A String", # The type of entity described
},
"name": "A String", # The ID of the shared flow.
"revision": [ # A list of revisions of this shared flow.
"A String",
],
"space": "A String", # Optional. The ID of the space associated with this shared flow. Any IAM policies applied to the space will control access to this shared flow. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
}</pre>
</div>
</body></html>
|
