File: apihub_v1.projects.locations.discoveredApiObservations.html

package info (click to toggle)
python-googleapi 2.182.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 533,852 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (215 lines) | stat: -rw-r--r-- 10,906 bytes parent folder | download
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
<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></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="apihub_v1.projects.locations.discoveredApiObservations.discoveredApiOperations.html">discoveredApiOperations()</a></code>
</p>
<p class="firstline">Returns the discoveredApiOperations 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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a DiscoveredAPIObservation in a given project, location and ApiObservation.</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 DiscoveredAPIObservations in a given project and location.</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 DiscoveredAPIObservation in a given project, location and ApiObservation.

Args:
  name: string, Required. The name of the DiscoveredApiObservation to retrieve. Format: projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Respresents an API Observation observed in one of the sources.
  &quot;apiOperationCount&quot;: &quot;A String&quot;, # Optional. The number of observed API Operations.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time stamp of the observation in API Hub.
  &quot;hostname&quot;: &quot;A String&quot;, # Optional. The hostname of requests processed for this Observation.
  &quot;knownOperationsCount&quot;: &quot;A String&quot;, # Output only. The number of known API Operations.
  &quot;lastEventDetectedTime&quot;: &quot;A String&quot;, # Optional. Last event detected time stamp
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the discovered API Observation. Format: `projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}`
  &quot;origin&quot;: &quot;A String&quot;, # Optional. For an observation pushed from a gcp resource, this would be the gcp project id.
  &quot;serverIps&quot;: [ # Optional. The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: `&quot;192.168.1.1&quot;`, `&quot;10.0.0.1:80&quot;`, `&quot;FE80::0202:B3FF:FE1E:8329&quot;`.
    &quot;A String&quot;,
  ],
  &quot;sourceLocations&quot;: [ # Optional. The location of the observation source.
    &quot;A String&quot;,
  ],
  &quot;sourceMetadata&quot;: { # SourceMetadata represents the metadata for a resource at the source. # Output only. The metadata of the source from which the observation was collected.
    &quot;originalResourceCreateTime&quot;: &quot;A String&quot;, # Output only. The time at which the resource was created at the source.
    &quot;originalResourceId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the resource at the source.
    &quot;originalResourceUpdateTime&quot;: &quot;A String&quot;, # Output only. The time at which the resource was last updated at the source.
    &quot;pluginInstanceActionSource&quot;: { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
      &quot;actionId&quot;: &quot;A String&quot;, # Output only. The id of the plugin instance action.
      &quot;pluginInstance&quot;: &quot;A String&quot;, # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
    },
    &quot;sourceType&quot;: &quot;A String&quot;, # Output only. The type of the source.
  },
  &quot;sourceTypes&quot;: [ # Optional. The type of the source from which the observation was collected.
    &quot;A String&quot;,
  ],
  &quot;style&quot;: &quot;A String&quot;, # Optional. Style of ApiObservation
  &quot;unknownOperationsCount&quot;: &quot;A String&quot;, # Output only. The number of unknown API Operations.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time stamp of the observation 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 DiscoveredAPIObservations in a given project and location.

Args:
  parent: string, Required. The parent, which owns this collection of ApiObservations. Format: projects/{project}/locations/{location} (required)
  pageSize: integer, Optional. The maximum number of ApiObservations to return. The service may return fewer than this value. If unspecified, at most 10 ApiObservations 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 `ListApiObservations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservations` 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 DiscoveredApiObservations
  &quot;discoveredApiObservations&quot;: [ # The DiscoveredApiObservation from the specified project and location.
    { # Respresents an API Observation observed in one of the sources.
      &quot;apiOperationCount&quot;: &quot;A String&quot;, # Optional. The number of observed API Operations.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time stamp of the observation in API Hub.
      &quot;hostname&quot;: &quot;A String&quot;, # Optional. The hostname of requests processed for this Observation.
      &quot;knownOperationsCount&quot;: &quot;A String&quot;, # Output only. The number of known API Operations.
      &quot;lastEventDetectedTime&quot;: &quot;A String&quot;, # Optional. Last event detected time stamp
      &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the discovered API Observation. Format: `projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}`
      &quot;origin&quot;: &quot;A String&quot;, # Optional. For an observation pushed from a gcp resource, this would be the gcp project id.
      &quot;serverIps&quot;: [ # Optional. The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: `&quot;192.168.1.1&quot;`, `&quot;10.0.0.1:80&quot;`, `&quot;FE80::0202:B3FF:FE1E:8329&quot;`.
        &quot;A String&quot;,
      ],
      &quot;sourceLocations&quot;: [ # Optional. The location of the observation source.
        &quot;A String&quot;,
      ],
      &quot;sourceMetadata&quot;: { # SourceMetadata represents the metadata for a resource at the source. # Output only. The metadata of the source from which the observation was collected.
        &quot;originalResourceCreateTime&quot;: &quot;A String&quot;, # Output only. The time at which the resource was created at the source.
        &quot;originalResourceId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the resource at the source.
        &quot;originalResourceUpdateTime&quot;: &quot;A String&quot;, # Output only. The time at which the resource was last updated at the source.
        &quot;pluginInstanceActionSource&quot;: { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
          &quot;actionId&quot;: &quot;A String&quot;, # Output only. The id of the plugin instance action.
          &quot;pluginInstance&quot;: &quot;A String&quot;, # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
        },
        &quot;sourceType&quot;: &quot;A String&quot;, # Output only. The type of the source.
      },
      &quot;sourceTypes&quot;: [ # Optional. The type of the source from which the observation was collected.
        &quot;A String&quot;,
      ],
      &quot;style&quot;: &quot;A String&quot;, # Optional. Style of ApiObservation
      &quot;unknownOperationsCount&quot;: &quot;A String&quot;, # Output only. The number of unknown API Operations.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time stamp of the observation in API Hub.
    },
  ],
  &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>