package model

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Event.RecordSearchParams, stub.SearchRecordRequest

• repeated AggregationItem items = 1

• repeated GroupingItem grouping = 2

Used in: Aggregation

• string name = 1

• AggregationItem.Algorithm algorithm = 2

• string property = 3

Used in: AggregationItem

• COUNT = 0

• SUM = 1

• AVG = 2

• MAX = 3

• MIN = 4

• string name = 1

• string value = 2

• string host = 1

• int32 port = 2

• string jwtPrivateKey = 3

• string jwtPublicKey = 4

• bool disableAuthentication = 5

• bool disableCache = 6

• string pluginsPath = 7

• optional MetricsConfig metrics = 8

• optional StatsConfig stats = 9

• optional Limitations limitations = 10

• string serviceId = 11

• optional Record systemDataSource = 12

• repeated Resource initResources = 13

• repeated InitRecord initRecords = 14

• repeated string applyPaths = 15

• optional EventChannelConfig eventChannelConfig = 16

• optional LoggingConfig loggingConfig = 17

• bool enablePprof = 18

• map<string, ModuleConfig> modules = 19

Used in: Resource, SecurityContext

• optional google.protobuf.Timestamp created_on = 1

• optional google.protobuf.Timestamp updated_on = 2

• string created_by = 3

• string updated_by = 4

Used in: ResourceProperty

• string property = 3

• optional BatchHeader header = 1

• repeated Resource resources = 2

• repeated BatchRecordsPart batchRecords = 3

Used in: Batch

• BatchHeader.BatchMode mode = 1

• map<string, string> annotations = 103

Used in: BatchHeader

• CREATE = 0

• UPDATE = 1

• DELETE = 2

Used in: Batch

• string namespace = 1

• string resource = 2

• repeated google.protobuf.Value values = 3

Used in: CompoundBooleanExpression, Event.RecordSearchParams, EventSelector, stub.ReadStreamRequest, stub.SearchRecordRequest, stub.UpdateMultiRecordRequest

• oneof expression

  • CompoundBooleanExpression and = 1

    logical expressions

  • CompoundBooleanExpression or = 2

  • BooleanExpression not = 3

  • PairExpression equal = 4

    basic comparison

  • PairExpression lessThan = 5

  • PairExpression greaterThan = 6

  • PairExpression lessThanOrEqual = 7

  • PairExpression greaterThanOrEqual = 8

  • PairExpression in = 9

  • Expression isNull = 10

  • PairExpression like = 13

  • PairExpression ilike = 14

  • PairExpression regex = 11

• map<string, google.protobuf.Value> filters = 12

Used in: BooleanExpression

• repeated BooleanExpression expressions = 1

Used in: stub.ListEntitiesResponse

• string name = 1

• repeated DataSourceEntity entities = 2

Used in: DataSourceCatalog

• string name = 1

• bool readOnly = 2

Used in: Event

• ErrorCode code = 1

• string message = 2

• repeated ErrorField fields = 3

Used in: Error

• UNKNOWN_ERROR = 0

• RECORD_NOT_FOUND = 1

• UNABLE_TO_LOCATE_PRIMARY_KEY = 2

• INTERNAL_ERROR = 3

• PROPERTY_NOT_FOUND = 4

• RECORD_VALIDATION_ERROR = 5

• RESOURCE_VALIDATION_ERROR = 13

• AUTHENTICATION_FAILED = 6

• ALREADY_EXISTS = 7

• ACCESS_DENIED = 8

• BACKEND_ERROR = 9

• UNIQUE_VIOLATION = 10

• REFERENCE_VIOLATION = 11

• RESOURCE_NOT_FOUND = 12

• UNSUPPORTED_OPERATION = 14

• EXTERNAL_BACKEND_COMMUNICATION_ERROR = 15

• EXTERNAL_BACKEND_ERROR = 16

• RATE_LIMIT_ERROR = 17

Used in: Error

• string recordId = 1

• string property = 2

• string message = 3

