Skip to content

Commit 26148f7

Browse files
feat(logging): update the api
#### logging:v2 The following keys were added: - resources.folders.methods.updateSettings (Total Keys: 15) - schemas.LogEntry.properties.split.$ref (Total Keys: 1) - schemas.LogSplit (Total Keys: 7)
1 parent a41b310 commit 26148f7

File tree

3 files changed

+116
-7
lines changed

3 files changed

+116
-7
lines changed

docs/dyn/logging_v2.entries.html

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,11 @@ <h3>Method Details</h3>
229229
&quot;line&quot;: &quot;A String&quot;, # Optional. Line within the source file. 1-based; 0 indicates no line number available.
230230
},
231231
&quot;spanId&quot;: &quot;A String&quot;, # Optional. The span ID within the trace associated with the log entry.For Trace spans, this is the same format that the Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as 000000000000004a.
232+
&quot;split&quot;: { # Additional information used to correlate multiple log entries. Used when a single LogEntry would exceed the Google Cloud Logging size limit and is split across multiple log entries. # Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.
233+
&quot;index&quot;: 42, # The index of this LogEntry in the sequence of split log entries. Log entries are given |index| values 0, 1, ..., n-1 for a sequence of n log entries.
234+
&quot;totalSplits&quot;: 42, # The total number of log entries that the original LogEntry was split into.
235+
&quot;uid&quot;: &quot;A String&quot;, # A globally unique identifier for all log entries in a sequence of split log entries. All log entries with the same |LogSplit.uid| are assumed to be part of the same sequence of split log entries.
236+
},
232237
&quot;textPayload&quot;: &quot;A String&quot;, # The log entry payload, represented as a Unicode string (UTF-8).
233238
&quot;timestamp&quot;: &quot;A String&quot;, # Optional. The time the event described by the log entry occurred. This time is used to compute the log entry&#x27;s age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed.Incoming log entries must have timestamps that don&#x27;t exceed the logs retention period (https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, and that don&#x27;t exceed 24 hours in the future. Log entries outside those time boundaries aren&#x27;t ingested by Logging.
234239
&quot;trace&quot;: &quot;A String&quot;, # Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824
@@ -336,6 +341,11 @@ <h3>Method Details</h3>
336341
&quot;line&quot;: &quot;A String&quot;, # Optional. Line within the source file. 1-based; 0 indicates no line number available.
337342
},
338343
&quot;spanId&quot;: &quot;A String&quot;, # Optional. The span ID within the trace associated with the log entry.For Trace spans, this is the same format that the Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as 000000000000004a.
344+
&quot;split&quot;: { # Additional information used to correlate multiple log entries. Used when a single LogEntry would exceed the Google Cloud Logging size limit and is split across multiple log entries. # Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.
345+
&quot;index&quot;: 42, # The index of this LogEntry in the sequence of split log entries. Log entries are given |index| values 0, 1, ..., n-1 for a sequence of n log entries.
346+
&quot;totalSplits&quot;: 42, # The total number of log entries that the original LogEntry was split into.
347+
&quot;uid&quot;: &quot;A String&quot;, # A globally unique identifier for all log entries in a sequence of split log entries. All log entries with the same |LogSplit.uid| are assumed to be part of the same sequence of split log entries.
348+
},
339349
&quot;textPayload&quot;: &quot;A String&quot;, # The log entry payload, represented as a Unicode string (UTF-8).
340350
&quot;timestamp&quot;: &quot;A String&quot;, # Optional. The time the event described by the log entry occurred. This time is used to compute the log entry&#x27;s age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed.Incoming log entries must have timestamps that don&#x27;t exceed the logs retention period (https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, and that don&#x27;t exceed 24 hours in the future. Log entries outside those time boundaries aren&#x27;t ingested by Logging.
341351
&quot;trace&quot;: &quot;A String&quot;, # Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824
@@ -419,6 +429,11 @@ <h3>Method Details</h3>
419429
&quot;line&quot;: &quot;A String&quot;, # Optional. Line within the source file. 1-based; 0 indicates no line number available.
420430
},
421431
&quot;spanId&quot;: &quot;A String&quot;, # Optional. The span ID within the trace associated with the log entry.For Trace spans, this is the same format that the Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as 000000000000004a.
432+
&quot;split&quot;: { # Additional information used to correlate multiple log entries. Used when a single LogEntry would exceed the Google Cloud Logging size limit and is split across multiple log entries. # Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.
433+
&quot;index&quot;: 42, # The index of this LogEntry in the sequence of split log entries. Log entries are given |index| values 0, 1, ..., n-1 for a sequence of n log entries.
434+
&quot;totalSplits&quot;: 42, # The total number of log entries that the original LogEntry was split into.
435+
&quot;uid&quot;: &quot;A String&quot;, # A globally unique identifier for all log entries in a sequence of split log entries. All log entries with the same |LogSplit.uid| are assumed to be part of the same sequence of split log entries.
436+
},
422437
&quot;textPayload&quot;: &quot;A String&quot;, # The log entry payload, represented as a Unicode string (UTF-8).
423438
&quot;timestamp&quot;: &quot;A String&quot;, # Optional. The time the event described by the log entry occurred. This time is used to compute the log entry&#x27;s age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed.Incoming log entries must have timestamps that don&#x27;t exceed the logs retention period (https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, and that don&#x27;t exceed 24 hours in the future. Log entries outside those time boundaries aren&#x27;t ingested by Logging.
424439
&quot;trace&quot;: &quot;A String&quot;, # Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824

