package resource

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Create (CreateRequest, CreateResponse)

  state.proto:33

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

  message CreateRequest

  state.proto:92

  • optional Resource resource = 1

  • optional CreateOptions options = 2

  message CreateResponse

  state.proto:102

  (message has no fields)

• rpc Destroy (DestroyRequest, DestroyResponse)

  state.proto:46

  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:123

  • string namespace = 1

  • string type = 2

  • string id = 3

  • optional DestroyOptions options = 4

  message DestroyResponse

  state.proto:135

  (message has no fields)

• rpc Get (GetRequest, GetResponse)

  state.proto:25

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

  message GetRequest

  state.proto:59

  • string namespace = 1

  • string type = 2

  • string id = 3

  • optional GetOptions options = 4

  message GetResponse

  state.proto:70

  • optional Resource resource = 1

• rpc List (ListRequest, stream ListResponse)

  state.proto:28

  List resources by type.

  message ListRequest

  state.proto:76

  • string namespace = 1

  • string type = 2

  • optional ListOptions options = 3

  message ListResponse

  state.proto:86

  • optional Resource resource = 1

• rpc Update (UpdateRequest, UpdateResponse)

  state.proto:40

  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:107

  • string current_version = 1

  • optional Resource new_resource = 2

  • optional UpdateOptions options = 3

  message UpdateResponse

  state.proto:118

  (message has no fields)

• rpc Watch (WatchRequest, stream WatchResponse)

  state.proto:54

  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:140

  • string namespace = 1

  • string type = 2

  • optional string id = 3

  • optional WatchOptions options = 4

  message WatchResponse

  state.proto:152

  • optional 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

• EventType event_type = 2

Used in: Event

• CREATED = 0

• UPDATED = 1

• DESTROYED = 2

Used in: GetRequest

(message has no fields)

Used in: ListRequest

(message has no fields)

Metadata represents resource metadata.

Used in: Resource

• string namespace = 1

• string type = 2

• string id = 3

• string version = 4

• string owner = 5

• string phase = 6

• repeated string finalizers = 7

Resource is a combination of metadata and spec.

Used in: CreateRequest, Event, GetResponse, ListResponse, UpdateRequest, runtime.RuntimeCreateRequest, runtime.RuntimeGetResponse, runtime.RuntimeListResponse, runtime.RuntimeUpdateRequest, runtime.RuntimeWatchForResponse

• optional Metadata metadata = 1

• optional Spec spec = 2

Spec defines content of the resource.

Used in: Resource

• bytes proto_spec = 1

• string yaml_spec = 2

Used in: UpdateRequest

• string owner = 1

Used in: WatchRequest

• bool bootstrap_contents = 1