• optional google.protobuf.Value value = 4

Used as response type in: stub.EventChannel.Poll, stub.Watch.Watch

Used as field type in: ext.FunctionCallRequest, ext.FunctionCallResponse, stub.EventWriteRequest, stub.EventWriteResponse

• string id = 1

• Event.Action action = 2

• optional Resource resource = 5

• repeated Record records = 6

  CREATE,UPDATE - records are for incoming and outgoing records GET - there will be only one record LIST - result of the list operation

• optional Event.RecordSearchParams recordSearchParams = 8

  LIST - search params for the list operation

• bool finalizes = 9

  If true, this will be last event on operation list

• bool sync = 10

  If true, backend will wait for processing this event before sending next one on operation list

• optional google.protobuf.Timestamp time = 11

• uint64 total = 12

• bool shallow = 13

• map<string, string> annotations = 103

  Request annotations

• optional Error error = 104

Used in: Event, EventSelector

• CREATE = 0

• UPDATE = 1

• DELETE = 2

• GET = 3

• LIST = 4

• OPERATE = 5

  for special cases

Used in: Event

• optional BooleanExpression query = 4

• uint32 limit = 5

• uint64 offset = 6

• repeated string resolveReferences = 8

• optional Aggregation aggregation = 9

• optional Sorting sorting = 10

Used in: AppConfig

• int32 maxChannelSize = 1

• int32 maxWaitTimeMs = 2

Events pass through selectors, if selector returns true, event will be processed Selector returns true if no selector fails. For example, if you passed empty selector, it will return true for all events.

Used in: stub.WatchRequest

• repeated Event.Action actions = 1

• optional BooleanExpression recordSelector = 2

• repeated string namespaces = 3

• repeated string resources = 4

• bool shallow = 5

• repeated string ids = 7

  star means all

• map<string, string> annotations = 103

  star means all, empty means proceed

Used in: BooleanExpression, PairExpression

• oneof expression

  • string property = 1

  • google.protobuf.Value value = 3

• optional FunctionCall functionCall = 1

• optional HttpCall httpCall = 2

• map<string, google.protobuf.Value> filters = 1

Used in: ExternalCall

• string host = 1

• string functionName = 2

Used in: Aggregation

• string property = 1

Used in: ExternalCall

• string uri = 1

• string method = 2

Used in: MetricsConfig

• string hostUrl = 1

• string token = 2

• string bucket = 3

• string organization = 4

Used in: AppConfig

• string namespace = 1

• string resource = 2

• bool override = 3

• optional Record record = 4

Used in: AppConfig

• bool enabled = 1

• int32 maxRecordCount = 2

• int32 maxResourceCount = 3

• int32 maxNamespaceCount = 4

• int32 requestPerMinute = 5

• int32 requestPerHour = 6

• int32 requestPerDay = 7

• int32 requestPerMonth = 8

• int32 requestPerYear = 9

Used in: LoggingConfig

• TEXT = 0

• JSON = 1

Used in: LoggingConfig

• PANIC = 0

• FATAL = 1

• ERROR = 2

• WARN = 3

• INFO = 4

• DEBUG = 5

• TRACE = 6

Used in: AppConfig

• LogLevel level = 1

• LogFormat format = 2

• bool reportCaller = 3

• map<string, google.protobuf.Any> content = 2

Used in: AppConfig

• bool enabled = 1

• optional int32 interval = 2

  defaults to 10 seconds

• optional int32 retention = 3

  defaults to 1 day

• optional InfluxDBConfig influxdb = 4

Used in: AppConfig

• bool disabled = 1

• map<string, string> options = 2

Used in: ResourceIndexProperty

• ORDER_UNKNOWN = 0

• ORDER_ASC = 1

• ORDER_DESC = 2

Used in: BooleanExpression

• optional Expression left = 1

• optional Expression right = 2

Used as request type in: stub.Record.WriteStream

Used as response type in: stub.Record.ReadStream

