model

Documentation

Overview

Package model is a generated protocol buffer package.

It is generated from these files:

metrics.proto

It has these top-level messages:

ClientEventData
ClientEventUploadRequest
KeyValuePair
ErrorResponse
HeartBeat

Index

• Variables
• type ClientEventData
  • func (m *ClientEventData) GetData() string
  • func (m *ClientEventData) GetEventId() string
  • func (m *ClientEventData) GetEventType() ClientEventType
  • func (m *ClientEventData) GetKvPair() []*KeyValuePair
  • func (m *ClientEventData) GetTimestamp() int64
  • func (*ClientEventData) ProtoMessage()
  • func (m *ClientEventData) Reset()
  • func (m *ClientEventData) String() string
• type ClientEventType
  • func (x ClientEventType) Enum() *ClientEventType
  • func (x ClientEventType) String() string
  • func (x *ClientEventType) UnmarshalJSON(data []byte) error
• type ClientEventUploadRequest
  • func (m *ClientEventUploadRequest) GetDeviceType() string
  • func (m *ClientEventUploadRequest) GetEvents() []*ClientEventData
  • func (m *ClientEventUploadRequest) GetRequestId() string
  • func (*ClientEventUploadRequest) ProtoMessage()
  • func (m *ClientEventUploadRequest) Reset()
  • func (m *ClientEventUploadRequest) String() string
• type ErrorResponse
  • func (m *ErrorResponse) GetCode() string
  • func (m *ErrorResponse) GetDescription() string
  • func (m *ErrorResponse) GetErrorMessage() string
  • func (*ErrorResponse) ProtoMessage()
  • func (m *ErrorResponse) Reset()
  • func (m *ErrorResponse) String() string
• type HeartBeat
  • func (m *HeartBeat) GetStatus() string
  • func (m *HeartBeat) GetTimestamp() string
  • func (*HeartBeat) ProtoMessage()
  • func (m *HeartBeat) Reset()
  • func (m *HeartBeat) String() string
• type KeyValuePair
  • func (m *KeyValuePair) GetKey() string
  • func (m *KeyValuePair) GetValue() string
  • func (*KeyValuePair) ProtoMessage()
  • func (m *KeyValuePair) Reset()
  • func (m *KeyValuePair) String() string

Variables

var ClientEventType_name = map[int32]string{
	1: "UNKNOWN",
	2: "USER_REGISTERED",
}

var ClientEventType_value = map[string]int32{
	"UNKNOWN":         1,
	"USER_REGISTERED": 2,
}

Types

type ClientEventData

type ClientEventData struct {
	// Core event attributes:
	EventId   *string          `protobuf:"bytes,1,req,name=event_id" json:"event_id,omitempty"`
	EventType *ClientEventType `protobuf:"varint,2,req,name=event_type,enum=model.ClientEventType" json:"event_type,omitempty"`
	Timestamp *int64           `protobuf:"varint,3,req,name=timestamp" json:"timestamp,omitempty"`
	// arbitrary data
	Data *string `protobuf:"bytes,4,opt,name=data" json:"data,omitempty"`
	// allow arbitrary key-value pairs
	KvPair           []*KeyValuePair `protobuf:"bytes,5,rep,name=kv_pair" json:"kv_pair,omitempty"`
	XXX_unrecognized []byte          `json:"-"`
}

Representing a single event.

func (*ClientEventData) GetData

func (m *ClientEventData) GetData() string

func (*ClientEventData) GetEventId

func (m *ClientEventData) GetEventId() string

func (*ClientEventData) GetEventType

func (m *ClientEventData) GetEventType() ClientEventType

func (*ClientEventData) GetKvPair

func (m *ClientEventData) GetKvPair() []*KeyValuePair

func (*ClientEventData) GetTimestamp

func (m *ClientEventData) GetTimestamp() int64

func (*ClientEventData) ProtoMessage

func (*ClientEventData) ProtoMessage()

func (*ClientEventData) Reset

func (m *ClientEventData) Reset()

func (*ClientEventData) String

func (m *ClientEventData) String() string

type ClientEventType

type ClientEventType int32

The event type enum:

