-
Notifications
You must be signed in to change notification settings - Fork 38
/
LoggingClient.java
1536 lines (1460 loc) · 68.1 KB
/
LoggingClient.java
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
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.logging.v2;
import com.google.api.MonitoredResource;
import com.google.api.MonitoredResourceDescriptor;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.BidiStreamingCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.logging.v2.stub.LoggingServiceV2Stub;
import com.google.cloud.logging.v2.stub.LoggingServiceV2StubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.logging.v2.BillingAccountName;
import com.google.logging.v2.DeleteLogRequest;
import com.google.logging.v2.FolderName;
import com.google.logging.v2.ListLogEntriesRequest;
import com.google.logging.v2.ListLogEntriesResponse;
import com.google.logging.v2.ListLogsRequest;
import com.google.logging.v2.ListLogsResponse;
import com.google.logging.v2.ListMonitoredResourceDescriptorsRequest;
import com.google.logging.v2.ListMonitoredResourceDescriptorsResponse;
import com.google.logging.v2.LogEntry;
import com.google.logging.v2.LogName;
import com.google.logging.v2.OrganizationName;
import com.google.logging.v2.ProjectName;
import com.google.logging.v2.TailLogEntriesRequest;
import com.google.logging.v2.TailLogEntriesResponse;
import com.google.logging.v2.WriteLogEntriesRequest;
import com.google.logging.v2.WriteLogEntriesResponse;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Service for ingesting and querying logs.
*
* <p>This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* LogName logName = LogName.ofProjectLogName("[PROJECT]", "[LOG]");
* loggingClient.deleteLog(logName);
* }
* }</pre>
*
* <p>Note: close() needs to be called on the LoggingClient object to clean up resources such as
* threads. In the example above, try-with-resources is used, which automatically calls close().
*
* <table>
* <caption>Methods</caption>
* <tr>
* <th>Method</th>
* <th>Description</th>
* <th>Method Variants</th>
* </tr>
* <tr>
* <td><p> DeleteLog</td>
* <td><p> Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.</td>
* <td>
* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
* <ul>
* <li><p> deleteLog(DeleteLogRequest request)
* </ul>
* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>
* <ul>
* <li><p> deleteLog(LogName logName)
* <li><p> deleteLog(String logName)
* </ul>
* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
* <ul>
* <li><p> deleteLogCallable()
* </ul>
* </td>
* </tr>
* <tr>
* <td><p> WriteLogEntries</td>
* <td><p> Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging. A single request may contain log entries for a maximum of 1000 different resources (projects, organizations, billing accounts or folders)</td>
* <td>
* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
* <ul>
* <li><p> writeLogEntries(WriteLogEntriesRequest request)
* </ul>
* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>
* <ul>
* <li><p> writeLogEntries(LogName logName, MonitoredResource resource, Map<String, String> labels, List<LogEntry> entries)
* <li><p> writeLogEntries(String logName, MonitoredResource resource, Map<String, String> labels, List<LogEntry> entries)
* </ul>
* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
* <ul>
* <li><p> writeLogEntriesCallable()
* </ul>
* </td>
* </tr>
* <tr>
* <td><p> ListLogEntries</td>
* <td><p> Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see [Exporting Logs](https://cloud.google.com/logging/docs/export).</td>
* <td>
* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
* <ul>
* <li><p> listLogEntries(ListLogEntriesRequest request)
* </ul>
* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>
* <ul>
* <li><p> listLogEntries(List<String> resourceNames, String filter, String orderBy)
* </ul>
* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
* <ul>
* <li><p> listLogEntriesPagedCallable()
* <li><p> listLogEntriesCallable()
* </ul>
* </td>
* </tr>
* <tr>
* <td><p> ListMonitoredResourceDescriptors</td>
* <td><p> Lists the descriptors for monitored resource types used by Logging.</td>
* <td>
* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
* <ul>
* <li><p> listMonitoredResourceDescriptors(ListMonitoredResourceDescriptorsRequest request)
* </ul>
* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
* <ul>
* <li><p> listMonitoredResourceDescriptorsPagedCallable()
* <li><p> listMonitoredResourceDescriptorsCallable()
* </ul>
* </td>
* </tr>
* <tr>
* <td><p> ListLogs</td>
* <td><p> Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.</td>
* <td>
* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
* <ul>
* <li><p> listLogs(ListLogsRequest request)
* </ul>
* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>
* <ul>
* <li><p> listLogs(BillingAccountName parent)
* <li><p> listLogs(FolderName parent)
* <li><p> listLogs(OrganizationName parent)
* <li><p> listLogs(ProjectName parent)
* <li><p> listLogs(String parent)
* </ul>
* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
* <ul>
* <li><p> listLogsPagedCallable()
* <li><p> listLogsCallable()
* </ul>
* </td>
* </tr>
* <tr>
* <td><p> TailLogEntries</td>
* <td><p> Streaming read of log entries as they are ingested. Until the stream is terminated, it will continue reading logs.</td>
* <td>
* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
* <ul>
* <li><p> tailLogEntriesCallable()
* </ul>
* </td>
* </tr>
* </table>
*
* <p>See the individual methods for example code.
*
* <p>Many parameters require resource names to be formatted in a particular way. To assist with
* these names, this class includes a format method for each type of name, and additionally a parse
* method to extract the individual identifiers contained within names that are returned.
*
* <p>This class can be customized by passing in a custom instance of LoggingSettings to create().
* For example:
*
* <p>To customize credentials:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* LoggingSettings loggingSettings =
* LoggingSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* LoggingClient loggingClient = LoggingClient.create(loggingSettings);
* }</pre>
*
* <p>To customize the endpoint:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* LoggingSettings loggingSettings = LoggingSettings.newBuilder().setEndpoint(myEndpoint).build();
* LoggingClient loggingClient = LoggingClient.create(loggingSettings);
* }</pre>
*
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class LoggingClient implements BackgroundResource {
private final LoggingSettings settings;
private final LoggingServiceV2Stub stub;
/** Constructs an instance of LoggingClient with default settings. */
public static final LoggingClient create() throws IOException {
return create(LoggingSettings.newBuilder().build());
}
/**
* Constructs an instance of LoggingClient, using the given settings. The channels are created
* based on the settings passed in, or defaults for any settings that are not set.
*/
public static final LoggingClient create(LoggingSettings settings) throws IOException {
return new LoggingClient(settings);
}
/**
* Constructs an instance of LoggingClient, using the given stub for making calls. This is for
* advanced usage - prefer using create(LoggingSettings).
*/
public static final LoggingClient create(LoggingServiceV2Stub stub) {
return new LoggingClient(stub);
}
/**
* Constructs an instance of LoggingClient, using the given settings. This is protected so that it
* is easy to make a subclass, but otherwise, the static factory methods should be preferred.
*/
protected LoggingClient(LoggingSettings settings) throws IOException {
this.settings = settings;
this.stub = ((LoggingServiceV2StubSettings) settings.getStubSettings()).createStub();
}
protected LoggingClient(LoggingServiceV2Stub stub) {
this.settings = null;
this.stub = stub;
}
public final LoggingSettings getSettings() {
return settings;
}
public LoggingServiceV2Stub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it
* receives new entries. Log entries written shortly before the delete operation might not be
* deleted. Entries received after the delete operation with a timestamp before the operation will
* be deleted.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* LogName logName = LogName.ofProjectLogName("[PROJECT]", "[LOG]");
* loggingClient.deleteLog(logName);
* }
* }</pre>
*
* @param logName Required. The resource name of the log to delete:
* <ul>
* <li>`projects/[PROJECT_ID]/logs/[LOG_ID]`
* <li>`organizations/[ORGANIZATION_ID]/logs/[LOG_ID]`
* <li>`billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]`
* <li>`folders/[FOLDER_ID]/logs/[LOG_ID]`
* </ul>
* <p>`[LOG_ID]` must be URL-encoded. For example, `"projects/my-project-id/logs/syslog"`,
* `"organizations/123/logs/cloudaudit.googleapis.com%2Factivity"`.
* <p>For more information about log names, see [LogEntry][google.logging.v2.LogEntry].
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteLog(LogName logName) {
DeleteLogRequest request =
DeleteLogRequest.newBuilder()
.setLogName(logName == null ? null : logName.toString())
.build();
deleteLog(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it
* receives new entries. Log entries written shortly before the delete operation might not be
* deleted. Entries received after the delete operation with a timestamp before the operation will
* be deleted.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* String logName = LogName.ofProjectLogName("[PROJECT]", "[LOG]").toString();
* loggingClient.deleteLog(logName);
* }
* }</pre>
*
* @param logName Required. The resource name of the log to delete:
* <ul>
* <li>`projects/[PROJECT_ID]/logs/[LOG_ID]`
* <li>`organizations/[ORGANIZATION_ID]/logs/[LOG_ID]`
* <li>`billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]`
* <li>`folders/[FOLDER_ID]/logs/[LOG_ID]`
* </ul>
* <p>`[LOG_ID]` must be URL-encoded. For example, `"projects/my-project-id/logs/syslog"`,
* `"organizations/123/logs/cloudaudit.googleapis.com%2Factivity"`.
* <p>For more information about log names, see [LogEntry][google.logging.v2.LogEntry].
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteLog(String logName) {
DeleteLogRequest request = DeleteLogRequest.newBuilder().setLogName(logName).build();
deleteLog(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it
* receives new entries. Log entries written shortly before the delete operation might not be
* deleted. Entries received after the delete operation with a timestamp before the operation will
* be deleted.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* DeleteLogRequest request =
* DeleteLogRequest.newBuilder()
* .setLogName(LogName.ofProjectLogName("[PROJECT]", "[LOG]").toString())
* .build();
* loggingClient.deleteLog(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteLog(DeleteLogRequest request) {
deleteLogCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it
* receives new entries. Log entries written shortly before the delete operation might not be
* deleted. Entries received after the delete operation with a timestamp before the operation will
* be deleted.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* DeleteLogRequest request =
* DeleteLogRequest.newBuilder()
* .setLogName(LogName.ofProjectLogName("[PROJECT]", "[LOG]").toString())
* .build();
* ApiFuture<Empty> future = loggingClient.deleteLogCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }</pre>
*/
public final UnaryCallable<DeleteLogRequest, Empty> deleteLogCallable() {
return stub.deleteLogCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Writes log entries to Logging. This API method is the only way to send log entries to Logging.
* This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging
* libraries configured to use Logging. A single request may contain log entries for a maximum of
* 1000 different resources (projects, organizations, billing accounts or folders)
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* LogName logName = LogName.ofProjectLogName("[PROJECT]", "[LOG]");
* MonitoredResource resource = MonitoredResource.newBuilder().build();
* Map<String, String> labels = new HashMap<>();
* List<LogEntry> entries = new ArrayList<>();
* WriteLogEntriesResponse response =
* loggingClient.writeLogEntries(logName, resource, labels, entries);
* }
* }</pre>
*
* @param logName Optional. A default log resource name that is assigned to all log entries in
* `entries` that do not specify a value for `log_name`:
* <ul>
* <li>`projects/[PROJECT_ID]/logs/[LOG_ID]`
* <li>`organizations/[ORGANIZATION_ID]/logs/[LOG_ID]`
* <li>`billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]`
* <li>`folders/[FOLDER_ID]/logs/[LOG_ID]`
* </ul>
* <p>`[LOG_ID]` must be URL-encoded. For example:
* <p>"projects/my-project-id/logs/syslog"
* "organizations/123/logs/cloudaudit.googleapis.com%2Factivity"
* <p>The permission `logging.logEntries.create` is needed on each project, organization,
* billing account, or folder that is receiving new log entries, whether the resource is
* specified in `logName` or in an individual log entry.
* @param resource Optional. A default monitored resource object that is assigned to all log
* entries in `entries` that do not specify a value for `resource`. Example:
* <p>{ "type": "gce_instance", "labels": { "zone": "us-central1-a", "instance_id":
* "00000000000000000000" }}
* <p>See [LogEntry][google.logging.v2.LogEntry].
* @param labels Optional. Default labels that are added to the `labels` field of all log entries
* in `entries`. If a log entry already has a label with the same key as a label in this
* parameter, then the log entry's label is not changed. See
* [LogEntry][google.logging.v2.LogEntry].
* @param entries Required. The log entries to send to Logging. The order of log entries in this
* list does not matter. Values supplied in this method's `log_name`, `resource`, and `labels`
* fields are copied into those log entries in this list that do not include values for their
* corresponding fields. For more information, see the [LogEntry][google.logging.v2.LogEntry]
* type.
* <p>If the `timestamp` or `insert_id` fields are missing in log entries, then this method
* supplies the current time or a unique identifier, respectively. The supplied values are
* chosen so that, among the log entries that did not supply their own values, the entries
* earlier in the list will sort before the entries later in the list. See the `entries.list`
* method.
* <p>Log entries with timestamps that are more than the [logs retention
* period](https://cloud.google.com/logging/quotas) in the past or more than 24 hours in the
* future will not be available when calling `entries.list`. However, those log entries can
* still be [exported with
* LogSinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
* <p>To improve throughput and to avoid exceeding the [quota
* limit](https://cloud.google.com/logging/quotas) for calls to `entries.write`, you should
* try to include several log entries in this list, rather than calling this method for each
* individual log entry.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final WriteLogEntriesResponse writeLogEntries(
LogName logName,
MonitoredResource resource,
Map<String, String> labels,
List<LogEntry> entries) {
WriteLogEntriesRequest request =
WriteLogEntriesRequest.newBuilder()
.setLogName(logName == null ? null : logName.toString())
.setResource(resource)
.putAllLabels(labels)
.addAllEntries(entries)
.build();
return writeLogEntries(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Writes log entries to Logging. This API method is the only way to send log entries to Logging.
* This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging
* libraries configured to use Logging. A single request may contain log entries for a maximum of
* 1000 different resources (projects, organizations, billing accounts or folders)
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* String logName = LogName.ofProjectLogName("[PROJECT]", "[LOG]").toString();
* MonitoredResource resource = MonitoredResource.newBuilder().build();
* Map<String, String> labels = new HashMap<>();
* List<LogEntry> entries = new ArrayList<>();
* WriteLogEntriesResponse response =
* loggingClient.writeLogEntries(logName, resource, labels, entries);
* }
* }</pre>
*
* @param logName Optional. A default log resource name that is assigned to all log entries in
* `entries` that do not specify a value for `log_name`:
* <ul>
* <li>`projects/[PROJECT_ID]/logs/[LOG_ID]`
* <li>`organizations/[ORGANIZATION_ID]/logs/[LOG_ID]`
* <li>`billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]`
* <li>`folders/[FOLDER_ID]/logs/[LOG_ID]`
* </ul>
* <p>`[LOG_ID]` must be URL-encoded. For example:
* <p>"projects/my-project-id/logs/syslog"
* "organizations/123/logs/cloudaudit.googleapis.com%2Factivity"
* <p>The permission `logging.logEntries.create` is needed on each project, organization,
* billing account, or folder that is receiving new log entries, whether the resource is
* specified in `logName` or in an individual log entry.
* @param resource Optional. A default monitored resource object that is assigned to all log
* entries in `entries` that do not specify a value for `resource`. Example:
* <p>{ "type": "gce_instance", "labels": { "zone": "us-central1-a", "instance_id":
* "00000000000000000000" }}
* <p>See [LogEntry][google.logging.v2.LogEntry].
* @param labels Optional. Default labels that are added to the `labels` field of all log entries
* in `entries`. If a log entry already has a label with the same key as a label in this
* parameter, then the log entry's label is not changed. See
* [LogEntry][google.logging.v2.LogEntry].
* @param entries Required. The log entries to send to Logging. The order of log entries in this
* list does not matter. Values supplied in this method's `log_name`, `resource`, and `labels`
* fields are copied into those log entries in this list that do not include values for their
* corresponding fields. For more information, see the [LogEntry][google.logging.v2.LogEntry]
* type.
* <p>If the `timestamp` or `insert_id` fields are missing in log entries, then this method
* supplies the current time or a unique identifier, respectively. The supplied values are
* chosen so that, among the log entries that did not supply their own values, the entries
* earlier in the list will sort before the entries later in the list. See the `entries.list`
* method.
* <p>Log entries with timestamps that are more than the [logs retention
* period](https://cloud.google.com/logging/quotas) in the past or more than 24 hours in the
* future will not be available when calling `entries.list`. However, those log entries can
* still be [exported with
* LogSinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
* <p>To improve throughput and to avoid exceeding the [quota
* limit](https://cloud.google.com/logging/quotas) for calls to `entries.write`, you should
* try to include several log entries in this list, rather than calling this method for each
* individual log entry.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final WriteLogEntriesResponse writeLogEntries(
String logName,
MonitoredResource resource,
Map<String, String> labels,
List<LogEntry> entries) {
WriteLogEntriesRequest request =
WriteLogEntriesRequest.newBuilder()
.setLogName(logName)
.setResource(resource)
.putAllLabels(labels)
.addAllEntries(entries)
.build();
return writeLogEntries(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Writes log entries to Logging. This API method is the only way to send log entries to Logging.
* This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging
* libraries configured to use Logging. A single request may contain log entries for a maximum of
* 1000 different resources (projects, organizations, billing accounts or folders)
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* WriteLogEntriesRequest request =
* WriteLogEntriesRequest.newBuilder()
* .setLogName(LogName.ofProjectLogName("[PROJECT]", "[LOG]").toString())
* .setResource(MonitoredResource.newBuilder().build())
* .putAllLabels(new HashMap<String, String>())
* .addAllEntries(new ArrayList<LogEntry>())
* .setPartialSuccess(true)
* .setDryRun(true)
* .build();
* WriteLogEntriesResponse response = loggingClient.writeLogEntries(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final WriteLogEntriesResponse writeLogEntries(WriteLogEntriesRequest request) {
return writeLogEntriesCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Writes log entries to Logging. This API method is the only way to send log entries to Logging.
* This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging
* libraries configured to use Logging. A single request may contain log entries for a maximum of
* 1000 different resources (projects, organizations, billing accounts or folders)
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* WriteLogEntriesRequest request =
* WriteLogEntriesRequest.newBuilder()
* .setLogName(LogName.ofProjectLogName("[PROJECT]", "[LOG]").toString())
* .setResource(MonitoredResource.newBuilder().build())
* .putAllLabels(new HashMap<String, String>())
* .addAllEntries(new ArrayList<LogEntry>())
* .setPartialSuccess(true)
* .setDryRun(true)
* .build();
* ApiFuture<WriteLogEntriesResponse> future =
* loggingClient.writeLogEntriesCallable().futureCall(request);
* // Do something.
* WriteLogEntriesResponse response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<WriteLogEntriesRequest, WriteLogEntriesResponse>
writeLogEntriesCallable() {
return stub.writeLogEntriesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists log entries. Use this method to retrieve log entries that originated from a
* project/folder/organization/billing account. For ways to export log entries, see [Exporting
* Logs](https://cloud.google.com/logging/docs/export).
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* List<String> resourceNames = new ArrayList<>();
* String filter = "filter-1274492040";
* String orderBy = "orderBy-1207110587";
* for (LogEntry element :
* loggingClient.listLogEntries(resourceNames, filter, orderBy).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param resourceNames Required. Names of one or more parent resources from which to retrieve log
* entries:
* <ul>
* <li>`projects/[PROJECT_ID]`
* <li>`organizations/[ORGANIZATION_ID]`
* <li>`billingAccounts/[BILLING_ACCOUNT_ID]`
* <li>`folders/[FOLDER_ID]`
* </ul>
* <p>May alternatively be one or more views:
* <p>*
* `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` *
* `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
* *
* `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
* * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
* <p>Projects listed in the `project_ids` field are added to this list. A maximum of 100
* resources may be specified in a single request.
* @param filter Optional. Only log entries that match the filter are returned. An empty filter
* matches all log entries in the resources listed in `resource_names`. Referencing a parent
* resource that is not listed in `resource_names` will cause the filter to return no results.
* The maximum length of a filter is 20,000 characters.
* @param orderBy Optional. How the results should be sorted. Presently, the only permitted values
* are `"timestamp asc"` (default) and `"timestamp desc"`. The first option returns entries in
* order of increasing values of `LogEntry.timestamp` (oldest first), and the second option
* returns entries in order of decreasing timestamps (newest first). Entries with equal
* timestamps are returned in order of their `insert_id` values.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListLogEntriesPagedResponse listLogEntries(
List<String> resourceNames, String filter, String orderBy) {
ListLogEntriesRequest request =
ListLogEntriesRequest.newBuilder()
.addAllResourceNames(resourceNames)
.setFilter(filter)
.setOrderBy(orderBy)
.build();
return listLogEntries(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists log entries. Use this method to retrieve log entries that originated from a
* project/folder/organization/billing account. For ways to export log entries, see [Exporting
* Logs](https://cloud.google.com/logging/docs/export).
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* ListLogEntriesRequest request =
* ListLogEntriesRequest.newBuilder()
* .addAllResourceNames(new ArrayList<String>())
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (LogEntry element : loggingClient.listLogEntries(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListLogEntriesPagedResponse listLogEntries(ListLogEntriesRequest request) {
return listLogEntriesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists log entries. Use this method to retrieve log entries that originated from a
* project/folder/organization/billing account. For ways to export log entries, see [Exporting
* Logs](https://cloud.google.com/logging/docs/export).
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* ListLogEntriesRequest request =
* ListLogEntriesRequest.newBuilder()
* .addAllResourceNames(new ArrayList<String>())
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture<LogEntry> future = loggingClient.listLogEntriesPagedCallable().futureCall(request);
* // Do something.
* for (LogEntry element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*/
public final UnaryCallable<ListLogEntriesRequest, ListLogEntriesPagedResponse>
listLogEntriesPagedCallable() {
return stub.listLogEntriesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists log entries. Use this method to retrieve log entries that originated from a
* project/folder/organization/billing account. For ways to export log entries, see [Exporting
* Logs](https://cloud.google.com/logging/docs/export).
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* ListLogEntriesRequest request =
* ListLogEntriesRequest.newBuilder()
* .addAllResourceNames(new ArrayList<String>())
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListLogEntriesResponse response = loggingClient.listLogEntriesCallable().call(request);
* for (LogEntry element : response.getEntriesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }</pre>
*/
public final UnaryCallable<ListLogEntriesRequest, ListLogEntriesResponse>
listLogEntriesCallable() {
return stub.listLogEntriesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the descriptors for monitored resource types used by Logging.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* ListMonitoredResourceDescriptorsRequest request =
* ListMonitoredResourceDescriptorsRequest.newBuilder()
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (MonitoredResourceDescriptor element :
* loggingClient.listMonitoredResourceDescriptors(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListMonitoredResourceDescriptorsPagedResponse listMonitoredResourceDescriptors(
ListMonitoredResourceDescriptorsRequest request) {
return listMonitoredResourceDescriptorsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the descriptors for monitored resource types used by Logging.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* ListMonitoredResourceDescriptorsRequest request =
* ListMonitoredResourceDescriptorsRequest.newBuilder()
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture<MonitoredResourceDescriptor> future =
* loggingClient.listMonitoredResourceDescriptorsPagedCallable().futureCall(request);
* // Do something.
* for (MonitoredResourceDescriptor element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*/
public final UnaryCallable<
ListMonitoredResourceDescriptorsRequest, ListMonitoredResourceDescriptorsPagedResponse>
listMonitoredResourceDescriptorsPagedCallable() {
return stub.listMonitoredResourceDescriptorsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the descriptors for monitored resource types used by Logging.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* ListMonitoredResourceDescriptorsRequest request =
* ListMonitoredResourceDescriptorsRequest.newBuilder()
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListMonitoredResourceDescriptorsResponse response =
* loggingClient.listMonitoredResourceDescriptorsCallable().call(request);
* for (MonitoredResourceDescriptor element : response.getResourceDescriptorsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }</pre>
*/
public final UnaryCallable<
ListMonitoredResourceDescriptorsRequest, ListMonitoredResourceDescriptorsResponse>
listMonitoredResourceDescriptorsCallable() {
return stub.listMonitoredResourceDescriptorsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have
* entries are listed.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* BillingAccountName parent = BillingAccountName.of("[BILLING_ACCOUNT]");
* for (String element : loggingClient.listLogs(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param parent Required. The resource name to list logs for:
* <ul>
* <li>`projects/[PROJECT_ID]`
* <li>`organizations/[ORGANIZATION_ID]`
* <li>`billingAccounts/[BILLING_ACCOUNT_ID]`
* <li>`folders/[FOLDER_ID]`
* </ul>
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListLogsPagedResponse listLogs(BillingAccountName parent) {
ListLogsRequest request =
ListLogsRequest.newBuilder().setParent(parent == null ? null : parent.toString()).build();
return listLogs(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have
* entries are listed.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LoggingClient loggingClient = LoggingClient.create()) {
* FolderName parent = FolderName.of("[FOLDER]");
* for (String element : loggingClient.listLogs(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }