aboutsummaryrefslogtreecommitdiffhomepage
path: root/third_party/googleapis/google/logging/v2/logging_gapic.yaml
blob: 14cd8d6a7c0f0da2e8253d5462560f6216beb257 (plain)
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
type: com.google.api.codegen.ConfigProto
language_settings:
  java:
    package_name: com.google.cloud.logging.spi.v2
    interface_names:
      google.logging.v2.ConfigServiceV2: Config
      google.logging.v2.LoggingServiceV2: Logging
      google.logging.v2.MetricsServiceV2: Metrics
  python:
    package_name: google.cloud.gapic.logging.v2
  go:
    package_name: cloud.google.com/go/logging/apiv2
    domain_layer_location: cloud.google.com/go/logging
  csharp:
    package_name: Google.Cloud.Logging.V2
  ruby:
    package_name: Google::Cloud::Logging::V2
  php:
    package_name: Google\Cloud\Logging\V2
  nodejs:
    package_name: logging.v2
    domain_layer_location: google-cloud
license_header:
  copyright_file: copyright-google.txt
  license_file: license-header-apache-2.0.txt
collections:
- name_pattern: projects/{project}
  entity_name: project
- name_pattern: projects/{project}/logs/{log}
  entity_name: log
- name_pattern: projects/{project}/sinks/{sink}
  entity_name: sink
- name_pattern: projects/{project}/metrics/{metric}
  entity_name: metric
- name_pattern: organizations/{organization}
  entity_name: organization
- name_pattern: organizations/{organization}/logs/{log}
  entity_name: organization_log
- name_pattern: organizations/{organization}/sinks/{sink}
  entity_name: organization_sink
- name_pattern: folders/{folder}
  entity_name: folder
- name_pattern: folders/{folder}/logs/{log}
  entity_name: folder_log
- name_pattern: folders/{folder}/sinks/{sink}
  entity_name: folder_sink
- name_pattern: billingAccounts/{billing_account}
  entity_name: billing
- name_pattern: billingAccounts/{billing_account}/logs/{log}
  entity_name: billing_log
- name_pattern: billingAccounts/{billing_account}/sinks/{sink}
  entity_name: billing_sink
collection_oneofs:
- oneof_name: parent_oneof
  collection_names:
  - project
  - organization
  - folder
  - billing
- oneof_name: sink_oneof
  collection_names:
  - sink
  - organization_sink
  - folder_sink
  - billing_sink
- oneof_name: log_oneof
  collection_names:
  - log
  - organization_log
  - folder_log
  - billing_log
- oneof_name: metric_oneof
  collection_names:
  - metric
interfaces:
- name: google.logging.v2.ConfigServiceV2
  collections:
  - name_pattern: projects/{project}
    entity_name: project
  - name_pattern: projects/{project}/sinks/{sink}
    entity_name: sink
  retry_codes_def:
  - name: idempotent
    retry_codes:
    - UNAVAILABLE
    - DEADLINE_EXCEEDED
  - name: non_idempotent
    retry_codes:
    - UNAVAILABLE
  retry_params_def:
  - name: default
    initial_retry_delay_millis: 100
    retry_delay_multiplier: 1.2
    max_retry_delay_millis: 1000
    initial_rpc_timeout_millis: 2000
    rpc_timeout_multiplier: 1.5
    max_rpc_timeout_millis: 30000
    total_timeout_millis: 45000
  methods:
  - name: ListSinks
    flattening:
      groups:
      - parameters:
        - parent
    required_fields:
    - parent
    request_object_method: true
    page_streaming:
      request:
        token_field: page_token
        page_size_field: page_size
      response:
        token_field: next_page_token
        resources_field: sinks
    retry_codes_name: idempotent
    retry_params_name: default
    timeout_millis: 30000
    field_name_patterns:
      parent: parent_oneof
    resource_name_treatment: STATIC_TYPES
  - name: GetSink
    flattening:
      groups:
      - parameters:
        - sink_name
    required_fields:
    - sink_name
    request_object_method: false
    retry_codes_name: idempotent
    retry_params_name: default
    timeout_millis: 30000
    field_name_patterns:
      sink_name: sink_oneof
    resource_name_treatment: STATIC_TYPES
  - name: CreateSink
    flattening:
      groups:
      - parameters:
        - parent
        - sink
    required_fields:
    - parent
    - sink
    request_object_method: true
    retry_codes_name: non_idempotent
    retry_params_name: default
    timeout_millis: 30000
    field_name_patterns:
      parent: parent_oneof
    resource_name_treatment: STATIC_TYPES
  - name: UpdateSink
    flattening:
      groups:
      - parameters:
        - sink_name
        - sink
    required_fields:
    - sink_name
    - sink
    request_object_method: true
    retry_codes_name: non_idempotent
    retry_params_name: default
    timeout_millis: 30000
    field_name_patterns:
      sink_name: sink_oneof
    resource_name_treatment: STATIC_TYPES
  - name: DeleteSink
    flattening:
      groups:
      - parameters:
        - sink_name
    required_fields:
    - sink_name
    request_object_method: false
    retry_codes_name: idempotent
    retry_params_name: default
    timeout_millis: 30000
    field_name_patterns:
      sink_name: sink_oneof
    resource_name_treatment: STATIC_TYPES
