blob: e4eec036770956b2ac0b95994dd5dab5599aff59 [file] [log] [blame] [edit]
<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
&quot;count&quot;: &quot;A String&quot;, # The number of occurrences of this API Operation.
&quot;firstSeenTime&quot;: &quot;A String&quot;, # First seen time stamp
&quot;httpOperation&quot;: { # An HTTP-based API Operation, sometimes called a &quot;REST&quot; Operation. # An HTTP Operation.
&quot;method&quot;: &quot;A String&quot;, # HTTP Method.
&quot;path&quot;: &quot;A String&quot;, # Path of the HTTP request.
&quot;pathParams&quot;: [ # Path params of HttpOperation
{ # HTTP Path parameter.
&quot;dataType&quot;: &quot;A String&quot;, # Data type of path param
&quot;position&quot;: 42, # Segment location in the path, 1-indexed
},
],
&quot;queryParams&quot;: { # Query params of HttpOperation
&quot;a_key&quot;: { # An aggregation of HTTP query parameter occurrences.
&quot;count&quot;: &quot;A String&quot;, # The number of occurrences of this query parameter across transactions.
&quot;dataType&quot;: &quot;A String&quot;, # Data type of path param
&quot;name&quot;: &quot;A String&quot;, # Name of query param
},
},
&quot;request&quot;: { # An aggregation of HTTP requests. # Request metadata.
&quot;headers&quot;: { # Unordered map from header name to header metadata
&quot;a_key&quot;: { # An aggregation of HTTP header occurrences.
&quot;count&quot;: &quot;A String&quot;, # The number of occurrences of this Header across transactions.
&quot;dataType&quot;: &quot;A String&quot;, # Data type of header
&quot;name&quot;: &quot;A String&quot;, # Header name.
},
},
},
&quot;response&quot;: { # An aggregation of HTTP responses. # Response metadata.
&quot;headers&quot;: { # Unordered map from header name to header metadata
&quot;a_key&quot;: { # An aggregation of HTTP header occurrences.
&quot;count&quot;: &quot;A String&quot;, # The number of occurrences of this Header across transactions.
&quot;dataType&quot;: &quot;A String&quot;, # Data type of header
&quot;name&quot;: &quot;A String&quot;, # Header name.
},
},
&quot;responseCodes&quot;: { # Map of status code to observed count
&quot;a_key&quot;: &quot;A String&quot;,
},
},
},
&quot;lastSeenTime&quot;: &quot;A String&quot;, # Last seen time stamp
&quot;name&quot;: &quot;A String&quot;, # 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
&quot;apiOperations&quot;: [ # The ApiOperations from the specified project and location and ObservationJob and ApiObservation.
{ # Message describing ApiOperation object
&quot;count&quot;: &quot;A String&quot;, # The number of occurrences of this API Operation.
&quot;firstSeenTime&quot;: &quot;A String&quot;, # First seen time stamp
&quot;httpOperation&quot;: { # An HTTP-based API Operation, sometimes called a &quot;REST&quot; Operation. # An HTTP Operation.
&quot;method&quot;: &quot;A String&quot;, # HTTP Method.
&quot;path&quot;: &quot;A String&quot;, # Path of the HTTP request.
&quot;pathParams&quot;: [ # Path params of HttpOperation
{ # HTTP Path parameter.
&quot;dataType&quot;: &quot;A String&quot;, # Data type of path param
&quot;position&quot;: 42, # Segment location in the path, 1-indexed
},
],
&quot;queryParams&quot;: { # Query params of HttpOperation
&quot;a_key&quot;: { # An aggregation of HTTP query parameter occurrences.
&quot;count&quot;: &quot;A String&quot;, # The number of occurrences of this query parameter across transactions.
&quot;dataType&quot;: &quot;A String&quot;, # Data type of path param
&quot;name&quot;: &quot;A String&quot;, # Name of query param
},
},
&quot;request&quot;: { # An aggregation of HTTP requests. # Request metadata.
&quot;headers&quot;: { # Unordered map from header name to header metadata
&quot;a_key&quot;: { # An aggregation of HTTP header occurrences.
&quot;count&quot;: &quot;A String&quot;, # The number of occurrences of this Header across transactions.
&quot;dataType&quot;: &quot;A String&quot;, # Data type of header
&quot;name&quot;: &quot;A String&quot;, # Header name.
},
},
},
&quot;response&quot;: { # An aggregation of HTTP responses. # Response metadata.
&quot;headers&quot;: { # Unordered map from header name to header metadata
&quot;a_key&quot;: { # An aggregation of HTTP header occurrences.
&quot;count&quot;: &quot;A String&quot;, # The number of occurrences of this Header across transactions.
&quot;dataType&quot;: &quot;A String&quot;, # Data type of header
&quot;name&quot;: &quot;A String&quot;, # Header name.
},
},
&quot;responseCodes&quot;: { # Map of status code to observed count
&quot;a_key&quot;: &quot;A String&quot;,
},
},
},
&quot;lastSeenTime&quot;: &quot;A String&quot;, # Last seen time stamp
&quot;name&quot;: &quot;A String&quot;, # Identifier. Name of resource
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # 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 &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>