Class OpaApiClient

Namespace

OpenPolicyAgent.Opa.OpenApi

Assembly

OpenPolicyAgent.Opa.dll

https://github.com/open-policy-agent/eopa/docs - EOPA documentation

public class OpaApiClient : IOpaApiClient

Inheritance

object

OpaApiClient

Implements

IOpaApiClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OpaApiClient(string?, Func<string>?, int?, string?, Dictionary<string, string>?, ISpeakeasyHttpClient?, RetryConfig?)

public OpaApiClient(string? bearerAuth = null, Func<string>? bearerAuthSource = null, int? serverIndex = null, string? serverUrl = null, Dictionary<string, string>? urlParams = null, ISpeakeasyHttpClient? client = null, RetryConfig? retryConfig = null)

Parameters

bearerAuth string

bearerAuthSource Func<string>

serverIndex int?

serverUrl string

urlParams Dictionary<string, string>

client ISpeakeasyHttpClient

retryConfig RetryConfig

Properties

SDKConfiguration

public SDKConfig SDKConfiguration { get; }

Property Value

SDKConfig

Methods

CompileQueryWithPartialEvaluationAsync(CompileQueryWithPartialEvaluationRequest)

Partially evaluate a query

public Task<CompileQueryWithPartialEvaluationResponse> CompileQueryWithPartialEvaluationAsync(CompileQueryWithPartialEvaluationRequest request)

Parameters

request CompileQueryWithPartialEvaluationRequest

Returns

Task<CompileQueryWithPartialEvaluationResponse>

ExecuteBatchPolicyWithInputAsync(ExecuteBatchPolicyWithInputRequest)

Execute a policy given a batch of inputs

public Task<ExecuteBatchPolicyWithInputResponse> ExecuteBatchPolicyWithInputAsync(ExecuteBatchPolicyWithInputRequest request)

Parameters

request ExecuteBatchPolicyWithInputRequest

Returns

Task<ExecuteBatchPolicyWithInputResponse>

ExecuteDefaultPolicyWithInputAsync(Input, bool?, GzipAcceptEncoding?)

Execute the default decision given an input

public Task<ExecuteDefaultPolicyWithInputResponse> ExecuteDefaultPolicyWithInputAsync(Input input, bool? pretty = null, GzipAcceptEncoding? acceptEncoding = null)

Parameters

input Input

pretty bool?

acceptEncoding GzipAcceptEncoding?

Returns

Task<ExecuteDefaultPolicyWithInputResponse>

ExecutePolicyAsync(ExecutePolicyRequest)

Execute a policy

public Task<ExecutePolicyResponse> ExecutePolicyAsync(ExecutePolicyRequest request)

Parameters

request ExecutePolicyRequest

Returns

Task<ExecutePolicyResponse>

ExecutePolicyWithInputAsync(ExecutePolicyWithInputRequest)

Execute a policy given an input

public Task<ExecutePolicyWithInputResponse> ExecutePolicyWithInputAsync(ExecutePolicyWithInputRequest request)

Parameters

request ExecutePolicyWithInputRequest

Returns

Task<ExecutePolicyWithInputResponse>

HealthAsync(bool?, bool?, List<string>?)

Verify the server is operational

The health API endpoint executes a simple built-in policy query to verify that the server is operational. Optionally it can account for bundle activation as well (useful for “ready” checks at startup).

public Task<HealthResponse> HealthAsync(bool? bundles = false, bool? plugins = false, List<string>? excludePlugin = null)

Parameters

bundles bool?

plugins bool?

excludePlugin List<string>

Returns

Task<HealthResponse>