Class OpaApiClient

Hierarchy

ClientSDK
- OpaApiClient

Index

Constructors

Properties

Methods

_createRequest _do compileQueryWithPartialEvaluation executeBatchPolicyWithInput executeDefaultPolicyWithInput executePolicy executePolicyWithInput health

Constructors

constructor

new OpaApiClient(options?: SDKOptions): OpaApiClient
Parameters
- options: SDKOptions = {}
Returns OpaApiClient
Inherited from ClientSDK.constructor
- Defined in packages/opa/src/lib/sdks.ts:84

Properties

`Readonly`_baseURL

_baseURL: null | URL

`Readonly`_options

_options: SDKOptions & { hooks?: SDKHooks }

Methods

_createRequest

_createRequest(
    context: HookContext,
    conf: RequestConfig,
    options?: RequestOptions,
): Result<Request, UnexpectedClientError | InvalidRequestError>
Parameters
- context: HookContext
- conf: RequestConfig
- Optionaloptions: RequestOptions
Returns Result<Request, UnexpectedClientError | InvalidRequestError>
Inherited from ClientSDK._createRequest
- Defined in packages/opa/src/lib/sdks.ts:111

_do

_do(
    request: Request,
    options: {
        context: HookContext;
        errorCodes: string | number | (string | number)[];
        retryCodes: string[];
        retryConfig: RetryConfig;
    },
): Promise<
    Result<
        Response,
        | UnexpectedClientError
        | RequestAbortedError
        | RequestTimeoutError
        | ConnectionError,
    >,
>
Parameters
- request: Request
- options: {
      context: HookContext;
      errorCodes: string | number | (string | number)[];
      retryCodes: string[];
      retryConfig: RetryConfig;
  }
Returns Promise<
    Result<
        Response,
        | UnexpectedClientError
        | RequestAbortedError
        | RequestTimeoutError
        | ConnectionError,
    >,
>
Inherited from ClientSDK._do
- Defined in packages/opa/src/lib/sdks.ts:221

compileQueryWithPartialEvaluation

compileQueryWithPartialEvaluation(
    request: CompileQueryWithPartialEvaluationRequest,
    options?: RequestOptions & {
        acceptHeaderOverride?: CompileQueryWithPartialEvaluationAcceptEnum;
    },
): Promise<CompileQueryWithPartialEvaluationResponse>
Partially evaluate a query
Parameters
- request: CompileQueryWithPartialEvaluationRequest
- Optionaloptions: RequestOptions & {
  acceptHeaderOverride?: CompileQueryWithPartialEvaluationAcceptEnum;
  }
Returns Promise<CompileQueryWithPartialEvaluationResponse>
- Defined in packages/opa/src/sdk/sdk.ts:85

executeBatchPolicyWithInput

executeBatchPolicyWithInput(
request: ExecuteBatchPolicyWithInputRequest,
options?: RequestOptions,
): Promise<ExecuteBatchPolicyWithInputResponse>
Execute a policy given a batch of inputs
Parameters
- request: ExecuteBatchPolicyWithInputRequest
- Optionaloptions: RequestOptions
Returns Promise<ExecuteBatchPolicyWithInputResponse>
- Defined in packages/opa/src/sdk/sdk.ts:71

executeDefaultPolicyWithInput

executeDefaultPolicyWithInput(
    input: Input,
    pretty?: boolean,
    acceptEncoding?: Gzip,
    options?: RequestOptions,
): Promise<ExecuteDefaultPolicyWithInputResponse>
Execute the default decision given an input
Parameters
- input: Input
- Optionalpretty: boolean
- OptionalacceptEncoding: Gzip
- Optionaloptions: RequestOptions
Returns Promise<ExecuteDefaultPolicyWithInputResponse>
- Defined in packages/opa/src/sdk/sdk.ts:25

executePolicy

executePolicy(
request: ExecutePolicyRequest,
options?: RequestOptions,
): Promise<ExecutePolicyResponse>
Execute a policy
Parameters
- request: ExecutePolicyRequest
- Optionaloptions: RequestOptions
Returns Promise<ExecutePolicyResponse>
- Defined in packages/opa/src/sdk/sdk.ts:43

executePolicyWithInput

executePolicyWithInput(
request: ExecutePolicyWithInputRequest,
options?: RequestOptions,
): Promise<ExecutePolicyWithInputResponse>
Execute a policy given an input
Parameters
- request: ExecutePolicyWithInputRequest
- Optionaloptions: RequestOptions
Returns Promise<ExecutePolicyWithInputResponse>
- Defined in packages/opa/src/sdk/sdk.ts:57

health

health(
    bundles?: boolean,
    plugins?: boolean,
    excludePlugin?: string[],
    options?: RequestOptions,
): Promise<HealthResponse>
Verify the server is operational
Parameters
- Optionalbundles: boolean
- Optionalplugins: boolean
- OptionalexcludePlugin: string[]
- Optionaloptions: RequestOptions
Returns Promise<HealthResponse>
Remarks
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).
- Defined in packages/opa/src/sdk/sdk.ts:104

Class OpaApiClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns OpaApiClient

Properties

Readonly_baseURL

Readonly_options

Methods

_createRequest

Parameters

Returns Result<Request, UnexpectedClientError | InvalidRequestError>

_do

Parameters

Returns Promise< Result< Response, | UnexpectedClientError | RequestAbortedError | RequestTimeoutError | ConnectionError, >,>

compileQueryWithPartialEvaluation

Parameters

Returns Promise<CompileQueryWithPartialEvaluationResponse>

executeBatchPolicyWithInput

Parameters

Returns Promise<ExecuteBatchPolicyWithInputResponse>

executeDefaultPolicyWithInput

Parameters

Returns Promise<ExecuteDefaultPolicyWithInputResponse>

executePolicy

Parameters

Returns Promise<ExecutePolicyResponse>

executePolicyWithInput

Parameters

Returns Promise<ExecutePolicyWithInputResponse>

health

Parameters

Returns Promise<HealthResponse>

Remarks

Settings

On This Page

`Readonly`_baseURL

`Readonly`_options

Returns Promise<
Result<
Response,
| UnexpectedClientError
| RequestAbortedError
| RequestTimeoutError
| ConnectionError,
>,
>