const (
	ClientEventType_UNKNOWN         ClientEventType = 1
	ClientEventType_USER_REGISTERED ClientEventType = 2
)

func (ClientEventType) Enum

func (x ClientEventType) Enum() *ClientEventType

func (ClientEventType) String

func (x ClientEventType) String() string

func (*ClientEventType) UnmarshalJSON

func (x *ClientEventType) UnmarshalJSON(data []byte) error

type ClientEventUploadRequest

type ClientEventUploadRequest struct {
	RequestId *string `protobuf:"bytes,1,req,name=request_id" json:"request_id,omitempty"`
	// The clients device type (Android, iPhone etc.)
	DeviceType *string `protobuf:"bytes,2,req,name=device_type" json:"device_type,omitempty"`
	// The events being uploaded
	Events           []*ClientEventData `protobuf:"bytes,3,rep,name=events" json:"events,omitempty"`
	XXX_unrecognized []byte             `json:"-"`
}

The message uploaded to the server - containing multiple events

func (*ClientEventUploadRequest) GetDeviceType

func (m *ClientEventUploadRequest) GetDeviceType() string

func (*ClientEventUploadRequest) GetEvents

func (m *ClientEventUploadRequest) GetEvents() []*ClientEventData

func (*ClientEventUploadRequest) GetRequestId

func (m *ClientEventUploadRequest) GetRequestId() string

func (*ClientEventUploadRequest) ProtoMessage

func (*ClientEventUploadRequest) ProtoMessage()

func (*ClientEventUploadRequest) Reset

func (m *ClientEventUploadRequest) Reset()

func (*ClientEventUploadRequest) String

func (m *ClientEventUploadRequest) String() string

type ErrorResponse

type ErrorResponse struct {
	Code             *string `protobuf:"bytes,1,req,name=code" json:"code,omitempty"`
	ErrorMessage     *string `protobuf:"bytes,2,opt,name=error_message" json:"error_message,omitempty"`
	Description      *string `protobuf:"bytes,3,opt,name=description" json:"description,omitempty"`
	XXX_unrecognized []byte  `json:"-"`
}

The message to send as the error response payload if something goes wrong

func (*ErrorResponse) GetCode

func (m *ErrorResponse) GetCode() string

func (*ErrorResponse) GetDescription

func (m *ErrorResponse) GetDescription() string

func (*ErrorResponse) GetErrorMessage

func (m *ErrorResponse) GetErrorMessage() string

func (*ErrorResponse) ProtoMessage

func (*ErrorResponse) ProtoMessage()

func (*ErrorResponse) Reset

func (m *ErrorResponse) Reset()

func (*ErrorResponse) String

func (m *ErrorResponse) String() string

type HeartBeat

type HeartBeat struct {
	Status           *string `protobuf:"bytes,1,req,name=status" json:"status,omitempty"`
	Timestamp        *string `protobuf:"bytes,2,req,name=timestamp" json:"timestamp,omitempty"`
	XXX_unrecognized []byte  `json:"-"`
}

The message to check if server is up and running

func (*HeartBeat) GetStatus

func (m *HeartBeat) GetStatus() string

func (*HeartBeat) GetTimestamp

func (m *HeartBeat) GetTimestamp() string

func (*HeartBeat) ProtoMessage

func (*HeartBeat) ProtoMessage()

func (*HeartBeat) Reset

func (m *HeartBeat) Reset()

func (*HeartBeat) String

func (m *HeartBeat) String() string

type KeyValuePair

type KeyValuePair struct {
	Key              *string `protobuf:"bytes,1,req,name=key" json:"key,omitempty"`
	Value            *string `protobuf:"bytes,2,req,name=value" json:"value,omitempty"`
	XXX_unrecognized []byte  `json:"-"`
}

The message for key value pairs

func (*KeyValuePair) GetKey

func (m *KeyValuePair) GetKey() string

func (*KeyValuePair) GetValue

func (m *KeyValuePair) GetValue() string

func (*KeyValuePair) ProtoMessage

func (*KeyValuePair) ProtoMessage()

func (*KeyValuePair) Reset

func (m *KeyValuePair) Reset()

func (*KeyValuePair) String

func (m *KeyValuePair) String() string