GdaReduceRequest

Properties

columns: GdaColumnSpec[];

Optional column/cell specifications of the columns/cells to retrieve

function: Object;

Computation function. The function must accept two parameters : the current value and the current row. The return value is ignored : the current value must be updated instead.

initialValue: Map<string,Object>;

Initial value for the computation function. Example : {sum:0, mean:null}

owner: string;

Optional User key. When calling the API, defaults to the current (calling) user’s primary key. For impersonation purposes, the caller may use the key of another user, provided that the proper authorizations have been given by the impersonated user

page: Pagination;

Pagination information

requestId: string;

User field for traceability of requests. Synchronous SDK APIs use this field for you.

start: string;

Start row key (inclusive)

stop: string;

Stop row key (exclusive)

table: string;

Table name

Source

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
interface GdaReduceRequest {

  /**
   * Optional column/cell specifications of the columns/cells to retrieve
   */
  columns: GdaColumnSpec[];

  /**
   * Computation function. The function must accept two parameters : the current value and the current row. The return value is ignored : the current value must be updated instead.
   */
  function: Object;

  /**
   * Initial value for the computation function. Example : {sum:0, mean:null}
   */
  initialValue: Map<string,Object>;

  /**
   * Optional User key. When calling the API, defaults to the current (calling) user's primary key. For impersonation purposes, the caller may use the key of another user, provided that the proper authorizations have been given by the impersonated user
   */
  owner: string;

  /**
   * Pagination information
   */
  page: Pagination;

  /**
   * User field for traceability of requests. Synchronous SDK APIs use this field for you.
   */
  requestId: string;

  /**
   * Start row key (inclusive)
   */
  start: string;

  /**
   * Stop row key (exclusive)
   */
  stop: string;

  /**
   * Table name
   */
  table: string;

}