File: networkmanagement_v1.projects.locations.networkMonitoringProviders.webPaths.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 (194 lines) | stat: -rw-r--r-- 8,524 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
<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.webPaths.html">webPaths</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 WebPath 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 WebPaths 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 WebPath resource.

Args:
  name: string, Required. Name of the resource.. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/webPaths/{web_path} (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 WebPath resource.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the WebPath was created.
  &quot;destination&quot;: &quot;A String&quot;, # Output only. Web monitoring target.
  &quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name of the WebPath.
  &quot;interval&quot;: &quot;A String&quot;, # Output only. Monitoring interval.
  &quot;monitoringEnabled&quot;: True or False, # Output only. Is monitoring enabled for the WebPath.
  &quot;monitoringPolicyDisplayName&quot;: &quot;A String&quot;, # Output only. Display name of the monitoring policy.
  &quot;monitoringPolicyId&quot;: &quot;A String&quot;, # Output only. ID of the monitoring policy.
  &quot;monitoringStatus&quot;: &quot;A String&quot;, # Output only. The monitoring status of the WebPath.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/webPaths/{web_path}`
  &quot;providerTags&quot;: [ # Output only. The provider tags of the web path.
    { # 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;providerUiUri&quot;: &quot;A String&quot;, # Output only. Link to provider&#x27;s UI; link shows the WebPath.
  &quot;relatedNetworkPathId&quot;: &quot;A String&quot;, # Output only. Provider&#x27;s UUID of the related NetworkPath.
  &quot;sourceMonitoringPointId&quot;: &quot;A String&quot;, # Output only. ID of the source MonitoringPoint.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the WebPath was updated.
  &quot;workflowType&quot;: &quot;A String&quot;, # Output only. The workflow type of the WebPath.
}</pre>
</div>

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

Args:
  parent: string, Required. Parent value for ListWebPathsRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} (required)
  pageSize: integer, Optional. The maximum number of web paths to return. The service may return fewer than this value. If unspecified, at most 20 web paths 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 `ListWebPaths` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWebPaths` 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 WebPaths
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results the server should return.
  &quot;webPaths&quot;: [ # The list of WebPath.
    { # Message describing WebPath resource.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the WebPath was created.
      &quot;destination&quot;: &quot;A String&quot;, # Output only. Web monitoring target.
      &quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name of the WebPath.
      &quot;interval&quot;: &quot;A String&quot;, # Output only. Monitoring interval.
      &quot;monitoringEnabled&quot;: True or False, # Output only. Is monitoring enabled for the WebPath.
      &quot;monitoringPolicyDisplayName&quot;: &quot;A String&quot;, # Output only. Display name of the monitoring policy.
      &quot;monitoringPolicyId&quot;: &quot;A String&quot;, # Output only. ID of the monitoring policy.
      &quot;monitoringStatus&quot;: &quot;A String&quot;, # Output only. The monitoring status of the WebPath.
      &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/webPaths/{web_path}`
      &quot;providerTags&quot;: [ # Output only. The provider tags of the web path.
        { # 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;providerUiUri&quot;: &quot;A String&quot;, # Output only. Link to provider&#x27;s UI; link shows the WebPath.
      &quot;relatedNetworkPathId&quot;: &quot;A String&quot;, # Output only. Provider&#x27;s UUID of the related NetworkPath.
      &quot;sourceMonitoringPointId&quot;: &quot;A String&quot;, # Output only. ID of the source MonitoringPoint.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the WebPath was updated.
      &quot;workflowType&quot;: &quot;A String&quot;, # Output only. The workflow type of the WebPath.
    },
  ],
}</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>