Documentation Reference gRPC API reference gRPC: inventory
Reference For: developers
gRPC: inventory
Services, methods, messages and enums of inventory.proto.
Inventory read/write/watch.
InventoryServiceReads, writes and watches the objects of the inventory.
Messages
GetObjectRequestReads one object.
Field Number Type Description id1 stringId of the object.
consistency2 ConsistencyRead consistency.
ListObjectsRequestLists objects of one kind.
Field Number Type Description kind1 stringObject kind to list.
parent2 stringOnly the objects under this parent; empty for all.
name_prefix3 stringOnly the objects whose name starts with this text.
changed_after4 uint64Only the objects changed after this store version; 0 for all.
page5 PageRequestPaging.
consistency6 ConsistencyRead consistency.
ListObjectsResponseA page of objects.
Field Number Type Description items1 repeated Object The objects of the page.
page2 PageInfoStore version and cursor of the next page.
GetChildrenRequestReads the direct children of an object.
Field Number Type Description id1 stringId of the parent.
consistency2 ConsistencyRead consistency.
WatchChangesRequestStarts the change feed.
Field Number Type Description since1 uint64Store version to continue after; 0 starts at the oldest retained change.
kinds2 repeated string Only these kinds (empty = all).
ChangeOne change of one object.
Field Number Type Description kind1 ChangeKindCreated, updated or deleted.
object2 ObjectThe object after the change (its last state for a deletion).
ChangeSetThe changes of one store version.
Field Number Type Description version1 uint64Store version of the changes.
at2 stringTime of the change, RFC 3339.
actor3 stringUser or service that made the change.
changes4 repeated Change The changed objects.
ResyncThe feed lost history: read the objects again and resume after version.
Field Number Type Description version1 uint64Store version to resume after.
WatchItemOne item of the change feed: a change set or a resync.
Field Number Type Description changes1 ChangeSetChanges of one store version.
resync2 ResyncThe client must read again.
CreateObjectRequestCreates an object.
Field Number Type Description kind1 stringObject kind to create.
parent2 stringId of the parent.
data_json3 stringBody of the object as JSON.
idempotency_key4 stringKey that makes a retried request create the object once.
UpdateObjectRequestReplaces the body of an object.
Field Number Type Description id1 stringId of the object.
expected_version2 uint64Version the change is based on; a newer version refuses it with CONFLICT.
data_json3 stringNew body as JSON.
DeleteObjectRequestDeletes an object.
Field Number Type Description id1 stringId of the object.
expected_version2 uint64Version the deletion is based on; 0 deletes any version.
cascade3 boolAlso delete the objects under it.
Enums
ConsistencyRead consistency: linearizable through the leader, or the local copy of the controller that answers.
Value Number Description CONSISTENCY_LINEARIZABLE0 CONSISTENCY_LOCAL1
ChangeKindWhat a change did to an object.
Value Number Description CHANGE_KIND_CREATED0 CHANGE_KIND_UPDATED1 CHANGE_KIND_DELETED2
Guides
Previous gRPC: common Next gRPC: vm
Version 0.1.