Skip to main content

BuildInfo Service Events 0.1.0 documentation

info

In this document, PUB means "publish" and SUB means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.

  • Specification ID: http://buildinfo-service
  • Protobuf File Spec: buildInfo.proto

Table of Contents

Operations

PUB block Operation

Accepts one of the following messages:

Message blockCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.blockobject---additional properties are allowed
payload.block.uuidstring----
payload.block.checksumstring----
payload.block.createdAtstring--format (date-time)-
payload.block.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"block": {
"uuid": "string",
"checksum": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message blockUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.blockobject---additional properties are allowed
payload.block.uuidstring----
payload.block.checksumstring----
payload.block.createdAtstring--format (date-time)-
payload.block.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"block": {
"uuid": "string",
"checksum": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message blockMissingBytesCommitted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.blockobject---additional properties are allowed
payload.block.uuidstring----
payload.block.checksumstring----
payload.block.createdAtstring--format (date-time)-
payload.block.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"block": {
"uuid": "string",
"checksum": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message blockUploadCommitted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.blockobject---additional properties are allowed
payload.block.uuidstring----
payload.block.checksumstring----
payload.block.createdAtstring--format (date-time)-
payload.block.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"block": {
"uuid": "string",
"checksum": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

PUB build Operation

Accepts one of the following messages:

Message buildCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.buildobject---additional properties are allowed
payload.build.idstring----
payload.build.appIdstring----
payload.build.namespacestring----
payload.build.gameAppIdstring----
payload.build.buildIdstring----
payload.build.versionstring----
payload.build.createdAtstring--format (date-time)-
payload.build.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"build": {
"id": "string",
"appId": "string",
"namespace": "string",
"gameAppId": "string",
"buildId": "string",
"version": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message buildUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.buildobject---additional properties are allowed
payload.build.idstring----
payload.build.appIdstring----
payload.build.namespacestring----
payload.build.gameAppIdstring----
payload.build.buildIdstring----
payload.build.versionstring----
payload.build.createdAtstring--format (date-time)-
payload.build.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"build": {
"id": "string",
"appId": "string",
"namespace": "string",
"gameAppId": "string",
"buildId": "string",
"version": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message buildCurrentStatusSet

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.buildobject---additional properties are allowed
payload.build.idstring----
payload.build.appIdstring----
payload.build.namespacestring----
payload.build.gameAppIdstring----
payload.build.buildIdstring----
payload.build.versionstring----
payload.build.createdAtstring--format (date-time)-
payload.build.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"build": {
"id": "string",
"appId": "string",
"namespace": "string",
"gameAppId": "string",
"buildId": "string",
"version": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message buildDeleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.buildobject---additional properties are allowed
payload.build.idstring----
payload.build.appIdstring----
payload.build.namespacestring----
payload.build.gameAppIdstring----
payload.build.buildIdstring----
payload.build.versionstring----
payload.build.createdAtstring--format (date-time)-
payload.build.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"build": {
"id": "string",
"appId": "string",
"namespace": "string",
"gameAppId": "string",
"buildId": "string",
"version": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

PUB diffStatus Operation

Accepts one of the following messages:

Message diffStatusCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.diffStatusobject---additional properties are allowed
payload.diffStatus.idstring----
payload.diffStatus.sourceBuildIdstring----
payload.diffStatus.destinationBuildIdstring----
payload.diffStatus.createdAtstring--format (date-time)-
payload.diffStatus.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"diffStatus": {
"id": "string",
"sourceBuildId": "string",
"destinationBuildId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message diffStatusUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.diffStatusobject---additional properties are allowed
payload.diffStatus.idstring----
payload.diffStatus.sourceBuildIdstring----
payload.diffStatus.destinationBuildIdstring----
payload.diffStatus.createdAtstring--format (date-time)-
payload.diffStatus.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"diffStatus": {
"id": "string",
"sourceBuildId": "string",
"destinationBuildId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message diffStatusCommitted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.diffStatusobject---additional properties are allowed
payload.diffStatus.idstring----
payload.diffStatus.sourceBuildIdstring----
payload.diffStatus.destinationBuildIdstring----
payload.diffStatus.createdAtstring--format (date-time)-
payload.diffStatus.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"diffStatus": {
"id": "string",
"sourceBuildId": "string",
"destinationBuildId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

PUB diffTrigger Operation

Accepts one of the following messages:

Message diffTriggerCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.diffTriggerobject---additional properties are allowed
payload.diffTrigger.idstring----
payload.diffTrigger.paramstring----
payload.diffTrigger.createdAtstring--format (date-time)-
payload.diffTrigger.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"diffTrigger": {
"id": "string",
"param": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message diffTriggerUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.diffTriggerobject---additional properties are allowed
payload.diffTrigger.idstring----
payload.diffTrigger.paramstring----
payload.diffTrigger.createdAtstring--format (date-time)-
payload.diffTrigger.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"diffTrigger": {
"id": "string",
"param": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message diffTriggerToggled

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.diffTriggerobject---additional properties are allowed
payload.diffTrigger.idstring----
payload.diffTrigger.paramstring----
payload.diffTrigger.createdAtstring--format (date-time)-
payload.diffTrigger.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"diffTrigger": {
"id": "string",
"param": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

PUB drmActivation Operation

Accepts one of the following messages:

Message drmActivationCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.drmActivationobject---additional properties are allowed
payload.drmActivation.drmActivationIdstring----
payload.drmActivation.machineIdstring----
payload.drmActivation.userIdstring----
payload.drmActivation.createdAtstring--format (date-time)-
payload.drmActivation.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"drmActivation": {
"drmActivationId": "string",
"machineId": "string",
"userId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message drmActivationUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.drmActivationobject---additional properties are allowed
payload.drmActivation.drmActivationIdstring----
payload.drmActivation.machineIdstring----
payload.drmActivation.userIdstring----
payload.drmActivation.createdAtstring--format (date-time)-
payload.drmActivation.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"drmActivation": {
"drmActivationId": "string",
"machineId": "string",
"userId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

PUB releaseNote Operation

Accepts one of the following messages:

Message releaseNoteCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.releaseNoteobject---additional properties are allowed
payload.releaseNote.releaseNoteIdstring----
payload.releaseNote.versionstring----
payload.releaseNote.createdAtstring--format (date-time)-
payload.releaseNote.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"releaseNote": {
"releaseNoteId": "string",
"version": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message releaseNoteUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.releaseNoteobject---additional properties are allowed
payload.releaseNote.releaseNoteIdstring----
payload.releaseNote.versionstring----
payload.releaseNote.createdAtstring--format (date-time)-
payload.releaseNote.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"releaseNote": {
"releaseNoteId": "string",
"version": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

PUB versionHistory Operation

Accepts one of the following messages:

Message versionHistoryCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.versionHistoryobject---additional properties are allowed
payload.versionHistory.versionHistoryIdstring----
payload.versionHistory.namespacestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"versionHistory": {
"versionHistoryId": "string",
"namespace": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message versionHistoryUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.versionHistoryobject---additional properties are allowed
payload.versionHistory.versionHistoryIdstring----
payload.versionHistory.namespacestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"versionHistory": {
"versionHistoryId": "string",
"namespace": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}