File: networkmanagement_v1.projects.locations.networkMonitoringProviders.monitoringPoints.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (250 lines) | stat: -rw-r--r-- 13,362 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
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
<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="networkmanagement_v1.html">Network Management API</a> . <a href="networkmanagement_v1.projects.html">projects</a> . <a href="networkmanagement_v1.projects.locations.html">locations</a> . <a href="networkmanagement_v1.projects.locations.networkMonitoringProviders.html">networkMonitoringProviders</a> . <a href="networkmanagement_v1.projects.locations.networkMonitoringProviders.monitoringPoints.html">monitoringPoints</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 the MonitoringPoint resource.</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 MonitoringPoints for a given network monitoring provider.</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 the MonitoringPoint resource.

Args:
  name: string, Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point} (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 MonitoringPoint resource.
  &quot;autoGeoLocationEnabled&quot;: True or False, # Output only. Indicates if automaitic geographic location is enabled for the MonitoringPoint.
  &quot;connectionStatus&quot;: &quot;A String&quot;, # Output only. Connection status of the MonitoringPoint.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the MonitoringPoint was created.
  &quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name of the MonitoringPoint.
  &quot;errors&quot;: [ # Output only. The codes of errors detected in the MonitoringPoint.
    &quot;A String&quot;,
  ],
  &quot;geoLocation&quot;: { # The geographical location of the MonitoringPoint. # Output only. The geographical location of the MonitoringPoint. ;
    &quot;country&quot;: &quot;A String&quot;, # Country.
    &quot;formattedAddress&quot;: &quot;A String&quot;, # Formatted address.
  },
  &quot;host&quot;: { # Message describing information about the host. # Output only. The host information of the MonitoringPoint.
    &quot;cloudInstanceId&quot;: &quot;A String&quot;, # Output only. The cloud instance id of the host.
    &quot;cloudProjectId&quot;: &quot;A String&quot;, # Output only. The cloud project id of the host.
    &quot;cloudProvider&quot;: &quot;A String&quot;, # Output only. The cloud provider of the host.
    &quot;cloudRegion&quot;: &quot;A String&quot;, # Output only. The cloud region of the host.
    &quot;cloudVirtualNetworkIds&quot;: [ # Output only. The ids of cloud virtual networks of the host.
      &quot;A String&quot;,
    ],
    &quot;cloudVpcId&quot;: &quot;A String&quot;, # Output only. The id of Virtual Private Cloud (VPC) of the host.
    &quot;cloudZone&quot;: &quot;A String&quot;, # Output only. The cloud zone of the host.
    &quot;os&quot;: &quot;A String&quot;, # Output only. The operating system of the host.
  },
  &quot;hostname&quot;: &quot;A String&quot;, # Output only. The hostname of the MonitoringPoint.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point}`
  &quot;networkInterfaces&quot;: [ # Output only. The network interfaces of the MonitoringPoint.
    { # Message describing network interfaces.
      &quot;adapterDescription&quot;: &quot;A String&quot;, # Output only. The description of the interface.
      &quot;cidr&quot;: &quot;A String&quot;, # Output only. The IP address of the interface and subnet mask in CIDR format. Examples: 192.168.1.0/24, 2001:db8::/32
      &quot;interfaceName&quot;: &quot;A String&quot;, # Output only. The name of the network interface. Examples: eth0, eno1
      &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. The IP address of the interface.
      &quot;macAddress&quot;: &quot;A String&quot;, # Output only. The MAC address of the interface.
      &quot;speed&quot;: &quot;A String&quot;, # Output only. Speed of the interface in millions of bits per second.
      &quot;vlanId&quot;: &quot;A String&quot;, # Output only. The id of the VLAN.
    },
  ],
  &quot;originatingIp&quot;: &quot;A String&quot;, # Output only. IP address visible when MonitoringPoint connects to the provider.
  &quot;providerTags&quot;: [ # Output only. The provider tags of the MonitoringPoint.
    { # Message describing the provider tag.
      &quot;category&quot;: &quot;A String&quot;, # Output only. The category of the provider tag.
      &quot;resourceType&quot;: &quot;A String&quot;, # Output only. The resource type of the provider tag.
      &quot;value&quot;: &quot;A String&quot;, # Output only. The value of the provider tag.
    },
  ],
  &quot;type&quot;: &quot;A String&quot;, # Output only. Deployment type of the MonitoringPoint.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the MonitoringPoint was updated.
  &quot;upgradeAvailable&quot;: True or False, # Output only. Indicates if an upgrade is available for the MonitoringPoint.
  &quot;upgradeType&quot;: &quot;A String&quot;, # Output only. The type of upgrade available for the MonitoringPoint.
  &quot;version&quot;: &quot;A String&quot;, # Output only. Version of the software running on the MonitoringPoint.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists MonitoringPoints for a given network monitoring provider.

Args:
  parent: string, Required. Parent value for ListMonitoringPointsRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} (required)
  pageSize: integer, Optional. The maximum number of monitoring points to return. The service may return fewer than this value. If unspecified, at most 20 monitoring points 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 `ListMonitoringPoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMonitoringPoints` 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 MonitoringPoints
  &quot;monitoringPoints&quot;: [ # The list of MonitoringPoints.
    { # Message describing MonitoringPoint resource.
      &quot;autoGeoLocationEnabled&quot;: True or False, # Output only. Indicates if automaitic geographic location is enabled for the MonitoringPoint.
      &quot;connectionStatus&quot;: &quot;A String&quot;, # Output only. Connection status of the MonitoringPoint.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the MonitoringPoint was created.
      &quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name of the MonitoringPoint.
      &quot;errors&quot;: [ # Output only. The codes of errors detected in the MonitoringPoint.
        &quot;A String&quot;,
      ],
      &quot;geoLocation&quot;: { # The geographical location of the MonitoringPoint. # Output only. The geographical location of the MonitoringPoint. ;
        &quot;country&quot;: &quot;A String&quot;, # Country.
        &quot;formattedAddress&quot;: &quot;A String&quot;, # Formatted address.
      },
      &quot;host&quot;: { # Message describing information about the host. # Output only. The host information of the MonitoringPoint.
        &quot;cloudInstanceId&quot;: &quot;A String&quot;, # Output only. The cloud instance id of the host.
        &quot;cloudProjectId&quot;: &quot;A String&quot;, # Output only. The cloud project id of the host.
        &quot;cloudProvider&quot;: &quot;A String&quot;, # Output only. The cloud provider of the host.
        &quot;cloudRegion&quot;: &quot;A String&quot;, # Output only. The cloud region of the host.
        &quot;cloudVirtualNetworkIds&quot;: [ # Output only. The ids of cloud virtual networks of the host.
          &quot;A String&quot;,
        ],
        &quot;cloudVpcId&quot;: &quot;A String&quot;, # Output only. The id of Virtual Private Cloud (VPC) of the host.
        &quot;cloudZone&quot;: &quot;A String&quot;, # Output only. The cloud zone of the host.
        &quot;os&quot;: &quot;A String&quot;, # Output only. The operating system of the host.
      },
      &quot;hostname&quot;: &quot;A String&quot;, # Output only. The hostname of the MonitoringPoint.
      &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point}`
      &quot;networkInterfaces&quot;: [ # Output only. The network interfaces of the MonitoringPoint.
        { # Message describing network interfaces.
          &quot;adapterDescription&quot;: &quot;A String&quot;, # Output only. The description of the interface.
          &quot;cidr&quot;: &quot;A String&quot;, # Output only. The IP address of the interface and subnet mask in CIDR format. Examples: 192.168.1.0/24, 2001:db8::/32
          &quot;interfaceName&quot;: &quot;A String&quot;, # Output only. The name of the network interface. Examples: eth0, eno1
          &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. The IP address of the interface.
          &quot;macAddress&quot;: &quot;A String&quot;, # Output only. The MAC address of the interface.
          &quot;speed&quot;: &quot;A String&quot;, # Output only. Speed of the interface in millions of bits per second.
          &quot;vlanId&quot;: &quot;A String&quot;, # Output only. The id of the VLAN.
        },
      ],
      &quot;originatingIp&quot;: &quot;A String&quot;, # Output only. IP address visible when MonitoringPoint connects to the provider.
      &quot;providerTags&quot;: [ # Output only. The provider tags of the MonitoringPoint.
        { # Message describing the provider tag.
          &quot;category&quot;: &quot;A String&quot;, # Output only. The category of the provider tag.
          &quot;resourceType&quot;: &quot;A String&quot;, # Output only. The resource type of the provider tag.
          &quot;value&quot;: &quot;A String&quot;, # Output only. The value of the provider tag.
        },
      ],
      &quot;type&quot;: &quot;A String&quot;, # Output only. Deployment type of the MonitoringPoint.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the MonitoringPoint was updated.
      &quot;upgradeAvailable&quot;: True or False, # Output only. Indicates if an upgrade is available for the MonitoringPoint.
      &quot;upgradeType&quot;: &quot;A String&quot;, # Output only. The type of upgrade available for the MonitoringPoint.
      &quot;version&quot;: &quot;A String&quot;, # Output only. Version of the software running on the MonitoringPoint.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results the server should return.
}</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>