encoder

type CreateStreamRequest struct {
	// The token that uniquely identifies the device. This is a required field.
	DeviceToken string `protobuf:"bytes,1,opt,name=device_token,json=deviceToken,proto3" json:"device_token,omitempty"`
	// A name chosen by the user that they have assigned to their device
	DeviceLabel string `protobuf:"bytes,9,opt,name=device_label,json=deviceLabel,proto3" json:"device_label,omitempty"`
	// A unique identifier for the specific community represented by the policy
	// being applied.
	CommunityId string `protobuf:"bytes,8,opt,name=community_id,json=communityId,proto3" json:"community_id,omitempty"`
	// The public key of the recipient, again this is used in order to encrypt
	// outgoing data, as well as being used to signify to the datastore the bucket
	// in which data should be stored. This is a required field.
	RecipientPublicKey string `protobuf:"bytes,3,opt,name=recipient_public_key,json=recipientPublicKey,proto3" json:"recipient_public_key,omitempty"`
	// The location of the device to be claimed.
	Location *CreateStreamRequest_Location `protobuf:"bytes,5,opt,name=location,proto3" json:"location,omitempty"`
	// The specific exposure of the device, i.e. is this instance indoors or
	// outdoors.
	Exposure CreateStreamRequest_Exposure `protobuf:"varint,6,opt,name=exposure,proto3,enum=decode.iot.encoder.CreateStreamRequest_Exposure" json:"exposure,omitempty"`
	// The entitlements field holds a repeated list of Operations which each
	// define a transformational function for a specific sensor id. If no
	// operations are submitted, we currently create a stream that writes
	// through all received channels without applying any processing
	// transformations to the data, but if this field contains any elements, the
	// resulting stream will only contain the specified sensor type.
	Operations           []*CreateStreamRequest_Operation `protobuf:"bytes,7,rep,name=operations,proto3" json:"operations,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                         `json:"-"`
	XXX_unrecognized     []byte                           `json:"-"`
	XXX_sizecache        int32                            `json:"-"`
}

type CreateStreamRequest_Exposure int32

type CreateStreamRequest_Location struct {
	// The longitude expressed as a decimal.
	Longitude float64 `protobuf:"fixed64,1,opt,name=longitude,proto3" json:"longitude,omitempty"`
	// The latitude expressed as a decimal.
	Latitude             float64  `protobuf:"fixed64,2,opt,name=latitude,proto3" json:"latitude,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type CreateStreamRequest_Operation struct {
	// The unique id of the sensor type for which this specific configuration is
	// defined. This is a required field.
	SensorId uint32 `protobuf:"varint,1,opt,name=sensor_id,json=sensorId,proto3" json:"sensor_id,omitempty"`
	// The specific action this entitlement defines for the sensor type. This is
	// a required field.
	Action CreateStreamRequest_Operation_Action `` /* 127-byte string literal not displayed */
	// The bins attribute is used to specify the the bins into which incoming
	// values should be classified. Each element in the list is the upper
	// inclusive bound of a bin. The values submitted must be sorted in strictly
	// increasing order. There is no need to add a highest bin with +Inf bound,
	// it will be added implicitly. This field is optional unless an Action of
	// `BIN` has been requested, in which case it is required. It is an error to
	// send values for this attribute unless the value of Action is `BIN`.
	Bins []float64 `protobuf:"fixed64,3,rep,packed,name=bins,proto3" json:"bins,omitempty"`
	// This attribute is used to control the entitlement in the case for which
	// we have specified an action type representing a moving average. It
	// represents the interval in seconds over which the moving average should
	// be calculated, e.g. for a 15 minute moving average the value supplied
	// here would be 900. This field is optional unless an Action of
	// `MOVING_AVG` has been specified, in which case it is required. It is an
	// error to send a value for this attribute unless the value of Action is
	// `MOVING_AVG`.
	Interval             uint32   `protobuf:"varint,4,opt,name=interval,proto3" json:"interval,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type CreateStreamRequest_Operation_Action int32

type CreateStreamResponse struct {
	// An identifier for the stream which can be used in order to delete a stream
	// when required.
	StreamUid string `protobuf:"bytes,1,opt,name=stream_uid,json=streamUid,proto3" json:"stream_uid,omitempty"`
	// A secret token passed back to the caller which it must keep secret, in
	// order to be permitted to delete the stream.
	Token                string   `protobuf:"bytes,2,opt,name=token,proto3" json:"token,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type DeleteStreamRequest struct {
	// The identifier for the stream to be deleted. This is a required field.
	StreamUid string `protobuf:"bytes,1,opt,name=stream_uid,json=streamUid,proto3" json:"stream_uid,omitempty"`
	// The secret token that was returned to the caller when creating the stream.
	// This is a required field, and must match the value stored internally for
	// the stream.
	Token                string   `protobuf:"bytes,2,opt,name=token,proto3" json:"token,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type DeleteStreamResponse struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type Encoder interface {
	// CreateStream sets up a new encoded stream for the encoder. Here we
	// subscribe to the specified MQTT topic, save the encryption keys, and start
	// listening for events. On receiving incoming messages via the MQTT broker,
	// we encrypt the contents using Zenroom and then write the encrypted data to
	// the configured datastore.
	CreateStream(context.Context, *CreateStreamRequest) (*CreateStreamResponse, error)

	// DeleteStream is called to remove the configuration for an encoded data
	// stream. This means deleting the MQTT subscription and removing all saved
	// credentials.
	DeleteStream(context.Context, *DeleteStreamRequest) (*DeleteStreamResponse, error)
}

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type TwirpServer interface {
	http.Handler
	// ServiceDescriptor returns gzipped bytes describing the .proto file that
	// this service was generated from. Once unzipped, the bytes can be
	// unmarshalled as a
	// github.com/golang/protobuf/protoc-gen-go/descriptor.FileDescriptorProto.
	//
	// The returned integer is the index of this particular service within that
	// FileDescriptorProto's 'Service' slice of ServiceDescriptorProtos. This is a
	// low-level field, expected to be used for reflection.
	ServiceDescriptor() ([]byte, int)
	// ProtocGenTwirpVersion is the semantic version string of the version of
	// twirp used to generate this file.
	ProtocGenTwirpVersion() string
}