package distribution.channel.pb

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Exec (CreateMessage, CreateMessage)

  services.proto:20

  message CreateMessage

  services.proto:36

  • repeated Channel channels = 1

  • optional CreateOptions opts = 2

• rpc Exec (DeleteRequest, google.protobuf.Empty)

  services.proto:24

  message DeleteRequest

  services.proto:41

  • repeated uint32 keys = 1

• rpc Exec (RenameRequest, google.protobuf.Empty)

  services.proto:28

  message RenameRequest

  services.proto:45

  • repeated uint32 keys = 1

  • repeated string names = 2

Channel is an internal representation of a channel containing all storage and distribution metadata. This type is used internally by the server; clients should use APIChannel instead.

Used in: CreateMessage

• string name = 1

  name is the human-readable channel name.

• uint32 leaseholder = 2

  leaseholder is the cluster node that holds the lease for this channel and is authorized to accept writes.

• string data_type = 3

  data_type is the data type of samples stored in this channel.

• bool is_index = 4

  is_index is true if this channel is an index channel. Index channels must have int64 values (TIMESTAMP data type) written in ascending order, and are most commonly unix nanosecond timestamps.

• uint32 local_key = 5

  local_key is the locally-unique portion of this channel's key.

• uint32 local_index = 6

  local_index is the channel used to index this channel's values, associating each value with a timestamp.

• bool virtual = 7

  virtual is true if this channel does not persist data and is used only for streaming.

• x.control.pb.Concurrency concurrency = 8

  concurrency sets the policy for concurrent writes to the channel's data. Only virtual channels can have a policy of shared concurrency.

• bool internal = 9

  internal is true if this is a system channel hidden from normal user queries.

• repeated Operation operations = 10

  operations contains aggregation operations applied to this channel's data.

• string expression = 11

  expression is an Arc expression for calculated channels. If set, the channel is automatically configured as virtual.

Used in: CreateMessage

• bool retrieve_if_name_exists = 1

• bool overwrite_if_name_exists = 2

Operation defines an aggregation operation applied to channel data. Operations calculate min, max, or average values over a time duration or triggered by a reset channel.

Used in: api.channel.pb.Channel, Channel

• OperationType type = 1

  type is the aggregation operation type: min, max, avg, or none.

• uint32 reset_channel = 2

  reset_channel is the channel key that triggers reset of the aggregation. If 0, duration-based reset is used.

• int64 duration = 3

  duration is the time window for aggregation when reset_channel is 0.

OperationType is the type of aggregation operation to apply to channel data over time.

Used in: Operation

• OPERATION_TYPE_MIN = 0

• OPERATION_TYPE_MAX = 1

• OPERATION_TYPE_AVG = 2

• OPERATION_TYPE_NONE = 3

• OPERATION_TYPE_DERIVATIVE = 4