56 lines
18 KiB
Markdown
56 lines
18 KiB
Markdown
# `Transform` [class-Transform]
|
||
|
||
## Constructor
|
||
|
||
```typescript
|
||
new Transform(transport: [Transport](./Transport.md));
|
||
```
|
||
|
||
## Properties [class-properties-Transform]
|
||
|
||
| Name | Type | Description |
|
||
| - | - | - |
|
||
| `acceptedParams` | Record<string, { path: string[]; body: string[]; query: string[]; }> | |
|
||
| `transport` | [Transport](./Transport.md) | |
|
||
|
||
## Methods [class-methods-Transform]
|
||
|
||
| Name | Signature | Description |
|
||
| - | - | - |
|
||
| `deleteTransform` | `deleteTransform(this: [That](./That.md), params: [TransformDeleteTransformRequest](./TransformDeleteTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformDeleteTransformResponse](./TransformDeleteTransformResponse.md)>;` | Delete a transform. |
|
||
| `deleteTransform` | `deleteTransform(this: [That](./That.md), params: [TransformDeleteTransformRequest](./TransformDeleteTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformDeleteTransformResponse](./TransformDeleteTransformResponse.md), unknown>>;` | |
|
||
| `deleteTransform` | `deleteTransform(this: [That](./That.md), params: [TransformDeleteTransformRequest](./TransformDeleteTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformDeleteTransformResponse](./TransformDeleteTransformResponse.md)>;` | |
|
||
| `getNodeStats` | `getNodeStats(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Retrieves transform usage information for transform nodes. |
|
||
| `getNodeStats` | `getNodeStats(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` | |
|
||
| `getNodeStats` | `getNodeStats(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` | |
|
||
| `getTransform` | `getTransform(this: [That](./That.md), params?: [TransformGetTransformRequest](./TransformGetTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformGetTransformResponse](./TransformGetTransformResponse.md)>;` | Get transforms. Get configuration information for transforms. |
|
||
| `getTransform` | `getTransform(this: [That](./That.md), params?: [TransformGetTransformRequest](./TransformGetTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformGetTransformResponse](./TransformGetTransformResponse.md), unknown>>;` | |
|
||
| `getTransform` | `getTransform(this: [That](./That.md), params?: [TransformGetTransformRequest](./TransformGetTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformGetTransformResponse](./TransformGetTransformResponse.md)>;` | |
|
||
| `getTransformStats` | `getTransformStats(this: [That](./That.md), params: [TransformGetTransformStatsRequest](./TransformGetTransformStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformGetTransformStatsResponse](./TransformGetTransformStatsResponse.md)>;` | Get transform stats. Get usage information for transforms. |
|
||
| `getTransformStats` | `getTransformStats(this: [That](./That.md), params: [TransformGetTransformStatsRequest](./TransformGetTransformStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformGetTransformStatsResponse](./TransformGetTransformStatsResponse.md), unknown>>;` | |
|
||
| `getTransformStats` | `getTransformStats(this: [That](./That.md), params: [TransformGetTransformStatsRequest](./TransformGetTransformStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformGetTransformStatsResponse](./TransformGetTransformStatsResponse.md)>;` | |
|
||
| `previewTransform` | `previewTransform<TTransform = unknown>(this: [That](./That.md), params?: [TransformPreviewTransformRequest](./TransformPreviewTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformPreviewTransformResponse](./TransformPreviewTransformResponse.md)<TTransform>>;` | Preview a transform. Generates a preview of the results that you will get when you create a transform with the same configuration. It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations. |
|
||
| `previewTransform` | `previewTransform<TTransform = unknown>(this: [That](./That.md), params?: [TransformPreviewTransformRequest](./TransformPreviewTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformPreviewTransformResponse](./TransformPreviewTransformResponse.md)<TTransform>, unknown>>;` | |
|
||
| `previewTransform` | `previewTransform<TTransform = unknown>(this: [That](./That.md), params?: [TransformPreviewTransformRequest](./TransformPreviewTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformPreviewTransformResponse](./TransformPreviewTransformResponse.md)<TTransform>>;` | |
|
||
| `putTransform` | `putTransform(this: [That](./That.md), params: [TransformPutTransformRequest](./TransformPutTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformPutTransformResponse](./TransformPutTransformResponse.md)>;` | Create a transform. Creates a transform. A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a unique row per entity. You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values in the latest object. You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and `view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations. NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any `.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not give users any privileges on `.data-frame-internal*` indices. |
|
||
| `putTransform` | `putTransform(this: [That](./That.md), params: [TransformPutTransformRequest](./TransformPutTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformPutTransformResponse](./TransformPutTransformResponse.md), unknown>>;` | |
|
||
| `putTransform` | `putTransform(this: [That](./That.md), params: [TransformPutTransformRequest](./TransformPutTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformPutTransformResponse](./TransformPutTransformResponse.md)>;` | |
|
||
| `resetTransform` | `resetTransform(this: [That](./That.md), params: [TransformResetTransformRequest](./TransformResetTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformResetTransformResponse](./TransformResetTransformResponse.md)>;` | Reset a transform. Before you can reset it, you must stop it; alternatively, use the `force` query parameter. If the destination index was created by the transform, it is deleted. |
|
||
| `resetTransform` | `resetTransform(this: [That](./That.md), params: [TransformResetTransformRequest](./TransformResetTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformResetTransformResponse](./TransformResetTransformResponse.md), unknown>>;` | |
|
||
| `resetTransform` | `resetTransform(this: [That](./That.md), params: [TransformResetTransformRequest](./TransformResetTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformResetTransformResponse](./TransformResetTransformResponse.md)>;` | |
|
||
| `scheduleNowTransform` | `scheduleNowTransform(this: [That](./That.md), params: [TransformScheduleNowTransformRequest](./TransformScheduleNowTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformScheduleNowTransformResponse](./TransformScheduleNowTransformResponse.md)>;` | Schedule a transform to start now. Instantly run a transform to process data. If you run this API, the transform will process the new data instantly, without waiting for the configured frequency interval. After the API is called, the transform will be processed again at `now + frequency` unless the API is called again in the meantime. |
|
||
| `scheduleNowTransform` | `scheduleNowTransform(this: [That](./That.md), params: [TransformScheduleNowTransformRequest](./TransformScheduleNowTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformScheduleNowTransformResponse](./TransformScheduleNowTransformResponse.md), unknown>>;` | |
|
||
| `scheduleNowTransform` | `scheduleNowTransform(this: [That](./That.md), params: [TransformScheduleNowTransformRequest](./TransformScheduleNowTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformScheduleNowTransformResponse](./TransformScheduleNowTransformResponse.md)>;` | |
|
||
| `startTransform` | `startTransform(this: [That](./That.md), params: [TransformStartTransformRequest](./TransformStartTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformStartTransformResponse](./TransformStartTransformResponse.md)>;` | Start a transform. When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping definitions for the destination index from the source indices and the transform aggregations. If fields in the destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations), the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings in a pivot transform. When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you created the transform, they occur when you start the transform—with the exception of privilege checks. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations. |
|
||
| `startTransform` | `startTransform(this: [That](./That.md), params: [TransformStartTransformRequest](./TransformStartTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformStartTransformResponse](./TransformStartTransformResponse.md), unknown>>;` | |
|
||
| `startTransform` | `startTransform(this: [That](./That.md), params: [TransformStartTransformRequest](./TransformStartTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformStartTransformResponse](./TransformStartTransformResponse.md)>;` | |
|
||
| `stopTransform` | `stopTransform(this: [That](./That.md), params: [TransformStopTransformRequest](./TransformStopTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformStopTransformResponse](./TransformStopTransformResponse.md)>;` | Stop transforms. Stops one or more transforms. |
|
||
| `stopTransform` | `stopTransform(this: [That](./That.md), params: [TransformStopTransformRequest](./TransformStopTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformStopTransformResponse](./TransformStopTransformResponse.md), unknown>>;` | |
|
||
| `stopTransform` | `stopTransform(this: [That](./That.md), params: [TransformStopTransformRequest](./TransformStopTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformStopTransformResponse](./TransformStopTransformResponse.md)>;` | |
|
||
| `updateTransform` | `updateTransform(this: [That](./That.md), params: [TransformUpdateTransformRequest](./TransformUpdateTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformUpdateTransformResponse](./TransformUpdateTransformResponse.md)>;` | Update a transform. Updates certain properties of a transform. All updated properties except `description` do not take effect until after the transform starts the next checkpoint, thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata` privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the time of update and runs with those privileges. |
|
||
| `updateTransform` | `updateTransform(this: [That](./That.md), params: [TransformUpdateTransformRequest](./TransformUpdateTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformUpdateTransformResponse](./TransformUpdateTransformResponse.md), unknown>>;` | |
|
||
| `updateTransform` | `updateTransform(this: [That](./That.md), params: [TransformUpdateTransformRequest](./TransformUpdateTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformUpdateTransformResponse](./TransformUpdateTransformResponse.md)>;` | |
|
||
| `upgradeTransforms` | `upgradeTransforms(this: [That](./That.md), params?: [TransformUpgradeTransformsRequest](./TransformUpgradeTransformsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformUpgradeTransformsResponse](./TransformUpgradeTransformsResponse.md)>;` | Upgrade all transforms. Transforms are compatible across minor versions and between supported major versions. However, over time, the format of transform configuration information may change. This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not affect the source and destination indices. The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. Resolve the issue then re-run the process again. A summary is returned when the upgrade is finished. To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. You may want to perform a recent cluster backup prior to the upgrade. |
|
||
| `upgradeTransforms` | `upgradeTransforms(this: [That](./That.md), params?: [TransformUpgradeTransformsRequest](./TransformUpgradeTransformsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformUpgradeTransformsResponse](./TransformUpgradeTransformsResponse.md), unknown>>;` | |
|
||
| `upgradeTransforms` | `upgradeTransforms(this: [That](./That.md), params?: [TransformUpgradeTransformsRequest](./TransformUpgradeTransformsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformUpgradeTransformsResponse](./TransformUpgradeTransformsResponse.md)>;` | |
|