Used as field type in: AppConfig, Event, InitRecord, stub.ApplyRecordRequest, stub.ApplyRecordResponse, stub.CreateRecordRequest, stub.CreateRecordResponse, stub.GetRecordResponse, stub.ListRecordResponse, stub.LoadRecordResponse, stub.SearchRecordResponse, stub.UpdateMultiRecordResponse, stub.UpdateRecordRequest, stub.UpdateRecordResponse

• map<string, google.protobuf.Value> properties = 4

• repeated google.protobuf.Value propertiesPacked = 5

Used in: StatsConfig

• string prefix = 1

• string addr = 2

• string password = 3

• int32 db = 4

Used in: ResourceProperty

• string namespace = 1

  referenced resource namespace

• string resource = 2

  referenced resource name

Used in: AppConfig, Batch, Event, ResourceMigrationPlan, stub.CreateResourceRequest, stub.CreateResourceResponse, stub.GetResourceByNameResponse, stub.GetResourceResponse, stub.GetSystemResourceResponse, stub.ListResourceResponse, stub.PrepareResourceFromEntityResponse, stub.PrepareResourceMigrationPlanRequest, stub.UpdateResourceRequest, stub.UpdateResourceResponse

• string id = 1

  unique resource id; read only

• string name = 2

  unique resource name, it is unique per namespace

• string namespace = 3

  each resource is kept inside a namespace. One namespace can have multiple resources

• optional ResourceSourceConfig sourceConfig = 5

• repeated ResourceProperty properties = 6

  list of properties of resource. This properties will be used by records of resource. Properties is columns on sql databases. For schemaless data structures properties is only managed by API Brew itself

• repeated ResourceSubType types = 7

• repeated ResourceIndex indexes = 8

  list of resource indexes. Its implementation is depending on data source backend and may not be supported by some backends.

• bool virtual = 11

  If virtual is true. Operations will not phisically affect datasource/backend. Virtual resources is for extension purposes. Their behaviors can be extended and altered. It can also be used to integrate 3rd party systems.

• bool immutable = 12

  if true, delete and update will not be allowed on this resource

• bool abstract = 13

  if abstract, resource is only available to internal and extension side operations

• bool checkReferences = 16

• optional string title = 14

• optional string description = 15

• optional AuditData auditData = 101

• uint32 version = 102

• map<string, string> annotations = 103

Used in: Resource

• repeated ResourceIndexProperty properties = 1

  list of properties inside single index. Normally you will need only single property. Multi property will be needed for multi property indexes(for complex indexes)

• ResourceIndexType indexType = 2

  Index type(BTREE, HASH)

• bool unique = 3

  if true index will be unique index

• map<string, string> annotations = 103

Used in: ResourceIndex

• string name = 1

• Order order = 2

Used in: ResourceIndex

• BTREE = 0

• HASH = 1

Used in: ResourceMigrationStep

• uint32 index = 1

Used in: ResourceMigrationStep

• string property = 1

• string subType = 2

Used in: ResourceMigrationStep

(message has no fields)

Used in: ResourceMigrationStep

• string name = 1

Used in: ResourceMigrationStep

• uint32 existingIndex = 1

Used in: ResourceMigrationStep

• string existingProperty = 1

• string subType = 2

Used in: ResourceMigrationStep

(message has no fields)

Used in: ResourceMigrationStep

• string name = 1

Used in: stub.PrepareResourceMigrationPlanResponse

• optional Resource existingResource = 1

• optional Resource currentResource = 2

• repeated ResourceMigrationStep steps = 3

Used in: ResourceMigrationPlan

• oneof kind

  • ResourceMigrationCreateResource createResource = 1

  • ResourceMigrationDeleteResource deleteResource = 2

  • ResourceMigrationUpdateResource updateResource = 3

  • ResourceMigrationCreateProperty createProperty = 4

  • ResourceMigrationDeleteProperty deleteProperty = 5

  • ResourceMigrationUpdateProperty updateProperty = 6

  • ResourceMigrationCreateIndex createIndex = 7

  • ResourceMigrationDeleteIndex deleteIndex = 8

  • ResourceMigrationCreateSubType createSubType = 9

  • ResourceMigrationDeleteSubType deleteSubType = 10

