package eopa.policy.v1

Get desktop application:
View/edit binary Protocol Buffers messages

rpc CreatePolicy (CreatePolicyRequest, CreatePolicyResponse)
policy.proto:151
CreatePolicy inserts a new policy module into the policy store. This is equivalent in functionality to OPA's [Policy REST API Create/Update method](https://www.openpolicyagent.org/docs/latest/rest-api/#create-or-update-a-policy). Warning: Inserting a new policy will trigger a full recompilation of *all* policies in the store, in order to ensure the new policy does not break existing policies. This is a known performance hazard for the OPA REST API, and remains a hazard for gRPC as well. Keeping the unique number of policies down, or using Bundles are the recommended workarounds for most OPA users.
rpc DeletePolicy (DeletePolicyRequest, DeletePolicyResponse)
policy.proto:185
DeletePolicy removes a policy module from the policy store. This is equivalent in functionality to OPA's [Policy REST API Delete method](https://www.openpolicyagent.org/docs/latest/rest-api/#delete-a-policy). Warning: Removing a policy will trigger a full recompilation of *all* policies in the store, in order to ensure that removing the policy module does not break existing policies. This is a known performance hazard for the OPA REST API, and remains a hazard for gRPC as well. Keeping the unique number of policies down, or using Bundles are the recommended workarounds for most OPA users.
rpc GetPolicy (GetPolicyRequest, GetPolicyResponse)
policy.proto:159
GetPolicy fetches a policy module's code from the policy store. This is roughly equivalent in functionality to OPA's [Policy REST API Get method](https://www.openpolicyagent.org/docs/latest/rest-api/#get-a-policy). Note: Only the raw policy text is returned in this version of the API.
rpc ListPolicies (ListPoliciesRequest, ListPoliciesResponse)
policy.proto:138
ListPolicies returns the set of stored policies in the policy store. This is equivalent in functionality to OPA's [Policy REST API List method](https://www.openpolicyagent.org/docs/latest/rest-api/#list-policies). Warning: This request will enumerate *all* policies stored by the Enterprise OPA instance. This can have substantial overheads if the policies are large in size.
message ListPoliciesRequest
policy.proto:27
ListPoliciesRequest is used to start a ListPolicy operation.
(message has no fields)
message ListPoliciesResponse
policy.proto:31
ListPoliciesResponse contains the list of all policies enumerated by a ListPolicy operation.
- repeated Policy results = 1
rpc StreamingPolicyRW (stream StreamingPolicyRWRequest, stream StreamingPolicyRWResponse)
policy.proto:196
StreamingPolicyRW specifies a stream of fixed-structure, batched read/write operations. WritePolicy operations are executed sequentially, aborting the entire gRPC call if any operations fail. The ReadPolicy operations are then executed in parallel, but will report errors inline in their responses, instead of aborting the entire gRPC call.
message StreamingPolicyRWRequest
policy.proto:77
StreamingPolicyRequest provides a way to send PolicyService 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 StreamingPolicyRWRequest.WriteRequest writes = 1
  writes provides a sequence of WritePolicy requests.
- repeated StreamingPolicyRWRequest.ReadRequest reads = 2
  reads provides a sequence of ReadPolicy requests.
message StreamingPolicyRWResponse
policy.proto:100
StreamingPolicyRWResponse contains lists of the appropriate response types for each operation in the StreamingPolicyRWRequest.
- repeated StreamingPolicyRWResponse.WriteResponse writes = 1
  writes provides a sequence of WritePolicy results.
- repeated StreamingPolicyRWResponse.ReadResponse reads = 2
  reads provides a sequence of ReadPolicy results or errors.
rpc UpdatePolicy (UpdatePolicyRequest, UpdatePolicyResponse)
policy.proto:172
UpdatePolicy updates a policy module in the policy store. This is equivalent in functionality to OPA's [Policy REST API Create/Update method](https://www.openpolicyagent.org/docs/latest/rest-api/#create-or-update-a-policy). Warning: Modifying an existing policy will trigger a full recompilation of *all* policies in the store, in order to ensure the updated policy does not break existing policies. This is a known performance hazard for the OPA REST API, and remains a hazard for gRPC as well. Keeping the unique number of policies down, or using Bundles are the recommended workarounds for most OPA users.