Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / logging_v2.exclusions.html
blob: e9885ceb22a0bd83b80beee461845942a11994ab [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <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]79<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>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes an exclusion.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets the description of an exclusion.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <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]88<p class="firstline">Lists all the exclusions in a parent resource.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <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]94<p class="firstline">Changes one or more properties of an existing exclusion.</p>
95<h3>Method Details</h3>
96<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]97 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 <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.
99
100Args:
101 parent: string, Required. The parent resource in which to create the exclusion:
102"projects/[PROJECT_ID]"
103"organizations/[ORGANIZATION_ID]"
104"billingAccounts/[BILLING_ACCOUNT_ID]"
105"folders/[FOLDER_ID]"
106Examples: "projects/my-logging-project", "organizations/123456789". (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]107 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108 The object takes the form of:
109
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]110{ # 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't apply to child resources, and that you can't exclude audit log entries.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111 "disabled": 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.
112 "updateTime": "A String", # Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]113 "name": "A String", # Required. A client-assigned identifier, such as "load-balancer-exclusion". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
114 "filter": "A String", # Required. An advanced logs filter that matches the log entries to be excluded. By using the sample function, 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:"resource.type=gcs_bucket severity&lt;ERROR sample(insertId, 0.99)"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115 "createTime": "A String", # Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]116 "description": "A String", # Optional. A description of this exclusion.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117 }
118
119 x__xgafv: string, V1 error format.
120 Allowed values
121 1 - v1 error format
122 2 - v2 error format
123
124Returns:
125 An object of the form:
126
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]127 { # 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't apply to child resources, and that you can't exclude audit log entries.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 "disabled": 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.
129 "updateTime": "A String", # Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]130 "name": "A String", # Required. A client-assigned identifier, such as "load-balancer-exclusion". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
131 "filter": "A String", # Required. An advanced logs filter that matches the log entries to be excluded. By using the sample function, 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:"resource.type=gcs_bucket severity&lt;ERROR sample(insertId, 0.99)"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 "createTime": "A String", # Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]133 "description": "A String", # Optional. A description of this exclusion.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]134 }</pre>
135</div>
136
137<div class="method">
138 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
139 <pre>Deletes an exclusion.
140
141Args:
142 name: string, Required. The resource name of an existing exclusion to delete:
143"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
144"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
145"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
146"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
147Example: "projects/my-project-id/exclusions/my-exclusion-id". (required)
148 x__xgafv: string, V1 error format.
149 Allowed values
150 1 - v1 error format
151 2 - v2 error format
152
153Returns:
154 An object of the form:
155
156 { # 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:
157 # service Foo {
158 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
159 # }
160 # The JSON representation for Empty is empty JSON object {}.
161 }</pre>
162</div>
163
164<div class="method">
165 <code class="details" id="get">get(name, x__xgafv=None)</code>
166 <pre>Gets the description of an exclusion.
167
168Args:
169 name: string, Required. The resource name of an existing exclusion:
170"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
171"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
172"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
173"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
174Example: "projects/my-project-id/exclusions/my-exclusion-id". (required)
175 x__xgafv: string, V1 error format.
176 Allowed values
177 1 - v1 error format
178 2 - v2 error format
179
180Returns:
181 An object of the form:
182
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]183 { # 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't apply to child resources, and that you can't exclude audit log entries.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]184 "disabled": 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.
185 "updateTime": "A String", # Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]186 "name": "A String", # Required. A client-assigned identifier, such as "load-balancer-exclusion". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
187 "filter": "A String", # Required. An advanced logs filter that matches the log entries to be excluded. By using the sample function, 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:"resource.type=gcs_bucket severity&lt;ERROR sample(insertId, 0.99)"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188 "createTime": "A String", # Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]189 "description": "A String", # Optional. A description of this exclusion.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]190 }</pre>
191</div>
192
193<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]194 <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]195 <pre>Lists all the exclusions in a parent resource.
196
197Args:
198 parent: string, Required. The parent resource whose exclusions are to be listed.
199"projects/[PROJECT_ID]"
200"organizations/[ORGANIZATION_ID]"
201"billingAccounts/[BILLING_ACCOUNT_ID]"
202"folders/[FOLDER_ID]"
203 (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]204 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 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.
206 x__xgafv: string, V1 error format.
207 Allowed values
208 1 - v1 error format
209 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]210
211Returns:
212 An object of the form:
213
214 { # Result returned from ListExclusions.
215 "nextPageToken": "A String", # 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.
216 "exclusions": [ # A list of exclusions.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]217 { # 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't apply to child resources, and that you can't exclude audit log entries.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]218 "disabled": 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.
219 "updateTime": "A String", # Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]220 "name": "A String", # Required. A client-assigned identifier, such as "load-balancer-exclusion". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
221 "filter": "A String", # Required. An advanced logs filter that matches the log entries to be excluded. By using the sample function, 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:"resource.type=gcs_bucket severity&lt;ERROR sample(insertId, 0.99)"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]222 "createTime": "A String", # Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]223 "description": "A String", # Optional. A description of this exclusion.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]224 },
225 ],
226 }</pre>
227</div>
228
229<div class="method">
230 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
231 <pre>Retrieves the next page of results.
232
233Args:
234 previous_request: The request for the previous page. (required)
235 previous_response: The response from the request for the previous page. (required)
236
237Returns:
238 A request object that you can call 'execute()' on to request the next
239 page. Returns None if there are no more items in the collection.
240 </pre>
241</div>
242
243<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]244 <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]245 <pre>Changes one or more properties of an existing exclusion.
246
247Args:
248 name: string, Required. The resource name of the exclusion to update:
249"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
250"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
251"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
252"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
253Example: "projects/my-project-id/exclusions/my-exclusion-id". (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]254 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]255 The object takes the form of:
256
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]257{ # 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't apply to child resources, and that you can't exclude audit log entries.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]258 "disabled": 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.
259 "updateTime": "A String", # Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]260 "name": "A String", # Required. A client-assigned identifier, such as "load-balancer-exclusion". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
261 "filter": "A String", # Required. An advanced logs filter that matches the log entries to be excluded. By using the sample function, 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:"resource.type=gcs_bucket severity&lt;ERROR sample(insertId, 0.99)"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]262 "createTime": "A String", # Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]263 "description": "A String", # Optional. A description of this exclusion.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]264 }
265
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]266 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 "filter,description".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]267 x__xgafv: string, V1 error format.
268 Allowed values
269 1 - v1 error format
270 2 - v2 error format
271
272Returns:
273 An object of the form:
274
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]275 { # 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't apply to child resources, and that you can't exclude audit log entries.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]276 "disabled": 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.
277 "updateTime": "A String", # Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]278 "name": "A String", # Required. A client-assigned identifier, such as "load-balancer-exclusion". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
279 "filter": "A String", # Required. An advanced logs filter that matches the log entries to be excluded. By using the sample function, 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:"resource.type=gcs_bucket severity&lt;ERROR sample(insertId, 0.99)"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]280 "createTime": "A String", # Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]281 "description": "A String", # Optional. A description of this exclusion.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]282 }</pre>
283</div>
284
285</body></html>