Skip to main content

Cloud Storage 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.

Table of Contents

Operations

PUB namespaceSlotConfig Operation

Accepts one of the following messages:

Message namespaceSlotConfigCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespaceSlotConfigobject---additional properties are allowed
payload.namespaceSlotConfig.maxSlotSizeinteger----
payload.namespaceSlotConfig.maxSlotsinteger----
payload.namespaceSlotConfig.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": {
"namespaceSlotConfig": {
"maxSlotSize": 0,
"maxSlots": 0,
"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 namespaceSlotConfigDeleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespaceSlotConfigobject---additional properties are allowed
payload.namespaceSlotConfig.maxSlotSizeinteger----
payload.namespaceSlotConfig.maxSlotsinteger----
payload.namespaceSlotConfig.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": {
"namespaceSlotConfig": {
"maxSlotSize": 0,
"maxSlots": 0,
"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 namespaceSlotConfigUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespaceSlotConfigobject---additional properties are allowed
payload.namespaceSlotConfig.maxSlotSizeinteger----
payload.namespaceSlotConfig.maxSlotsinteger----
payload.namespaceSlotConfig.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": {
"namespaceSlotConfig": {
"maxSlotSize": 0,
"maxSlots": 0,
"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"
}

PUB slot Operation

Accepts one of the following messages:

Message slotCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.slotobject---additional properties are allowed
payload.slot.checksumstring----
payload.slot.customAttributestring----
payload.slot.dateAccessedstring--format (date-time)-
payload.slot.dateCreatedstring--format (date-time)-
payload.slot.date-modifiedstring--format (date-time)-
payload.slot.labelstring----
payload.slot.mimeTypestring----
payload.slot.namespacestring----
payload.slot.originalNamestring----
payload.slot.slotIdstring----
payload.slot.statusstring----
payload.slot.storedNamestring----
payload.slot.tagsarray<string>----
payload.slot.tags (single item)string----
payload.slot.userIdstring----
payload.slot.slotInfoobject---additional properties are allowed
payload.slot.slotInfo.descriptionstring----
payload.slot.slotInfo.fileobject---additional properties are allowed
payload.slot.slotInfo.file.absoluteboolean----
payload.slot.slotInfo.file.absoluteFileobject---additional properties are allowed
payload.slot.slotInfo.file.absolutePathstring----
payload.slot.slotInfo.file.canonicalFileobject---additional properties are allowed
payload.slot.slotInfo.file.canonicalPathstring----
payload.slot.slotInfo.file.directoryboolean----
payload.slot.slotInfo.file.fileboolean----
payload.slot.slotInfo.file.freeSpaceinteger----
payload.slot.slotInfo.file.hiddenboolean----
payload.slot.slotInfo.file.namestring----
payload.slot.slotInfo.file.parentstring----
payload.slot.slotInfo.file.parentFileobject---additional properties are allowed
payload.slot.slotInfo.file.pathstring----
payload.slot.slotInfo.file.totalSpaceinteger----
payload.slot.slotInfo.file.usableSpaceinteger----
payload.slot.slotInfo.filenamestring----
payload.slot.slotInfo.inputStreamobject---additional properties are allowed
payload.slot.slotInfo.openboolean----
payload.slot.slotInfo.readableboolean----
payload.slot.slotInfo.uriobject---additional properties are allowed
payload.slot.slotInfo.uri.absoluteboolean----
payload.slot.slotInfo.uri.authoritystring----
payload.slot.slotInfo.uri.fragmentstring----
payload.slot.slotInfo.uri.hoststring----
payload.slot.slotInfo.uri.opaqueboolean----
payload.slot.slotInfo.uri.pathstring----
payload.slot.slotInfo.uri.portinteger----
payload.slot.slotInfo.uri.querystring----
payload.slot.slotInfo.uri.rawAuthoritystring----
payload.slot.slotInfo.uri.rawFragmentstring----
payload.slot.slotInfo.uri.rawPathstring----
payload.slot.slotInfo.uri.rawQuerystring----
payload.slot.slotInfo.uri.rawSchemeSpecificPartstring----
payload.slot.slotInfo.uri.rawUserInfostring----
payload.slot.slotInfo.uri.schemestring----
payload.slot.slotInfo.uri.schemeSpecificPartstring----
payload.slot.slotInfo.uri.userInfostring----
payload.slot.slotInfo.urlobject---additional properties are allowed
payload.slot.slotInfo.url.authoritystring----
payload.slot.slotInfo.url.contentobject---additional properties are allowed
payload.slot.slotInfo.url.defaultPortinteger----
payload.slot.slotInfo.url.filestring----
payload.slot.slotInfo.url.hoststring----
payload.slot.slotInfo.url.pathstring----
payload.slot.slotInfo.url.portinteger----
payload.slot.slotInfo.url.protocolstring----
payload.slot.slotInfo.url.querystring----
payload.slot.slotInfo.url.refstring----
payload.slot.slotInfo.url.userInfostring----
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": {
"slot": {
"checksum": "string",
"customAttribute": "string",
"dateAccessed": "2019-08-24T14:15:22Z",
"dateCreated": "2019-08-24T14:15:22Z",
"date-modified": "2019-08-24T14:15:22Z",
"label": "string",
"mimeType": "string",
"namespace": "string",
"originalName": "string",
"slotId": "string",
"status": "string",
"storedName": "string",
"tags": [
"string"
],
"userId": "string",
"slotInfo": {
"description": "string",
"file": {
"absolute": true,
"absoluteFile": {},
"absolutePath": "string",
"canonicalFile": {},
"canonicalPath": "string",
"directory": true,
"file": true,
"freeSpace": 0,
"hidden": true,
"name": "string",
"parent": "string",
"parentFile": {},
"path": "string",
"totalSpace": 0,
"usableSpace": 0
},
"filename": "string",
"inputStream": {},
"open": true,
"readable": true,
"uri": {
"absolute": true,
"authority": "string",
"fragment": "string",
"host": "string",
"opaque": true,
"path": "string",
"port": 0,
"query": "string",
"rawAuthority": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"rawSchemeSpecificPart": "string",
"rawUserInfo": "string",
"scheme": "string",
"schemeSpecificPart": "string",
"userInfo": "string"
},
"url": {
"authority": "string",
"content": {},
"defaultPort": 0,
"file": "string",
"host": "string",
"path": "string",
"port": 0,
"protocol": "string",
"query": "string",
"ref": "string",
"userInfo": "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 slotDeleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.slotobject---additional properties are allowed
payload.slot.checksumstring----
payload.slot.customAttributestring----
payload.slot.dateAccessedstring--format (date-time)-
payload.slot.dateCreatedstring--format (date-time)-
payload.slot.date-modifiedstring--format (date-time)-
payload.slot.labelstring----
payload.slot.mimeTypestring----
payload.slot.namespacestring----
payload.slot.originalNamestring----
payload.slot.slotIdstring----
payload.slot.statusstring----
payload.slot.storedNamestring----
payload.slot.tagsarray<string>----
payload.slot.tags (single item)string----
payload.slot.userIdstring----
payload.slot.slotInfoobject---additional properties are allowed
payload.slot.slotInfo.descriptionstring----
payload.slot.slotInfo.fileobject---additional properties are allowed
payload.slot.slotInfo.file.absoluteboolean----
payload.slot.slotInfo.file.absoluteFileobject---additional properties are allowed
payload.slot.slotInfo.file.absolutePathstring----
payload.slot.slotInfo.file.canonicalFileobject---additional properties are allowed
payload.slot.slotInfo.file.canonicalPathstring----
payload.slot.slotInfo.file.directoryboolean----
payload.slot.slotInfo.file.fileboolean----
payload.slot.slotInfo.file.freeSpaceinteger----
payload.slot.slotInfo.file.hiddenboolean----
payload.slot.slotInfo.file.namestring----
payload.slot.slotInfo.file.parentstring----
payload.slot.slotInfo.file.parentFileobject---additional properties are allowed
payload.slot.slotInfo.file.pathstring----
payload.slot.slotInfo.file.totalSpaceinteger----
payload.slot.slotInfo.file.usableSpaceinteger----
payload.slot.slotInfo.filenamestring----
payload.slot.slotInfo.inputStreamobject---additional properties are allowed
payload.slot.slotInfo.openboolean----
payload.slot.slotInfo.readableboolean----
payload.slot.slotInfo.uriobject---additional properties are allowed
payload.slot.slotInfo.uri.absoluteboolean----
payload.slot.slotInfo.uri.authoritystring----
payload.slot.slotInfo.uri.fragmentstring----
payload.slot.slotInfo.uri.hoststring----
payload.slot.slotInfo.uri.opaqueboolean----
payload.slot.slotInfo.uri.pathstring----
payload.slot.slotInfo.uri.portinteger----
payload.slot.slotInfo.uri.querystring----
payload.slot.slotInfo.uri.rawAuthoritystring----
payload.slot.slotInfo.uri.rawFragmentstring----
payload.slot.slotInfo.uri.rawPathstring----
payload.slot.slotInfo.uri.rawQuerystring----
payload.slot.slotInfo.uri.rawSchemeSpecificPartstring----
payload.slot.slotInfo.uri.rawUserInfostring----
payload.slot.slotInfo.uri.schemestring----
payload.slot.slotInfo.uri.schemeSpecificPartstring----
payload.slot.slotInfo.uri.userInfostring----
payload.slot.slotInfo.urlobject---additional properties are allowed
payload.slot.slotInfo.url.authoritystring----
payload.slot.slotInfo.url.contentobject---additional properties are allowed
payload.slot.slotInfo.url.defaultPortinteger----
payload.slot.slotInfo.url.filestring----
payload.slot.slotInfo.url.hoststring----
payload.slot.slotInfo.url.pathstring----
payload.slot.slotInfo.url.portinteger----
payload.slot.slotInfo.url.protocolstring----
payload.slot.slotInfo.url.querystring----
payload.slot.slotInfo.url.refstring----
payload.slot.slotInfo.url.userInfostring----
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": {
"slot": {
"checksum": "string",
"customAttribute": "string",
"dateAccessed": "2019-08-24T14:15:22Z",
"dateCreated": "2019-08-24T14:15:22Z",
"date-modified": "2019-08-24T14:15:22Z",
"label": "string",
"mimeType": "string",
"namespace": "string",
"originalName": "string",
"slotId": "string",
"status": "string",
"storedName": "string",
"tags": [
"string"
],
"userId": "string",
"slotInfo": {
"description": "string",
"file": {
"absolute": true,
"absoluteFile": {},
"absolutePath": "string",
"canonicalFile": {},
"canonicalPath": "string",
"directory": true,
"file": true,
"freeSpace": 0,
"hidden": true,
"name": "string",
"parent": "string",
"parentFile": {},
"path": "string",
"totalSpace": 0,
"usableSpace": 0
},
"filename": "string",
"inputStream": {},
"open": true,
"readable": true,
"uri": {
"absolute": true,
"authority": "string",
"fragment": "string",
"host": "string",
"opaque": true,
"path": "string",
"port": 0,
"query": "string",
"rawAuthority": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"rawSchemeSpecificPart": "string",
"rawUserInfo": "string",
"scheme": "string",
"schemeSpecificPart": "string",
"userInfo": "string"
},
"url": {
"authority": "string",
"content": {},
"defaultPort": 0,
"file": "string",
"host": "string",
"path": "string",
"port": 0,
"protocol": "string",
"query": "string",
"ref": "string",
"userInfo": "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 slotUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.slotobject---additional properties are allowed
payload.slot.checksumstring----
payload.slot.customAttributestring----
payload.slot.dateAccessedstring--format (date-time)-
payload.slot.dateCreatedstring--format (date-time)-
payload.slot.date-modifiedstring--format (date-time)-
payload.slot.labelstring----
payload.slot.mimeTypestring----
payload.slot.namespacestring----
payload.slot.originalNamestring----
payload.slot.slotIdstring----
payload.slot.statusstring----
payload.slot.storedNamestring----
payload.slot.tagsarray<string>----
payload.slot.tags (single item)string----
payload.slot.userIdstring----
payload.slot.slotInfoobject---additional properties are allowed
payload.slot.slotInfo.descriptionstring----
payload.slot.slotInfo.fileobject---additional properties are allowed
payload.slot.slotInfo.file.absoluteboolean----
payload.slot.slotInfo.file.absoluteFileobject---additional properties are allowed
payload.slot.slotInfo.file.absolutePathstring----
payload.slot.slotInfo.file.canonicalFileobject---additional properties are allowed
payload.slot.slotInfo.file.canonicalPathstring----
payload.slot.slotInfo.file.directoryboolean----
payload.slot.slotInfo.file.fileboolean----
payload.slot.slotInfo.file.freeSpaceinteger----
payload.slot.slotInfo.file.hiddenboolean----
payload.slot.slotInfo.file.namestring----
payload.slot.slotInfo.file.parentstring----
payload.slot.slotInfo.file.parentFileobject---additional properties are allowed
payload.slot.slotInfo.file.pathstring----
payload.slot.slotInfo.file.totalSpaceinteger----
payload.slot.slotInfo.file.usableSpaceinteger----
payload.slot.slotInfo.filenamestring----
payload.slot.slotInfo.inputStreamobject---additional properties are allowed
payload.slot.slotInfo.openboolean----
payload.slot.slotInfo.readableboolean----
payload.slot.slotInfo.uriobject---additional properties are allowed
payload.slot.slotInfo.uri.absoluteboolean----
payload.slot.slotInfo.uri.authoritystring----
payload.slot.slotInfo.uri.fragmentstring----
payload.slot.slotInfo.uri.hoststring----
payload.slot.slotInfo.uri.opaqueboolean----
payload.slot.slotInfo.uri.pathstring----
payload.slot.slotInfo.uri.portinteger----
payload.slot.slotInfo.uri.querystring----
payload.slot.slotInfo.uri.rawAuthoritystring----
payload.slot.slotInfo.uri.rawFragmentstring----
payload.slot.slotInfo.uri.rawPathstring----
payload.slot.slotInfo.uri.rawQuerystring----
payload.slot.slotInfo.uri.rawSchemeSpecificPartstring----
payload.slot.slotInfo.uri.rawUserInfostring----
payload.slot.slotInfo.uri.schemestring----
payload.slot.slotInfo.uri.schemeSpecificPartstring----
payload.slot.slotInfo.uri.userInfostring----
payload.slot.slotInfo.urlobject---additional properties are allowed
payload.slot.slotInfo.url.authoritystring----
payload.slot.slotInfo.url.contentobject---additional properties are allowed
payload.slot.slotInfo.url.defaultPortinteger----
payload.slot.slotInfo.url.filestring----
payload.slot.slotInfo.url.hoststring----
payload.slot.slotInfo.url.pathstring----
payload.slot.slotInfo.url.portinteger----
payload.slot.slotInfo.url.protocolstring----
payload.slot.slotInfo.url.querystring----
payload.slot.slotInfo.url.refstring----
payload.slot.slotInfo.url.userInfostring----
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": {
"slot": {
"checksum": "string",
"customAttribute": "string",
"dateAccessed": "2019-08-24T14:15:22Z",
"dateCreated": "2019-08-24T14:15:22Z",
"date-modified": "2019-08-24T14:15:22Z",
"label": "string",
"mimeType": "string",
"namespace": "string",
"originalName": "string",
"slotId": "string",
"status": "string",
"storedName": "string",
"tags": [
"string"
],
"userId": "string",
"slotInfo": {
"description": "string",
"file": {
"absolute": true,
"absoluteFile": {},
"absolutePath": "string",
"canonicalFile": {},
"canonicalPath": "string",
"directory": true,
"file": true,
"freeSpace": 0,
"hidden": true,
"name": "string",
"parent": "string",
"parentFile": {},
"path": "string",
"totalSpace": 0,
"usableSpace": 0
},
"filename": "string",
"inputStream": {},
"open": true,
"readable": true,
"uri": {
"absolute": true,
"authority": "string",
"fragment": "string",
"host": "string",
"opaque": true,
"path": "string",
"port": 0,
"query": "string",
"rawAuthority": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"rawSchemeSpecificPart": "string",
"rawUserInfo": "string",
"scheme": "string",
"schemeSpecificPart": "string",
"userInfo": "string"
},
"url": {
"authority": "string",
"content": {},
"defaultPort": 0,
"file": "string",
"host": "string",
"path": "string",
"port": 0,
"protocol": "string",
"query": "string",
"ref": "string",
"userInfo": "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"
}

PUB slotConfig Operation

Accepts one of the following messages:

Message slotConfigCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.slotConfigobject---additional properties are allowed
payload.slotConfig.maxSlotSizeinteger----
payload.slotConfig.maxSlotsinteger----
payload.slotConfig.namespacestring----
payload.slotConfig.userIdstring----
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": {
"slotConfig": {
"maxSlotSize": 0,
"maxSlots": 0,
"namespace": "string",
"userId": "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 slotConfigDeleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.slotConfigobject---additional properties are allowed
payload.slotConfig.maxSlotSizeinteger----
payload.slotConfig.maxSlotsinteger----
payload.slotConfig.namespacestring----
payload.slotConfig.userIdstring----
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": {
"slotConfig": {
"maxSlotSize": 0,
"maxSlots": 0,
"namespace": "string",
"userId": "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 slotConfigUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.slotConfigobject---additional properties are allowed
payload.slotConfig.maxSlotSizeinteger----
payload.slotConfig.maxSlotsinteger----
payload.slotConfig.namespacestring----
payload.slotConfig.userIdstring----
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": {
"slotConfig": {
"maxSlotSize": 0,
"maxSlots": 0,
"namespace": "string",
"userId": "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"
}