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
|
<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="apim_v1alpha.html">API Management API</a> . <a href="apim_v1alpha.projects.html">projects</a> . <a href="apim_v1alpha.projects.locations.html">locations</a> . <a href="apim_v1alpha.projects.locations.observationJobs.html">observationJobs</a> . <a href="apim_v1alpha.projects.locations.observationJobs.apiObservations.html">apiObservations</a> . <a href="apim_v1alpha.projects.locations.observationJobs.apiObservations.apiOperations.html">apiOperations</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">GetApiOperation retrieves a single ApiOperation by name.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">ListApiOperations gets all ApiOperations for a given project and location and ObservationJob 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>GetApiOperation retrieves a single ApiOperation by name.
Args:
name: string, Required. The name of the ApiOperation to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation}/apiOperation/{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:
{ # Message describing ApiOperation object
"count": "A String", # The number of occurrences of this API Operation.
"firstSeenTime": "A String", # First seen time stamp
"httpOperation": { # An HTTP-based API Operation, sometimes called a "REST" Operation. # An HTTP Operation.
"method": "A String", # HTTP Method.
"path": "A String", # Path of the HTTP request.
"pathParams": [ # Path params of HttpOperation
{ # HTTP Path parameter.
"dataType": "A String", # Data type of path param
"position": 42, # Segment location in the path, 1-indexed
},
],
"queryParams": { # Query params of HttpOperation
"a_key": { # An aggregation of HTTP query parameter occurrences.
"count": "A String", # The number of occurrences of this query parameter across transactions.
"dataType": "A String", # Data type of path param
"name": "A String", # Name of query param
},
},
"request": { # An aggregation of HTTP requests. # Request metadata.
"headers": { # 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. # Response metadata.
"headers": { # 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": { # Map of status code to observed count
"a_key": "A String",
},
},
},
"lastSeenTime": "A String", # Last seen time stamp
"name": "A String", # Identifier. Name of resource
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.
Args:
parent: string, Required. The parent, which owns this collection of ApiOperations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation} (required)
pageSize: integer, Optional. The maximum number of ApiOperations to return. The service may return fewer than this value. If unspecified, at most 10 ApiOperations 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 `ListApiApiOperations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiApiOperations` 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 ApiOperations
"apiOperations": [ # The ApiOperations from the specified project and location and ObservationJob and ApiObservation.
{ # Message describing ApiOperation object
"count": "A String", # The number of occurrences of this API Operation.
"firstSeenTime": "A String", # First seen time stamp
"httpOperation": { # An HTTP-based API Operation, sometimes called a "REST" Operation. # An HTTP Operation.
"method": "A String", # HTTP Method.
"path": "A String", # Path of the HTTP request.
"pathParams": [ # Path params of HttpOperation
{ # HTTP Path parameter.
"dataType": "A String", # Data type of path param
"position": 42, # Segment location in the path, 1-indexed
},
],
"queryParams": { # Query params of HttpOperation
"a_key": { # An aggregation of HTTP query parameter occurrences.
"count": "A String", # The number of occurrences of this query parameter across transactions.
"dataType": "A String", # Data type of path param
"name": "A String", # Name of query param
},
},
"request": { # An aggregation of HTTP requests. # Request metadata.
"headers": { # 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. # Response metadata.
"headers": { # 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": { # Map of status code to observed count
"a_key": "A String",
},
},
},
"lastSeenTime": "A String", # Last seen time stamp
"name": "A String", # Identifier. Name of resource
},
],
"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>
|
