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
|
<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="apihub_v1.html">API hub API</a> . <a href="apihub_v1.projects.html">projects</a> . <a href="apihub_v1.projects.locations.html">locations</a> . <a href="apihub_v1.projects.locations.discoveredApiObservations.html">discoveredApiObservations</a> . <a href="apihub_v1.projects.locations.discoveredApiObservations.discoveredApiOperations.html">discoveredApiOperations</a></h1>
<h2>Instance Methods</h2>
<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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a DiscoveredAPIOperation in a given project, location, ApiObservation and ApiOperation.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the DiscoveredAPIOperations in a given project, location and ApiObservation.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</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="get">get(name, x__xgafv=None)</code>
<pre>Gets a DiscoveredAPIOperation in a given project, location, ApiObservation and ApiOperation.
Args:
name: string, Required. The name of the DiscoveredApiOperation to retrieve. Format: projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}/discoveredApiOperations/{discovered_api_operation} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # DiscoveredApiOperation represents an API Operation observed in one of the sources.
"classification": "A String", # Output only. The classification of the discovered API operation.
"count": "A String", # Optional. The number of occurrences of this API Operation.
"createTime": "A String", # Output only. Create time stamp of the discovered API operation in API Hub.
"firstSeenTime": "A String", # Optional. First seen time stamp
"httpOperation": { # An HTTP-based API Operation, sometimes called a "REST" Operation. # Optional. An HTTP Operation.
"httpOperation": { # The HTTP Operation. # Required. An HTTP Operation.
"method": "A String", # Optional. Operation method Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
"path": { # The path details derived from the spec. # Optional. The path details for the Operation. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
"description": "A String", # Optional. A short description for the path applicable to all operations.
"path": "A String", # Optional. Complete path relative to server endpoint. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
},
},
"pathParams": [ # Optional. Path params of HttpOperation
{ # HTTP Path parameter.
"dataType": "A String", # Optional. Data type of path param
"position": 42, # Optional. Segment location in the path, 1-indexed
},
],
"queryParams": { # Optional. Query params of HttpOperation
"a_key": { # An aggregation of HTTP query parameter occurrences.
"count": "A String", # Optional. The number of occurrences of this query parameter across transactions.
"dataType": "A String", # Optional. Data type of path param
"name": "A String", # Required. Name of query param
},
},
"request": { # An aggregation of HTTP requests. # Optional. Request metadata.
"headers": { # Optional. Unordered map from header name to header metadata
"a_key": { # An aggregation of HTTP header occurrences.
"count": "A String", # The number of occurrences of this Header across transactions.
"dataType": "A String", # Data type of header
"name": "A String", # Header name.
},
},
},
"response": { # An aggregation of HTTP responses. # Optional. Response metadata.
"headers": { # Optional. Unordered map from header name to header metadata
"a_key": { # An aggregation of HTTP header occurrences.
"count": "A String", # The number of occurrences of this Header across transactions.
"dataType": "A String", # Data type of header
"name": "A String", # Header name.
},
},
"responseCodes": { # Optional. Map of status code to observed count
"a_key": "A String",
},
},
},
"lastSeenTime": "A String", # Optional. Last seen time stamp
"matchResults": [ # Output only. The list of matched results for the discovered API operation. This will be populated only if the classification is known. The current usecase is for a single match. Keeping it repeated to support multiple matches in future.
{ # MatchResult represents the result of matching a discovered API operation with a catalog API operation.
"name": "A String", # Output only. The name of the matched API Operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
},
],
"name": "A String", # Identifier. The name of the discovered API Operation. Format: `projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}/discoveredApiOperations/{discovered_api_operation}`
"sourceMetadata": { # SourceMetadata represents the metadata for a resource at the source. # Output only. The metadata of the source from which the api operation was collected.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
"updateTime": "A String", # Output only. Update time stamp of the discovered API operation in API Hub.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all the DiscoveredAPIOperations in a given project, location and ApiObservation.
Args:
parent: string, Required. The parent, which owns this collection of DiscoveredApiOperations. Format: projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation} (required)
pageSize: integer, Optional. DiscoveredApiOperations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `ListDiscoveredApiApiOperations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDiscoveredApiApiOperations` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to listing DiscoveredApiOperations
"discoveredApiOperations": [ # The DiscoveredApiOperations from the specified project, location and DiscoveredApiObservation.
{ # DiscoveredApiOperation represents an API Operation observed in one of the sources.
"classification": "A String", # Output only. The classification of the discovered API operation.
"count": "A String", # Optional. The number of occurrences of this API Operation.
"createTime": "A String", # Output only. Create time stamp of the discovered API operation in API Hub.
"firstSeenTime": "A String", # Optional. First seen time stamp
"httpOperation": { # An HTTP-based API Operation, sometimes called a "REST" Operation. # Optional. An HTTP Operation.
"httpOperation": { # The HTTP Operation. # Required. An HTTP Operation.
"method": "A String", # Optional. Operation method Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
"path": { # The path details derived from the spec. # Optional. The path details for the Operation. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
"description": "A String", # Optional. A short description for the path applicable to all operations.
"path": "A String", # Optional. Complete path relative to server endpoint. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
},
},
"pathParams": [ # Optional. Path params of HttpOperation
{ # HTTP Path parameter.
"dataType": "A String", # Optional. Data type of path param
"position": 42, # Optional. Segment location in the path, 1-indexed
},
],
"queryParams": { # Optional. Query params of HttpOperation
"a_key": { # An aggregation of HTTP query parameter occurrences.
"count": "A String", # Optional. The number of occurrences of this query parameter across transactions.
"dataType": "A String", # Optional. Data type of path param
"name": "A String", # Required. Name of query param
},
},
"request": { # An aggregation of HTTP requests. # Optional. Request metadata.
"headers": { # Optional. Unordered map from header name to header metadata
"a_key": { # An aggregation of HTTP header occurrences.
"count": "A String", # The number of occurrences of this Header across transactions.
"dataType": "A String", # Data type of header
"name": "A String", # Header name.
},
},
},
"response": { # An aggregation of HTTP responses. # Optional. Response metadata.
"headers": { # Optional. Unordered map from header name to header metadata
"a_key": { # An aggregation of HTTP header occurrences.
"count": "A String", # The number of occurrences of this Header across transactions.
"dataType": "A String", # Data type of header
"name": "A String", # Header name.
},
},
"responseCodes": { # Optional. Map of status code to observed count
"a_key": "A String",
},
},
},
"lastSeenTime": "A String", # Optional. Last seen time stamp
"matchResults": [ # Output only. The list of matched results for the discovered API operation. This will be populated only if the classification is known. The current usecase is for a single match. Keeping it repeated to support multiple matches in future.
{ # MatchResult represents the result of matching a discovered API operation with a catalog API operation.
"name": "A String", # Output only. The name of the matched API Operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
},
],
"name": "A String", # Identifier. The name of the discovered API Operation. Format: `projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}/discoveredApiOperations/{discovered_api_operation}`
"sourceMetadata": { # SourceMetadata represents the metadata for a resource at the source. # Output only. The metadata of the source from which the api operation was collected.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
"updateTime": "A String", # Output only. Update time stamp of the discovered API operation in API Hub.
},
],
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
