Skip to content

Commit ebfd6dd

Browse files
feat(monitoring): update the api
#### monitoring:v3 The following keys were added: - resources.projects.resources.uptimeCheckConfigs.methods.list.parameters.filter (Total Keys: 2) - schemas.HttpCheck.properties.pingConfig.$ref (Total Keys: 1) - schemas.PingConfig (Total Keys: 4) - schemas.TcpCheck.properties.pingConfig.$ref (Total Keys: 1)
1 parent 3e79bd5 commit ebfd6dd

File tree

3 files changed

+66
-4
lines changed

3 files changed

+66
-4
lines changed

docs/dyn/monitoring_v3.projects.uptimeCheckConfigs.html

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ <h2>Instance Methods</h2>
8787
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
8888
<p class="firstline">Gets a single Uptime check configuration.</p>
8989
<p class="toc_element">
90-
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
90+
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
9191
<p class="firstline">Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).</p>
9292
<p class="toc_element">
9393
<code><a href="#list_next">list_next()</a></code></p>
@@ -141,6 +141,9 @@ <h3>Method Details</h3>
141141
},
142142
&quot;maskHeaders&quot;: True or False, # Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to true then the headers will be obscured with ******.
143143
&quot;path&quot;: &quot;A String&quot;, # Optional (defaults to &quot;/&quot;). The path to the page against which to run the check. Will be combined with the host (specified within the monitored_resource) and port to construct the full URL. If the provided path does not begin with &quot;/&quot;, a &quot;/&quot; will be prepended automatically.
144+
&quot;pingConfig&quot;: { # Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain. # Contains information needed to add pings to an HTTP check.
145+
&quot;pingsCount&quot;: 42, # Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
146+
},
144147
&quot;port&quot;: 42, # Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified within the monitored_resource) and path to construct the full URL.
145148
&quot;requestMethod&quot;: &quot;A String&quot;, # The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.
146149
&quot;useSsl&quot;: True or False, # If true, use HTTPS instead of HTTP to run the check.
@@ -173,6 +176,9 @@ <h3>Method Details</h3>
173176
&quot;A String&quot;,
174177
],
175178
&quot;tcpCheck&quot;: { # Information required for a TCP Uptime check request. # Contains information needed to make a TCP check.
179+
&quot;pingConfig&quot;: { # Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain. # Contains information needed to add pings to a TCP check.
180+
&quot;pingsCount&quot;: 42, # Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
181+
},
176182
&quot;port&quot;: 42, # The TCP port on the server against which to run the check. Will be combined with host (specified within the monitored_resource) to construct the full URL. Required.
177183
},
178184
&quot;timeout&quot;: &quot;A String&quot;, # The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
@@ -220,6 +226,9 @@ <h3>Method Details</h3>
220226
},
221227
&quot;maskHeaders&quot;: True or False, # Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to true then the headers will be obscured with ******.
222228
&quot;path&quot;: &quot;A String&quot;, # Optional (defaults to &quot;/&quot;). The path to the page against which to run the check. Will be combined with the host (specified within the monitored_resource) and port to construct the full URL. If the provided path does not begin with &quot;/&quot;, a &quot;/&quot; will be prepended automatically.
229+
&quot;pingConfig&quot;: { # Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain. # Contains information needed to add pings to an HTTP check.
230+
&quot;pingsCount&quot;: 42, # Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
231+
},
223232
&quot;port&quot;: 42, # Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified within the monitored_resource) and path to construct the full URL.
224233
&quot;requestMethod&quot;: &quot;A String&quot;, # The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.
225234
&quot;useSsl&quot;: True or False, # If true, use HTTPS instead of HTTP to run the check.
@@ -252,6 +261,9 @@ <h3>Method Details</h3>
252261
&quot;A String&quot;,
253262
],
254263
&quot;tcpCheck&quot;: { # Information required for a TCP Uptime check request. # Contains information needed to make a TCP check.
264+
&quot;pingConfig&quot;: { # Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain. # Contains information needed to add pings to a TCP check.
265+
&quot;pingsCount&quot;: 42, # Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
266+
},
255267
&quot;port&quot;: 42, # The TCP port on the server against which to run the check. Will be combined with host (specified within the monitored_resource) to construct the full URL. Required.
256268
},
257269
&quot;timeout&quot;: &quot;A String&quot;, # The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
@@ -324,6 +336,9 @@ <h3>Method Details</h3>
324336
},
325337
&quot;maskHeaders&quot;: True or False, # Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to true then the headers will be obscured with ******.
326338
&quot;path&quot;: &quot;A String&quot;, # Optional (defaults to &quot;/&quot;). The path to the page against which to run the check. Will be combined with the host (specified within the monitored_resource) and port to construct the full URL. If the provided path does not begin with &quot;/&quot;, a &quot;/&quot; will be prepended automatically.
339+
&quot;pingConfig&quot;: { # Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain. # Contains information needed to add pings to an HTTP check.
340+
&quot;pingsCount&quot;: 42, # Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
341+
},
327342
&quot;port&quot;: 42, # Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified within the monitored_resource) and path to construct the full URL.
328343
&quot;requestMethod&quot;: &quot;A String&quot;, # The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.
329344
&quot;useSsl&quot;: True or False, # If true, use HTTPS instead of HTTP to run the check.
@@ -356,6 +371,9 @@ <h3>Method Details</h3>
356371
&quot;A String&quot;,
357372
],
358373
&quot;tcpCheck&quot;: { # Information required for a TCP Uptime check request. # Contains information needed to make a TCP check.
374+
&quot;pingConfig&quot;: { # Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain. # Contains information needed to add pings to a TCP check.
375+
&quot;pingsCount&quot;: 42, # Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
376+
},
359377
&quot;port&quot;: 42, # The TCP port on the server against which to run the check. Will be combined with host (specified within the monitored_resource) to construct the full URL. Required.
360378
},
361379
&quot;timeout&quot;: &quot;A String&quot;, # The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
@@ -366,11 +384,12 @@ <h3>Method Details</h3>
366384
</div>
367385

