This repository has been archived by the owner on Sep 16, 2023. It is now read-only.
/
UserEventServiceClient.java
753 lines (701 loc) · 33.5 KB
/
UserEventServiceClient.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
/*
* Copyright 2020 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.recommendationengine.v1beta1;
import com.google.api.HttpBody;
import com.google.api.core.ApiFunction;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.longrunning.OperationFuture;
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.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.recommendationengine.v1beta1.stub.UserEventServiceStub;
import com.google.cloud.recommendationengine.v1beta1.stub.UserEventServiceStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.longrunning.Operation;
import com.google.longrunning.OperationsClient;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Service for ingesting end user actions on the customer website.
*
* <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:
*
* <p>Note: close() needs to be called on the UserEventServiceClient object to clean up resources
* such as threads. In the example above, try-with-resources is used, which automatically calls
* close().
*
* <p>The surface of this class includes several types of Java methods for each of the API's
* methods:
*
* <ol>
* <li>A "flattened" method. With this type of method, the fields of the request type have been
* converted into function parameters. It may be the case that not all fields are available as
* parameters, and not every API method will have a flattened method entry point.
* <li>A "request object" method. This type of method only takes one parameter, a request object,
* which must be constructed before the call. Not every API method will have a request object
* method.
* <li>A "callable" method. This type of method takes no parameters and returns an immutable API
* callable object, which can be used to initiate calls to the service.
* </ol>
*
* <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 UserEventServiceSettings to
* create(). For example:
*
* <p>To customize credentials:
*
* <pre>{@code
* UserEventServiceSettings userEventServiceSettings =
* UserEventServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* UserEventServiceClient userEventServiceClient =
* UserEventServiceClient.create(userEventServiceSettings);
* }</pre>
*
* <p>To customize the endpoint:
*
* <pre>{@code
* UserEventServiceSettings userEventServiceSettings =
* UserEventServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* UserEventServiceClient userEventServiceClient =
* UserEventServiceClient.create(userEventServiceSettings);
* }</pre>
*
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@BetaApi
@Generated("by gapic-generator-java")
public class UserEventServiceClient implements BackgroundResource {
private final UserEventServiceSettings settings;
private final UserEventServiceStub stub;
private final OperationsClient operationsClient;
/** Constructs an instance of UserEventServiceClient with default settings. */
public static final UserEventServiceClient create() throws IOException {
return create(UserEventServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of UserEventServiceClient, 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 UserEventServiceClient create(UserEventServiceSettings settings)
throws IOException {
return new UserEventServiceClient(settings);
}
/**
* Constructs an instance of UserEventServiceClient, using the given stub for making calls. This
* is for advanced usage - prefer using create(UserEventServiceSettings).
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final UserEventServiceClient create(UserEventServiceStub stub) {
return new UserEventServiceClient(stub);
}
/**
* Constructs an instance of UserEventServiceClient, 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 UserEventServiceClient(UserEventServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((UserEventServiceStubSettings) settings.getStubSettings()).createStub();
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected UserEventServiceClient(UserEventServiceStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
public final UserEventServiceSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public UserEventServiceStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final OperationsClient getOperationsClient() {
return operationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Writes a single user event.
*
* @param parent Required. The parent eventStore resource name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* @param userEvent Required. User event to write.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final UserEvent writeUserEvent(EventStoreName parent, UserEvent userEvent) {
WriteUserEventRequest request =
WriteUserEventRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setUserEvent(userEvent)
.build();
return writeUserEvent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Writes a single user event.
*
* @param parent Required. The parent eventStore resource name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* @param userEvent Required. User event to write.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final UserEvent writeUserEvent(String parent, UserEvent userEvent) {
WriteUserEventRequest request =
WriteUserEventRequest.newBuilder().setParent(parent).setUserEvent(userEvent).build();
return writeUserEvent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Writes a single user event.
*
* @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 UserEvent writeUserEvent(WriteUserEventRequest request) {
return writeUserEventCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Writes a single user event.
*
* <p>Sample code:
*/
public final UnaryCallable<WriteUserEventRequest, UserEvent> writeUserEventCallable() {
return stub.writeUserEventCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Writes a single user event from the browser. This uses a GET request to due to browser
* restriction of POST-ing to a 3rd party domain.
*
* <p>This method is used only by the Recommendations AI JavaScript pixel. Users should not call
* this method directly.
*
* @param parent Required. The parent eventStore name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* @param userEvent Required. URL encoded UserEvent proto.
* @param uri Optional. The url including cgi-parameters but excluding the hash fragment. The URL
* must be truncated to 1.5K bytes to conservatively be under the 2K bytes. This is often more
* useful than the referer url, because many browsers only send the domain for 3rd party
* requests.
* @param ets Optional. The event timestamp in milliseconds. This prevents browser caching of
* otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final HttpBody collectUserEvent(
EventStoreName parent, String userEvent, String uri, long ets) {
CollectUserEventRequest request =
CollectUserEventRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setUserEvent(userEvent)
.setUri(uri)
.setEts(ets)
.build();
return collectUserEvent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Writes a single user event from the browser. This uses a GET request to due to browser
* restriction of POST-ing to a 3rd party domain.
*
* <p>This method is used only by the Recommendations AI JavaScript pixel. Users should not call
* this method directly.
*
* @param parent Required. The parent eventStore name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* @param userEvent Required. URL encoded UserEvent proto.
* @param uri Optional. The url including cgi-parameters but excluding the hash fragment. The URL
* must be truncated to 1.5K bytes to conservatively be under the 2K bytes. This is often more
* useful than the referer url, because many browsers only send the domain for 3rd party
* requests.
* @param ets Optional. The event timestamp in milliseconds. This prevents browser caching of
* otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final HttpBody collectUserEvent(String parent, String userEvent, String uri, long ets) {
CollectUserEventRequest request =
CollectUserEventRequest.newBuilder()
.setParent(parent)
.setUserEvent(userEvent)
.setUri(uri)
.setEts(ets)
.build();
return collectUserEvent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Writes a single user event from the browser. This uses a GET request to due to browser
* restriction of POST-ing to a 3rd party domain.
*
* <p>This method is used only by the Recommendations AI JavaScript pixel. Users should not call
* this method directly.
*
* @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 HttpBody collectUserEvent(CollectUserEventRequest request) {
return collectUserEventCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Writes a single user event from the browser. This uses a GET request to due to browser
* restriction of POST-ing to a 3rd party domain.
*
* <p>This method is used only by the Recommendations AI JavaScript pixel. Users should not call
* this method directly.
*
* <p>Sample code:
*/
public final UnaryCallable<CollectUserEventRequest, HttpBody> collectUserEventCallable() {
return stub.collectUserEventCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a list of user events within a time range, with potential filtering.
*
* @param parent Required. The parent eventStore resource name, such as
* "projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store".
* @param filter Optional. Filtering expression to specify restrictions over returned events. This
* is a sequence of terms, where each term applies some kind of a restriction to the returned
* user events. Use this expression to restrict results to a specific time range, or filter
* events by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z"
* eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search
* <p>We expect only 3 types of fields:
* <p>* eventTime: this can be specified a maximum of 2 times, once with a less than
* operator and once with a greater than operator. The eventTime restrict should result in one
* contiguous valid eventTime range.
* <p>* eventType: only 1 eventType restriction can be specified.
* <p>* eventsMissingCatalogItems: specififying this will restrict results to events for
* which catalog items were not found in the catalog. The default behavior is to return only
* those events for which catalog items were found.
* <p>Some examples of valid filters expressions:
* <p>* Example 1: eventTime > "2012-04-23T18:25:43.511Z" eventTime <
* "2012-04-23T18:30:43.511Z" * Example 2: eventTime > "2012-04-23T18:25:43.511Z"
* eventType = detail-page-view * Example 3: eventsMissingCatalogItems eventType = search
* eventTime < "2018-04-23T18:30:43.511Z" * Example 4: eventTime >
* "2012-04-23T18:25:43.511Z" * Example 5: eventType = search * Example 6:
* eventsMissingCatalogItems
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListUserEventsPagedResponse listUserEvents(EventStoreName parent, String filter) {
ListUserEventsRequest request =
ListUserEventsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setFilter(filter)
.build();
return listUserEvents(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a list of user events within a time range, with potential filtering.
*
* @param parent Required. The parent eventStore resource name, such as
* "projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store".
* @param filter Optional. Filtering expression to specify restrictions over returned events. This
* is a sequence of terms, where each term applies some kind of a restriction to the returned
* user events. Use this expression to restrict results to a specific time range, or filter
* events by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z"
* eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search
* <p>We expect only 3 types of fields:
* <p>* eventTime: this can be specified a maximum of 2 times, once with a less than
* operator and once with a greater than operator. The eventTime restrict should result in one
* contiguous valid eventTime range.
* <p>* eventType: only 1 eventType restriction can be specified.
* <p>* eventsMissingCatalogItems: specififying this will restrict results to events for
* which catalog items were not found in the catalog. The default behavior is to return only
* those events for which catalog items were found.
* <p>Some examples of valid filters expressions:
* <p>* Example 1: eventTime > "2012-04-23T18:25:43.511Z" eventTime <
* "2012-04-23T18:30:43.511Z" * Example 2: eventTime > "2012-04-23T18:25:43.511Z"
* eventType = detail-page-view * Example 3: eventsMissingCatalogItems eventType = search
* eventTime < "2018-04-23T18:30:43.511Z" * Example 4: eventTime >
* "2012-04-23T18:25:43.511Z" * Example 5: eventType = search * Example 6:
* eventsMissingCatalogItems
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListUserEventsPagedResponse listUserEvents(String parent, String filter) {
ListUserEventsRequest request =
ListUserEventsRequest.newBuilder().setParent(parent).setFilter(filter).build();
return listUserEvents(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a list of user events within a time range, with potential filtering.
*
* @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 ListUserEventsPagedResponse listUserEvents(ListUserEventsRequest request) {
return listUserEventsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a list of user events within a time range, with potential filtering.
*
* <p>Sample code:
*/
public final UnaryCallable<ListUserEventsRequest, ListUserEventsPagedResponse>
listUserEventsPagedCallable() {
return stub.listUserEventsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a list of user events within a time range, with potential filtering.
*
* <p>Sample code:
*/
public final UnaryCallable<ListUserEventsRequest, ListUserEventsResponse>
listUserEventsCallable() {
return stub.listUserEventsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes permanently all user events specified by the filter provided. Depending on the number
* of events specified by the filter, this operation could take hours or days to complete. To test
* a filter, use the list command first.
*
* @param parent Required. The resource name of the event_store under which the events are
* created. The format is
* "projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}"
* @param filter Required. The filter string to specify the events to be deleted. Empty string
* filter is not allowed. This filter can also be used with ListUserEvents API to list events
* that will be deleted. The eligible fields for filtering are:
* <ul>
* <li>eventType - UserEvent.eventType field of type string.
* <li>eventTime - in ISO 8601 "zulu" format.
* <li>visitorId - field of type string. Specifying this will delete all events associated
* with a visitor.
* <li>userId - field of type string. Specifying this will delete all events associated with
* a user. Example 1: Deleting all events in a time range. `eventTime >
* "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` Example 2:
* Deleting specific eventType in time range. `eventTime > "2012-04-23T18:25:43.511Z"
* eventType = "detail-page-view"` Example 3: Deleting all events for a specific visitor
* `visitorId = visitor1024` The filtering fields are assumed to have an implicit AND.
* </ul>
*
* @param force Optional. The default value is false. Override this flag to true to actually
* perform the purge. If the field is not set to true, a sampling of events to be deleted will
* be returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<PurgeUserEventsResponse, PurgeUserEventsMetadata>
purgeUserEventsAsync(EventStoreName parent, String filter, boolean force) {
PurgeUserEventsRequest request =
PurgeUserEventsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setFilter(filter)
.setForce(force)
.build();
return purgeUserEventsAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes permanently all user events specified by the filter provided. Depending on the number
* of events specified by the filter, this operation could take hours or days to complete. To test
* a filter, use the list command first.
*
* @param parent Required. The resource name of the event_store under which the events are
* created. The format is
* "projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}"
* @param filter Required. The filter string to specify the events to be deleted. Empty string
* filter is not allowed. This filter can also be used with ListUserEvents API to list events
* that will be deleted. The eligible fields for filtering are:
* <ul>
* <li>eventType - UserEvent.eventType field of type string.
* <li>eventTime - in ISO 8601 "zulu" format.
* <li>visitorId - field of type string. Specifying this will delete all events associated
* with a visitor.
* <li>userId - field of type string. Specifying this will delete all events associated with
* a user. Example 1: Deleting all events in a time range. `eventTime >
* "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` Example 2:
* Deleting specific eventType in time range. `eventTime > "2012-04-23T18:25:43.511Z"
* eventType = "detail-page-view"` Example 3: Deleting all events for a specific visitor
* `visitorId = visitor1024` The filtering fields are assumed to have an implicit AND.
* </ul>
*
* @param force Optional. The default value is false. Override this flag to true to actually
* perform the purge. If the field is not set to true, a sampling of events to be deleted will
* be returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<PurgeUserEventsResponse, PurgeUserEventsMetadata>
purgeUserEventsAsync(String parent, String filter, boolean force) {
PurgeUserEventsRequest request =
PurgeUserEventsRequest.newBuilder()
.setParent(parent)
.setFilter(filter)
.setForce(force)
.build();
return purgeUserEventsAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes permanently all user events specified by the filter provided. Depending on the number
* of events specified by the filter, this operation could take hours or days to complete. To test
* a filter, use the list command first.
*
* @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 OperationFuture<PurgeUserEventsResponse, PurgeUserEventsMetadata>
purgeUserEventsAsync(PurgeUserEventsRequest request) {
return purgeUserEventsOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes permanently all user events specified by the filter provided. Depending on the number
* of events specified by the filter, this operation could take hours or days to complete. To test
* a filter, use the list command first.
*
* <p>Sample code:
*/
public final OperationCallable<
PurgeUserEventsRequest, PurgeUserEventsResponse, PurgeUserEventsMetadata>
purgeUserEventsOperationCallable() {
return stub.purgeUserEventsOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes permanently all user events specified by the filter provided. Depending on the number
* of events specified by the filter, this operation could take hours or days to complete. To test
* a filter, use the list command first.
*
* <p>Sample code:
*/
public final UnaryCallable<PurgeUserEventsRequest, Operation> purgeUserEventsCallable() {
return stub.purgeUserEventsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Bulk import of User events. Request processing might be synchronous. Events that already exist
* are skipped. Use this method for backfilling historical user events.
*
* <p>Operation.response is of type ImportResponse. Note that it is possible for a subset of the
* items to be successfully inserted. Operation.metadata is of type ImportMetadata.
*
* @param parent Required.
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"
* @param requestId Optional. Unique identifier provided by client, within the ancestor dataset
* scope. Ensures idempotency for expensive long running operations. Server-generated if
* unspecified. Up to 128 characters long. This is returned as
* google.longrunning.Operation.name in the response. Note that this field must not be set if
* the desired input config is catalog_inline_source.
* @param inputConfig Required. The desired input location of the data.
* @param errorsConfig Optional. The desired location of errors incurred during the Import.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<ImportUserEventsResponse, ImportMetadata> importUserEventsAsync(
EventStoreName parent,
String requestId,
InputConfig inputConfig,
ImportErrorsConfig errorsConfig) {
ImportUserEventsRequest request =
ImportUserEventsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setRequestId(requestId)
.setInputConfig(inputConfig)
.setErrorsConfig(errorsConfig)
.build();
return importUserEventsAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Bulk import of User events. Request processing might be synchronous. Events that already exist
* are skipped. Use this method for backfilling historical user events.
*
* <p>Operation.response is of type ImportResponse. Note that it is possible for a subset of the
* items to be successfully inserted. Operation.metadata is of type ImportMetadata.
*
* @param parent Required.
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"
* @param requestId Optional. Unique identifier provided by client, within the ancestor dataset
* scope. Ensures idempotency for expensive long running operations. Server-generated if
* unspecified. Up to 128 characters long. This is returned as
* google.longrunning.Operation.name in the response. Note that this field must not be set if
* the desired input config is catalog_inline_source.
* @param inputConfig Required. The desired input location of the data.
* @param errorsConfig Optional. The desired location of errors incurred during the Import.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<ImportUserEventsResponse, ImportMetadata> importUserEventsAsync(
String parent, String requestId, InputConfig inputConfig, ImportErrorsConfig errorsConfig) {
ImportUserEventsRequest request =
ImportUserEventsRequest.newBuilder()
.setParent(parent)
.setRequestId(requestId)
.setInputConfig(inputConfig)
.setErrorsConfig(errorsConfig)
.build();
return importUserEventsAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Bulk import of User events. Request processing might be synchronous. Events that already exist
* are skipped. Use this method for backfilling historical user events.
*
* <p>Operation.response is of type ImportResponse. Note that it is possible for a subset of the
* items to be successfully inserted. Operation.metadata is of type ImportMetadata.
*
* @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 OperationFuture<ImportUserEventsResponse, ImportMetadata> importUserEventsAsync(
ImportUserEventsRequest request) {
return importUserEventsOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Bulk import of User events. Request processing might be synchronous. Events that already exist
* are skipped. Use this method for backfilling historical user events.
*
* <p>Operation.response is of type ImportResponse. Note that it is possible for a subset of the
* items to be successfully inserted. Operation.metadata is of type ImportMetadata.
*
* <p>Sample code:
*/
public final OperationCallable<ImportUserEventsRequest, ImportUserEventsResponse, ImportMetadata>
importUserEventsOperationCallable() {
return stub.importUserEventsOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Bulk import of User events. Request processing might be synchronous. Events that already exist
* are skipped. Use this method for backfilling historical user events.
*
* <p>Operation.response is of type ImportResponse. Note that it is possible for a subset of the
* items to be successfully inserted. Operation.metadata is of type ImportMetadata.
*
* <p>Sample code:
*/
public final UnaryCallable<ImportUserEventsRequest, Operation> importUserEventsCallable() {
return stub.importUserEventsCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListUserEventsPagedResponse
extends AbstractPagedListResponse<
ListUserEventsRequest,
ListUserEventsResponse,
UserEvent,
ListUserEventsPage,
ListUserEventsFixedSizeCollection> {
public static ApiFuture<ListUserEventsPagedResponse> createAsync(
PageContext<ListUserEventsRequest, ListUserEventsResponse, UserEvent> context,
ApiFuture<ListUserEventsResponse> futureResponse) {
ApiFuture<ListUserEventsPage> futurePage =
ListUserEventsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
new ApiFunction<ListUserEventsPage, ListUserEventsPagedResponse>() {
@Override
public ListUserEventsPagedResponse apply(ListUserEventsPage input) {
return new ListUserEventsPagedResponse(input);
}
},
MoreExecutors.directExecutor());
}
private ListUserEventsPagedResponse(ListUserEventsPage page) {
super(page, ListUserEventsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListUserEventsPage
extends AbstractPage<
ListUserEventsRequest, ListUserEventsResponse, UserEvent, ListUserEventsPage> {
private ListUserEventsPage(
PageContext<ListUserEventsRequest, ListUserEventsResponse, UserEvent> context,
ListUserEventsResponse response) {
super(context, response);
}
private static ListUserEventsPage createEmptyPage() {
return new ListUserEventsPage(null, null);
}
@Override
protected ListUserEventsPage createPage(
PageContext<ListUserEventsRequest, ListUserEventsResponse, UserEvent> context,
ListUserEventsResponse response) {
return new ListUserEventsPage(context, response);
}
@Override
public ApiFuture<ListUserEventsPage> createPageAsync(
PageContext<ListUserEventsRequest, ListUserEventsResponse, UserEvent> context,
ApiFuture<ListUserEventsResponse> futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListUserEventsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListUserEventsRequest,
ListUserEventsResponse,
UserEvent,
ListUserEventsPage,
ListUserEventsFixedSizeCollection> {
private ListUserEventsFixedSizeCollection(List<ListUserEventsPage> pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListUserEventsFixedSizeCollection createEmptyCollection() {
return new ListUserEventsFixedSizeCollection(null, 0);
}
@Override
protected ListUserEventsFixedSizeCollection createCollection(
List<ListUserEventsPage> pages, int collectionSize) {
return new ListUserEventsFixedSizeCollection(pages, collectionSize);
}
}
}