1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="logging_v2.html">Stackdriver Logging API</a> . <a href="logging_v2.projects.html">projects</a> . <a href="logging_v2.projects.sinks.html">sinks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a sink.</p>
<p class="toc_element">
<code><a href="#delete">delete(sinkName=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a sink.</p>
<p class="toc_element">
<code><a href="#get">get(sinkName=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a sink.</p>
<p class="toc_element">
<code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
<p class="firstline">Lists sinks.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(sinkName=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Updates or creates a sink.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
<pre>Creates a sink.
Args:
parent: string, Required. The resource in which to create the sink.
Example: `"projects/my-project-id"`.
The new sink must be provided in the request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Describes a sink used to export log entries outside of Stackdriver Logging.
"endTime": "A String", # Optional. Time at which this sink expires.
"name": "A String", # Required. The client-assigned sink identifier, unique within the
# project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
# limited to 1000 characters and can include only the following characters:
# `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
# of the name is 100 characters.
"destination": "A String", # Required. The export destination. See
# [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
# Examples:
#
# "storage.googleapis.com/my-gcs-bucket"
# "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
# "pubsub.googleapis.com/projects/my-project/topics/my-topic"
"filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Only log entries matching the filter are exported. The filter
# must be consistent with the log entry format specified by the
# `outputVersionFormat` parameter, regardless of the format of the
# log entry that was originally written to Stackdriver Logging.
# Example filter (V2 format):
#
# logName=projects/my-projectid/logs/syslog AND severity>=ERROR
"startTime": "A String", # Optional. Time range for which this sink is active.
# Logs are exported only if start_time <= entry.timestamp < end_time
# Both start_time and end_time may be omitted to specify
# (half) infinite ranges. The start_time must be less than the end_time.
"outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
# entries. This version does not have to correspond to the version of the
# log entry that was written to Stackdriver Logging. If omitted, the
# v2 format is used.
"writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
# access. This may be a service account or a group.
# Examples (Do not assume these specific values):
# "serviceAccount:cloud-logs@system.gserviceaccount.com"
# "group:cloud-logs@google.com"
#
# For GCS destinations, the role "roles/owner" is required on the bucket
# For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
# required on the topic
# For BigQuery, the role "roles/editor" is required on the dataset
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Describes a sink used to export log entries outside of Stackdriver Logging.
"endTime": "A String", # Optional. Time at which this sink expires.
"name": "A String", # Required. The client-assigned sink identifier, unique within the
# project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
# limited to 1000 characters and can include only the following characters:
# `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
# of the name is 100 characters.
"destination": "A String", # Required. The export destination. See
# [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
# Examples:
#
# "storage.googleapis.com/my-gcs-bucket"
# "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
# "pubsub.googleapis.com/projects/my-project/topics/my-topic"
"filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Only log entries matching the filter are exported. The filter
# must be consistent with the log entry format specified by the
# `outputVersionFormat` parameter, regardless of the format of the
# log entry that was originally written to Stackdriver Logging.
# Example filter (V2 format):
#
# logName=projects/my-projectid/logs/syslog AND severity>=ERROR
"startTime": "A String", # Optional. Time range for which this sink is active.
# Logs are exported only if start_time <= entry.timestamp < end_time
# Both start_time and end_time may be omitted to specify
# (half) infinite ranges. The start_time must be less than the end_time.
"outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
# entries. This version does not have to correspond to the version of the
# log entry that was written to Stackdriver Logging. If omitted, the
# v2 format is used.
"writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
# access. This may be a service account or a group.
# Examples (Do not assume these specific values):
# "serviceAccount:cloud-logs@system.gserviceaccount.com"
# "group:cloud-logs@google.com"
#
# For GCS destinations, the role "roles/owner" is required on the bucket
# For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
# required on the topic
# For BigQuery, the role "roles/editor" is required on the dataset
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(sinkName=None, x__xgafv=None)</code>
<pre>Deletes a sink.
Args:
sinkName: string, Required. The resource name of the sink to delete, including the parent
resource and the sink identifier. Example:
`"projects/my-project-id/sinks/my-sink-id"`. It is an error if the sink
does not exist. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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 `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(sinkName=None, x__xgafv=None)</code>
<pre>Gets a sink.
Args:
sinkName: string, Required. The resource name of the sink to return.
Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Describes a sink used to export log entries outside of Stackdriver Logging.
"endTime": "A String", # Optional. Time at which this sink expires.
"name": "A String", # Required. The client-assigned sink identifier, unique within the
# project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
# limited to 1000 characters and can include only the following characters:
# `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
# of the name is 100 characters.
"destination": "A String", # Required. The export destination. See
# [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
# Examples:
#
# "storage.googleapis.com/my-gcs-bucket"
# "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
# "pubsub.googleapis.com/projects/my-project/topics/my-topic"
"filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Only log entries matching the filter are exported. The filter
# must be consistent with the log entry format specified by the
# `outputVersionFormat` parameter, regardless of the format of the
# log entry that was originally written to Stackdriver Logging.
# Example filter (V2 format):
#
# logName=projects/my-projectid/logs/syslog AND severity>=ERROR
"startTime": "A String", # Optional. Time range for which this sink is active.
# Logs are exported only if start_time <= entry.timestamp < end_time
# Both start_time and end_time may be omitted to specify
# (half) infinite ranges. The start_time must be less than the end_time.
"outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
# entries. This version does not have to correspond to the version of the
# log entry that was written to Stackdriver Logging. If omitted, the
# v2 format is used.
"writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
# access. This may be a service account or a group.
# Examples (Do not assume these specific values):
# "serviceAccount:cloud-logs@system.gserviceaccount.com"
# "group:cloud-logs@google.com"
#
# For GCS destinations, the role "roles/owner" is required on the bucket
# For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
# required on the topic
# For BigQuery, the role "roles/editor" is required on the dataset
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
<pre>Lists sinks.
Args:
parent: string, Required. The cloud resource containing the sinks.
Example: `"projects/my-logging-project"`. (required)
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
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.
Returns:
An object of the form:
{ # Result returned from `ListSinks`.
"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`.
"sinks": [ # A list of sinks.
{ # Describes a sink used to export log entries outside of Stackdriver Logging.
"endTime": "A String", # Optional. Time at which this sink expires.
"name": "A String", # Required. The client-assigned sink identifier, unique within the
# project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
# limited to 1000 characters and can include only the following characters:
# `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
# of the name is 100 characters.
"destination": "A String", # Required. The export destination. See
# [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
# Examples:
#
# "storage.googleapis.com/my-gcs-bucket"
# "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
# "pubsub.googleapis.com/projects/my-project/topics/my-topic"
"filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Only log entries matching the filter are exported. The filter
# must be consistent with the log entry format specified by the
# `outputVersionFormat` parameter, regardless of the format of the
# log entry that was originally written to Stackdriver Logging.
# Example filter (V2 format):
#
# logName=projects/my-projectid/logs/syslog AND severity>=ERROR
"startTime": "A String", # Optional. Time range for which this sink is active.
# Logs are exported only if start_time <= entry.timestamp < end_time
# Both start_time and end_time may be omitted to specify
# (half) infinite ranges. The start_time must be less than the end_time.
"outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
# entries. This version does not have to correspond to the version of the
# log entry that was written to Stackdriver Logging. If omitted, the
# v2 format is used.
"writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
# access. This may be a service account or a group.
# Examples (Do not assume these specific values):
# "serviceAccount:cloud-logs@system.gserviceaccount.com"
# "group:cloud-logs@google.com"
#
# For GCS destinations, the role "roles/owner" is required on the bucket
# For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
# required on the topic
# For BigQuery, the role "roles/editor" is required on the dataset
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="update">update(sinkName=None, body, x__xgafv=None)</code>
<pre>Updates or creates a sink.
Args:
sinkName: string, Required. The resource name of the sink to update, including the parent
resource and the sink identifier. If the sink does not exist, this method
creates the sink. Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Describes a sink used to export log entries outside of Stackdriver Logging.
"endTime": "A String", # Optional. Time at which this sink expires.
"name": "A String", # Required. The client-assigned sink identifier, unique within the
# project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
# limited to 1000 characters and can include only the following characters:
# `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
# of the name is 100 characters.
"destination": "A String", # Required. The export destination. See
# [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
# Examples:
#
# "storage.googleapis.com/my-gcs-bucket"
# "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
# "pubsub.googleapis.com/projects/my-project/topics/my-topic"
"filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Only log entries matching the filter are exported. The filter
# must be consistent with the log entry format specified by the
# `outputVersionFormat` parameter, regardless of the format of the
# log entry that was originally written to Stackdriver Logging.
# Example filter (V2 format):
#
# logName=projects/my-projectid/logs/syslog AND severity>=ERROR
"startTime": "A String", # Optional. Time range for which this sink is active.
# Logs are exported only if start_time <= entry.timestamp < end_time
# Both start_time and end_time may be omitted to specify
# (half) infinite ranges. The start_time must be less than the end_time.
"outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
# entries. This version does not have to correspond to the version of the
# log entry that was written to Stackdriver Logging. If omitted, the
# v2 format is used.
"writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
# access. This may be a service account or a group.
# Examples (Do not assume these specific values):
# "serviceAccount:cloud-logs@system.gserviceaccount.com"
# "group:cloud-logs@google.com"
#
# For GCS destinations, the role "roles/owner" is required on the bucket
# For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
# required on the topic
# For BigQuery, the role "roles/editor" is required on the dataset
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Describes a sink used to export log entries outside of Stackdriver Logging.
"endTime": "A String", # Optional. Time at which this sink expires.
"name": "A String", # Required. The client-assigned sink identifier, unique within the
# project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
# limited to 1000 characters and can include only the following characters:
# `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
# of the name is 100 characters.
"destination": "A String", # Required. The export destination. See
# [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
# Examples:
#
# "storage.googleapis.com/my-gcs-bucket"
# "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
# "pubsub.googleapis.com/projects/my-project/topics/my-topic"
"filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Only log entries matching the filter are exported. The filter
# must be consistent with the log entry format specified by the
# `outputVersionFormat` parameter, regardless of the format of the
# log entry that was originally written to Stackdriver Logging.
# Example filter (V2 format):
#
# logName=projects/my-projectid/logs/syslog AND severity>=ERROR
"startTime": "A String", # Optional. Time range for which this sink is active.
# Logs are exported only if start_time <= entry.timestamp < end_time
# Both start_time and end_time may be omitted to specify
# (half) infinite ranges. The start_time must be less than the end_time.
"outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
# entries. This version does not have to correspond to the version of the
# log entry that was written to Stackdriver Logging. If omitted, the
# v2 format is used.
"writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
# access. This may be a service account or a group.
# Examples (Do not assume these specific values):
# "serviceAccount:cloud-logs@system.gserviceaccount.com"
# "group:cloud-logs@google.com"
#
# For GCS destinations, the role "roles/owner" is required on the bucket
# For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
# required on the topic
# For BigQuery, the role "roles/editor" is required on the dataset
}</pre>
</div>
</body></html>
|
