35 lines
5.0 KiB
Markdown
35 lines
5.0 KiB
Markdown
## `Enrich`
|
|
|
|
### Constructor
|
|
|
|
:::
|
|
new Enrich(transport: [Transport](./Transport.md));
|
|
:::
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Description |
|
|
| - | - | - |
|
|
| `acceptedParams` | Record<string, { path: string[]; body: string[]; query: string[]; }> | |
|
|
| `transport` | [Transport](./Transport.md) | |
|
|
|
|
### Methods
|
|
|
|
| Name | Signature | Description |
|
|
| - | - | - |
|
|
| `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md)>;` | Delete an enrich policy. Deletes an existing enrich policy and its enrich index. |
|
|
| `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md), unknown>>;` | |
|
|
| `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md)>;` | |
|
|
| `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md)>;` | Run an enrich policy. Create the enrich index for an existing enrich policy. |
|
|
| `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md), unknown>>;` | |
|
|
| `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md)>;` | |
|
|
| `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md)>;` | Get an enrich policy. Returns information about an enrich policy. |
|
|
| `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md), unknown>>;` | |
|
|
| `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md)>;` | |
|
|
| `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md)>;` | Create an enrich policy. Creates an enrich policy. |
|
|
| `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md), unknown>>;` | |
|
|
| `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md)>;` | |
|
|
| `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichStatsResponse](./EnrichStatsResponse.md)>;` | Get enrich stats. Returns enrich coordinator statistics and information about enrich policies that are currently executing. |
|
|
| `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichStatsResponse](./EnrichStatsResponse.md), unknown>>;` | |
|
|
| `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichStatsResponse](./EnrichStatsResponse.md)>;` | |
|