Skip to content

Commit bb04c67

Browse files
committed
docs: add code comments for filter object getters and setters
1 parent 7f76c1b commit bb04c67

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed

sdk/src/main/java/com/fingerprint/api/FingerprintApi.java

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -392,82 +392,136 @@ public static class SearchEventsFilter {
392392
private Boolean reverse;
393393
private Boolean suspect;
394394

395+
/**
396+
* getter for paginationKey - Use `pagination_key` to get the next page of results. When more results are available (e.g., you requested up to 200 results for your search using `limit`, but there are more than 200 events total matching your request), the `paginationKey` top-level attribute is added to the response. The key corresponds to the `timestamp` of the last returned event. In the following request, use that value in the `pagination_key` parameter to get the next page of results: 1. First request, returning most recent 200 events: `GET api-base-url/events/search?limit=200` 2. Use `response.paginationKey` to get the next page of results: `GET api-base-url/events/search?limit=200&pagination_key=1740815825085`
397+
**/
395398
public String getPaginationKey() {
396399
return paginationKey;
397400
}
398401

402+
/**
403+
* setter for paginationKey - Use `pagination_key` to get the next page of results. When more results are available (e.g., you requested up to 200 results for your search using `limit`, but there are more than 200 events total matching your request), the `paginationKey` top-level attribute is added to the response. The key corresponds to the `timestamp` of the last returned event. In the following request, use that value in the `pagination_key` parameter to get the next page of results: 1. First request, returning most recent 200 events: `GET api-base-url/events/search?limit=200` 2. Use `response.paginationKey` to get the next page of results: `GET api-base-url/events/search?limit=200&pagination_key=1740815825085`
404+
**/
399405
public SearchEventsFilter setPaginationKey(String paginationKey) {
400406
this.paginationKey = paginationKey;
401407
return this;
402408
}
403409

410+
/**
411+
* getter for visitorId - Unique [visitor identifier](https://dev.fingerprint.com/reference/get-function#visitorid) issued by Fingerprint Pro. Filter for events matching this `visitor_id`.
412+
**/
404413
public String getVisitorId() {
405414
return visitorId;
406415
}
407416

417+
/**
418+
* setter for visitorId - Unique [visitor identifier](https://dev.fingerprint.com/reference/get-function#visitorid) issued by Fingerprint Pro. Filter for events matching this `visitor_id`.
419+
**/
408420
public SearchEventsFilter setVisitorId(String visitorId) {
409421
this.visitorId = visitorId;
410422
return this;
411423
}
412424

425+
/**
426+
* getter for bot - Filter events by the bot detection result, specifically: `all` - events where any kind of bot was detected. `good` - events where a good bot was detected. `bad` - events where a bad bot was detected. `none` - events where no bot was detected.
427+
**/
413428
public String getBot() {
414429
return bot;
415430
}
416431

432+
/**
433+
* setter for bot - Filter events by the bot detection result, specifically: `all` - events where any kind of bot was detected. `good` - events where a good bot was detected. `bad` - events where a bad bot was detected. `none` - events where no bot was detected.
434+
**/
417435
public SearchEventsFilter setBot(String bot) {
418436
this.bot = bot;
419437
return this;
420438
}
421439

440+
/**
441+
* getter for ipAddress - Filter events by IP address range. The range can be as specific as a single IP (/32 for IPv4 or /128 for IPv6) All ip_address filters must use CIDR notation, for example, 10.0.0.0/24, 192.168.0.1/32
442+
**/
422443
public String getIpAddress() {
423444
return ipAddress;
424445
}
425446

447+
/**
448+
* setter for ipAddress - Filter events by IP address range. The range can be as specific as a single IP (/32 for IPv4 or /128 for IPv6) All ip_address filters must use CIDR notation, for example, 10.0.0.0/24, 192.168.0.1/32
449+
**/
426450
public SearchEventsFilter setIpAddress(String ipAddress) {
427451
this.ipAddress = ipAddress;
428452
return this;
429453
}
430454

455+
/**
456+
* getter for linkedId - Filter events by your custom identifier. You can use [linked IDs](https://dev.fingerprint.com/reference/get-function#linkedid) to associate identification requests with your own identifier, for example, session ID, purchase ID, or transaction ID. You can then use this `linked_id` parameter to retrieve all events associated with your custom identifier.
457+
**/
431458
public String getLinkedId() {
432459
return linkedId;
433460
}
434461

462+
/**
463+
* setter for linkedId - Filter events by your custom identifier. You can use [linked IDs](https://dev.fingerprint.com/reference/get-function#linkedid) to associate identification requests with your own identifier, for example, session ID, purchase ID, or transaction ID. You can then use this `linked_id` parameter to retrieve all events associated with your custom identifier.
464+
**/
435465
public SearchEventsFilter setLinkedId(String linkedId) {
436466
this.linkedId = linkedId;
437467
return this;
438468
}
439469

470+
/**
471+
* getter for start - Filter events with a timestamp greater than the start time, in Unix time (milliseconds).
472+
**/
440473
public Long getStart() {
441474
return start;
442475
}
443476

477+
/**
478+
* setter for start - Filter events with a timestamp greater than the start time, in Unix time (milliseconds).
479+
**/
444480
public SearchEventsFilter setStart(Long start) {
445481
this.start = start;
446482
return this;
447483
}
448484

485+
/**
486+
* getter for end - Filter events with a timestamp smaller than the end time, in Unix time (milliseconds).
487+
**/
449488
public Long getEnd() {
450489
return end;
451490
}
452491

492+
/**
493+
* setter for end - Filter events with a timestamp smaller than the end time, in Unix time (milliseconds).
494+
**/
453495
public SearchEventsFilter setEnd(Long end) {
454496
this.end = end;
455497
return this;
456498
}
457499

500+
/**
501+
* getter for reverse - Sort events in reverse timestamp order.
502+
**/
458503
public Boolean getReverse() {
459504
return reverse;
460505
}
461506

507+
/**
508+
* setter for reverse - Sort events in reverse timestamp order.
509+
**/
462510
public SearchEventsFilter setReverse(Boolean reverse) {
463511
this.reverse = reverse;
464512
return this;
465513
}
466514

515+
/**
516+
* getter for suspect - Filter events previously tagged as suspicious via the [Update API](https://dev.fingerprint.com/reference/updateevent). > Note: When using this parameter, only events with the `suspect` property explicitly set to `true` or `false` are returned. Events with undefined `suspect` property are left out of the response.
517+
**/
467518
public Boolean getSuspect() {
468519
return suspect;
469520
}
470521

522+
/**
523+
* setter for suspect - Filter events previously tagged as suspicious via the [Update API](https://dev.fingerprint.com/reference/updateevent). > Note: When using this parameter, only events with the `suspect` property explicitly set to `true` or `false` are returned. Events with undefined `suspect` property are left out of the response.
524+
**/
471525
public SearchEventsFilter setSuspect(Boolean suspect) {
472526
this.suspect = suspect;
473527
return this;

template/libraries/jersey3/api.mustache

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,16 @@ public class {{classname}} {
6969

7070
{{#allParams}}
7171
{{^required}}
72+
/**
73+
* getter for {{paramName}} - {{{description}}}
74+
**/
7275
public {{{dataType}}} get{{#lambda.titlecase}}{{paramName}}{{/lambda.titlecase}}() {
7376
return {{paramName}};
7477
}
7578

79+
/**
80+
* setter for {{paramName}} - {{{description}}}
81+
**/
7682
public {{operationIdCamelCase}}Filter set{{#lambda.titlecase}}{{paramName}}{{/lambda.titlecase}}({{{dataType}}} {{paramName}}) {
7783
this.{{paramName}} = {{paramName}};
7884
return this;

0 commit comments

Comments
 (0)