package cassem.api.concept

Get desktop application:
View/edit binary Protocol Buffers messages

AgentInstance describes agent node instance attributes.

Used in: AgentInstanceChange

• string agentId = 1

  agentId is the unique identifier for agent.

• string addr = 2

• map<string, string> annotations = 3

  annotations contains the some custom label and value of AgentInstance.

• optional AgentInstance ins = 1

• ChangeOp op = 2

AppMetadata contains metadata of one app, includes specific identity, description, and other fields to display the app's status.

• string id = 1

• string description = 2

• int64 createdAt = 3

• string creator = 4

  creator of the app indicates the user who created the app.

• string owner = 5

  owner of the app indicates the user who actually own this app. of course, admin account owns all apps.

• AppMetadata.Status status = 6

• map<string, string> secrets = 7

  secrets is the key to acccecss the app's elements by different envs. If it's empty, that means the app is public.

Used in: AppMetadata

• INUSE = 0

• DEPRECATED = 1

  DEPRECATED represents the app is deprecated. It can only read but update.

Casbin represent the casbin model.

• repeated Casbin.Policy policies = 1

Used in: Casbin

• string Ptype = 1

• string V0 = 2

• string V1 = 3

• string V2 = 4

• string V3 = 5

• string V4 = 6

• string V5 = 7

Used in: AgentInstanceChange

• UNDEFINED = 0

• NEW = 1

• UPDATE = 2

• DELETE = 3

• CHANGE_TYPE_UNKNOWN = 0

• KV = 1

• DIR = 2

ContentType enumerates all built-in content types those Element's raw could be.

Used in: ElementMetadata

• UNKNOWN = 0

• JSON = 1

  application/json

• TOML = 2

  application/toml

• INI = 3

  application/ini

• PLAINTEXT = 4

  application/plaintext

Element represent a config element with specific version.

Used in: agent.dispatchReq, agent.getElementResp, agent.watchResp

• optional ElementMetadata metadata = 1

  refer ElementMetadata

• bytes raw = 2

  raw data in the version.

• int32 version = 3

  version number start since 1.

• bool published = 4

  indicates published or not.

ElementMetadata contains metadata of one element, includes specific key, app, env attributes, and other fields to display the element's version status.

Used in: Element

• string key = 1

• string app = 2

• string env = 3

• int32 latestVersion = 4

  the latest version in all versions of the element.

• int32 unpublishedVersion = 5

  if there is any unpublished version, if there's any unpublished version, the element can not create a new version util all versions have been published,

• int32 usingVersion = 6

  the in-use version.

• string usingFingerprint = 7

  the using version's fingerprint.

• ContentType contentType = 8

  indicates the content type of Element's raw data

ElementOperation is used to indicate the operation of one element.

• string operator = 1

  operator indicates the user who execute the operation.

• int64 operatedAt = 2

• string operatedKey = 3

• ElementOperation.Op op = 4

• int32 lastVersion = 5

• int32 currentVersion = 6

• string remark = 7

Used in: ElementOperation

• INVALID = 0

• SET = 1

• UNSET = 2

• PUBLISH = 3

Instance describes client instance.

• string clientId = 1

• string agentId = 2

• string clientIp = 3

• repeated Instance.Watching watching = 4

• int64 lastRenewTimestamp = 5

Used in: agent.registerReq, agent.watchReq, Instance

• string app = 1

• string env = 2

• repeated string watchKeys = 3

• string account = 1

  account

• string nickname = 2

• string hashedPassword = 3

• string salt = 4

• User.Status status = 5

Used in: User

• NORMAL = 0

• FORBIDDEN = 1

  FORBIDDEN indicates the user is forbidden to access the system.