package eopa.data.v1

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc CreateData (CreateDataRequest, CreateDataResponse)

  data.proto:161

  CreateData looks up the document by path, and inserts a new JSON value at the end of the path. This is equivalent in functionality to OPA's [Data REST API Create/Overwrite method](https://www.openpolicyagent.org/docs/latest/rest-api/#create-or-overwrite-a-document).

• rpc DeleteData (DeleteDataRequest, DeleteDataResponse)

  data.proto:188

  DeleteData looks up the document by path, and then attempts to remove it from the store. This is equivalent in functionality to OPA's [Data REST API Delete method](https://www.openpolicyagent.org/docs/latest/rest-api/#delete-a-document).

• rpc GetData (GetDataRequest, GetDataResponse)

  data.proto:173

  GetData looks up the document by path. This can be either a plain JSON value (a "Base" document in OPA parlance), or a rule head (a "Virtual"/computed document). This is equivalent in functionality to OPA's [Data REST API Get with Input method](https://www.openpolicyagent.org/docs/latest/rest-api/#get-a-document-with-input). Note that the input field should not be wrapped with `{ "input": <value> }`, you can simply put the JSON serialized `<value>` in the input field directly.

• rpc StreamingDataRW (stream StreamingDataRWRequest, stream StreamingDataRWResponse)

  data.proto:199

  StreamingDataRW specifies a stream of fixed-structure, batched read/write operations. WriteData operations are executed sequentially, aborting the entire gRPC call if any operations fail. The ReadData operations are then executed in parallel, but will report errors inline in their responses, instead of aborting the entire gRPC call.

  message StreamingDataRWRequest

  data.proto:104

  StreamingDataRequest provides a way to send DataService requests over gRPC streams. Limited batching support is provided via the `writes`/`reads` fields. As in the BulkRW API, if a write operation fails, the entire request will be aborted. Writes are done as a single transaction, reads are done in parallel.

  • repeated StreamingDataRWRequest.WriteRequest writes = 1

    writes provides a sequence of WriteData requests.

  • repeated StreamingDataRWRequest.ReadRequest reads = 2

    reads provides a sequence of ReadData requests.

  message StreamingDataRWResponse

  data.proto:127

  StreamingDataRWResponse contains lists of the appropriate response types for each operation in the StreamingDataRWRequest.

  • repeated StreamingDataRWResponse.WriteResponse writes = 1

    writes provides a sequence of WriteData results.

  • repeated StreamingDataRWResponse.ReadResponse reads = 2

    reads provides a sequence of ReadData results or errors.

• rpc UpdateData (UpdateDataRequest, UpdateDataResponse)

  data.proto:181

  UpdateData looks up the document by path, and then attempts to perform one of three patching operations at that location: add, remove, or replace. This is roughly equivalent in functionality to OPA's [Data REST API Patch method](https://www.openpolicyagent.org/docs/latest/rest-api/#patch-a-document)

CreateDataRequest provides a document and the path to insert it at.

Used as request type in: DataService.CreateData

Used as field type in: bulk.v1.BulkRWRequest.WriteDataRequest, StreamingDataRWRequest.WriteRequest

• optional DataDocument data = 1

CreateDataResponse is an empty confirmation message type.

Used as response type in: DataService.CreateData

Used as field type in: bulk.v1.BulkRWResponse.WriteDataResponse, StreamingDataRWResponse.WriteResponse

(message has no fields)

DataDocument is a thin wrapper type around a JSON value located at a particular path in the virtual document store.

Used in: CreateDataRequest, GetDataResponse, UpdateDataRequest

• string path = 1

• optional google.protobuf.Value document = 2

  json value, like {"foo":true} or [1, 2, 3]

DeleteDataRequest provides the path of a document to delete from the document store.

Used as request type in: DataService.DeleteData

Used as field type in: bulk.v1.BulkRWRequest.WriteDataRequest, StreamingDataRWRequest.WriteRequest

• string path = 1

DeleteDataResponse is an empty confirmation message type.

Used as response type in: DataService.DeleteData

Used as field type in: bulk.v1.BulkRWResponse.WriteDataResponse, StreamingDataRWResponse.WriteResponse

(message has no fields)

Context-dependent error messages.

Used in: StreamingDataRWResponse.ReadResponse

• repeated google.protobuf.Any errors = 1

  The errors in the list.

GetDataRequest queries the virtual document store at the specified path. This path can target a rule, or any value under the `data` document. Input to a query can also be provided, as a key-value mapping that will appear under the `input` document at runtime. For example, the following input mapping: ```json { "a": 2, "b": "example", "c": true } ```` would map to `input.a`, `input.b`, and `input.c`, where `input.a` has the value `2`, and so forth in a Rego policy.

Used as request type in: DataService.GetData

Used as field type in: bulk.v1.BulkRWRequest.ReadDataRequest, StreamingDataRWRequest.ReadRequest

• string path = 1

• optional InputDocument input = 2

GetDataResponse is the query result returned from a GetData operation.

Used as response type in: DataService.GetData

Used as field type in: bulk.v1.BulkRWResponse.ReadDataResponse, StreamingDataRWResponse.ReadResponse

• optional DataDocument result = 1

InputDocument is a thin wrapper type around OPA inputs, which are always JSON object types.

Used in: GetDataRequest

• optional google.protobuf.Struct document = 1

  json object, like {"foo":true}

PatchOp allows specifying a subset of JSON-Patch operations, namely "add", "remove", and "replace".

Used in: UpdateDataRequest

• PATCH_OP_UNSPECIFIED = 0

• PATCH_OP_ADD = 1

• PATCH_OP_REMOVE = 2

• PATCH_OP_REPLACE = 3

ReadRequest is currently a simple wrapper over the GetData request type.

Used in: StreamingDataRWRequest

• optional GetDataRequest get = 1

WriteDataRequest provides a union of possible Data request types. This allows creating arbitrary sequences of data store operations.

Used in: StreamingDataRWRequest

• oneof req

  • CreateDataRequest create = 1

  • UpdateDataRequest update = 2

  • DeleteDataRequest delete = 3

ReadResponse is currently a simple wrapper over the GetData request type.

Used in: StreamingDataRWResponse

• optional GetDataResponse get = 1

• optional ErrorList errors = 2

WriteResponse provides a union of possible Data request types. This allows creating arbitrary sequences of data store operations.

Used in: StreamingDataRWResponse

• oneof resp

  • CreateDataResponse create = 1

  • UpdateDataResponse update = 2

  • DeleteDataResponse delete = 3

UpdateDataRequest provides an optional document to patch in, and the patch operation specifying whether it's a create/update/delete operation to be performed.

Used as request type in: DataService.UpdateData

Used as field type in: bulk.v1.BulkRWRequest.WriteDataRequest, StreamingDataRWRequest.WriteRequest

• optional DataDocument data = 1

  JSON value to be patched in, like {"foo":true}

• PatchOp op = 2

  If unspecified, defaults to "overwrite/replace".

UpdateDataResponse is an empty confirmation message type.

Used as response type in: DataService.UpdateData

Used as field type in: bulk.v1.BulkRWResponse.WriteDataResponse, StreamingDataRWResponse.WriteResponse

(message has no fields)