Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / cc94ec86e652769e9d3d5cb6d6491efb8d76dd21 / . / docs / dyn / logging_v2.exclusions.html
blob: 044f1db8377860f9e4c2c83751ce216f6852056d [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]75<h1><a href="logging_v2.html">Cloud Logging API</a> . <a href="logging_v2.exclusions.html">exclusions</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes an exclusion.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets the description of an exclusion.</p>
89<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="firstline">Lists all the exclusions in a parent resource.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Changes one or more properties of an existing exclusion.</p>
98<h3>Method Details</h3>
99<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 <pre>Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.
107
108Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]109 parent: string, Required. The parent resource in which to create the exclusion: &quot;projects/[PROJECT_ID]&quot; &quot;organizations/[ORGANIZATION_ID]&quot; &quot;billingAccounts/[BILLING_ACCOUNT_ID]&quot; &quot;folders/[FOLDER_ID]&quot; Examples: &quot;projects/my-logging-project&quot;, &quot;organizations/123456789&quot;. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]110 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111 The object takes the form of:
112
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113{ # Specifies a set of log entries that are not to be stored in Logging. If your GCP resource receives a large volume of logs, you can use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded. Note that organization-level and folder-level exclusions don&#x27;t apply to child resources, and that you can&#x27;t exclude audit log entries.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]114 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions.
115 &quot;description&quot;: &quot;A String&quot;, # Optional. A description of this exclusion.
116 &quot;disabled&quot;: True or False, # Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can update an exclusion to change the value of this field.
117 &quot;filter&quot;: &quot;A String&quot;, # Required. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries) that matches the log entries to be excluded. By using the sample function (https://cloud.google.com/logging/docs/view/advanced-queries#sample), you can exclude less than 100% of the matching log entries. For example, the following query matches 99% of low-severity log entries from Google Cloud Storage buckets:&quot;resource.type=gcs_bucket severity&lt;ERROR sample(insertId, 0.99)&quot;
118 &quot;name&quot;: &quot;A String&quot;, # Required. A client-assigned identifier, such as &quot;load-balancer-exclusion&quot;. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
119 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions.
120}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121
122 x__xgafv: string, V1 error format.
123 Allowed values
124 1 - v1 error format
125 2 - v2 error format
126
127Returns:
128 An object of the form:
129
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]130 { # Specifies a set of log entries that are not to be stored in Logging. If your GCP resource receives a large volume of logs, you can use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded. Note that organization-level and folder-level exclusions don&#x27;t apply to child resources, and that you can&#x27;t exclude audit log entries.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]131 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions.
132 &quot;description&quot;: &quot;A String&quot;, # Optional. A description of this exclusion.
133 &quot;disabled&quot;: True or False, # Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can update an exclusion to change the value of this field.
134 &quot;filter&quot;: &quot;A String&quot;, # Required. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries) that matches the log entries to be excluded. By using the sample function (https://cloud.google.com/logging/docs/view/advanced-queries#sample), you can exclude less than 100% of the matching log entries. For example, the following query matches 99% of low-severity log entries from Google Cloud Storage buckets:&quot;resource.type=gcs_bucket severity&lt;ERROR sample(insertId, 0.99)&quot;
135 &quot;name&quot;: &quot;A String&quot;, # Required. A client-assigned identifier, such as &quot;load-balancer-exclusion&quot;. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
136 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions.
137}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138</div>
139
140<div class="method">
141 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
142 <pre>Deletes an exclusion.
143
144Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]145 name: string, Required. The resource name of an existing exclusion to delete: &quot;projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]&quot; &quot;organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]&quot; &quot;billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]&quot; &quot;folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]&quot; Example: &quot;projects/my-project-id/exclusions/my-exclusion-id&quot;. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 x__xgafv: string, V1 error format.
147 Allowed values
148 1 - v1 error format
149 2 - v2 error format
150
151Returns:
152 An object of the form:
153
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]154 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]155}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156</div>
157
158<div class="method">
159 <code class="details" id="get">get(name, x__xgafv=None)</code>
160 <pre>Gets the description of an exclusion.
161
162Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]163 name: string, Required. The resource name of an existing exclusion: &quot;projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]&quot; &quot;organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]&quot; &quot;billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]&quot; &quot;folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]&quot; Example: &quot;projects/my-project-id/exclusions/my-exclusion-id&quot;. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 x__xgafv: string, V1 error format.
165 Allowed values
166 1 - v1 error format
167 2 - v2 error format
168
169Returns:
170 An object of the form:
171
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]172 { # Specifies a set of log entries that are not to be stored in Logging. If your GCP resource receives a large volume of logs, you can use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded. Note that organization-level and folder-level exclusions don&#x27;t apply to child resources, and that you can&#x27;t exclude audit log entries.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]173 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions.
174 &quot;description&quot;: &quot;A String&quot;, # Optional. A description of this exclusion.
175 &quot;disabled&quot;: True or False, # Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can update an exclusion to change the value of this field.
176 &quot;filter&quot;: &quot;A String&quot;, # Required. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries) that matches the log entries to be excluded. By using the sample function (https://cloud.google.com/logging/docs/view/advanced-queries#sample), you can exclude less than 100% of the matching log entries. For example, the following query matches 99% of low-severity log entries from Google Cloud Storage buckets:&quot;resource.type=gcs_bucket severity&lt;ERROR sample(insertId, 0.99)&quot;
177 &quot;name&quot;: &quot;A String&quot;, # Required. A client-assigned identifier, such as &quot;load-balancer-exclusion&quot;. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
178 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions.
179}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180</div>
181
182<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]183 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]184 <pre>Lists all the exclusions in a parent resource.
185
186Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]187 parent: string, Required. The parent resource whose exclusions are to be listed. &quot;projects/[PROJECT_ID]&quot; &quot;organizations/[ORGANIZATION_ID]&quot; &quot;billingAccounts/[BILLING_ACCOUNT_ID]&quot; &quot;folders/[FOLDER_ID]&quot; (required)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]188 pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]189 pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]190 x__xgafv: string, V1 error format.
191 Allowed values
192 1 - v1 error format
193 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]194
195Returns:
196 An object of the form:
197
198 { # Result returned from ListExclusions.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]199 &quot;exclusions&quot;: [ # A list of exclusions.
200 { # Specifies a set of log entries that are not to be stored in Logging. If your GCP resource receives a large volume of logs, you can use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded. Note that organization-level and folder-level exclusions don&#x27;t apply to child resources, and that you can&#x27;t exclude audit log entries.
201 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions.
202 &quot;description&quot;: &quot;A String&quot;, # Optional. A description of this exclusion.
203 &quot;disabled&quot;: True or False, # Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can update an exclusion to change the value of this field.
204 &quot;filter&quot;: &quot;A String&quot;, # Required. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries) that matches the log entries to be excluded. By using the sample function (https://cloud.google.com/logging/docs/view/advanced-queries#sample), you can exclude less than 100% of the matching log entries. For example, the following query matches 99% of low-severity log entries from Google Cloud Storage buckets:&quot;resource.type=gcs_bucket severity&lt;ERROR sample(insertId, 0.99)&quot;
205 &quot;name&quot;: &quot;A String&quot;, # Required. A client-assigned identifier, such as &quot;load-balancer-exclusion&quot;. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
206 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions.
207 },
208 ],
209 &quot;nextPageToken&quot;: &quot;A String&quot;, # If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.
210}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]211</div>
212
213<div class="method">
214 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
215 <pre>Retrieves the next page of results.
216
217Args:
218 previous_request: The request for the previous page. (required)
219 previous_response: The response from the request for the previous page. (required)
220
221Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]222 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223 page. Returns None if there are no more items in the collection.
224 </pre>
225</div>
226
227<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]228 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229 <pre>Changes one or more properties of an existing exclusion.
230
231Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]232 name: string, Required. The resource name of the exclusion to update: &quot;projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]&quot; &quot;organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]&quot; &quot;billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]&quot; &quot;folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]&quot; Example: &quot;projects/my-project-id/exclusions/my-exclusion-id&quot;. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]233 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]234 The object takes the form of:
235
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]236{ # Specifies a set of log entries that are not to be stored in Logging. If your GCP resource receives a large volume of logs, you can use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded. Note that organization-level and folder-level exclusions don&#x27;t apply to child resources, and that you can&#x27;t exclude audit log entries.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]237 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions.
238 &quot;description&quot;: &quot;A String&quot;, # Optional. A description of this exclusion.
239 &quot;disabled&quot;: True or False, # Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can update an exclusion to change the value of this field.
240 &quot;filter&quot;: &quot;A String&quot;, # Required. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries) that matches the log entries to be excluded. By using the sample function (https://cloud.google.com/logging/docs/view/advanced-queries#sample), you can exclude less than 100% of the matching log entries. For example, the following query matches 99% of low-severity log entries from Google Cloud Storage buckets:&quot;resource.type=gcs_bucket severity&lt;ERROR sample(insertId, 0.99)&quot;
241 &quot;name&quot;: &quot;A String&quot;, # Required. A client-assigned identifier, such as &quot;load-balancer-exclusion&quot;. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
242 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions.
243}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]244
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]245 updateMask: string, Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of &quot;filter,description&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]246 x__xgafv: string, V1 error format.
247 Allowed values
248 1 - v1 error format
249 2 - v2 error format
250
251Returns:
252 An object of the form:
253
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]254 { # Specifies a set of log entries that are not to be stored in Logging. If your GCP resource receives a large volume of logs, you can use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded. Note that organization-level and folder-level exclusions don&#x27;t apply to child resources, and that you can&#x27;t exclude audit log entries.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]255 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions.
256 &quot;description&quot;: &quot;A String&quot;, # Optional. A description of this exclusion.
257 &quot;disabled&quot;: True or False, # Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can update an exclusion to change the value of this field.
258 &quot;filter&quot;: &quot;A String&quot;, # Required. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries) that matches the log entries to be excluded. By using the sample function (https://cloud.google.com/logging/docs/view/advanced-queries#sample), you can exclude less than 100% of the matching log entries. For example, the following query matches 99% of low-severity log entries from Google Cloud Storage buckets:&quot;resource.type=gcs_bucket severity&lt;ERROR sample(insertId, 0.99)&quot;
259 &quot;name&quot;: &quot;A String&quot;, # Required. A client-assigned identifier, such as &quot;load-balancer-exclusion&quot;. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
260 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions.
261}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]262</div>
263
264</body></html>