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>Sinks Patch - Logging v2.0.4+20210325</title>
|
||||
<title>Sinks Patch - 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>
|
||||
|
||||
@@ -257,6 +287,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>
|
||||
|
||||
@@ -322,6 +362,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>
|
||||
|
||||
@@ -362,6 +417,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../folders_update-settings">Update Settings</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -433,6 +493,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>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -460,11 +535,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>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -512,6 +597,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>
|
||||
|
||||
@@ -577,6 +667,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>
|
||||
|
||||
@@ -622,6 +727,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_update-settings">Update Settings</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -653,6 +763,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>
|
||||
|
||||
@@ -718,6 +838,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>
|
||||
|
||||
@@ -886,7 +1021,7 @@ You can set the scope for this method like this: <code>logging2 --scope <scop
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><sink-name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id".</li>
|
||||
<li>Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my-project/sinks/my-sink"</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -914,55 +1049,55 @@ 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 .bigquery-options use-partitioned-tables=false</code><ul>
|
||||
<li>Optional. Whether to use BigQuery's partition tables (https://cloud.google.com/bigquery/docs/partitioned-tables). By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax (https://cloud.google.com/bigquery/docs/querying-partitioned-tables) has to be used instead. In both cases, tables are sharded based on UTC timezone.</li>
|
||||
<li>Optional. Whether to use BigQuery's partition tables (https://cloud.google.com/bigquery/docs/partitioned-tables). By default, Cloud Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax (https://cloud.google.com/bigquery/docs/querying-partitioned-tables) has to be used instead. In both cases, tables are sharded based on UTC timezone.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>uses-timestamp-column-partitioning=false</code></p>
|
||||
<ul>
|
||||
<li>Output only. True if new timestamp column based partitioning is in use, false if legacy ingestion-time partitioning is in use. All new sinks will have this field set true and will use timestamp column based partitioning. If use_partitioned_tables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field set to false.</li>
|
||||
<li>Output only. True if new timestamp column based partitioning is in use, false if legacy ingestion-time partitioning is in use.All new sinks will have this field set true and will use timestamp column based partitioning. If use_partitioned_tables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field set to false.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. create-time=magna</code></p>
|
||||
<p><code>.. create-time=dolor</code></p>
|
||||
<ul>
|
||||
<li>Output only. The creation timestamp of the sink.This field may not be present for older sinks.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>description=sit</code><ul>
|
||||
<li>Optional. A description of this sink. The maximum length of the description is 8000 characters.</li>
|
||||
<li><code>description=eos</code><ul>
|
||||
<li>Optional. A description of this sink.The maximum length of the description is 8000 characters.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>destination=gubergren</code><ul>
|
||||
<li><code>destination=magna</code><ul>
|
||||
<li>Required. The export destination: "storage.googleapis.com/[GCS_BUCKET]" "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks (https://cloud.google.com/logging/docs/api/tasks/exporting-logs).</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>disabled=false</code><ul>
|
||||
<li>Optional. If set to True, then this sink is disabled and it does not export any log entries.</li>
|
||||
<li>Optional. If set to true, then this sink is disabled and it does not export any log entries.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>filter=ipsum</code><ul>
|
||||
<li>Optional. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries). The only exported log entries are those that are in the resource owning the sink and that match the filter. For example: logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR </li>
|
||||
<li><code>filter=aliquyam</code><ul>
|
||||
<li>Optional. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries). The only exported log entries are those that are in the resource owning the sink and that match the filter.For example:logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>include-children=true</code><ul>
|
||||
<li>Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name: logName:("projects/test-project1/" OR "projects/test-project2/") AND resource.type=gce_instance </li>
|
||||
<li><code>include-children=false</code><ul>
|
||||
<li>Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then log entries from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression.For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent.To only export entries from certain child projects, filter on the project part of the log name:logName:("projects/test-project1/" OR "projects/test-project2/") AND resource.type=gce_instance</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>name=amet</code><ul>
|
||||
<li>Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric.</li>
|
||||
<li><code>name=ea</code><ul>
|
||||
<li>Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>output-version-format=ipsum</code><ul>
|
||||
<li><code>output-version-format=lorem</code><ul>
|
||||
<li>Deprecated. This field is unused.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>update-time=lorem</code><ul>
|
||||
<li><code>update-time=elitr</code><ul>
|
||||
<li>Output only. The last update timestamp of the sink.This field may not be present for older sinks.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>writer-identity=dolores</code><ul>
|
||||
<li>Output only. An IAM identity—a service account or group—under which Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.</li>
|
||||
<li><code>writer-identity=justo</code><ul>
|
||||
<li>Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -999,7 +1134,7 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
<li>
|
||||
<p><strong>-p update-mask=string</strong></p>
|
||||
<ul>
|
||||
<li>Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.</li>
|
||||
<li>Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
Reference in New Issue
Block a user