package cosi.resource

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Create (CreateRequest, CreateResponse)

  state.proto:39

  Create a resource. If a resource already exists, Create returns an error.

  message CreateRequest

  state.proto:114

  • optional Resource resource = 1

  • optional CreateOptions options = 2

  message CreateResponse

  state.proto:124

  • optional Resource resource = 1

• rpc Destroy (DestroyRequest, DestroyResponse)

  state.proto:52

  Destroy a resource. If a resource doesn't exist, error is returned. If a resource has pending finalizers, error is returned.

  message DestroyRequest

  state.proto:150

  • string namespace = 1

  • string type = 2

  • string id = 3

  • optional DestroyOptions options = 4

  message DestroyResponse

  state.proto:162

  (message has no fields)

• rpc Get (GetRequest, GetResponse)

  state.proto:31

  Get a resource by type and ID. If a resource is not found, error is returned.

  message GetRequest

  state.proto:79

  • string namespace = 1

  • string type = 2

  • string id = 3

  • optional GetOptions options = 4

  message GetResponse

  state.proto:90

  • optional Resource resource = 1

• rpc List (ListRequest, stream ListResponse)

  state.proto:34

  List resources by type.

  message ListRequest

  state.proto:96

  • string namespace = 1

  • string type = 2

  • optional ListOptions options = 3

  message ListResponse

  state.proto:108

  • optional Resource resource = 1

• rpc Teardown (TeardownRequest, TeardownResponse)

  state.proto:67

  Teardown a resource (mark as being destroyed). If a resource doesn't exist, error is returned. It's not an error to tear down a resource which is already being torn down. Teardown returns a flag telling whether it's fine to destroy a resource.

  message TeardownRequest

  state.proto:196

  • string namespace = 1

  • string type = 2

  • string id = 3

  • optional TeardownOptions options = 4

  message TeardownResponse

  state.proto:208

  • bool destroy_ready = 1

    DestroyReady is true when the resource has no pending finalizers and is ready to be destroyed.

• rpc TeardownAndDestroy (TeardownAndDestroyRequest, TeardownAndDestroyResponse)

  state.proto:74

  TeardownAndDestroy tears down a resource and destroys it once all finalizers are gone. If a resource doesn't exist, error is returned. It's not an error to tear down a resource which is already being torn down. The call blocks until the resource has no pending finalizers and has been destroyed.

  message TeardownAndDestroyRequest

  state.proto:215

  • string namespace = 1

  • string type = 2

  • string id = 3

  • optional TeardownAndDestroyOptions options = 4

  message TeardownAndDestroyResponse

  state.proto:227

  (message has no fields)

• rpc Update (UpdateRequest, UpdateResponse)

  state.proto:46

  Update a resource. If a resource doesn't exist, error is returned. On update current version of resource `new` in the state should match curVersion, otherwise conflict error is returned.

  message UpdateRequest

  state.proto:130

  • optional Resource new_resource = 2

  • optional UpdateOptions options = 3

  message UpdateResponse

  state.proto:144

  • optional Resource resource = 1

• rpc Watch (WatchRequest, stream WatchResponse)

  state.proto:60

  Watch state of a resource by (namespace, type) or a specific resource by (namespace, type, id). It's fine to watch for a resource which doesn't exist yet. Watch is canceled when context gets canceled. Watch sends initial resource state as the very first event on the channel, and then sends any updates to the resource as events.

  message WatchRequest

  state.proto:167

  • string namespace = 1

  • string type = 2

  • optional string id = 3

  • optional WatchOptions options = 4

  • int32 api_version = 5

    Supported API versions: 0 (not set): event types Created,Updated,Deleted 1: additional event types Bootstrapped,Errored

  message WatchResponse

  state.proto:190

  • repeated Event event = 1

Used in: CreateRequest

• string owner = 1

Used in: DestroyRequest

• string owner = 1

Event is emitted when resource changes.

Used in: WatchResponse

• optional Resource resource = 1

• optional Resource old = 3

• optional string error = 4

• EventType event_type = 2

• optional bytes bookmark = 5

Used in: Event

• CREATED = 0

• UPDATED = 1

• DESTROYED = 2

• BOOTSTRAPPED = 3

• ERRORED = 4

• NOOP = 5

Used in: GetRequest

(message has no fields)

IDQuery is a query on resource metadata ID.

Used in: ListOptions, WatchOptions

• string regexp = 1

LabelQuery is a query on resource metadata labels. Terms are combined with AND.

Used in: ListOptions, WatchOptions

• repeated LabelTerm terms = 1

LabelTerm is an expression on a label.

Used in: LabelQuery

• string key = 1

• LabelTerm.Operation op = 2

• repeated string value = 3

• bool invert = 5

  Inverts the condition.

Used in: LabelTerm

• EXISTS = 0

  Label exists.

• EQUAL = 1

  Label value is equal.

• NOT_EXISTS = 2

  Label doesn't exist.

• IN = 3

  Label value is in the set.

• LT = 4

  Label value is less.

• LTE = 5

  Label value is less or equal.

• LT_NUMERIC = 6

  Label value is less than number.

• LTE_NUMERIC = 7

  Label value is less or equal numeric.

Used in: ListRequest

• repeated LabelQuery label_query = 1

• optional IDQuery id_query = 2

Metadata represents resource metadata. (namespace, type, id) is a resource pointer. (version) is a current resource version. (owner) is filled in for controller-managed resources with controller name. (phase) indicates whether resource is going through tear down phase. (finalizers) are attached controllers blocking teardown of the resource. (labels) and (annotations) are free-form key-value pairs; labels allow queries.

Used in: Resource

• string namespace = 1

• string type = 2

• string id = 3

• string version = 4

• string owner = 5

• string phase = 6

• optional google.protobuf.Timestamp created = 7

• optional google.protobuf.Timestamp updated = 8

• repeated string finalizers = 9

• map<string, string> annotations = 11

• map<string, string> labels = 10

Resource is a combination of metadata and spec.

Used in: CreateRequest, CreateResponse, Event, GetResponse, ListResponse, UpdateRequest, UpdateResponse

• optional Metadata metadata = 1

• optional Spec spec = 2

Spec defines content of the resource.

Used in: Resource

• bytes proto_spec = 1

  Protobuf-serialized representation of the resource.

• string yaml_spec = 2

  YAML representation of the spec (optional).

Used in: TeardownAndDestroyRequest

• string owner = 1

Used in: TeardownRequest

• string owner = 1

Used in: UpdateRequest

• string owner = 1

• optional string expected_phase = 2

Used in: WatchRequest

• bool bootstrap_contents = 1

• int32 tail_events = 2

• repeated LabelQuery label_query = 3

• optional IDQuery id_query = 4

• bool aggregated = 5

• optional bytes start_from_bookmark = 6

• bool bootstrap_bookmark = 7