Reference For: developers

gRPC: common

Services, methods, messages and enums of common.proto.

Shared messages of the Kyvernon native API (v1). Conventions: * Object ids are MoRef-compatible strings ("vm-42", "host-7"). * Timestamps are RFC 3339 strings in UTC with microsecond precision. * Typed record bodies travel as JSON (*_json fields) in v1; the schemas are published in docs/api/openapi.yaml. Dedicated protobuf messages exist where the operation itself is typed (power operations, tasks, agent).

Messages

RecordMeta

Store-maintained metadata of every record.

FieldNumberTypeDescription
id1string

Id of the object (vm-12, host-3).

uuid2string

UUID of the object, stable for its lifetime.

parent3string

Id of the parent in the inventory tree; empty for a root.

name4string

Name of the object.

version5uint64

Store version of the last change; the expected version of a compare-and-set update.

created_version6uint64

Store version that created the object.

created_at7string

Creation time, RFC 3339.

updated_at8string

Time of the last change, RFC 3339.

Object

A record with its JSON body.

FieldNumberTypeDescription
meta1RecordMeta

Identity, place and versions of the object.

kind2string

Object kind (for example VirtualMachine).

data_json3string

The kind-specific body as JSON, the same shape as in the REST API.

PageRequest

Pagination request; after is the id to resume after.

FieldNumberTypeDescription
limit1uint32

Most items in one answer; 0 means the server default.

after2string

Cursor: the next of the previous page; empty for the first page.

PageInfo

Pagination response.

FieldNumberTypeDescription
version1uint64

Store version the page was read at.

next2string

Cursor of the next page; empty on the last page.

ErrorDetail

Error details attached to gRPC status (also the REST envelope body).

FieldNumberTypeDescription
code1string

Error code (NOT_FOUND, FAILED_PRECONDITION, ...).

message2string

English developer message.

key3string

Message id the console localises (error.not_found); empty when there is none.

details4map<string, string>

Arguments of the message id.

correlation_id5string

Correlation id of the request (the x-request-id metadata, or one the server chose).

TaskRef

Reference to a task created by a long-running operation.

FieldNumberTypeDescription
task_id1string

Id of the task to poll or wait for.

Empty

No fields.

Version 0.1.