docs/dyn/logging_v2.folders.html

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,9 @@ <h2>Instance Methods</h2>
103103
<p class="toc_element">
104104
<code><a href="#getSettings">getSettings(name, x__xgafv=None)</a></code></p>
105105
<p class="firstline">Gets the Log Router settings for the given resource.Note: Settings for the Log Router can be get for Google Cloud projects, folders, organizations and billing accounts. Currently it can only be configured for organizations. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.</p>
106+
<p class="toc_element">
107+
<code><a href="#updateSettings">updateSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
108+
<p class="firstline">Updates the Log Router settings for the given resource.Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.UpdateSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled. 4) location_id is not supported by Logging. 5) location_id violate OrgPolicy.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.</p>
106109
<h3>Method Details</h3>
107110
<div class="method">
108111
<code class="details" id="close">close()</code>
@@ -151,4 +154,35 @@ <h3>Method Details</h3>
151154
}</pre>
152155
</div>
153156

157+
<div class="method">
158+
<code class="details" id="updateSettings">updateSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
159+
<pre>Updates the Log Router settings for the given resource.Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.UpdateSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled. 4) location_id is not supported by Logging. 5) location_id violate OrgPolicy.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
160+
161+
Args:
162+
name: string, Required. The resource name for the settings to update. &quot;organizations/[ORGANIZATION_ID]/settings&quot; For example:&quot;organizations/12345/settings&quot;Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization. (required)
163+
body: object, The request body.
164+
The object takes the form of:
165+
166+
{ # Describes the settings associated with a project, folder, organization, billing account, or flexible resource.
167+
&quot;disableDefaultSink&quot;: True or False, # Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log ingestion if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed.
168+
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the settings.
169+
&quot;storageLocation&quot;: &quot;A String&quot;, # Optional. The Cloud region that will be used for _Default and _Required log buckets for newly created projects and folders. For example europe-west1. This setting does not affect the location of custom log buckets.
170+
}
171+
172+
updateMask: string, Optional. Field mask identifying which fields from settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.See FieldMask for more information.For example: &quot;updateMask=kmsKeyName&quot;
173+
x__xgafv: string, V1 error format.
174+
Allowed values
175+
1 - v1 error format
176+
2 - v2 error format
177+
178+
Returns:
179+
An object of the form:
180+
181+
{ # Describes the settings associated with a project, folder, organization, billing account, or flexible resource.
182+
&quot;disableDefaultSink&quot;: True or False, # Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log ingestion if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed.
183+
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the settings.
184+
&quot;storageLocation&quot;: &quot;A String&quot;, # Optional. The Cloud region that will be used for _Default and _Required log buckets for newly created projects and folders. For example europe-west1. This setting does not affect the location of custom log buckets.
185+
}</pre>
186+
</div>
187+
154188
</body></html>

0 commit comments

Comments
 (0)