- name: google.logging.v2.MetricsServiceV2
  collections:
  - name_pattern: projects/{project}
    entity_name: project
  - name_pattern: projects/{project}/metrics/{metric}
    entity_name: metric
  retry_codes_def:
  - name: idempotent
    retry_codes:
    - UNAVAILABLE
    - DEADLINE_EXCEEDED
  - name: non_idempotent
    retry_codes:
    - UNAVAILABLE
  retry_params_def:
  - name: default
    initial_retry_delay_millis: 100
    retry_delay_multiplier: 1.2
    max_retry_delay_millis: 1000
    initial_rpc_timeout_millis: 2000
    rpc_timeout_multiplier: 1.5
    max_rpc_timeout_millis: 30000
    total_timeout_millis: 45000
  methods:
  - name: ListLogMetrics
    flattening:
      groups:
      - parameters:
        - parent
    required_fields:
    - parent
    request_object_method: true
    page_streaming:
      request:
        token_field: page_token
        page_size_field: page_size
      response:
        token_field: next_page_token
        resources_field: metrics
    retry_codes_name: idempotent
    retry_params_name: default
    timeout_millis: 30000
    field_name_patterns:
      parent: parent_oneof
    resource_name_treatment: STATIC_TYPES
  - name: GetLogMetric
    flattening:
      groups:
      - parameters:
        - metric_name
    required_fields:
    - metric_name
    request_object_method: false
    retry_codes_name: idempotent
    retry_params_name: default
    timeout_millis: 30000
    field_name_patterns:
      metric_name: metric_oneof
    resource_name_treatment: STATIC_TYPES
  - name: CreateLogMetric
    flattening:
      groups:
      - parameters:
        - parent
        - metric
    required_fields:
    - parent
    - metric
    request_object_method: true
    retry_codes_name: non_idempotent
    retry_params_name: default
    timeout_millis: 30000
    field_name_patterns:
      parent: parent_oneof
    resource_name_treatment: STATIC_TYPES
  - name: UpdateLogMetric
    flattening:
      groups:
      - parameters:
        - metric_name
        - metric
    required_fields:
    - metric_name
    - metric
    request_object_method: true
    retry_codes_name: non_idempotent
    retry_params_name: default
    timeout_millis: 30000
    field_name_patterns:
      metric_name: metric_oneof
    resource_name_treatment: STATIC_TYPES
  - name: DeleteLogMetric
    flattening:
      groups:
      - parameters:
        - metric_name
    required_fields:
    - metric_name
    request_object_method: false
    retry_codes_name: idempotent
    retry_params_name: default
    timeout_millis: 30000
    field_name_patterns:
      metric_name: metric_oneof
    resource_name_treatment: STATIC_TYPES
