mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
Update documentation
This commit is contained in:
Sebastian Thiel
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Time Series List - Monitoring v2.0.4+20210322</title>
|
||||
<title>Time Series List - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -230,6 +230,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -368,7 +373,7 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Lists time series that match a filter. This method does not require a Workspace.</p>
|
||||
<p>Lists time series that match a filter.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
@@ -381,7 +386,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The project, organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID] </li>
|
||||
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name), organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID] </li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Monitoring v2.0.4+20210322</title>
|
||||
<title>Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href="." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href="." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="projects_time-series-create-service/">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="projects_time-series-list/">Time Series List</a>
|
||||
|
||||
@@ -368,7 +373,7 @@ capabilities. Errors will be printed to standard error, and cause the program's
|
||||
|
||||
<p>Find the source code <a href="https://github.com/Byron/google-apis-rs/tree/main/gen/monitoring3-cli">on github</a>.</p>
|
||||
<h1 id="usage">Usage</h1>
|
||||
<p>This documentation was generated from the <em>Monitoring</em> API at revision <em>20210322</em>. The CLI is at version <em>2.0.4</em>.</p>
|
||||
<p>This documentation was generated from the <em>Monitoring</em> API at revision <em>20220218</em>. The CLI is at version <em>3.0.0</em>.</p>
|
||||
<pre><code class="bash">monitoring3 [options]
|
||||
folders
|
||||
time-series-list <name> [-p <v>]... [-o <out>]
|
||||
@@ -404,6 +409,7 @@ capabilities. Errors will be printed to standard error, and cause the program's
|
||||
notification-channels-send-verification-code <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
notification-channels-verify <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
time-series-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
time-series-create-service <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
time-series-list <name> [-p <v>]... [-o <out>]
|
||||
time-series-query <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
uptime-check-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Time Series List - Monitoring v2.0.4+20210322</title>
|
||||
<title>Time Series List - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -230,6 +230,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -368,7 +373,7 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Lists time series that match a filter. This method does not require a Workspace.</p>
|
||||
<p>Lists time series that match a filter.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
@@ -381,7 +386,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The project, organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID] </li>
|
||||
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name), organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID] </li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Alert Policies Create - Monitoring v2.0.4+20210322</title>
|
||||
<title>Alert Policies Create - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -232,6 +232,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -382,7 +387,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The project in which to create the alerting policy. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a workspace, otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[ALERT_POLICY_ID], identifying the policy in the container.</li>
|
||||
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the alerting policy. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a workspace, otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[ALERT_POLICY_ID], identifying the policy in the container.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -391,6 +396,10 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
||||
<p>For example, a structure like this:</p>
|
||||
<pre><code>AlertPolicy:
|
||||
alert-strategy:
|
||||
auto-close: string
|
||||
notification-rate-limit:
|
||||
period: string
|
||||
combiner: string
|
||||
creation-record:
|
||||
mutate-time: string
|
||||
@@ -414,38 +423,50 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<ul>
|
||||
<li><code>-r . combiner=et</code><ul>
|
||||
<li><code>-r .alert-strategy auto-close=et</code><ul>
|
||||
<li>If an alert policy that was active has no data for this long, any open incidents will close</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>notification-rate-limit period=magna</code></p>
|
||||
<ul>
|
||||
<li>Not more than one notification per period.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>... combiner=no</code></p>
|
||||
<ul>
|
||||
<li>How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>creation-record mutate-time=magna</code><ul>
|
||||
<li><code>creation-record mutate-time=ipsum</code><ul>
|
||||
<li>When the change occurred.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>mutated-by=no</code></p>
|
||||
<p><code>mutated-by=voluptua.</code></p>
|
||||
<ul>
|
||||
<li>The email address of the user making the change.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. display-name=ipsum</code></p>
|
||||
<p><code>.. display-name=at</code></p>
|
||||
<ul>
|
||||
<li>A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>documentation content=voluptua.</code><ul>
|
||||
<li>The text of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller.</li>
|
||||
<li><code>documentation content=sanctus</code><ul>
|
||||
<li>The text of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables).</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>mime-type=at</code></p>
|
||||
<p><code>mime-type=sed</code></p>
|
||||
<ul>
|
||||
<li>The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown (https://en.wikipedia.org/wiki/Markdown) for more information.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. enabled=false</code></p>
|
||||
<p><code>.. enabled=true</code></p>
|
||||
<ul>
|
||||
<li>Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.</li>
|
||||
</ul>
|
||||
@@ -455,32 +476,32 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>mutated-by=takimata</code></p>
|
||||
<p><code>mutated-by=duo</code></p>
|
||||
<ul>
|
||||
<li>The email address of the user making the change.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. name=amet.</code></p>
|
||||
<p><code>.. name=ipsum</code></p>
|
||||
<ul>
|
||||
<li>Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>notification-channels=duo</code><ul>
|
||||
<li><code>notification-channels=gubergren</code><ul>
|
||||
<li>Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] </li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>user-labels=key=ipsum</code><ul>
|
||||
<li><code>user-labels=key=lorem</code><ul>
|
||||
<li>User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.</li>
|
||||
<li>the value will be associated with the given <code>key</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>validity code=39</code><ul>
|
||||
<li><code>validity code=89</code><ul>
|
||||
<li>The status code, which should be an enum value of google.rpc.Code.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>message=lorem</code><ul>
|
||||
<li><code>message=eos</code><ul>
|
||||
<li>A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Alert Policies Delete - Monitoring v2.0.4+20210322</title>
|
||||
<title>Alert Policies Delete - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -227,6 +227,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Alert Policies Get - Monitoring v2.0.4+20210322</title>
|
||||
<title>Alert Policies Get - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -227,6 +227,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Alert Policies List - Monitoring v2.0.4+20210322</title>
|
||||
<title>Alert Policies List - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -230,6 +230,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -381,7 +386,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The project whose alert policies are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.</li>
|
||||
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose alert policies are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Alert Policies Patch - Monitoring v2.0.4+20210322</title>
|
||||
<title>Alert Policies Patch - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -235,6 +235,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -394,6 +399,10 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
||||
<p>For example, a structure like this:</p>
|
||||
<pre><code>AlertPolicy:
|
||||
alert-strategy:
|
||||
auto-close: string
|
||||
notification-rate-limit:
|
||||
period: string
|
||||
combiner: string
|
||||
creation-record:
|
||||
mutate-time: string
|
||||
@@ -417,32 +426,44 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<ul>
|
||||
<li><code>-r . combiner=gubergren</code><ul>
|
||||
<li><code>-r .alert-strategy auto-close=dolor</code><ul>
|
||||
<li>If an alert policy that was active has no data for this long, any open incidents will close</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>notification-rate-limit period=ea</code></p>
|
||||
<ul>
|
||||
<li>Not more than one notification per period.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>... combiner=ipsum</code></p>
|
||||
<ul>
|
||||
<li>How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>creation-record mutate-time=eos</code><ul>
|
||||
<li><code>creation-record mutate-time=invidunt</code><ul>
|
||||
<li>When the change occurred.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>mutated-by=dolor</code></p>
|
||||
<p><code>mutated-by=amet</code></p>
|
||||
<ul>
|
||||
<li>The email address of the user making the change.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. display-name=ea</code></p>
|
||||
<p><code>.. display-name=duo</code></p>
|
||||
<ul>
|
||||
<li>A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>documentation content=ipsum</code><ul>
|
||||
<li>The text of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller.</li>
|
||||
<li>The text of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables).</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>mime-type=invidunt</code></p>
|
||||
<p><code>mime-type=sed</code></p>
|
||||
<ul>
|
||||
<li>The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown (https://en.wikipedia.org/wiki/Markdown) for more information.</li>
|
||||
</ul>
|
||||
@@ -453,7 +474,7 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
<li>Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>mutation-record mutate-time=duo</code><ul>
|
||||
<li><code>mutation-record mutate-time=ipsum</code><ul>
|
||||
<li>When the change occurred.</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -464,26 +485,26 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. name=sed</code></p>
|
||||
<p><code>.. name=est</code></p>
|
||||
<ul>
|
||||
<li>Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>notification-channels=ut</code><ul>
|
||||
<li><code>notification-channels=gubergren</code><ul>
|
||||
<li>Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] </li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>user-labels=key=gubergren</code><ul>
|
||||
<li><code>user-labels=key=ea</code><ul>
|
||||
<li>User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.</li>
|
||||
<li>the value will be associated with the given <code>key</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>validity code=85</code><ul>
|
||||
<li><code>validity code=2</code><ul>
|
||||
<li>The status code, which should be an enum value of google.rpc.Code.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>message=est</code><ul>
|
||||
<li><code>message=lorem</code><ul>
|
||||
<li>A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Collectd Time Series Create - Monitoring v2.0.4+20210322</title>
|
||||
<title>Collectd Time Series Create - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -232,6 +232,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -383,7 +388,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>The project in which to create the time series. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
<li>The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the time series. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -401,17 +406,17 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<ul>
|
||||
<li><code>-r . collectd-version=ipsum</code><ul>
|
||||
<li><code>-r . collectd-version=eos</code><ul>
|
||||
<li>The version of collectd that collected the data. Example: "5.3.0-192.el6".</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>resource labels=key=ipsum</code><ul>
|
||||
<li><code>resource labels=key=labore</code><ul>
|
||||
<li>Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone".</li>
|
||||
<li>the value will be associated with the given <code>key</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>type=est</code><ul>
|
||||
<li>Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types and Logging resource types.</li>
|
||||
<li><code>type=sed</code><ul>
|
||||
<li>Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list).</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Groups Create - Monitoring v2.0.4+20210322</title>
|
||||
<title>Groups Create - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -235,6 +235,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -385,7 +390,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The project in which to create the group. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the group. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -404,23 +409,23 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<ul>
|
||||
<li><code>-r . display-name=gubergren</code><ul>
|
||||
<li><code>-r . display-name=duo</code><ul>
|
||||
<li>A user-assigned name for this group, used only for display purposes.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>filter=ea</code><ul>
|
||||
<li><code>filter=sed</code><ul>
|
||||
<li>The filter used to determine which monitored resources belong to this group.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>is-cluster=false</code><ul>
|
||||
<li><code>is-cluster=true</code><ul>
|
||||
<li>If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>name=lorem</code><ul>
|
||||
<li><code>name=stet</code><ul>
|
||||
<li>Output only. The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>parent-name=eos</code><ul>
|
||||
<li><code>parent-name=kasd</code><ul>
|
||||
<li>The name of the group's parent, if it has one. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] For groups with no parent, parent_name is the empty string, "".</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Groups Delete - Monitoring v2.0.4+20210322</title>
|
||||
<title>Groups Delete - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -230,6 +230,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Groups Get - Monitoring v2.0.4+20210322</title>
|
||||
<title>Groups Get - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -227,6 +227,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Groups List - Monitoring v2.0.4+20210322</title>
|
||||
<title>Groups List - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -230,6 +230,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -381,7 +386,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The project whose groups are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose groups are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Groups Members List - Monitoring v2.0.4+20210322</title>
|
||||
<title>Groups Members List - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -230,6 +230,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Groups Update - Monitoring v2.0.4+20210322</title>
|
||||
<title>Groups Update - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -235,6 +235,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -404,7 +409,7 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<ul>
|
||||
<li><code>-r . display-name=labore</code><ul>
|
||||
<li><code>-r . display-name=et</code><ul>
|
||||
<li>A user-assigned name for this group, used only for display purposes.</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -412,15 +417,15 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
<li>The filter used to determine which monitored resources belong to this group.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>is-cluster=false</code><ul>
|
||||
<li><code>is-cluster=true</code><ul>
|
||||
<li>If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>name=sed</code><ul>
|
||||
<li><code>name=vero</code><ul>
|
||||
<li>Output only. The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>parent-name=no</code><ul>
|
||||
<li><code>parent-name=erat</code><ul>
|
||||
<li>The name of the group's parent, if it has one. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] For groups with no parent, parent_name is the empty string, "".</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Metric Descriptors Create - Monitoring v2.0.4+20210322</title>
|
||||
<title>Metric Descriptors Create - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -232,6 +232,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -370,7 +375,7 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Creates a new metric descriptor. User-created metric descriptors define custom metrics (https://cloud.google.com/monitoring/custom-metrics).</p>
|
||||
<p>Creates a new metric descriptor. The creation is executed asynchronously and callers may check the returned operation to track its progress. User-created metric descriptors define custom metrics (https://cloud.google.com/monitoring/custom-metrics).</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
@@ -383,7 +388,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: 4 projects/PROJECT_ID_OR_NUMBER</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -410,56 +415,56 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<ul>
|
||||
<li><code>-r . description=stet</code><ul>
|
||||
<li><code>-r . description=sed</code><ul>
|
||||
<li>A detailed description of the metric, which can be used in documentation.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>display-name=kasd</code><ul>
|
||||
<li><code>display-name=duo</code><ul>
|
||||
<li>A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>launch-stage=et</code><ul>
|
||||
<li><code>launch-stage=dolore</code><ul>
|
||||
<li>Optional. The launch stage of the metric definition.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>metadata ingest-delay=sed</code><ul>
|
||||
<li><code>metadata ingest-delay=et</code><ul>
|
||||
<li>The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>launch-stage=et</code><ul>
|
||||
<li><code>launch-stage=voluptua.</code><ul>
|
||||
<li>Deprecated. Must use the MetricDescriptor.launch_stage instead.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>sample-period=et</code></p>
|
||||
<p><code>sample-period=amet.</code></p>
|
||||
<ul>
|
||||
<li>The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. metric-kind=vero</code></p>
|
||||
<p><code>.. metric-kind=consetetur</code></p>
|
||||
<ul>
|
||||
<li>Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>monitored-resource-types=erat</code><ul>
|
||||
<li><code>monitored-resource-types=diam</code><ul>
|
||||
<li>Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>name=sed</code><ul>
|
||||
<li><code>name=dolor</code><ul>
|
||||
<li>The resource name of the metric descriptor.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>type=duo</code><ul>
|
||||
<li><code>type=et</code><ul>
|
||||
<li>The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" </li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>unit=dolore</code><ul>
|
||||
<li><code>unit=et</code><ul>
|
||||
<li>The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>value-type=et</code><ul>
|
||||
<li><code>value-type=sadipscing</code><ul>
|
||||
<li>Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Metric Descriptors Delete - Monitoring v2.0.4+20210322</title>
|
||||
<title>Metric Descriptors Delete - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -227,6 +227,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Metric Descriptors Get - Monitoring v2.0.4+20210322</title>
|
||||
<title>Metric Descriptors Get - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -227,6 +227,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -365,7 +370,7 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Gets a single metric descriptor. This method does not require a Workspace.</p>
|
||||
<p>Gets a single metric descriptor.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Metric Descriptors List - Monitoring v2.0.4+20210322</title>
|
||||
<title>Metric Descriptors List - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -230,6 +230,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -368,7 +373,7 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Lists metric descriptors that match a filter. This method does not require a Workspace.</p>
|
||||
<p>Lists metric descriptors that match a filter.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
@@ -382,7 +387,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Monitored Resource Descriptors Get - Monitoring v2.0.4+20210322</title>
|
||||
<title>Monitored Resource Descriptors Get - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -227,6 +227,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -365,7 +370,7 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Gets a single monitored resource descriptor. This method does not require a Workspace.</p>
|
||||
<p>Gets a single monitored resource descriptor.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Monitored Resource Descriptors List - Monitoring v2.0.4+20210322</title>
|
||||
<title>Monitored Resource Descriptors List - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -230,6 +230,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -368,7 +373,7 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Lists monitored resource descriptors that match a filter. This method does not require a Workspace.</p>
|
||||
<p>Lists monitored resource descriptors that match a filter.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
@@ -382,7 +387,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Notification Channel Descriptors Get - Monitoring v2.0.4+20210322</title>
|
||||
<title>Notification Channel Descriptors Get - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -227,6 +227,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Notification Channel Descriptors List - Monitoring v2.0.4+20210322</title>
|
||||
<title>Notification Channel Descriptors List - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -230,6 +230,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -381,7 +386,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is: projects/[PROJECT_ID_OR_NUMBER] Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead.</li>
|
||||
<li>Required. The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is: projects/[PROJECT_ID_OR_NUMBER] Note that this names (https://cloud.google.com/monitoring/api/v3#project_name) the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Notification Channels Create - Monitoring v2.0.4+20210322</title>
|
||||
<title>Notification Channels Create - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -232,6 +232,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -382,7 +387,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the container into which the channel will be written, this does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a prefix, but will add /notificationChannels/[CHANNEL_ID] to identify the channel.</li>
|
||||
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the container into which the channel will be written, this does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a prefix, but will add /notificationChannels/[CHANNEL_ID] to identify the channel.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -407,49 +412,49 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<ul>
|
||||
<li><code>-r .creation-record mutate-time=voluptua.</code><ul>
|
||||
<li><code>-r .creation-record mutate-time=stet</code><ul>
|
||||
<li>When the change occurred.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>mutated-by=amet.</code></p>
|
||||
<p><code>mutated-by=dolor</code></p>
|
||||
<ul>
|
||||
<li>The email address of the user making the change.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. description=consetetur</code></p>
|
||||
<p><code>.. description=duo</code></p>
|
||||
<ul>
|
||||
<li>An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>display-name=diam</code><ul>
|
||||
<li><code>display-name=vero</code><ul>
|
||||
<li>An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>enabled=true</code><ul>
|
||||
<li><code>enabled=false</code><ul>
|
||||
<li>Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>labels=key=et</code><ul>
|
||||
<li><code>labels=key=invidunt</code><ul>
|
||||
<li>Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field.</li>
|
||||
<li>the value will be associated with the given <code>key</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>name=et</code><ul>
|
||||
<li><code>name=stet</code><ul>
|
||||
<li>The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>type=sadipscing</code><ul>
|
||||
<li><code>type=vero</code><ul>
|
||||
<li>The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>user-labels=key=stet</code><ul>
|
||||
<li><code>user-labels=key=elitr</code><ul>
|
||||
<li>User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.</li>
|
||||
<li>the value will be associated with the given <code>key</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>verification-status=dolor</code><ul>
|
||||
<li><code>verification-status=lorem</code><ul>
|
||||
<li>Indicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel.</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Notification Channels Delete - Monitoring v2.0.4+20210322</title>
|
||||
<title>Notification Channels Delete - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -230,6 +230,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Notification Channels Get Verification Code - Monitoring v2.0.4+20210322</title>
|
||||
<title>Notification Channels Get Verification Code - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -232,6 +232,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -397,7 +402,7 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<ul>
|
||||
<li><code>-r . expire-time=duo</code><ul>
|
||||
<li><code>-r . expire-time=diam</code><ul>
|
||||
<li>The desired expiration time. If specified, the API will guarantee that the returned code will not be valid after the specified timestamp; however, the API cannot guarantee that the returned code will be valid for at least as long as the requested time (the API puts an upper bound on the amount of time for which a code may be valid). If omitted, a default expiration will be used, which may be less than the max permissible expiration (so specifying an expiration may extend the code's lifetime over omitting an expiration, even though the API does impose an upper limit on the maximum expiration that is permitted).</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Notification Channels Get - Monitoring v2.0.4+20210322</title>
|
||||
<title>Notification Channels Get - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -227,6 +227,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Notification Channels List - Monitoring v2.0.4+20210322</title>
|
||||
<title>Notification Channels List - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -230,6 +230,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -381,7 +386,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the GetNotificationChannel operation.</li>
|
||||
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the GetNotificationChannel operation.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Notification Channels Patch - Monitoring v2.0.4+20210322</title>
|
||||
<title>Notification Channels Patch - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -235,6 +235,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -410,49 +415,49 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<ul>
|
||||
<li><code>-r .creation-record mutate-time=vero</code><ul>
|
||||
<li><code>-r .creation-record mutate-time=no</code><ul>
|
||||
<li>When the change occurred.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>mutated-by=vero</code></p>
|
||||
<p><code>mutated-by=ipsum</code></p>
|
||||
<ul>
|
||||
<li>The email address of the user making the change.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. description=invidunt</code></p>
|
||||
<p><code>.. description=accusam</code></p>
|
||||
<ul>
|
||||
<li>An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>display-name=stet</code><ul>
|
||||
<li><code>display-name=takimata</code><ul>
|
||||
<li>An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>enabled=false</code><ul>
|
||||
<li><code>enabled=true</code><ul>
|
||||
<li>Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>labels=key=elitr</code><ul>
|
||||
<li><code>labels=key=voluptua.</code><ul>
|
||||
<li>Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field.</li>
|
||||
<li>the value will be associated with the given <code>key</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>name=lorem</code><ul>
|
||||
<li><code>name=et</code><ul>
|
||||
<li>The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>type=diam</code><ul>
|
||||
<li><code>type=erat</code><ul>
|
||||
<li>The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>user-labels=key=no</code><ul>
|
||||
<li><code>user-labels=key=consetetur</code><ul>
|
||||
<li>User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.</li>
|
||||
<li>the value will be associated with the given <code>key</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>verification-status=ipsum</code><ul>
|
||||
<li><code>verification-status=amet.</code><ul>
|
||||
<li>Indicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel.</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Notification Channels Send Verification Code - Monitoring v2.0.4+20210322</title>
|
||||
<title>Notification Channels Send Verification Code - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -232,6 +232,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Notification Channels Verify - Monitoring v2.0.4+20210322</title>
|
||||
<title>Notification Channels Verify - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -232,6 +232,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -397,7 +402,7 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<ul>
|
||||
<li><code>-r . code=accusam</code><ul>
|
||||
<li><code>-r . code=sed</code><ul>
|
||||
<li>Required. The verification code that was delivered to the channel as a result of invoking the SendNotificationChannelVerificationCode API method or that was retrieved from a verified channel via GetNotificationChannelVerificationCode. For example, one might have "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, one is only guaranteed that the code is valid UTF-8; one should not make any assumptions regarding the structure or format of the code).</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@@ -0,0 +1,536 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Time Series Create Service - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
||||
|
||||
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../css/highlight.css">
|
||||
|
||||
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
|
||||
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
|
||||
<script type="text/javascript" src="../js/highlight.pack.js"></script>
|
||||
<script src="../js/theme.js"></script>
|
||||
|
||||
<style>
|
||||
body {font-size: 90%;}
|
||||
pre, code {font-size: 100%;}
|
||||
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
|
||||
</style>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
<ul class="current">
|
||||
|
||||
|
||||
<span>Folders</span>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../folders_time-series-list">Time Series List</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span>Organizations</span>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_time-series-list">Time Series List</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span>Projects</span>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_alert-policies-create">Alert Policies Create</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_alert-policies-delete">Alert Policies Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_alert-policies-get">Alert Policies Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_alert-policies-list">Alert Policies List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_alert-policies-patch">Alert Policies Patch</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_collectd-time-series-create">Collectd Time Series Create</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_groups-create">Groups Create</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_groups-delete">Groups Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_groups-get">Groups Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_groups-list">Groups List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_groups-members-list">Groups Members List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_groups-update">Groups Update</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_metric-descriptors-create">Metric Descriptors Create</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_metric-descriptors-delete">Metric Descriptors Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_metric-descriptors-get">Metric Descriptors Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_metric-descriptors-list">Metric Descriptors List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_monitored-resource-descriptors-get">Monitored Resource Descriptors Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_monitored-resource-descriptors-list">Monitored Resource Descriptors List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_notification-channel-descriptors-get">Notification Channel Descriptors Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_notification-channel-descriptors-list">Notification Channel Descriptors List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_notification-channels-create">Notification Channels Create</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_notification-channels-delete">Notification Channels Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_notification-channels-get">Notification Channels Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_notification-channels-get-verification-code">Notification Channels Get Verification Code</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_notification-channels-list">Notification Channels List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_notification-channels-patch">Notification Channels Patch</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_notification-channels-send-verification-code">Notification Channels Send Verification Code</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_notification-channels-verify">Notification Channels Verify</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create">Time Series Create</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 current">
|
||||
<a class="current" href=".">Time Series Create Service</a>
|
||||
|
||||
<ul>
|
||||
|
||||
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
|
||||
|
||||
|
||||
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
|
||||
|
||||
|
||||
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
|
||||
|
||||
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
|
||||
|
||||
|
||||
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
|
||||
|
||||
|
||||
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-query">Time Series Query</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_uptime-check-configs-create">Uptime Check Configs Create</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_uptime-check-configs-delete">Uptime Check Configs Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_uptime-check-configs-get">Uptime Check Configs Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_uptime-check-configs-list">Uptime Check Configs List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_uptime-check-configs-patch">Uptime Check Configs Patch</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span>Services</span>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../services_create">Create</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../services_delete">Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../services_get">Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../services_list">List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../services_patch">Patch</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../services_service-level-objectives-create">Service Level Objectives Create</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../services_service-level-objectives-delete">Service Level Objectives Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../services_service-level-objectives-get">Service Level Objectives Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../services_service-level-objectives-list">Service Level Objectives List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../services_service-level-objectives-patch">Service Level Objectives Patch</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span>Uptime Check Ips</span>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../uptime-check-ips_list">List</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
||||
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
|
||||
<a href=".."></a>
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="..">Docs</a> »</li>
|
||||
<li>Time Series Create Service</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/monitoring3-cli" class="icon icon-github"> Edit on GitHub</a>
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Creates or adds data to one or more service time series. A service time series is a time series for a metric from a Google Cloud service. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response. This endpoint rejects writes to user-defined metrics. This method is only for use by Google Cloud services. Use projects.timeSeries.create instead.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/monitoring</em></li>
|
||||
<li><em>https://www.googleapis.com/auth/monitoring.write</em></li>
|
||||
</ul>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
|
||||
You can set the scope for this method like this: <code>monitoring3 --scope <scope> projects time-series-create-service ...</code></p>
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h1 id="required-request-value">Required Request Value</h1>
|
||||
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
||||
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
||||
<p>For example, a structure like this:</p>
|
||||
<pre><code>CreateTimeSeriesRequest:
|
||||
|
||||
</code></pre>
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<h3 id="about-cursors">About Cursors</h3>
|
||||
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
||||
<ul>
|
||||
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
||||
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
||||
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
||||
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
||||
</ul>
|
||||
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
||||
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
||||
<ul>
|
||||
<li><strong>-o out</strong><ul>
|
||||
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
||||
It will be a JSON-encoded structure.
|
||||
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
||||
If unset, it defaults to standard output.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h1 id="optional-general-properties">Optional General Properties</h1>
|
||||
<p>The following properties can configure any call, and are not specific to this method.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p><strong>-p $-xgafv=string</strong></p>
|
||||
<ul>
|
||||
<li>V1 error format.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p access-token=string</strong></p>
|
||||
<ul>
|
||||
<li>OAuth access token.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p alt=string</strong></p>
|
||||
<ul>
|
||||
<li>Data format for response.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p callback=string</strong></p>
|
||||
<ul>
|
||||
<li>JSONP</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p fields=string</strong></p>
|
||||
<ul>
|
||||
<li>Selector specifying which fields to include in a partial response.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p key=string</strong></p>
|
||||
<ul>
|
||||
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p oauth-token=string</strong></p>
|
||||
<ul>
|
||||
<li>OAuth 2.0 token for the current user.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p pretty-print=boolean</strong></p>
|
||||
<ul>
|
||||
<li>Returns response with indentations and line breaks.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p quota-user=string</strong></p>
|
||||
<ul>
|
||||
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p upload-type=string</strong></p>
|
||||
<ul>
|
||||
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p upload-protocol=string</strong></p>
|
||||
<ul>
|
||||
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="../projects_time-series-list" class="btn btn-neutral float-right" title="Time Series List"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
|
||||
|
||||
<a href="../projects_time-series-create" class="btn btn-neutral" title="Time Series Create"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
<!-- Copyright etc -->
|
||||
</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" style="cursor: pointer">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
||||
|
||||
<span><a href="../projects_time-series-create" style="color: #fcfcfc;">« Previous</a></span>
|
||||
<span style="margin-left: 15px"><a href="../projects_time-series-list" style="color: #fcfcfc">Next »</a></span>
|
||||
</span>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Time Series Create - Monitoring v2.0.4+20210322</title>
|
||||
<title>Time Series Create - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -232,6 +232,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -383,7 +388,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -492,7 +497,7 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="../projects_time-series-list" class="btn btn-neutral float-right" title="Time Series List"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
<a href="../projects_time-series-create-service" class="btn btn-neutral float-right" title="Time Series Create Service"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
|
||||
|
||||
<a href="../projects_notification-channels-verify" class="btn btn-neutral" title="Notification Channels Verify"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
@@ -524,7 +529,7 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
||||
|
||||
<span><a href="../projects_notification-channels-verify" style="color: #fcfcfc;">« Previous</a></span>
|
||||
<span style="margin-left: 15px"><a href="../projects_time-series-list" style="color: #fcfcfc">Next »</a></span>
|
||||
<span style="margin-left: 15px"><a href="../projects_time-series-create-service" style="color: #fcfcfc">Next »</a></span>
|
||||
</span>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Time Series List - Monitoring v2.0.4+20210322</title>
|
||||
<title>Time Series List - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 current">
|
||||
<a class="current" href=".">Time Series List</a>
|
||||
|
||||
@@ -368,7 +373,7 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Lists time series that match a filter. This method does not require a Workspace.</p>
|
||||
<p>Lists time series that match a filter.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
@@ -381,7 +386,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The project, organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID] </li>
|
||||
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name), organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID] </li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -572,7 +577,7 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
<a href="../projects_time-series-query" class="btn btn-neutral float-right" title="Time Series Query"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
|
||||
|
||||
<a href="../projects_time-series-create" class="btn btn-neutral" title="Time Series Create"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
<a href="../projects_time-series-create-service" class="btn btn-neutral" title="Time Series Create Service"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -600,7 +605,7 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
|
||||
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
||||
|
||||
<span><a href="../projects_time-series-create" style="color: #fcfcfc;">« Previous</a></span>
|
||||
<span><a href="../projects_time-series-create-service" style="color: #fcfcfc;">« Previous</a></span>
|
||||
<span style="margin-left: 15px"><a href="../projects_time-series-query" style="color: #fcfcfc">Next »</a></span>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Time Series Query - Monitoring v2.0.4+20210322</title>
|
||||
<title>Time Series Query - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -370,7 +375,7 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Queries time series using Monitoring Query Language. This method does not require a Workspace.</p>
|
||||
<p>Queries time series using Monitoring Query Language.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
||||
<ul>
|
||||
@@ -383,7 +388,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -400,15 +405,15 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<ul>
|
||||
<li><code>-r . page-size=42</code><ul>
|
||||
<li><code>-r . page-size=92</code><ul>
|
||||
<li>A positive number that is the maximum number of time_series_data to return.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>page-token=consetetur</code><ul>
|
||||
<li><code>page-token=dolores</code><ul>
|
||||
<li>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 additional results from the previous method call.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>query=voluptua.</code><ul>
|
||||
<li><code>query=gubergren</code><ul>
|
||||
<li>Required. The query in the Monitoring Query Language (https://cloud.google.com/monitoring/mql/reference) format. The default time zone is in UTC.</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Uptime Check Configs Create - Monitoring v2.0.4+20210322</title>
|
||||
<title>Uptime Check Configs Create - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -382,7 +387,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><parent></strong> <em>(string)</em><ul>
|
||||
<li>Required. The project in which to create the Uptime check. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the Uptime check. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -391,6 +396,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
||||
<p>For example, a structure like this:</p>
|
||||
<pre><code>UptimeCheckConfig:
|
||||
checker-type: string
|
||||
display-name: string
|
||||
http-check:
|
||||
auth-info:
|
||||
@@ -423,52 +429,56 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<ul>
|
||||
<li><code>-r . display-name=et</code><ul>
|
||||
<li><code>-r . checker-type=et</code><ul>
|
||||
<li>The type of checkers to use to execute the Uptime check.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>display-name=accusam</code><ul>
|
||||
<li>A human-friendly name for the Uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>http-check.auth-info password=erat</code><ul>
|
||||
<li><code>http-check.auth-info password=voluptua.</code><ul>
|
||||
<li>The password to use when authenticating with the HTTP server.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>username=consetetur</code></p>
|
||||
<p><code>username=dolore</code></p>
|
||||
<ul>
|
||||
<li>The username to use when authenticating with the HTTP server.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. body=amet.</code></p>
|
||||
<p><code>.. body=dolore</code></p>
|
||||
<ul>
|
||||
<li>The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=".</li>
|
||||
<li>The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte.Note: If client libraries aren't used (which performs the conversion automatically) base64 encode your body data since the field is of bytes type.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>content-type=sed</code><ul>
|
||||
<li><code>content-type=dolore</code><ul>
|
||||
<li>The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>headers=key=takimata</code><ul>
|
||||
<li><code>headers=key=voluptua.</code><ul>
|
||||
<li>The list of headers to send as part of the Uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.</li>
|
||||
<li>the value will be associated with the given <code>key</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>mask-headers=true</code><ul>
|
||||
<li><code>mask-headers=false</code><ul>
|
||||
<li>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 <strong>*</strong>*.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>path=et</code><ul>
|
||||
<li><code>path=lorem</code><ul>
|
||||
<li>Optional (defaults to "/"). 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 "/", a "/" will be prepended automatically.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>port=78</code><ul>
|
||||
<li><code>port=63</code><ul>
|
||||
<li>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.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>request-method=voluptua.</code><ul>
|
||||
<li><code>request-method=no</code><ul>
|
||||
<li>The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>use-ssl=false</code><ul>
|
||||
<li><code>use-ssl=true</code><ul>
|
||||
<li>If true, use HTTPS instead of HTTP to run the check.</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -484,52 +494,52 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
<li>If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>monitored-resource labels=key=no</code><ul>
|
||||
<li><code>monitored-resource labels=key=aliquyam</code><ul>
|
||||
<li>Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone".</li>
|
||||
<li>the value will be associated with the given <code>key</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>type=est</code></p>
|
||||
<p><code>type=ipsum</code></p>
|
||||
<ul>
|
||||
<li>Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types and Logging resource types.</li>
|
||||
<li>Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list).</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. name=at</code></p>
|
||||
<p><code>.. name=et</code></p>
|
||||
<ul>
|
||||
<li>A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>period=sed</code><ul>
|
||||
<li><code>period=sanctus</code><ul>
|
||||
<li>How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>resource-group group-id=sit</code><ul>
|
||||
<li><code>resource-group group-id=lorem</code><ul>
|
||||
<li>The group of resources being monitored. Should be only the [GROUP_ID], and not the full-path projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID].</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>resource-type=et</code></p>
|
||||
<p><code>resource-type=est</code></p>
|
||||
<ul>
|
||||
<li>The resource type of the group members.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. selected-regions=tempor</code></p>
|
||||
<p><code>.. selected-regions=sed</code></p>
|
||||
<ul>
|
||||
<li>The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>tcp-check port=69</code></p>
|
||||
<p><code>tcp-check port=72</code></p>
|
||||
<ul>
|
||||
<li>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.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. timeout=ipsum</code></p>
|
||||
<p><code>.. timeout=dolores</code></p>
|
||||
<ul>
|
||||
<li>The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Uptime Check Configs Delete - Monitoring v2.0.4+20210322</title>
|
||||
<title>Uptime Check Configs Delete - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Uptime Check Configs Get - Monitoring v2.0.4+20210322</title>
|
||||
<title>Uptime Check Configs Get - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Uptime Check Configs List - Monitoring v2.0.4+20210322</title>
|
||||
<title>Uptime Check Configs List - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -381,7 +386,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><parent></strong> <em>(string)</em><ul>
|
||||
<li>Required. The project whose Uptime check configurations are listed. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
<li>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] </li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Uptime Check Configs Patch - Monitoring v2.0.4+20210322</title>
|
||||
<title>Uptime Check Configs Patch - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -394,6 +399,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
||||
<p>For example, a structure like this:</p>
|
||||
<pre><code>UptimeCheckConfig:
|
||||
checker-type: string
|
||||
display-name: string
|
||||
http-check:
|
||||
auth-info:
|
||||
@@ -426,31 +432,35 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<ul>
|
||||
<li><code>-r . display-name=et</code><ul>
|
||||
<li><code>-r . checker-type=dolores</code><ul>
|
||||
<li>The type of checkers to use to execute the Uptime check.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>display-name=et</code><ul>
|
||||
<li>A human-friendly name for the Uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>http-check.auth-info password=sanctus</code><ul>
|
||||
<li><code>http-check.auth-info password=sed</code><ul>
|
||||
<li>The password to use when authenticating with the HTTP server.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>username=lorem</code></p>
|
||||
<p><code>username=no</code></p>
|
||||
<ul>
|
||||
<li>The username to use when authenticating with the HTTP server.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. body=est</code></p>
|
||||
<p><code>.. body=et</code></p>
|
||||
<ul>
|
||||
<li>The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=".</li>
|
||||
<li>The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte.Note: If client libraries aren't used (which performs the conversion automatically) base64 encode your body data since the field is of bytes type.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>content-type=sed</code><ul>
|
||||
<li><code>content-type=elitr</code><ul>
|
||||
<li>The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>headers=key=diam</code><ul>
|
||||
<li><code>headers=key=sed</code><ul>
|
||||
<li>The list of headers to send as part of the Uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.</li>
|
||||
<li>the value will be associated with the given <code>key</code></li>
|
||||
</ul>
|
||||
@@ -459,19 +469,19 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
<li>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 <strong>*</strong>*.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>path=et</code><ul>
|
||||
<li><code>path=nonumy</code><ul>
|
||||
<li>Optional (defaults to "/"). 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 "/", a "/" will be prepended automatically.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>port=8</code><ul>
|
||||
<li><code>port=24</code><ul>
|
||||
<li>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.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>request-method=no</code><ul>
|
||||
<li><code>request-method=sadipscing</code><ul>
|
||||
<li>The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>use-ssl=false</code><ul>
|
||||
<li><code>use-ssl=true</code><ul>
|
||||
<li>If true, use HTTPS instead of HTTP to run the check.</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -487,46 +497,46 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
<li>If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>monitored-resource labels=key=no</code><ul>
|
||||
<li><code>monitored-resource labels=key=amet</code><ul>
|
||||
<li>Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone".</li>
|
||||
<li>the value will be associated with the given <code>key</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>type=nonumy</code></p>
|
||||
<p><code>type=est</code></p>
|
||||
<ul>
|
||||
<li>Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types and Logging resource types.</li>
|
||||
<li>Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list).</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. name=at</code></p>
|
||||
<p><code>.. name=et</code></p>
|
||||
<ul>
|
||||
<li>A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>period=sadipscing</code><ul>
|
||||
<li><code>period=sea</code><ul>
|
||||
<li>How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>resource-group group-id=aliquyam</code><ul>
|
||||
<li><code>resource-group group-id=consetetur</code><ul>
|
||||
<li>The group of resources being monitored. Should be only the [GROUP_ID], and not the full-path projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID].</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>resource-type=dolores</code></p>
|
||||
<p><code>resource-type=consetetur</code></p>
|
||||
<ul>
|
||||
<li>The resource type of the group members.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. selected-regions=sadipscing</code></p>
|
||||
<p><code>.. selected-regions=stet</code></p>
|
||||
<ul>
|
||||
<li>The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>tcp-check port=70</code></p>
|
||||
<p><code>tcp-check port=94</code></p>
|
||||
<ul>
|
||||
<li>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.</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Create - Monitoring v2.0.4+20210322</title>
|
||||
<title>Create - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -385,7 +390,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><parent></strong> <em>(string)</em><ul>
|
||||
<li>Required. Resource name of the parent workspace. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
<li>Required. Resource name (https://cloud.google.com/monitoring/api/v3#project_name) of the parent workspace. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -415,89 +420,99 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
name: string
|
||||
telemetry:
|
||||
resource-name: string
|
||||
user-labels: { string: string }
|
||||
|
||||
</code></pre>
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p><code>-r .app-engine module-id=amet</code></p>
|
||||
<p><code>-r .app-engine module-id=elitr</code></p>
|
||||
<ul>
|
||||
<li>The ID of the App Engine module underlying this service. Corresponds to the module_id resource label in the gae_app monitored resource: https://cloud.google.com/monitoring/api/resources#tag_gae_app</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>..cloud-endpoints service=est</code></p>
|
||||
<p><code>..cloud-endpoints service=duo</code></p>
|
||||
<ul>
|
||||
<li>The name of the Cloud Endpoints service underlying this service. Corresponds to the service resource label in the api monitored resource: https://cloud.google.com/monitoring/api/resources#tag_api</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>..cluster-istio cluster-name=et</code></p>
|
||||
<p><code>..cluster-istio cluster-name=diam</code></p>
|
||||
<ul>
|
||||
<li>The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the cluster_name resource label in k8s_cluster resources.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>location=sea</code><ul>
|
||||
<li><code>location=est</code><ul>
|
||||
<li>The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the location resource label in k8s_cluster resources.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>service-name=consetetur</code><ul>
|
||||
<li><code>service-name=sit</code><ul>
|
||||
<li>The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>service-namespace=consetetur</code></p>
|
||||
<p><code>service-namespace=sed</code></p>
|
||||
<ul>
|
||||
<li>The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. display-name=stet</code></p>
|
||||
<p><code>.. display-name=eos</code></p>
|
||||
<ul>
|
||||
<li>Name used for UI elements listing this Service.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>istio-canonical-service canonical-service=est</code><ul>
|
||||
<li><code>istio-canonical-service canonical-service=lorem</code><ul>
|
||||
<li>The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio).</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>canonical-service-namespace=aliquyam</code><ul>
|
||||
<li><code>canonical-service-namespace=ea</code><ul>
|
||||
<li>The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio).</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>mesh-uid=elitr</code></p>
|
||||
<p><code>mesh-uid=stet</code></p>
|
||||
<ul>
|
||||
<li>Identifier for the Istio mesh in which this canonical service is defined. Corresponds to the mesh_uid metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio).</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>..mesh-istio mesh-uid=duo</code></p>
|
||||
<p><code>..mesh-istio mesh-uid=dolores</code></p>
|
||||
<ul>
|
||||
<li>Identifier for the mesh in which this Istio service is defined. Corresponds to the mesh_uid metric label in Istio metrics.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>service-name=diam</code><ul>
|
||||
<li><code>service-name=eos</code><ul>
|
||||
<li>The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>service-namespace=est</code></p>
|
||||
<p><code>service-namespace=et</code></p>
|
||||
<ul>
|
||||
<li>The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. name=sit</code></p>
|
||||
<p><code>.. name=sea</code></p>
|
||||
<ul>
|
||||
<li>Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] </li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>telemetry resource-name=sed</code><ul>
|
||||
<li>
|
||||
<p><code>telemetry resource-name=et</code></p>
|
||||
<ul>
|
||||
<li>The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. user-labels=key=at</code></p>
|
||||
<ul>
|
||||
<li>Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.</li>
|
||||
<li>the value will be associated with the given <code>key</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id="about-cursors">About Cursors</h3>
|
||||
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Delete - Monitoring v2.0.4+20210322</title>
|
||||
<title>Delete - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Get - Monitoring v2.0.4+20210322</title>
|
||||
<title>Get - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>List - Monitoring v2.0.4+20210322</title>
|
||||
<title>List - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -381,7 +386,7 @@ You can set the scope for this method like this: <code>monitoring3 --scope <s
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><parent></strong> <em>(string)</em><ul>
|
||||
<li>Required. Resource name of the parent containing the listed services, either a project or a Monitoring Workspace. The formats are: projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER] </li>
|
||||
<li>Required. Resource name of the parent containing the listed services, either a project (https://cloud.google.com/monitoring/api/v3#project_name) or a Monitoring Workspace. The formats are: projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER] </li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Patch - Monitoring v2.0.4+20210322</title>
|
||||
<title>Patch - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -415,89 +420,99 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
name: string
|
||||
telemetry:
|
||||
resource-name: string
|
||||
user-labels: { string: string }
|
||||
|
||||
</code></pre>
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p><code>-r .app-engine module-id=eos</code></p>
|
||||
<p><code>-r .app-engine module-id=dolore</code></p>
|
||||
<ul>
|
||||
<li>The ID of the App Engine module underlying this service. Corresponds to the module_id resource label in the gae_app monitored resource: https://cloud.google.com/monitoring/api/resources#tag_gae_app</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>..cloud-endpoints service=lorem</code></p>
|
||||
<p><code>..cloud-endpoints service=eirmod</code></p>
|
||||
<ul>
|
||||
<li>The name of the Cloud Endpoints service underlying this service. Corresponds to the service resource label in the api monitored resource: https://cloud.google.com/monitoring/api/resources#tag_api</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>..cluster-istio cluster-name=ea</code></p>
|
||||
<p><code>..cluster-istio cluster-name=lorem</code></p>
|
||||
<ul>
|
||||
<li>The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the cluster_name resource label in k8s_cluster resources.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>location=stet</code><ul>
|
||||
<li><code>location=accusam</code><ul>
|
||||
<li>The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the location resource label in k8s_cluster resources.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>service-name=dolores</code><ul>
|
||||
<li><code>service-name=amet</code><ul>
|
||||
<li>The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>service-namespace=eos</code></p>
|
||||
<p><code>service-namespace=erat</code></p>
|
||||
<ul>
|
||||
<li>The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. display-name=et</code></p>
|
||||
<p><code>.. display-name=dolores</code></p>
|
||||
<ul>
|
||||
<li>Name used for UI elements listing this Service.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>istio-canonical-service canonical-service=sea</code><ul>
|
||||
<li><code>istio-canonical-service canonical-service=erat</code><ul>
|
||||
<li>The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio).</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>canonical-service-namespace=et</code><ul>
|
||||
<li><code>canonical-service-namespace=accusam</code><ul>
|
||||
<li>The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio).</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>mesh-uid=at</code></p>
|
||||
<p><code>mesh-uid=sea</code></p>
|
||||
<ul>
|
||||
<li>Identifier for the Istio mesh in which this canonical service is defined. Corresponds to the mesh_uid metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio).</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>..mesh-istio mesh-uid=dolore</code></p>
|
||||
<p><code>..mesh-istio mesh-uid=takimata</code></p>
|
||||
<ul>
|
||||
<li>Identifier for the mesh in which this Istio service is defined. Corresponds to the mesh_uid metric label in Istio metrics.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>service-name=eirmod</code><ul>
|
||||
<li><code>service-name=lorem</code><ul>
|
||||
<li>The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>service-namespace=lorem</code></p>
|
||||
<p><code>service-namespace=et</code></p>
|
||||
<ul>
|
||||
<li>The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. name=accusam</code></p>
|
||||
<p><code>.. name=at</code></p>
|
||||
<ul>
|
||||
<li>Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] </li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>telemetry resource-name=amet</code><ul>
|
||||
<li>
|
||||
<p><code>telemetry resource-name=dolor</code></p>
|
||||
<ul>
|
||||
<li>The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. user-labels=key=et</code></p>
|
||||
<ul>
|
||||
<li>Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.</li>
|
||||
<li>the value will be associated with the given <code>key</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id="about-cursors">About Cursors</h3>
|
||||
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Service Level Objectives Create - Monitoring v2.0.4+20210322</title>
|
||||
<title>Service Level Objectives Create - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -447,96 +452,34 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
min: number
|
||||
time-series: string
|
||||
window-period: string
|
||||
user-labels: { string: string }
|
||||
|
||||
</code></pre>
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<ul>
|
||||
<li><code>-r . calendar-period=erat</code><ul>
|
||||
<li><code>-r . calendar-period=sit</code><ul>
|
||||
<li>A calendar period, semantically "since the start of the current ". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>display-name=dolores</code><ul>
|
||||
<li><code>display-name=erat</code><ul>
|
||||
<li>Name used for UI elements listing this SLO.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>goal=0.15972633079770038</code><ul>
|
||||
<li><code>goal=0.7179078569204367</code><ul>
|
||||
<li>The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>name=sea</code><ul>
|
||||
<li><code>name=et</code><ul>
|
||||
<li>Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] </li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>rolling-period=takimata</code><ul>
|
||||
<li><code>rolling-period=gubergren</code><ul>
|
||||
<li>A rolling time period, semantically "in the past ". Must be an integer multiple of 1 day no larger than 30 days.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>service-level-indicator.basic-sli.latency threshold=lorem</code></p>
|
||||
<ul>
|
||||
<li>Good service is defined to be the count of requests made to this service that return in no more than threshold.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. location=et</code></p>
|
||||
<ul>
|
||||
<li>OPTIONAL: The set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>method=at</code><ul>
|
||||
<li>OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>version=dolor</code></p>
|
||||
<ul>
|
||||
<li>OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>..request-based.distribution-cut distribution-filter=et</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries aggregating values. Must have ValueType = DISTRIBUTION and MetricKind = DELTA or MetricKind = CUMULATIVE.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>range max=0.9295719371551834</code><ul>
|
||||
<li>Range maximum.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>min=0.9343576145104524</code></p>
|
||||
<ul>
|
||||
<li>Range minimum.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>...good-total-ratio bad-service-filter=sea</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries quantifying bad service, either demanded service that was not provided or demanded service that was of inadequate quality. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>good-service-filter=nonumy</code><ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries quantifying good service provided. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>total-service-filter=et</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries quantifying total demanded service. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>...windows-based good-bad-metric-filter=gubergren</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries with ValueType = BOOL. The window is good if any true values appear in the window.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>good-total-ratio-threshold.basic-sli-performance.latency threshold=justo</code></p>
|
||||
<p><code>service-level-indicator.basic-sli.latency threshold=justo</code></p>
|
||||
<ul>
|
||||
<li>Good service is defined to be the count of requests made to this service that return in no more than threshold.</li>
|
||||
</ul>
|
||||
@@ -561,7 +504,7 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>..performance.distribution-cut distribution-filter=aliquyam</code></p>
|
||||
<p><code>..request-based.distribution-cut distribution-filter=aliquyam</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries aggregating values. Must have ValueType = DISTRIBUTION and MetricKind = DELTA or MetricKind = CUMULATIVE.</li>
|
||||
</ul>
|
||||
@@ -593,32 +536,43 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>... threshold=0.3151317222476111</code></p>
|
||||
<p><code>...windows-based good-bad-metric-filter=no</code></p>
|
||||
<ul>
|
||||
<li>If window performance >= threshold, the window is counted as good.</li>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries with ValueType = BOOL. The window is good if any true values appear in the window.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>..metric-mean-in-range.range max=0.4023962607532475</code></p>
|
||||
<p><code>good-total-ratio-threshold.basic-sli-performance.latency threshold=amet.</code></p>
|
||||
<ul>
|
||||
<li>Range maximum.</li>
|
||||
<li>Good service is defined to be the count of requests made to this service that return in no more than threshold.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>min=0.3586942197762041</code></p>
|
||||
<p><code>.. location=ipsum</code></p>
|
||||
<ul>
|
||||
<li>Range minimum.</li>
|
||||
<li>OPTIONAL: The set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>method=lorem</code><ul>
|
||||
<li>OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. time-series=gubergren</code></p>
|
||||
<p><code>version=accusam</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying the TimeSeries to use for evaluating window quality.</li>
|
||||
<li>OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>..metric-sum-in-range.range max=0.8918752107029069</code></p>
|
||||
<p><code>..performance.distribution-cut distribution-filter=gubergren</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries aggregating values. Must have ValueType = DISTRIBUTION and MetricKind = DELTA or MetricKind = CUMULATIVE.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>range max=0.8918752107029069</code><ul>
|
||||
<li>Range maximum.</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -629,17 +583,76 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. time-series=duo</code></p>
|
||||
<p><code>...good-total-ratio bad-service-filter=duo</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries quantifying bad service, either demanded service that was not provided or demanded service that was of inadequate quality. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>good-service-filter=sit</code><ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries quantifying good service provided. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>total-service-filter=magna</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries quantifying total demanded service. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>... threshold=0.6236655549731105</code></p>
|
||||
<ul>
|
||||
<li>If window performance >= threshold, the window is counted as good.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>..metric-mean-in-range.range max=0.27563278945233194</code></p>
|
||||
<ul>
|
||||
<li>Range maximum.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>min=0.7462932559602827</code></p>
|
||||
<ul>
|
||||
<li>Range minimum.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. time-series=amet.</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying the TimeSeries to use for evaluating window quality.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. window-period=sit</code></p>
|
||||
<p><code>..metric-sum-in-range.range max=0.8131118916597782</code></p>
|
||||
<ul>
|
||||
<li>Range maximum.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>min=0.08583127305487803</code></p>
|
||||
<ul>
|
||||
<li>Range minimum.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. time-series=kasd</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying the TimeSeries to use for evaluating window quality.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. window-period=lorem</code></p>
|
||||
<ul>
|
||||
<li>Duration over which window quality is evaluated. Must be an integer fraction of a day and at least 60s.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>... user-labels=key=sanctus</code></p>
|
||||
<ul>
|
||||
<li>Labels which have been used to annotate the service-level objective. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.</li>
|
||||
<li>the value will be associated with the given <code>key</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id="about-cursors">About Cursors</h3>
|
||||
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Service Level Objectives Delete - Monitoring v2.0.4+20210322</title>
|
||||
<title>Service Level Objectives Delete - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Service Level Objectives Get - Monitoring v2.0.4+20210322</title>
|
||||
<title>Service Level Objectives Get - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Service Level Objectives List - Monitoring v2.0.4+20210322</title>
|
||||
<title>Service Level Objectives List - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Service Level Objectives Patch - Monitoring v2.0.4+20210322</title>
|
||||
<title>Service Level Objectives Patch - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
@@ -447,68 +452,69 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
min: number
|
||||
time-series: string
|
||||
window-period: string
|
||||
user-labels: { string: string }
|
||||
|
||||
</code></pre>
|
||||
|
||||
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
||||
<ul>
|
||||
<li><code>-r . calendar-period=magna</code><ul>
|
||||
<li><code>-r . calendar-period=nonumy</code><ul>
|
||||
<li>A calendar period, semantically "since the start of the current ". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>display-name=et</code><ul>
|
||||
<li><code>display-name=rebum.</code><ul>
|
||||
<li>Name used for UI elements listing this SLO.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>goal=0.820349993375188</code><ul>
|
||||
<li><code>goal=0.49172447269529684</code><ul>
|
||||
<li>The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>name=dolor</code><ul>
|
||||
<li><code>name=eos</code><ul>
|
||||
<li>Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] </li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>rolling-period=lorem</code><ul>
|
||||
<li><code>rolling-period=amet.</code><ul>
|
||||
<li>A rolling time period, semantically "in the past ". Must be an integer multiple of 1 day no larger than 30 days.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>service-level-indicator.basic-sli.latency threshold=justo</code></p>
|
||||
<p><code>service-level-indicator.basic-sli.latency threshold=dolore</code></p>
|
||||
<ul>
|
||||
<li>Good service is defined to be the count of requests made to this service that return in no more than threshold.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. location=amet.</code></p>
|
||||
<p><code>.. location=amet</code></p>
|
||||
<ul>
|
||||
<li>OPTIONAL: The set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>method=no</code><ul>
|
||||
<li><code>method=ut</code><ul>
|
||||
<li>OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>version=nonumy</code></p>
|
||||
<p><code>version=at</code></p>
|
||||
<ul>
|
||||
<li>OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>..request-based.distribution-cut distribution-filter=sed</code></p>
|
||||
<p><code>..request-based.distribution-cut distribution-filter=sit</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries aggregating values. Must have ValueType = DISTRIBUTION and MetricKind = DELTA or MetricKind = CUMULATIVE.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>range max=0.6940359249925465</code><ul>
|
||||
<li><code>range max=0.1955564814768168</code><ul>
|
||||
<li>Range maximum.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>min=0.342498288197713</code></p>
|
||||
<p><code>min=0.44431237216058306</code></p>
|
||||
<ul>
|
||||
<li>Range minimum.</li>
|
||||
</ul>
|
||||
@@ -519,127 +525,134 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries quantifying bad service, either demanded service that was not provided or demanded service that was of inadequate quality. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>good-service-filter=tempor</code><ul>
|
||||
<li><code>good-service-filter=duo</code><ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries quantifying good service provided. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>total-service-filter=dolore</code></p>
|
||||
<p><code>total-service-filter=kasd</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries quantifying total demanded service. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>...windows-based good-bad-metric-filter=eos</code></p>
|
||||
<p><code>...windows-based good-bad-metric-filter=sadipscing</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries with ValueType = BOOL. The window is good if any true values appear in the window.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>good-total-ratio-threshold.basic-sli-performance.latency threshold=amet.</code></p>
|
||||
<p><code>good-total-ratio-threshold.basic-sli-performance.latency threshold=tempor</code></p>
|
||||
<ul>
|
||||
<li>Good service is defined to be the count of requests made to this service that return in no more than threshold.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. location=dolore</code></p>
|
||||
<p><code>.. location=sea</code></p>
|
||||
<ul>
|
||||
<li>OPTIONAL: The set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>method=amet</code><ul>
|
||||
<li><code>method=et</code><ul>
|
||||
<li>OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>version=ut</code></p>
|
||||
<p><code>version=lorem</code></p>
|
||||
<ul>
|
||||
<li>OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>..performance.distribution-cut distribution-filter=at</code></p>
|
||||
<p><code>..performance.distribution-cut distribution-filter=magna</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries aggregating values. Must have ValueType = DISTRIBUTION and MetricKind = DELTA or MetricKind = CUMULATIVE.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>range max=0.3787849038508272</code><ul>
|
||||
<li><code>range max=0.3283916781018025</code><ul>
|
||||
<li>Range maximum.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>min=0.6394924405538467</code></p>
|
||||
<p><code>min=0.2767666248974914</code></p>
|
||||
<ul>
|
||||
<li>Range minimum.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>...good-total-ratio bad-service-filter=ut</code></p>
|
||||
<p><code>...good-total-ratio bad-service-filter=invidunt</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries quantifying bad service, either demanded service that was not provided or demanded service that was of inadequate quality. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>good-service-filter=rebum.</code><ul>
|
||||
<li><code>good-service-filter=clita</code><ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries quantifying good service provided. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>total-service-filter=duo</code></p>
|
||||
<p><code>total-service-filter=stet</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries quantifying total demanded service. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>... threshold=0.30129532554933913</code></p>
|
||||
<p><code>... threshold=0.9502568181793487</code></p>
|
||||
<ul>
|
||||
<li>If window performance >= threshold, the window is counted as good.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>..metric-mean-in-range.range max=0.49164260022944106</code></p>
|
||||
<p><code>..metric-mean-in-range.range max=0.5058218521649169</code></p>
|
||||
<ul>
|
||||
<li>Range maximum.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>min=0.7169828132723964</code></p>
|
||||
<p><code>min=0.5909579744308877</code></p>
|
||||
<ul>
|
||||
<li>Range minimum.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. time-series=lorem</code></p>
|
||||
<p><code>.. time-series=dolores</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying the TimeSeries to use for evaluating window quality.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>..metric-sum-in-range.range max=0.5349682891994094</code></p>
|
||||
<p><code>..metric-sum-in-range.range max=0.04322352738011259</code></p>
|
||||
<ul>
|
||||
<li>Range maximum.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>min=0.9289312830326454</code></p>
|
||||
<p><code>min=0.5604347251077454</code></p>
|
||||
<ul>
|
||||
<li>Range minimum.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. time-series=at</code></p>
|
||||
<p><code>.. time-series=clita</code></p>
|
||||
<ul>
|
||||
<li>A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying the TimeSeries to use for evaluating window quality.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. window-period=invidunt</code></p>
|
||||
<p><code>.. window-period=dolor</code></p>
|
||||
<ul>
|
||||
<li>Duration over which window quality is evaluated. Must be an integer fraction of a day and at least 60s.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>... user-labels=key=aliquyam</code></p>
|
||||
<ul>
|
||||
<li>Labels which have been used to annotate the service-level objective. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.</li>
|
||||
<li>the value will be associated with the given <code>key</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id="about-cursors">About Cursors</h3>
|
||||
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>List - Monitoring v2.0.4+20210322</title>
|
||||
<title>List - Monitoring v3.0.0+20220218</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Monitoring v2.0.4+20210322</a>
|
||||
<a href=".." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,6 +211,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-create-service">Time Series Create Service</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../projects_time-series-list">Time Series List</a>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user