Update documentation

This commit is contained in:
Sebastian Thiel
2022-03-08 15:36:16 +08:00
parent b84384c010
commit a20241b241
10471 changed files with 1934132 additions and 64947 deletions

View File

@@ -5,7 +5,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Write - Logging v2.0.4+20210325</title>
<title>Write - Logging v3.0.0+20220225</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"> Logging v2.0.4+20210325</a>
<a href=".." class="icon icon-home"> Logging v3.0.0+20220225</a>
</div>
@@ -79,6 +79,16 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../billing-accounts_get-cmek-settings">Get Cmek Settings</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../billing-accounts_get-settings">Get Settings</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../billing-accounts_locations-buckets-create">Locations Buckets Create</a>
@@ -134,6 +144,16 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../billing-accounts_locations-operations-cancel">Locations Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../billing-accounts_locations-operations-list">Locations Operations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../billing-accounts_logs-delete">Logs Delete</a>
@@ -144,6 +164,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../billing-accounts_operations-get">Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../billing-accounts_sinks-create">Sinks Create</a>
@@ -180,6 +205,11 @@
<span>Entries</span>
<li class="toctree-l1 ">
<a class="" href="../entries_copy">Copy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../entries_list">List</a>
@@ -275,6 +305,16 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_get-cmek-settings">Get Cmek Settings</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_get-settings">Get Settings</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_locations-buckets-create">Locations Buckets Create</a>
@@ -340,6 +380,21 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_locations-operations-cancel">Locations Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_locations-operations-get">Locations Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_locations-operations-list">Locations Operations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_logs-delete">Logs Delete</a>
@@ -380,6 +435,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_update-settings">Update Settings</a>
</li>
@@ -451,6 +511,21 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../locations_operations-cancel">Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../locations_operations-get">Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../locations_operations-list">Operations List</a>
</li>
@@ -478,11 +553,21 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../methods_get-settings">Get Settings</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../methods_update-cmek-settings">Update Cmek Settings</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../methods_update-settings">Update Settings</a>
</li>
@@ -530,6 +615,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_get-settings">Get Settings</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_locations-buckets-create">Locations Buckets Create</a>
@@ -595,6 +685,21 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_locations-operations-cancel">Locations Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_locations-operations-get">Locations Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_locations-operations-list">Locations Operations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_logs-delete">Logs Delete</a>
@@ -640,6 +745,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_update-settings">Update Settings</a>
</li>
@@ -671,6 +781,16 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_get-cmek-settings">Get Cmek Settings</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_get-settings">Get Settings</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-buckets-create">Locations Buckets Create</a>
@@ -736,6 +856,21 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-cancel">Locations Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-get">Locations Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-list">Locations Operations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_logs-delete">Logs Delete</a>
@@ -895,30 +1030,30 @@ 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 . dry-run=false</code><ul>
<li><code>-r . dry-run=true</code><ul>
<li>Optional. If true, the request should expect normal response, but the entries won&#39;t be persisted nor exported. Useful for checking whether the logging API endpoints are working properly before sending valuable data.</li>
</ul>
</li>
<li><code>labels=key=amet.</code><ul>
<li><code>labels=key=est</code><ul>
<li>Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry&#39;s label is not changed. See LogEntry.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>log-name=ea</code><ul>
<li>Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name: &#34;projects/[PROJECT_ID]/logs/[LOG_ID]&#34; &#34;organizations/[ORGANIZATION_ID]/logs/[LOG_ID]&#34; &#34;billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]&#34; &#34;folders/[FOLDER_ID]/logs/[LOG_ID]&#34; [LOG_ID] must be URL-encoded. For example: &#34;projects/my-project-id/logs/syslog&#34; &#34;organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity&#34; The permission logging.logEntries.create is needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified in logName or in an individual log entry.</li>
<li><code>log-name=sed</code><ul>
<li>Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example: &#34;projects/my-project-id/logs/syslog&#34; &#34;organizations/123/logs/cloudaudit.googleapis.com%2Factivity&#34; The permission logging.logEntries.create is needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified in logName or in an individual log entry.</li>
</ul>
</li>
<li><code>partial-success=false</code><ul>
<li><code>partial-success=true</code><ul>
<li>Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries&#39; zero-based index in the entries.write method.</li>
</ul>
</li>
<li><code>resource labels=key=lorem</code><ul>
<li><code>resource labels=key=et</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 &#34;project_id&#34;, &#34;instance_id&#34;, and &#34;zone&#34;.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>type=invidunt</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.</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. Some descriptors include the service name in the type; for example, the type of a Datastream stream is datastream.googleapis.com/Stream.</li>
</ul>
</li>
</ul>