Used in: ResourceMigrationStep

• string existingProperty = 1

• string property = 2

• string subType = 4

Used in: ResourceMigrationStep

• repeated string changedFields = 1

Resource properties is used to describe its schema. Each resource property is corresponding to a field in a record API Brew is responsible to validate data according to property types. For example, when you call create record and if you send 123.45 for int64

Used in: Resource, ResourceSubType

• string name = 2

  property name

• ResourceProperty.Type type = 3

  type of property

• optional string typeRef = 17

  type ref

  type ref, is only applicable to Struct

• bool required = 5

  this is to mark property as required

• bool primary = 6

• uint32 length = 7

  length property is only valid and required for String typed properties

• bool unique = 8

• bool immutable = 9

  immutable is to mark property as immutable. If marked, updates on this field on records will be discarded

• bool virtual = 10

  virtual is to mark property as virtual. Virtual properties are not stored on backend. They are calculated on the fly

• optional google.protobuf.Value defaultValue = 11

  defaultValue is default value.

• optional google.protobuf.Value exampleValue = 12

  exampleValue is example value. It is an informative column

• repeated string enumValues = 13

  enumValues is used if property type is an enum

• optional Reference reference = 14

  reference property is only valid and required for Reference types.

• optional BackReference backReference = 15

  reference property is only valid and required for Reference types.

• optional ResourceProperty item = 18

  item is used for complex types(list, map). For list, subType is element type. For map, it is value type(key type is always string)

• optional string title = 19

  It is an informative column

• optional string description = 20

  It is an informative column

• map<string, string> annotations = 103

Used in: ResourceProperty

• BOOL = 0

• STRING = 1

• FLOAT32 = 2

• FLOAT64 = 3

• INT32 = 4

• INT64 = 5

• BYTES = 6

• UUID = 8

• DATE = 9

• TIME = 10

• TIMESTAMP = 11

• OBJECT = 12

• MAP = 13

• LIST = 14

• REFERENCE = 15

• ENUM = 16

• STRUCT = 17

source config is to configure resource and bind it to data-source and an entity inside data source. An entity is like a table on sql databases or collection on mongodb etc.

Used in: Resource

• string dataSource = 1

  data source name: where resource structure and its data will be physically exists. Data source name is required if resource is not virtual

• string catalog = 2

  catalog is like a folder/schema/database. It is changing from backend to backend. Basically it is for grouping entities

• string entity = 3

  entity name an item on datasource backend where resource will be bound. For sql databases it is table name, for mongo it is collection name, etc.

Used in: Resource

• string name = 1

• string title = 2

• string description = 3

• repeated ResourceProperty properties = 6

  list of properties of resource. This properties will be used by records of resource. Properties is columns on sql databases. For schemaless data structures properties is only managed by API Brew itself

• map<string, string> annotations = 103

• string id = 1

• string name = 2

• optional google.protobuf.Struct details = 7

• optional AuditData auditData = 101

• uint32 version = 102

Used in: Sorting

• string property = 1

• SortItem.Direction direction = 2

Used in: SortItem

• ASC = 0

• DESC = 1

Used in: Event.RecordSearchParams, stub.SearchRecordRequest

• repeated SortItem items = 1

Used in: AppConfig

• bool enabled = 1

• optional RedisConfig redis = 2

Used in: stub.AuthenticationResponse, stub.RenewTokenResponse

• TokenTerm term = 1

  issue term

• string content = 2

  jwt token

• optional google.protobuf.Timestamp expiration = 3

  expiration time

Used in: Token, stub.AuthenticationRequest, stub.RenewTokenRequest

• VERY_SHORT = 0

  1 minute

• SHORT = 1

  20 minutes

• MIDDLE = 2

  2 days

• LONG = 3

  60 days

• VERY_LONG = 4

  2 years