368386
<div class="method">
369-
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
387+
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
370388
<pre>Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).
371389

372390
Args:
373391
parent: string, Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose Uptime check configurations are listed. The format is: projects/[PROJECT_ID_OR_NUMBER] (required)
392+
filter: string, If provided, this field specifies the criteria that must be met by uptime checks to be included in the response.For more details, see Filtering syntax (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering#filter_syntax).
374393
pageSize: integer, The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is &lt;=0, the server will decide the number of results to be returned.
375394
pageToken: string, If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.
376395
x__xgafv: string, V1 error format.
@@ -416,6 +435,9 @@ <h3>Method Details</h3>
416435
},
417436
&quot;maskHeaders&quot;: True or False, # Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to true then the headers will be obscured with ******.
418437
&quot;path&quot;: &quot;A String&quot;, # Optional (defaults to &quot;/&quot;). The path to the page against which to run the check. Will be combined with the host (specified within the monitored_resource) and port to construct the full URL. If the provided path does not begin with &quot;/&quot;, a &quot;/&quot; will be prepended automatically.
438+
&quot;pingConfig&quot;: { # Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain. # Contains information needed to add pings to an HTTP check.
439+
&quot;pingsCount&quot;: 42, # Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
440+
},
419441
&quot;port&quot;: 42, # Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified within the monitored_resource) and path to construct the full URL.
420442
&quot;requestMethod&quot;: &quot;A String&quot;, # The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.
421443
&quot;useSsl&quot;: True or False, # If true, use HTTPS instead of HTTP to run the check.
@@ -448,6 +470,9 @@ <h3>Method Details</h3>
448470
&quot;A String&quot;,
449471
],
450472
&quot;tcpCheck&quot;: { # Information required for a TCP Uptime check request. # Contains information needed to make a TCP check.
473+
&quot;pingConfig&quot;: { # Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain. # Contains information needed to add pings to a TCP check.
474+
&quot;pingsCount&quot;: 42, # Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
475+
},
451476
&quot;port&quot;: 42, # The TCP port on the server against which to run the check. Will be combined with host (specified within the monitored_resource) to construct the full URL. Required.
452477
},
453478
&quot;timeout&quot;: &quot;A String&quot;, # The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
@@ -513,6 +538,9 @@ <h3>Method Details</h3>
513538
},
514539
&quot;maskHeaders&quot;: True or False, # Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to true then the headers will be obscured with ******.
515540
&quot;path&quot;: &quot;A String&quot;, # Optional (defaults to &quot;/&quot;). The path to the page against which to run the check. Will be combined with the host (specified within the monitored_resource) and port to construct the full URL. If the provided path does not begin with &quot;/&quot;, a &quot;/&quot; will be prepended automatically.
541+
&quot;pingConfig&quot;: { # Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain. # Contains information needed to add pings to an HTTP check.
542+
&quot;pingsCount&quot;: 42, # Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
543+
},
516544
&quot;port&quot;: 42, # Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified within the monitored_resource) and path to construct the full URL.
517545
&quot;requestMethod&quot;: &quot;A String&quot;, # The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.
518546
&quot;useSsl&quot;: True or False, # If true, use HTTPS instead of HTTP to run the check.
@@ -545,6 +573,9 @@ <h3>Method Details</h3>
545573
&quot;A String&quot;,
546574
],
547575
&quot;tcpCheck&quot;: { # Information required for a TCP Uptime check request. # Contains information needed to make a TCP check.
576+
&quot;pingConfig&quot;: { # Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain. # Contains information needed to add pings to a TCP check.
577+
&quot;pingsCount&quot;: 42, # Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
578+
},
548579
&quot;port&quot;: 42, # The TCP port on the server against which to run the check. Will be combined with host (specified within the monitored_resource) to construct the full URL. Required.
549580
},
550581
&quot;timeout&quot;: &quot;A String&quot;, # The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
@@ -593,6 +624,9 @@ <h3>Method Details</h3>
593624
},
594625
&quot;maskHeaders&quot;: True or False, # Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to true then the headers will be obscured with ******.
595626
&quot;path&quot;: &quot;A String&quot;, # Optional (defaults to &quot;/&quot;). The path to the page against which to run the check. Will be combined with the host (specified within the monitored_resource) and port to construct the full URL. If the provided path does not begin with &quot;/&quot;, a &quot;/&quot; will be prepended automatically.
627+
&quot;pingConfig&quot;: { # Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain. # Contains information needed to add pings to an HTTP check.
628+
&quot;pingsCount&quot;: 42, # Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
629+
},
596630
&quot;port&quot;: 42, # Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified within the monitored_resource) and path to construct the full URL.
597631
&quot;requestMethod&quot;: &quot;A String&quot;, # The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.
598632
&quot;useSsl&quot;: True or False, # If true, use HTTPS instead of HTTP to run the check.
@@ -625,6 +659,9 @@ <h3>Method Details</h3>
625659
&quot;A String&quot;,
626660
],
627661
&quot;tcpCheck&quot;: { # Information required for a TCP Uptime check request. # Contains information needed to make a TCP check.
662+
&quot;pingConfig&quot;: { # Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain. # Contains information needed to add pings to a TCP check.
663+
&quot;pingsCount&quot;: 42, # Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
664+
},
628665
&quot;port&quot;: 42, # The TCP port on the server against which to run the check. Will be combined with host (specified within the monitored_resource) to construct the full URL. Required.
629666
},
630667
&quot;timeout&quot;: &quot;A String&quot;, # The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.

googleapiclient/discovery_cache/documents/monitoring.v1.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -769,7 +769,7 @@
769769
}
770770
}
771771
},
772-
"revision": "20220812",
772+
"revision": "20220819",
773773
"rootUrl": "https://monitoring.googleapis.com/",
774774
"schemas": {
775775
"Aggregation": {

0 commit comments

Comments
 (0)