nominal-api 0.1207.0

API bindings for the Nominal platform
Documentation 
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

syntax = "proto3";

// TODO(jnewman): move these to the right directory when we fix the python package generation
// buf:lint:ignore PACKAGE_VERSION_SUFFIX
// buf:lint:ignore PACKAGE_DIRECTORY_MATCH
package io.nominal.scout.api.proto;

import "google/protobuf/timestamp.proto";

option java_multiple_files = true;
option java_package = "io.nominal.scout.api.proto";

message WriteRequestNominal {
  repeated Series series = 1;
  // Optional client-provided session name identifier for tracing the origin of a write request.
  optional string session_name = 2;
}

message Series {
  Channel channel = 1;

  map<string, string> tags = 2;

  Points points = 3;
}

message Channel {
  string name = 1;
}

message Points {
  oneof points_type {
    DoublePoints double_points = 1;
    StringPoints string_points = 2;
    IntegerPoints integer_points = 3;
    ArrayPoints array_points = 4;
    StructPoints struct_points = 5;
    Uint64Points uint64_points = 6;
  }
}

message DoublePoints {
  repeated DoublePoint points = 1;
}

message StringPoints {
  repeated StringPoint points = 1;
}

message IntegerPoints {
  repeated IntegerPoint points = 1;
}

message Uint64Points {
  repeated Uint64Point points = 1;
}

message StructPoints {
  repeated StructPoint points = 1;
}

message DoublePoint {
  google.protobuf.Timestamp timestamp = 1;
  double value = 2;
}

message StringPoint {
  google.protobuf.Timestamp timestamp = 1;
  string value = 2;
}

message IntegerPoint {
  google.protobuf.Timestamp timestamp = 1;
  int64 value = 2;
}

message Uint64Point {
  google.protobuf.Timestamp timestamp = 1;
  uint64 value = 2;
}

message StructPoint {
  google.protobuf.Timestamp timestamp = 1;
  string json_string = 2;
}

message ArrayPoints {
  oneof array_type {
    DoubleArrayPoints double_array_points = 1;
    StringArrayPoints string_array_points = 2;
  }
}

message DoubleArrayPoints {
  repeated DoubleArrayPoint points = 1;
}

message StringArrayPoints {
  repeated StringArrayPoint points = 1;
}

message DoubleArrayPoint {
  google.protobuf.Timestamp timestamp = 1;
  repeated double value = 2;
}

message StringArrayPoint {
  google.protobuf.Timestamp timestamp = 1;
  repeated string value = 2;
}