- name: google.logging.v2.LoggingServiceV2
  smoke_test:
    method: WriteLogEntries
    init_fields:
    - entries
    - log_name%project=$PROJECT_ID
    - log_name%log="test-$RANDOM"
  collections:
  - name_pattern: projects/{project}
    entity_name: project
  - name_pattern: projects/{project}/logs/{log}
    entity_name: log
  retry_codes_def:
  - name: idempotent
    retry_codes:
    - UNAVAILABLE
    - DEADLINE_EXCEEDED
  - name: non_idempotent
    retry_codes:
    - UNAVAILABLE
  retry_params_def:
  - name: default
    initial_retry_delay_millis: 100
    retry_delay_multiplier: 1.2
    max_retry_delay_millis: 1000
    initial_rpc_timeout_millis: 2000
    rpc_timeout_multiplier: 1.5
    max_rpc_timeout_millis: 30000
    total_timeout_millis: 45000
  - name: list
    initial_retry_delay_millis: 100
    retry_delay_multiplier: 1.2
    max_retry_delay_millis: 1000
    initial_rpc_timeout_millis: 7000
    rpc_timeout_multiplier: 1.5
    max_rpc_timeout_millis: 30000
    total_timeout_millis: 45000
  methods:
  - name: DeleteLog
    flattening:
      groups:
      - parameters:
        - log_name
    required_fields:
    - log_name
    request_object_method: false
    retry_codes_name: idempotent
    retry_params_name: default
    timeout_millis: 30000
    field_name_patterns:
      log_name: log_oneof
    resource_name_treatment: STATIC_TYPES
  - name: WriteLogEntries
    flattening:
      groups:
      - parameters:
        - log_name
        - resource
        - labels
        - entries
    required_fields:
    - entries
    request_object_method: true
    retry_codes_name: non_idempotent
    retry_params_name: default
    timeout_millis: 30000
    field_name_patterns:
      log_name: log_oneof
    resource_name_treatment: STATIC_TYPES
    batching:
      thresholds:
        element_count_threshold: 1000
        request_byte_threshold: 1048576 # 1 MiB
        delay_threshold_millis: 50
        flow_control_element_limit: 100000
        flow_control_byte_limit: 10485760 # 10 MiB
        flow_control_limit_exceeded_behavior: THROW_EXCEPTION
      batch_descriptor:
        batched_field: entries
        discriminator_fields:
        - log_name
        - resource
        - labels
  - name: ListLogEntries
    flattening:
      groups:
      - parameters:
        - resource_names
        - filter
        - order_by
    required_fields:
    - resource_names
    request_object_method: true
    page_streaming:
      request:
        page_size_field: page_size
        token_field: page_token
      response:
        token_field: next_page_token
        resources_field: entries
    retry_codes_name: idempotent
    retry_params_name: list
    timeout_millis: 30000
    resource_name_treatment: STATIC_TYPES
  - name: ListMonitoredResourceDescriptors
    request_object_method: true
    page_streaming:
      request:
        page_size_field: page_size
        token_field: page_token
      response:
        token_field: next_page_token
        resources_field: resource_descriptors
    retry_codes_name: idempotent
    retry_params_name: default
    timeout_millis: 30000
    resource_name_treatment: STATIC_TYPES
  - name: ListLogs
    flattening:
      groups:
      - parameters:
        - parent
    required_fields:
    - parent
    request_object_method: true
    page_streaming:
      request:
        page_size_field: page_size
        token_field: page_token
      response:
        token_field: next_page_token
        resources_field: log_names
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      parent: parent_oneof
    timeout_millis: 30000
    resource_name_treatment: STATIC_TYPES
resource_name_generation:
- message_name: DeleteLogRequest
  field_entity_map:
    log_name: log_oneof
- message_name: WriteLogEntriesRequest
  field_entity_map:
    log_name: log_oneof
- message_name: ListLogEntriesRequest
  field_entity_map:
    log_name: log_oneof
- message_name: LogEntry
  field_entity_map:
    log_name: log_oneof
- message_name: LogSink
  field_entity_map:
    destination: "*"
- message_name: ListSinksRequest
  field_entity_map:
    parent: parent_oneof
- message_name: GetSinkRequest
  field_entity_map:
    sink_name: sink_oneof
- message_name: CreateSinkRequest
  field_entity_map:
    parent: parent_oneof
- message_name: UpdateSinkRequest
  field_entity_map:
    sink_name: sink_oneof
- message_name: DeleteSinkRequest
  field_entity_map:
    sink_name: sink_oneof
- message_name: ListLogMetricsRequest
  field_entity_map:
    parent: parent_oneof
- message_name: GetLogMetricRequest
  field_entity_map:
    metric_name: metric_oneof
- message_name: CreateLogMetricRequest
  field_entity_map:
    parent: parent_oneof
- message_name: UpdateLogMetricRequest
  field_entity_map:
    metric_name: metric_oneof
- message_name: DeleteLogMetricRequest
  field_entity_map:
    metric_name: metric_oneof
- message_name: ListLogsRequest
  field_entity_map:
    parent: parent_oneof