Auto-generated code for main (#2384)
This commit is contained in:
Elastic Machine
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
kwd: {
|
||||
type: "keyword",
|
||||
@ -3,8 +3,6 @@
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.cluster.reroute({
|
||||
metric: "none",
|
||||
});
|
||||
const response = await client.cluster.reroute();
|
||||
console.log(response);
|
||||
----
|
||||
@ -8,6 +8,7 @@ const response = await client.esql.asyncQuery({
|
||||
body: {
|
||||
query:
|
||||
"\n FROM my-index-000001,cluster_one:my-index-000001,cluster_two:my-index*\n | STATS COUNT(http.response.status_code) BY user.id\n | LIMIT 2\n ",
|
||||
include_ccs_metadata: true,
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
18
docs/doc_examples/0c8be7aec84ea86b243904f5d4162f5a.asciidoc
Normal file
18
docs/doc_examples/0c8be7aec84ea86b243904f5d4162f5a.asciidoc
Normal file
@ -0,0 +1,18 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.search({
|
||||
index: "cooking_blog",
|
||||
query: {
|
||||
match: {
|
||||
title: {
|
||||
query: "fluffy pancakes breakfast",
|
||||
minimum_should_match: 2,
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -9,7 +9,7 @@ const response = await client.connector.put({
|
||||
name: "My Connector",
|
||||
description: "My Connector to sync data to Elastic index from Google Drive",
|
||||
service_type: "google_drive",
|
||||
language: "english",
|
||||
language: "en",
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
21
docs/doc_examples/0e31b8ad176b31028becf9500989bcbd.asciidoc
Normal file
21
docs/doc_examples/0e31b8ad176b31028becf9500989bcbd.asciidoc
Normal file
@ -0,0 +1,21 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.inference.put({
|
||||
task_type: "text_embedding",
|
||||
inference_id: "watsonx-embeddings",
|
||||
inference_config: {
|
||||
service: "watsonxai",
|
||||
service_settings: {
|
||||
api_key: "<api_key>",
|
||||
url: "<url>",
|
||||
model_id: "ibm/slate-30m-english-rtrvr",
|
||||
project_id: "<project_id>",
|
||||
api_version: "2024-03-14",
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
55
docs/doc_examples/191074b2eebd5f74e628c2ada4b6d2e4.asciidoc
Normal file
55
docs/doc_examples/191074b2eebd5f74e628c2ada4b6d2e4.asciidoc
Normal file
@ -0,0 +1,55 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.search({
|
||||
index: "cooking_blog",
|
||||
query: {
|
||||
bool: {
|
||||
must: [
|
||||
{
|
||||
term: {
|
||||
"category.keyword": "Main Course",
|
||||
},
|
||||
},
|
||||
{
|
||||
term: {
|
||||
tags: "vegetarian",
|
||||
},
|
||||
},
|
||||
{
|
||||
range: {
|
||||
rating: {
|
||||
gte: 4.5,
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
should: [
|
||||
{
|
||||
multi_match: {
|
||||
query: "curry spicy",
|
||||
fields: ["title^2", "description"],
|
||||
},
|
||||
},
|
||||
{
|
||||
range: {
|
||||
date: {
|
||||
gte: "now-1M/d",
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
must_not: [
|
||||
{
|
||||
term: {
|
||||
"category.keyword": "Dessert",
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
19
docs/doc_examples/1a7483796087053ba55029d0dc2ab356.asciidoc
Normal file
19
docs/doc_examples/1a7483796087053ba55029d0dc2ab356.asciidoc
Normal file
@ -0,0 +1,19 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.index({
|
||||
index: "mv",
|
||||
refresh: "true",
|
||||
document: {
|
||||
a: [2, null, 1],
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
|
||||
const response1 = await client.esql.query({
|
||||
query: "FROM mv | LIMIT 1",
|
||||
});
|
||||
console.log(response1);
|
||||
----
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
card: {
|
||||
type: "wildcard",
|
||||
77
docs/doc_examples/2c079d1ae4819a0c206b9e1aa5623523.asciidoc
Normal file
77
docs/doc_examples/2c079d1ae4819a0c206b9e1aa5623523.asciidoc
Normal file
@ -0,0 +1,77 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "my-index-000001",
|
||||
mappings: {
|
||||
properties: {
|
||||
attributes: {
|
||||
type: "passthrough",
|
||||
priority: 10,
|
||||
properties: {
|
||||
id: {
|
||||
type: "keyword",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
|
||||
const response1 = await client.index({
|
||||
index: "my-index-000001",
|
||||
id: 1,
|
||||
document: {
|
||||
attributes: {
|
||||
id: "foo",
|
||||
zone: 10,
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response1);
|
||||
|
||||
const response2 = await client.search({
|
||||
index: "my-index-000001",
|
||||
query: {
|
||||
bool: {
|
||||
must: [
|
||||
{
|
||||
match: {
|
||||
id: "foo",
|
||||
},
|
||||
},
|
||||
{
|
||||
match: {
|
||||
zone: 10,
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response2);
|
||||
|
||||
const response3 = await client.search({
|
||||
index: "my-index-000001",
|
||||
query: {
|
||||
bool: {
|
||||
must: [
|
||||
{
|
||||
match: {
|
||||
"attributes.id": "foo",
|
||||
},
|
||||
},
|
||||
{
|
||||
match: {
|
||||
"attributes.zone": 10,
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response3);
|
||||
----
|
||||
@ -29,6 +29,7 @@ const response = await client.indices.create({
|
||||
"arabic_normalization",
|
||||
"persian_normalization",
|
||||
"persian_stop",
|
||||
"persian_stem",
|
||||
],
|
||||
},
|
||||
},
|
||||
16
docs/doc_examples/40f287bf733420bbab134b74c7d0ea5d.asciidoc
Normal file
16
docs/doc_examples/40f287bf733420bbab134b74c7d0ea5d.asciidoc
Normal file
@ -0,0 +1,16 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.index({
|
||||
index: "amazon-reviews",
|
||||
id: 1,
|
||||
document: {
|
||||
review_text:
|
||||
"This product is lifechanging! I'm telling all my friends about it.",
|
||||
review_vector: [0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8],
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
14
docs/doc_examples/4b91ad7c9b44e07db4a4e81390f19ad3.asciidoc
Normal file
14
docs/doc_examples/4b91ad7c9b44e07db4a4e81390f19ad3.asciidoc
Normal file
@ -0,0 +1,14 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.inference.streamInference({
|
||||
task_type: "completion",
|
||||
inference_id: "openai-completion",
|
||||
body: {
|
||||
input: "What is Elastic?",
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
32
docs/doc_examples/55085e6a2891040b6ac696561d0787c8.asciidoc
Normal file
32
docs/doc_examples/55085e6a2891040b6ac696561d0787c8.asciidoc
Normal file
@ -0,0 +1,32 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "my-index-000002",
|
||||
mappings: {
|
||||
properties: {
|
||||
attributes: {
|
||||
type: "passthrough",
|
||||
priority: 10,
|
||||
properties: {
|
||||
id: {
|
||||
type: "keyword",
|
||||
},
|
||||
},
|
||||
},
|
||||
"resource.attributes": {
|
||||
type: "passthrough",
|
||||
priority: 20,
|
||||
properties: {
|
||||
id: {
|
||||
type: "keyword",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
agg_metric: {
|
||||
type: "aggregate_metric_double",
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
my_range: {
|
||||
type: "long_range",
|
||||
18
docs/doc_examples/58dd26afc919722e21358c91e112b27a.asciidoc
Normal file
18
docs/doc_examples/58dd26afc919722e21358c91e112b27a.asciidoc
Normal file
@ -0,0 +1,18 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.search({
|
||||
index: "cooking_blog",
|
||||
query: {
|
||||
range: {
|
||||
date: {
|
||||
gte: "2023-05-01",
|
||||
lte: "2023-05-31",
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
22
docs/doc_examples/5a70db31f587b7ffed5e9bc1445430cb.asciidoc
Normal file
22
docs/doc_examples/5a70db31f587b7ffed5e9bc1445430cb.asciidoc
Normal file
@ -0,0 +1,22 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "semantic-embeddings",
|
||||
mappings: {
|
||||
properties: {
|
||||
semantic_text: {
|
||||
type: "semantic_text",
|
||||
inference_id: "my-elser-endpoint",
|
||||
},
|
||||
content: {
|
||||
type: "text",
|
||||
copy_to: "semantic_text",
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -8,6 +8,7 @@ const response = await client.esql.asyncQuery({
|
||||
body: {
|
||||
query:
|
||||
"\n FROM cluster_one:my-index*,cluster_two:logs*\n | STATS COUNT(http.response.status_code) BY user.id\n | LIMIT 2\n ",
|
||||
include_ccs_metadata: true,
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
23
docs/doc_examples/5ceb734e3affe00e2cdc29af748d95bf.asciidoc
Normal file
23
docs/doc_examples/5ceb734e3affe00e2cdc29af748d95bf.asciidoc
Normal file
@ -0,0 +1,23 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.inference.put({
|
||||
task_type: "sparse_embedding",
|
||||
inference_id: "small_chunk_size",
|
||||
inference_config: {
|
||||
service: "elasticsearch",
|
||||
service_settings: {
|
||||
num_allocations: 1,
|
||||
num_threads: 1,
|
||||
},
|
||||
chunking_settings: {
|
||||
strategy: "sentence",
|
||||
max_chunk_size: 100,
|
||||
sentence_overlap: 0,
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
19
docs/doc_examples/5cf12cc4f98d98dc79bead7e6556679c.asciidoc
Normal file
19
docs/doc_examples/5cf12cc4f98d98dc79bead7e6556679c.asciidoc
Normal file
@ -0,0 +1,19 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
flattened: {
|
||||
type: "flattened",
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
text: {
|
||||
type: "text",
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
versions: {
|
||||
type: "version",
|
||||
@ -4,7 +4,6 @@
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.cluster.reroute({
|
||||
metric: "none",
|
||||
commands: [
|
||||
{
|
||||
allocate_empty_primary: {
|
||||
52
docs/doc_examples/76c73b54f3f1e5cb1c0fcccd7c3fd18e.asciidoc
Normal file
52
docs/doc_examples/76c73b54f3f1e5cb1c0fcccd7c3fd18e.asciidoc
Normal file
@ -0,0 +1,52 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.bulk({
|
||||
operations: [
|
||||
{
|
||||
index: {
|
||||
_index: "amazon-reviews",
|
||||
_id: "2",
|
||||
},
|
||||
},
|
||||
{
|
||||
review_text: "This product is amazing! I love it.",
|
||||
review_vector: [0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8],
|
||||
},
|
||||
{
|
||||
index: {
|
||||
_index: "amazon-reviews",
|
||||
_id: "3",
|
||||
},
|
||||
},
|
||||
{
|
||||
review_text: "This product is terrible. I hate it.",
|
||||
review_vector: [0.8, 0.7, 0.6, 0.5, 0.4, 0.3, 0.2, 0.1],
|
||||
},
|
||||
{
|
||||
index: {
|
||||
_index: "amazon-reviews",
|
||||
_id: "4",
|
||||
},
|
||||
},
|
||||
{
|
||||
review_text: "This product is great. I can do anything with it.",
|
||||
review_vector: [0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8],
|
||||
},
|
||||
{
|
||||
index: {
|
||||
_index: "amazon-reviews",
|
||||
_id: "5",
|
||||
},
|
||||
},
|
||||
{
|
||||
review_text:
|
||||
"This product has ruined my life and the lives of my family and friends.",
|
||||
review_vector: [0.8, 0.7, 0.6, 0.5, 0.4, 0.3, 0.2, 0.1],
|
||||
},
|
||||
],
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
18
docs/doc_examples/77082b1ffaae9ac52dfc133fa597baa7.asciidoc
Normal file
18
docs/doc_examples/77082b1ffaae9ac52dfc133fa597baa7.asciidoc
Normal file
@ -0,0 +1,18 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.search({
|
||||
index: "cooking_blog",
|
||||
query: {
|
||||
match: {
|
||||
description: {
|
||||
query: "fluffy pancakes",
|
||||
operator: "and",
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
49
docs/doc_examples/79ff4e7fa5c004226d05d7e2bfb5dc1e.asciidoc
Normal file
49
docs/doc_examples/79ff4e7fa5c004226d05d7e2bfb5dc1e.asciidoc
Normal file
@ -0,0 +1,49 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.indices.putIndexTemplate({
|
||||
name: "my-metrics",
|
||||
index_patterns: ["metrics-mymetrics-*"],
|
||||
priority: 200,
|
||||
data_stream: {},
|
||||
template: {
|
||||
settings: {
|
||||
"index.mode": "time_series",
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
attributes: {
|
||||
type: "passthrough",
|
||||
priority: 10,
|
||||
time_series_dimension: true,
|
||||
properties: {
|
||||
"host.name": {
|
||||
type: "keyword",
|
||||
},
|
||||
},
|
||||
},
|
||||
cpu: {
|
||||
type: "integer",
|
||||
time_series_metric: "counter",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
|
||||
const response1 = await client.index({
|
||||
index: "metrics-mymetrics-test",
|
||||
document: {
|
||||
"@timestamp": "2020-01-01T00:00:00.000Z",
|
||||
attributes: {
|
||||
"host.name": "foo",
|
||||
zone: "bar",
|
||||
},
|
||||
cpu: 10,
|
||||
},
|
||||
});
|
||||
console.log(response1);
|
||||
----
|
||||
23
docs/doc_examples/7b9691bd34a02dd859562eb927f175e0.asciidoc
Normal file
23
docs/doc_examples/7b9691bd34a02dd859562eb927f175e0.asciidoc
Normal file
@ -0,0 +1,23 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.inference.put({
|
||||
task_type: "sparse_embedding",
|
||||
inference_id: "my-elser-model",
|
||||
inference_config: {
|
||||
service: "elasticsearch",
|
||||
service_settings: {
|
||||
adaptive_allocations: {
|
||||
enabled: true,
|
||||
min_number_of_allocations: 1,
|
||||
max_number_of_allocations: 10,
|
||||
},
|
||||
num_threads: 1,
|
||||
model_id: ".elser_model_2",
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
flattened: {
|
||||
type: "flattened",
|
||||
18
docs/doc_examples/7db09cab02d71f3a10d91071216d80fc.asciidoc
Normal file
18
docs/doc_examples/7db09cab02d71f3a10d91071216d80fc.asciidoc
Normal file
@ -0,0 +1,18 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.search({
|
||||
index: "amazon-reviews",
|
||||
retriever: {
|
||||
knn: {
|
||||
field: "review_vector",
|
||||
query_vector: [0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8],
|
||||
k: 2,
|
||||
num_candidates: 5,
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
17
docs/doc_examples/7db798942cf2d334456e30ef5fcb801b.asciidoc
Normal file
17
docs/doc_examples/7db798942cf2d334456e30ef5fcb801b.asciidoc
Normal file
@ -0,0 +1,17 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.search({
|
||||
index: "cooking_blog",
|
||||
query: {
|
||||
match: {
|
||||
description: {
|
||||
query: "fluffy pancakes",
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -3,9 +3,10 @@
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.indices.putSettings({
|
||||
index: ".watches",
|
||||
settings: {
|
||||
const response = await client.transport.request({
|
||||
method: "PUT",
|
||||
path: "/_watcher/settings",
|
||||
body: {
|
||||
"index.routing.allocation.include.role": "watcher",
|
||||
},
|
||||
});
|
||||
@ -3,9 +3,8 @@
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.snapshot.create({
|
||||
repository: "my_repository",
|
||||
snapshot: "_verify_integrity",
|
||||
const response = await client.snapshot.repositoryVerifyIntegrity({
|
||||
name: "my_repository",
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
|
||||
15
docs/doc_examples/84ef9fe951c6d3caa7438238a5b23319.asciidoc
Normal file
15
docs/doc_examples/84ef9fe951c6d3caa7438238a5b23319.asciidoc
Normal file
@ -0,0 +1,15 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.search({
|
||||
index: "cooking_blog",
|
||||
query: {
|
||||
term: {
|
||||
"author.keyword": "Maria Rodriguez",
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
17
docs/doc_examples/85f9fc6f98e8573efed9b034e853d5ae.asciidoc
Normal file
17
docs/doc_examples/85f9fc6f98e8573efed9b034e853d5ae.asciidoc
Normal file
@ -0,0 +1,17 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.inference.put({
|
||||
task_type: "sparse_embedding",
|
||||
inference_id: "use_existing_deployment",
|
||||
inference_config: {
|
||||
service: "elasticsearch",
|
||||
service_settings: {
|
||||
deployment_id: ".elser_model_2",
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx_keep",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
path: {
|
||||
type: "object",
|
||||
61
docs/doc_examples/8d05862be1f9e7edaba162b1888b5677.asciidoc
Normal file
61
docs/doc_examples/8d05862be1f9e7edaba162b1888b5677.asciidoc
Normal file
@ -0,0 +1,61 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.indices.putMapping({
|
||||
index: "cooking_blog",
|
||||
properties: {
|
||||
title: {
|
||||
type: "text",
|
||||
analyzer: "standard",
|
||||
fields: {
|
||||
keyword: {
|
||||
type: "keyword",
|
||||
ignore_above: 256,
|
||||
},
|
||||
},
|
||||
},
|
||||
description: {
|
||||
type: "text",
|
||||
fields: {
|
||||
keyword: {
|
||||
type: "keyword",
|
||||
},
|
||||
},
|
||||
},
|
||||
author: {
|
||||
type: "text",
|
||||
fields: {
|
||||
keyword: {
|
||||
type: "keyword",
|
||||
},
|
||||
},
|
||||
},
|
||||
date: {
|
||||
type: "date",
|
||||
format: "yyyy-MM-dd",
|
||||
},
|
||||
category: {
|
||||
type: "text",
|
||||
fields: {
|
||||
keyword: {
|
||||
type: "keyword",
|
||||
},
|
||||
},
|
||||
},
|
||||
tags: {
|
||||
type: "text",
|
||||
fields: {
|
||||
keyword: {
|
||||
type: "keyword",
|
||||
},
|
||||
},
|
||||
},
|
||||
rating: {
|
||||
type: "float",
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
35
docs/doc_examples/9ad0864bcd665b63551e944653d32423.asciidoc
Normal file
35
docs/doc_examples/9ad0864bcd665b63551e944653d32423.asciidoc
Normal file
@ -0,0 +1,35 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.search({
|
||||
index: "semantic-embeddings",
|
||||
retriever: {
|
||||
rrf: {
|
||||
retrievers: [
|
||||
{
|
||||
standard: {
|
||||
query: {
|
||||
match: {
|
||||
content: "How to avoid muscle soreness while running?",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
standard: {
|
||||
query: {
|
||||
semantic: {
|
||||
field: "semantic_text",
|
||||
query: "How to avoid muscle soreness while running?",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -4,7 +4,6 @@
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.cluster.reroute({
|
||||
metric: "none",
|
||||
commands: [
|
||||
{
|
||||
move: {
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
flattened: {
|
||||
type: "flattened",
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
my_range: {
|
||||
type: "long_range",
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
date: {
|
||||
type: "date_nanos",
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
bool: {
|
||||
type: "boolean",
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
my_range: {
|
||||
type: "integer_range",
|
||||
21
docs/doc_examples/aab810de3314d5e11bd564ea096785b8.asciidoc
Normal file
21
docs/doc_examples/aab810de3314d5e11bd564ea096785b8.asciidoc
Normal file
@ -0,0 +1,21 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.search({
|
||||
index: "cooking_blog",
|
||||
query: {
|
||||
bool: {
|
||||
filter: [
|
||||
{
|
||||
term: {
|
||||
"category.keyword": "Breakfast",
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
f: {
|
||||
type: "scaled_float",
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
my_range: {
|
||||
type: "date_range",
|
||||
16
docs/doc_examples/add82cbe7cd95c4be5ce1c9958f2f208.asciidoc
Normal file
16
docs/doc_examples/add82cbe7cd95c4be5ce1c9958f2f208.asciidoc
Normal file
@ -0,0 +1,16 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.search({
|
||||
index: "cooking_blog",
|
||||
query: {
|
||||
multi_match: {
|
||||
query: "vegetarian curry",
|
||||
fields: ["title^3", "description^2", "tags"],
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
point: {
|
||||
type: "geo_point",
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
long: {
|
||||
type: "long",
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
binary: {
|
||||
type: "binary",
|
||||
17
docs/doc_examples/b9ba66209b7fcc111a7bcef0b3e00052.asciidoc
Normal file
17
docs/doc_examples/b9ba66209b7fcc111a7bcef0b3e00052.asciidoc
Normal file
@ -0,0 +1,17 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.index({
|
||||
index: "my-index-000001",
|
||||
id: 1,
|
||||
document: {
|
||||
attributes: {
|
||||
id: "foo",
|
||||
},
|
||||
id: "bar",
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
date: {
|
||||
type: "date",
|
||||
88
docs/doc_examples/bb5a67e3d2d9cd3016e487e627769fe8.asciidoc
Normal file
88
docs/doc_examples/bb5a67e3d2d9cd3016e487e627769fe8.asciidoc
Normal file
@ -0,0 +1,88 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.bulk({
|
||||
index: "cooking_blog",
|
||||
refresh: "wait_for",
|
||||
operations: [
|
||||
{
|
||||
index: {
|
||||
_id: "1",
|
||||
},
|
||||
},
|
||||
{
|
||||
title: "Perfect Pancakes: A Fluffy Breakfast Delight",
|
||||
description:
|
||||
"Learn the secrets to making the fluffiest pancakes, so amazing you won't believe your tastebuds. This recipe uses buttermilk and a special folding technique to create light, airy pancakes that are perfect for lazy Sunday mornings.",
|
||||
author: "Maria Rodriguez",
|
||||
date: "2023-05-01",
|
||||
category: "Breakfast",
|
||||
tags: ["pancakes", "breakfast", "easy recipes"],
|
||||
rating: 4.8,
|
||||
},
|
||||
{
|
||||
index: {
|
||||
_id: "2",
|
||||
},
|
||||
},
|
||||
{
|
||||
title: "Spicy Thai Green Curry: A Vegetarian Adventure",
|
||||
description:
|
||||
"Dive into the flavors of Thailand with this vibrant green curry. Packed with vegetables and aromatic herbs, this dish is both healthy and satisfying. Don't worry about the heat - you can easily adjust the spice level to your liking.",
|
||||
author: "Liam Chen",
|
||||
date: "2023-05-05",
|
||||
category: "Main Course",
|
||||
tags: ["thai", "vegetarian", "curry", "spicy"],
|
||||
rating: 4.6,
|
||||
},
|
||||
{
|
||||
index: {
|
||||
_id: "3",
|
||||
},
|
||||
},
|
||||
{
|
||||
title: "Classic Beef Stroganoff: A Creamy Comfort Food",
|
||||
description:
|
||||
"Indulge in this rich and creamy beef stroganoff. Tender strips of beef in a savory mushroom sauce, served over a bed of egg noodles. It's the ultimate comfort food for chilly evenings.",
|
||||
author: "Emma Watson",
|
||||
date: "2023-05-10",
|
||||
category: "Main Course",
|
||||
tags: ["beef", "pasta", "comfort food"],
|
||||
rating: 4.7,
|
||||
},
|
||||
{
|
||||
index: {
|
||||
_id: "4",
|
||||
},
|
||||
},
|
||||
{
|
||||
title: "Vegan Chocolate Avocado Mousse",
|
||||
description:
|
||||
"Discover the magic of avocado in this rich, vegan chocolate mousse. Creamy, indulgent, and secretly healthy, it's the perfect guilt-free dessert for chocolate lovers.",
|
||||
author: "Alex Green",
|
||||
date: "2023-05-15",
|
||||
category: "Dessert",
|
||||
tags: ["vegan", "chocolate", "avocado", "healthy dessert"],
|
||||
rating: 4.5,
|
||||
},
|
||||
{
|
||||
index: {
|
||||
_id: "5",
|
||||
},
|
||||
},
|
||||
{
|
||||
title: "Crispy Oven-Fried Chicken",
|
||||
description:
|
||||
"Get that perfect crunch without the deep fryer! This oven-fried chicken recipe delivers crispy, juicy results every time. A healthier take on the classic comfort food.",
|
||||
author: "Maria Rodriguez",
|
||||
date: "2023-05-20",
|
||||
category: "Main Course",
|
||||
tags: ["chicken", "oven-fried", "healthy"],
|
||||
rating: 4.9,
|
||||
},
|
||||
],
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
16
docs/doc_examples/bc01aee2ab2ce1690986374bd836e1c7.asciidoc
Normal file
16
docs/doc_examples/bc01aee2ab2ce1690986374bd836e1c7.asciidoc
Normal file
@ -0,0 +1,16 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.search({
|
||||
index: "cooking_blog",
|
||||
query: {
|
||||
multi_match: {
|
||||
query: "vegetarian curry",
|
||||
fields: ["title", "description", "tags"],
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
kwd: {
|
||||
type: "keyword",
|
||||
37
docs/doc_examples/befa73a8a419fcf3b7798548b54a20bf.asciidoc
Normal file
37
docs/doc_examples/befa73a8a419fcf3b7798548b54a20bf.asciidoc
Normal file
@ -0,0 +1,37 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.search({
|
||||
index: "my-index",
|
||||
size: 10,
|
||||
knn: {
|
||||
query_vector: [0.04283529, 0.85670587, -0.51402352, 0],
|
||||
field: "my_int4_vector",
|
||||
k: 20,
|
||||
num_candidates: 50,
|
||||
},
|
||||
rescore: {
|
||||
window_size: 20,
|
||||
query: {
|
||||
rescore_query: {
|
||||
script_score: {
|
||||
query: {
|
||||
match_all: {},
|
||||
},
|
||||
script: {
|
||||
source: "(dotProduct(params.queryVector, 'my_int4_vector') + 1.0)",
|
||||
params: {
|
||||
queryVector: [0.04283529, 0.85670587, -0.51402352, 0],
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
query_weight: 0,
|
||||
rescore_query_weight: 1,
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
ip: {
|
||||
type: "ip",
|
||||
23
docs/doc_examples/c8aa8e8c0ac160b8c4efd1ac3b9f48f3.asciidoc
Normal file
23
docs/doc_examples/c8aa8e8c0ac160b8c4efd1ac3b9f48f3.asciidoc
Normal file
@ -0,0 +1,23 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "amazon-reviews",
|
||||
mappings: {
|
||||
properties: {
|
||||
review_vector: {
|
||||
type: "dense_vector",
|
||||
dims: 8,
|
||||
index: true,
|
||||
similarity: "cosine",
|
||||
},
|
||||
review_text: {
|
||||
type: "text",
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -52,6 +52,20 @@ const response = await client.simulate.ingest({
|
||||
},
|
||||
},
|
||||
},
|
||||
index_template_substitutions: {
|
||||
"my-index-template": {
|
||||
index_patterns: ["my-index-*"],
|
||||
composed_of: ["component_template_1", "component_template_2"],
|
||||
},
|
||||
},
|
||||
mapping_addition: {
|
||||
dynamic: "strict",
|
||||
properties: {
|
||||
foo: {
|
||||
type: "keyword",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
28
docs/doc_examples/dcf82f3aacae49c0bb4ccbc673f13e9f.asciidoc
Normal file
28
docs/doc_examples/dcf82f3aacae49c0bb4ccbc673f13e9f.asciidoc
Normal file
@ -0,0 +1,28 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.search({
|
||||
index: "my-index",
|
||||
size: 10,
|
||||
query: {
|
||||
script_score: {
|
||||
query: {
|
||||
knn: {
|
||||
query_vector: [0.04283529, 0.85670587, -0.51402352, 0],
|
||||
field: "my_int4_vector",
|
||||
num_candidates: 20,
|
||||
},
|
||||
},
|
||||
script: {
|
||||
source: "(dotProduct(params.queryVector, 'my_int4_vector') + 1.0)",
|
||||
params: {
|
||||
queryVector: [0.04283529, 0.85670587, -0.51402352, 0],
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
14
docs/doc_examples/ddaadd91b7743a1c7e946ce1b593cd1b.asciidoc
Normal file
14
docs/doc_examples/ddaadd91b7743a1c7e946ce1b593cd1b.asciidoc
Normal file
@ -0,0 +1,14 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.inference.inference({
|
||||
task_type: "my-inference-endpoint",
|
||||
inference_id: "_update",
|
||||
service_settings: {
|
||||
api_key: "<API_KEY>",
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
22
docs/doc_examples/f1bf0c03581b79c3324cfa3246a60e4d.asciidoc
Normal file
22
docs/doc_examples/f1bf0c03581b79c3324cfa3246a60e4d.asciidoc
Normal file
@ -0,0 +1,22 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "my-byte-quantized-index",
|
||||
mappings: {
|
||||
properties: {
|
||||
my_vector: {
|
||||
type: "dense_vector",
|
||||
dims: 64,
|
||||
index: true,
|
||||
index_options: {
|
||||
type: "bbq_hnsw",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -4,12 +4,7 @@
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
index: "cooking_blog",
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -5,7 +5,7 @@
|
||||
----
|
||||
const response = await client.cat.mlTrainedModels({
|
||||
h: "c,o,l,ct,v",
|
||||
v: "ture",
|
||||
v: "true",
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
text: {
|
||||
type: "text",
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
kwd: {
|
||||
type: "keyword",
|
||||
@ -5,10 +5,16 @@
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "idx",
|
||||
mappings: {
|
||||
_source: {
|
||||
mode: "synthetic",
|
||||
settings: {
|
||||
index: {
|
||||
mapping: {
|
||||
source: {
|
||||
mode: "synthetic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
my_range: {
|
||||
type: "ip_range",
|
||||
File diff suppressed because it is too large
Load Diff
@ -45,7 +45,7 @@ export default class AsyncSearch {
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes an async search by identifier. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.
|
||||
* Delete an async search. If the asynchronous search is still running, it is cancelled. Otherwise, the saved search results are deleted. If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async delete (this: That, params: T.AsyncSearchDeleteRequest | TB.AsyncSearchDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.AsyncSearchDeleteResponse>
|
||||
@ -77,7 +77,7 @@ export default class AsyncSearch {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the results of a previously submitted async search request given its identifier. If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.
|
||||
* Get async search results. Retrieve the results of a previously submitted asynchronous search request. If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async get<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params: T.AsyncSearchGetRequest | TB.AsyncSearchGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.AsyncSearchGetResponse<TDocument, TAggregations>>
|
||||
@ -109,7 +109,7 @@ export default class AsyncSearch {
|
||||
}
|
||||
|
||||
/**
|
||||
* Get async search status Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.
|
||||
* Get async search status. Retrieve the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async status (this: That, params: T.AsyncSearchStatusRequest | TB.AsyncSearchStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.AsyncSearchStatusResponse>
|
||||
@ -141,7 +141,7 @@ export default class AsyncSearch {
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs a search request asynchronously. When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. Warning: Async search does not support scroll nor search requests that only include the suggest section. By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.
|
||||
* Run an async search. When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async submit<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params?: T.AsyncSearchSubmitRequest | TB.AsyncSearchSubmitRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.AsyncSearchSubmitResponse<TDocument, TAggregations>>
|
||||
|
||||
@ -85,7 +85,7 @@ export default class Ccr {
|
||||
async follow (this: That, params: T.CcrFollowRequest | TB.CcrFollowRequest, options?: TransportRequestOptions): Promise<T.CcrFollowResponse>
|
||||
async follow (this: That, params: T.CcrFollowRequest | TB.CcrFollowRequest, options?: TransportRequestOptions): Promise<any> {
|
||||
const acceptedPath: string[] = ['index']
|
||||
const acceptedBody: string[] = ['leader_index', 'max_outstanding_read_requests', 'max_outstanding_write_requests', 'max_read_request_operation_count', 'max_read_request_size', 'max_retry_delay', 'max_write_buffer_count', 'max_write_buffer_size', 'max_write_request_operation_count', 'max_write_request_size', 'read_poll_timeout', 'remote_cluster']
|
||||
const acceptedBody: string[] = ['data_stream_name', 'leader_index', 'max_outstanding_read_requests', 'max_outstanding_write_requests', 'max_read_request_operation_count', 'max_read_request_size', 'max_retry_delay', 'max_write_buffer_count', 'max_write_buffer_size', 'max_write_request_operation_count', 'max_write_request_size', 'read_poll_timeout', 'remote_cluster', 'settings']
|
||||
const querystring: Record<string, any> = {}
|
||||
// @ts-expect-error
|
||||
const userBody: any = params?.body
|
||||
|
||||
@ -45,7 +45,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the last_seen field in the connector, and sets it to current timestamp
|
||||
* Check in a connector. Update the `last_seen` field in the connector and set it to the current timestamp.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/check-in-connector-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async checkIn (this: That, params: T.ConnectorCheckInRequest | TB.ConnectorCheckInRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorCheckInResponse>
|
||||
@ -77,7 +77,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes a connector.
|
||||
* Delete a connector. Removes a connector and associated sync jobs. This is a destructive action that is not recoverable. NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector. These need to be removed manually.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-connector-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async delete (this: That, params: T.ConnectorDeleteRequest | TB.ConnectorDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorDeleteResponse>
|
||||
@ -109,7 +109,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves a connector.
|
||||
* Get a connector. Get the details about a connector.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-connector-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async get (this: That, params: T.ConnectorGetRequest | TB.ConnectorGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorGetResponse>
|
||||
@ -141,7 +141,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates last sync stats in the connector document
|
||||
* Update the connector last sync stats. Update the fields related to the last sync of a connector. This action is used for analytics and monitoring.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-last-sync-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async lastSync (this: That, params: T.ConnectorLastSyncRequest | TB.ConnectorLastSyncRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorLastSyncResponse>
|
||||
@ -185,7 +185,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns existing connectors.
|
||||
* Get all connectors. Get information about all connectors.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/list-connector-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async list (this: That, params?: T.ConnectorListRequest | TB.ConnectorListRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorListResponse>
|
||||
@ -215,7 +215,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a connector.
|
||||
* Create a connector. Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. Self-managed connectors (Connector clients) are self-managed on your infrastructure.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async post (this: That, params?: T.ConnectorPostRequest | TB.ConnectorPostRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorPostResponse>
|
||||
@ -257,7 +257,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates or updates a connector.
|
||||
* Create or update a connector.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async put (this: That, params?: T.ConnectorPutRequest | TB.ConnectorPutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorPutResponse>
|
||||
@ -430,7 +430,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Cancels a connector sync job.
|
||||
* Cancel a connector sync job. Cancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time. The connector service is then responsible for setting the status of connector sync jobs to cancelled.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cancel-connector-sync-job-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async syncJobCancel (this: That, params: T.ConnectorSyncJobCancelRequest | TB.ConnectorSyncJobCancelRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSyncJobCancelResponse>
|
||||
@ -526,7 +526,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes a connector sync job.
|
||||
* Delete a connector sync job. Remove a connector sync job and its associated data. This is a destructive action that is not recoverable.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-connector-sync-job-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async syncJobDelete (this: That, params: T.ConnectorSyncJobDeleteRequest | TB.ConnectorSyncJobDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSyncJobDeleteResponse>
|
||||
@ -590,7 +590,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves a connector sync job.
|
||||
* Get a connector sync job.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-connector-sync-job-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async syncJobGet (this: That, params: T.ConnectorSyncJobGetRequest | TB.ConnectorSyncJobGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSyncJobGetResponse>
|
||||
@ -622,7 +622,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Lists connector sync jobs.
|
||||
* Get all connector sync jobs. Get information about all stored connector sync jobs listed by their creation date in ascending order.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/list-connector-sync-jobs-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async syncJobList (this: That, params?: T.ConnectorSyncJobListRequest | TB.ConnectorSyncJobListRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSyncJobListResponse>
|
||||
@ -652,7 +652,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a connector sync job.
|
||||
* Create a connector sync job. Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-sync-job-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async syncJobPost (this: That, params: T.ConnectorSyncJobPostRequest | TB.ConnectorSyncJobPostRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSyncJobPostResponse>
|
||||
@ -725,7 +725,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Activates the valid draft filtering for a connector.
|
||||
* Activate the connector draft filter. Activates the valid draft filtering for a connector.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-filtering-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async updateActiveFiltering (this: That, params: T.ConnectorUpdateActiveFilteringRequest | TB.ConnectorUpdateActiveFilteringRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateActiveFilteringResponse>
|
||||
@ -757,7 +757,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the API key id in the connector document
|
||||
* Update the connector API key ID. Update the `api_key_id` and `api_key_secret_id` fields of a connector. You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. The connector secret ID is required only for Elastic managed (native) connectors. Self-managed connectors (connector clients) do not use this field.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-api-key-id-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async updateApiKeyId (this: That, params: T.ConnectorUpdateApiKeyIdRequest | TB.ConnectorUpdateApiKeyIdRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateApiKeyIdResponse>
|
||||
@ -801,7 +801,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the configuration field in the connector document
|
||||
* Update the connector configuration. Update the configuration field in the connector document.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-configuration-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async updateConfiguration (this: That, params: T.ConnectorUpdateConfigurationRequest | TB.ConnectorUpdateConfigurationRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateConfigurationResponse>
|
||||
@ -845,7 +845,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the filtering field in the connector document
|
||||
* Update the connector error field. Set the error field for the connector. If the error provided in the request body is non-null, the connector’s status is updated to error. Otherwise, if the error is reset to null, the connector status is updated to connected.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-error-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async updateError (this: That, params: T.ConnectorUpdateErrorRequest | TB.ConnectorUpdateErrorRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateErrorResponse>
|
||||
@ -921,7 +921,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the filtering field in the connector document
|
||||
* Update the connector filtering. Update the draft filtering configuration of a connector and marks the draft validation state as edited. The filtering draft is activated once validated by the running Elastic connector service. The filtering property is used to configure sync rules (both basic and advanced) for a connector.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-filtering-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async updateFiltering (this: That, params: T.ConnectorUpdateFilteringRequest | TB.ConnectorUpdateFilteringRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateFilteringResponse>
|
||||
@ -965,7 +965,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the draft filtering validation info for a connector.
|
||||
* Update the connector draft filtering validation. Update the draft filtering validation info for a connector.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-filtering-validation-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async updateFilteringValidation (this: That, params: T.ConnectorUpdateFilteringValidationRequest | TB.ConnectorUpdateFilteringValidationRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateFilteringValidationResponse>
|
||||
@ -1009,7 +1009,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the index_name in the connector document
|
||||
* Update the connector index name. Update the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-index-name-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async updateIndexName (this: That, params: T.ConnectorUpdateIndexNameRequest | TB.ConnectorUpdateIndexNameRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateIndexNameResponse>
|
||||
@ -1053,7 +1053,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the name and description fields in the connector document
|
||||
* Update the connector name and description.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-name-description-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async updateName (this: That, params: T.ConnectorUpdateNameRequest | TB.ConnectorUpdateNameRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateNameResponse>
|
||||
@ -1097,7 +1097,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the is_native flag in the connector document
|
||||
* Update the connector is_native flag.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-native-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async updateNative (this: That, params: T.ConnectorUpdateNativeRequest | TB.ConnectorUpdateNativeRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateNativeResponse>
|
||||
@ -1141,7 +1141,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the pipeline field in the connector document
|
||||
* Update the connector pipeline. When you create a new connector, the configuration of an ingest pipeline is populated with default settings.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-pipeline-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async updatePipeline (this: That, params: T.ConnectorUpdatePipelineRequest | TB.ConnectorUpdatePipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdatePipelineResponse>
|
||||
@ -1185,7 +1185,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the scheduling field in the connector document
|
||||
* Update the connector scheduling.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-scheduling-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async updateScheduling (this: That, params: T.ConnectorUpdateSchedulingRequest | TB.ConnectorUpdateSchedulingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateSchedulingResponse>
|
||||
@ -1229,7 +1229,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the service type of the connector
|
||||
* Update the connector service type.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-service-type-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async updateServiceType (this: That, params: T.ConnectorUpdateServiceTypeRequest | TB.ConnectorUpdateServiceTypeRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateServiceTypeResponse>
|
||||
@ -1273,7 +1273,7 @@ export default class Connector {
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the status of the connector
|
||||
* Update the connector status.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-status-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async updateStatus (this: That, params: T.ConnectorUpdateStatusRequest | TB.ConnectorUpdateStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateStatusResponse>
|
||||
|
||||
@ -45,7 +45,7 @@ export default class DanglingIndices {
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes the specified dangling index
|
||||
* Delete a dangling index. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async deleteDanglingIndex (this: That, params: T.DanglingIndicesDeleteDanglingIndexRequest | TB.DanglingIndicesDeleteDanglingIndexRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.DanglingIndicesDeleteDanglingIndexResponse>
|
||||
@ -77,7 +77,7 @@ export default class DanglingIndices {
|
||||
}
|
||||
|
||||
/**
|
||||
* Imports the specified dangling index
|
||||
* Import a dangling index. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async importDanglingIndex (this: That, params: T.DanglingIndicesImportDanglingIndexRequest | TB.DanglingIndicesImportDanglingIndexRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.DanglingIndicesImportDanglingIndexResponse>
|
||||
@ -109,7 +109,7 @@ export default class DanglingIndices {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns all dangling indices.
|
||||
* Get the dangling indices. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. Use this API to list dangling indices, which you can then import or delete.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async listDanglingIndices (this: That, params?: T.DanglingIndicesListDanglingIndicesRequest | TB.DanglingIndicesListDanglingIndicesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.DanglingIndicesListDanglingIndicesResponse>
|
||||
|
||||
@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
|
||||
interface That { transport: Transport }
|
||||
|
||||
/**
|
||||
* Changes the number of requests per second for a particular Delete By Query operation.
|
||||
* Throttle a delete by query operation. Change the number of requests per second for a particular delete by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html | Elasticsearch API documentation}
|
||||
*/
|
||||
export default async function DeleteByQueryRethrottleApi (this: That, params: T.DeleteByQueryRethrottleRequest | TB.DeleteByQueryRethrottleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.DeleteByQueryRethrottleResponse>
|
||||
|
||||
@ -149,7 +149,7 @@ export default class Eql {
|
||||
async search<TEvent = unknown> (this: That, params: T.EqlSearchRequest | TB.EqlSearchRequest, options?: TransportRequestOptions): Promise<T.EqlSearchResponse<TEvent>>
|
||||
async search<TEvent = unknown> (this: That, params: T.EqlSearchRequest | TB.EqlSearchRequest, options?: TransportRequestOptions): Promise<any> {
|
||||
const acceptedPath: string[] = ['index']
|
||||
const acceptedBody: string[] = ['query', 'case_sensitive', 'event_category_field', 'tiebreaker_field', 'timestamp_field', 'fetch_size', 'filter', 'keep_alive', 'keep_on_completion', 'wait_for_completion_timeout', 'size', 'fields', 'result_position', 'runtime_mappings']
|
||||
const acceptedBody: string[] = ['query', 'case_sensitive', 'event_category_field', 'tiebreaker_field', 'timestamp_field', 'fetch_size', 'filter', 'keep_alive', 'keep_on_completion', 'wait_for_completion_timeout', 'size', 'fields', 'result_position', 'runtime_mappings', 'max_samples_per_key']
|
||||
const querystring: Record<string, any> = {}
|
||||
// @ts-expect-error
|
||||
const userBody: any = params?.body
|
||||
|
||||
@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
|
||||
interface That { transport: Transport }
|
||||
|
||||
/**
|
||||
* Returns all script contexts.
|
||||
* Get script contexts. Get a list of supported script contexts and their methods.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html | Elasticsearch API documentation}
|
||||
*/
|
||||
export default async function GetScriptContextApi (this: That, params?: T.GetScriptContextRequest | TB.GetScriptContextRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.GetScriptContextResponse>
|
||||
|
||||
@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
|
||||
interface That { transport: Transport }
|
||||
|
||||
/**
|
||||
* Returns available script types, languages and contexts
|
||||
* Get script languages. Get a list of available script types, languages, and contexts.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html | Elasticsearch API documentation}
|
||||
*/
|
||||
export default async function GetScriptLanguagesApi (this: That, params?: T.GetScriptLanguagesRequest | TB.GetScriptLanguagesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.GetScriptLanguagesResponse>
|
||||
|
||||
@ -78,7 +78,7 @@ export default class Indices {
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs analysis on a text string and returns the resulting tokens.
|
||||
* Get tokens from text analysis. The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async analyze (this: That, params?: T.IndicesAnalyzeRequest | TB.IndicesAnalyzeRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesAnalyzeResponse>
|
||||
@ -1468,22 +1468,15 @@ export default class Indices {
|
||||
async putDataLifecycle (this: That, params: T.IndicesPutDataLifecycleRequest | TB.IndicesPutDataLifecycleRequest, options?: TransportRequestOptions): Promise<T.IndicesPutDataLifecycleResponse>
|
||||
async putDataLifecycle (this: That, params: T.IndicesPutDataLifecycleRequest | TB.IndicesPutDataLifecycleRequest, options?: TransportRequestOptions): Promise<any> {
|
||||
const acceptedPath: string[] = ['name']
|
||||
const acceptedBody: string[] = ['data_retention', 'downsampling']
|
||||
const acceptedBody: string[] = ['lifecycle']
|
||||
const querystring: Record<string, any> = {}
|
||||
// @ts-expect-error
|
||||
const userBody: any = params?.body
|
||||
let body: Record<string, any> | string
|
||||
if (typeof userBody === 'string') {
|
||||
body = userBody
|
||||
} else {
|
||||
body = userBody != null ? { ...userBody } : undefined
|
||||
}
|
||||
let body: any = params.body ?? undefined
|
||||
|
||||
for (const key in params) {
|
||||
if (acceptedBody.includes(key)) {
|
||||
body = body ?? {}
|
||||
// @ts-expect-error
|
||||
body[key] = params[key]
|
||||
body = params[key]
|
||||
} else if (acceptedPath.includes(key)) {
|
||||
continue
|
||||
} else if (key !== 'body') {
|
||||
|
||||
@ -224,4 +224,44 @@ export default class Inference {
|
||||
}
|
||||
return await this.transport.request({ path, method, querystring, body, meta }, options)
|
||||
}
|
||||
|
||||
/**
|
||||
* Perform streaming inference
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/post-stream-inference-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async streamInference (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
|
||||
async streamInference (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
|
||||
async streamInference (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
|
||||
async streamInference (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
|
||||
const acceptedPath: string[] = ['inference_id', 'task_type']
|
||||
const querystring: Record<string, any> = {}
|
||||
const body = undefined
|
||||
|
||||
params = params ?? {}
|
||||
for (const key in params) {
|
||||
if (acceptedPath.includes(key)) {
|
||||
continue
|
||||
} else if (key !== 'body') {
|
||||
querystring[key] = params[key]
|
||||
}
|
||||
}
|
||||
|
||||
let method = ''
|
||||
let path = ''
|
||||
if (params.task_type != null && params.inference_id != null) {
|
||||
method = 'POST'
|
||||
path = `/_inference/${encodeURIComponent(params.task_type.toString())}/${encodeURIComponent(params.inference_id.toString())}/_stream`
|
||||
} else {
|
||||
method = 'POST'
|
||||
path = `/_inference/${encodeURIComponent(params.inference_id.toString())}/_stream`
|
||||
}
|
||||
const meta: TransportRequestMetadata = {
|
||||
name: 'inference.stream_inference',
|
||||
pathParts: {
|
||||
inference_id: params.inference_id,
|
||||
task_type: params.task_type
|
||||
}
|
||||
}
|
||||
return await this.transport.request({ path, method, querystring, body, meta }, options)
|
||||
}
|
||||
}
|
||||
|
||||
@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
|
||||
interface That { transport: Transport }
|
||||
|
||||
/**
|
||||
* Allows to get multiple documents in one request.
|
||||
* Get multiple documents. Get multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the request body. To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html | Elasticsearch API documentation}
|
||||
*/
|
||||
export default async function MgetApi<TDocument = unknown> (this: That, params?: T.MgetRequest | TB.MgetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MgetResponse<TDocument>>
|
||||
|
||||
@ -1989,7 +1989,7 @@ export default class Ml {
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a datafeed. Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. You can associate only one datafeed with each anomaly detection job. The datafeed contains a query that runs at a defined interval (`frequency`). If you are concerned about delayed data, you can add a delay (`query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.
|
||||
* Create a datafeed. Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. You can associate only one datafeed with each anomaly detection job. The datafeed contains a query that runs at a defined interval (`frequency`). If you are concerned about delayed data, you can add a delay (`query_delay`) at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-put-datafeed.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async putDatafeed (this: That, params: T.MlPutDatafeedRequest | TB.MlPutDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlPutDatafeedResponse>
|
||||
|
||||
@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
|
||||
interface That { transport: Transport }
|
||||
|
||||
/**
|
||||
* Allows to execute several search operations in one request.
|
||||
* Run multiple searches. The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. The structure is as follows: ``` header\n body\n header\n body\n ``` This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. IMPORTANT: The final line of data must end with a newline character `\n`. Each newline character may be preceded by a carriage return `\r`. When sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html | Elasticsearch API documentation}
|
||||
*/
|
||||
export default async function MsearchApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params: T.MsearchRequest | TB.MsearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MsearchResponse<TDocument, TAggregations>>
|
||||
|
||||
@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
|
||||
interface That { transport: Transport }
|
||||
|
||||
/**
|
||||
* Returns multiple termvectors in one request.
|
||||
* Get multiple term vectors. You can specify existing documents by index and ID or provide artificial documents in the body of the request. You can specify the index in the request body or request URI. The response contains a `docs` array with all the fetched termvectors. Each element has the structure provided by the termvectors API.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html | Elasticsearch API documentation}
|
||||
*/
|
||||
export default async function MtermvectorsApi (this: That, params?: T.MtermvectorsRequest | TB.MtermvectorsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MtermvectorsResponse>
|
||||
|
||||
@ -292,4 +292,48 @@ export default class QueryRules {
|
||||
}
|
||||
return await this.transport.request({ path, method, querystring, body, meta }, options)
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates or updates a query ruleset.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/test-query-ruleset.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async test (this: That, params: T.QueryRulesTestRequest | TB.QueryRulesTestRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesTestResponse>
|
||||
async test (this: That, params: T.QueryRulesTestRequest | TB.QueryRulesTestRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesTestResponse, unknown>>
|
||||
async test (this: That, params: T.QueryRulesTestRequest | TB.QueryRulesTestRequest, options?: TransportRequestOptions): Promise<T.QueryRulesTestResponse>
|
||||
async test (this: That, params: T.QueryRulesTestRequest | TB.QueryRulesTestRequest, options?: TransportRequestOptions): Promise<any> {
|
||||
const acceptedPath: string[] = ['ruleset_id']
|
||||
const acceptedBody: string[] = ['match_criteria']
|
||||
const querystring: Record<string, any> = {}
|
||||
// @ts-expect-error
|
||||
const userBody: any = params?.body
|
||||
let body: Record<string, any> | string
|
||||
if (typeof userBody === 'string') {
|
||||
body = userBody
|
||||
} else {
|
||||
body = userBody != null ? { ...userBody } : undefined
|
||||
}
|
||||
|
||||
for (const key in params) {
|
||||
if (acceptedBody.includes(key)) {
|
||||
body = body ?? {}
|
||||
// @ts-expect-error
|
||||
body[key] = params[key]
|
||||
} else if (acceptedPath.includes(key)) {
|
||||
continue
|
||||
} else if (key !== 'body') {
|
||||
// @ts-expect-error
|
||||
querystring[key] = params[key]
|
||||
}
|
||||
}
|
||||
|
||||
const method = 'POST'
|
||||
const path = `/_query_rules/${encodeURIComponent(params.ruleset_id.toString())}/_test`
|
||||
const meta: TransportRequestMetadata = {
|
||||
name: 'query_rules.test',
|
||||
pathParts: {
|
||||
ruleset_id: params.ruleset_id
|
||||
}
|
||||
}
|
||||
return await this.transport.request({ path, method, querystring, body, meta }, options)
|
||||
}
|
||||
}
|
||||
|
||||
@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
|
||||
interface That { transport: Transport }
|
||||
|
||||
/**
|
||||
* Copies documents from a source to a destination.
|
||||
* Throttle a reindex operation. Change the number of requests per second for a particular reindex operation.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html | Elasticsearch API documentation}
|
||||
*/
|
||||
export default async function ReindexRethrottleApi (this: That, params: T.ReindexRethrottleRequest | TB.ReindexRethrottleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ReindexRethrottleResponse>
|
||||
|
||||
@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
|
||||
interface That { transport: Transport }
|
||||
|
||||
/**
|
||||
* Allows to retrieve a large numbers of results from a single search request.
|
||||
* Run a scrolling search. IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT). The scroll API gets large sets of results from a single scrolling search request. To get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter. The `scroll` parameter indicates how long Elasticsearch should retain the search context for the request. The search response returns a scroll ID in the `_scroll_id` response body parameter. You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search. You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context. IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll | Elasticsearch API documentation}
|
||||
*/
|
||||
export default async function ScrollApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params: T.ScrollRequest | TB.ScrollRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ScrollResponse<TDocument, TAggregations>>
|
||||
|
||||
@ -45,7 +45,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates or updates a user profile on behalf of another user.
|
||||
* Activate a user profile. Create or update a user profile on behalf of another user.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-activate-user-profile.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async activateUserProfile (this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityActivateUserProfileResponse>
|
||||
@ -116,7 +116,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk delete roles API cannot delete roles that are defined in roles files.
|
||||
* Bulk delete roles. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk delete roles API cannot delete roles that are defined in roles files.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-bulk-delete-role.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async bulkDeleteRole (this: That, params: T.SecurityBulkDeleteRoleRequest | TB.SecurityBulkDeleteRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityBulkDeleteRoleResponse>
|
||||
@ -157,7 +157,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk create or update roles API cannot update roles that are defined in roles files.
|
||||
* Bulk create or update roles. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk create or update roles API cannot update roles that are defined in roles files.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-bulk-put-role.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async bulkPutRole (this: That, params: T.SecurityBulkPutRoleRequest | TB.SecurityBulkPutRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityBulkPutRoleResponse>
|
||||
@ -227,7 +227,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Changes the passwords of users in the native realm and built-in users.
|
||||
* Change passwords. Change the passwords of users in the native realm and built-in users.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-change-password.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async changePassword (this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityChangePasswordResponse>
|
||||
@ -279,7 +279,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Evicts a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index.
|
||||
* Clear the API key cache. Evict a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-clear-api-key-cache.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async clearApiKeyCache (this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearApiKeyCacheResponse>
|
||||
@ -311,7 +311,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Evicts application privileges from the native application privileges cache.
|
||||
* Clear the privileges cache. Evict privileges from the native application privilege cache. The cache is also automatically cleared for applications that have their privileges updated.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-clear-privilege-cache.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async clearCachedPrivileges (this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedPrivilegesResponse>
|
||||
@ -343,7 +343,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Evicts users from the user cache. Can completely clear the cache or evict specific users.
|
||||
* Clear the user cache. Evict users from the user cache. You can completely clear the cache or evict specific users.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-clear-cache.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async clearCachedRealms (this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedRealmsResponse>
|
||||
@ -375,7 +375,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Evicts roles from the native role cache.
|
||||
* Clear the roles cache. Evict roles from the native role cache.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-clear-role-cache.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async clearCachedRoles (this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedRolesResponse>
|
||||
@ -407,7 +407,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Evicts tokens from the service account token caches.
|
||||
* Clear service account token caches. Evict a subset of all entries from the service account token caches.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-clear-service-token-caches.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async clearCachedServiceTokens (this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedServiceTokensResponse>
|
||||
@ -441,7 +441,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an API key. Creates an API key for access without requiring basic authentication. A successful request returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.
|
||||
* Create an API key. Create an API key for access without requiring basic authentication. A successful request returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-create-api-key.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async createApiKey (this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityCreateApiKeyResponse>
|
||||
@ -512,7 +512,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a service accounts token for access without requiring basic authentication.
|
||||
* Create a service account token. Create a service accounts token for access without requiring basic authentication.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-create-service-token.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async createServiceToken (this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityCreateServiceTokenResponse>
|
||||
@ -553,7 +553,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes application privileges.
|
||||
* Delete application privileges.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-delete-privilege.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async deletePrivileges (this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeletePrivilegesResponse>
|
||||
@ -586,7 +586,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes roles in the native realm.
|
||||
* Delete roles. Delete roles in the native realm.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-delete-role.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async deleteRole (this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteRoleResponse>
|
||||
@ -618,7 +618,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes role mappings.
|
||||
* Delete role mappings.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-delete-role-mapping.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async deleteRoleMapping (this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteRoleMappingResponse>
|
||||
@ -650,7 +650,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes a service account token.
|
||||
* Delete service account tokens. Delete service account tokens for a service in a specified namespace.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-delete-service-token.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async deleteServiceToken (this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteServiceTokenResponse>
|
||||
@ -684,7 +684,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes users from the native realm.
|
||||
* Delete users. Delete users from the native realm.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-delete-user.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async deleteUser (this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteUserResponse>
|
||||
@ -716,7 +716,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Disables users in the native realm.
|
||||
* Disable users. Disable users in the native realm.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-disable-user.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async disableUser (this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDisableUserResponse>
|
||||
@ -748,7 +748,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Disables a user profile so it's not visible in user profile searches.
|
||||
* Disable a user profile. Disable user profiles so that they are not visible in user profile searches.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-disable-user-profile.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async disableUserProfile (this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDisableUserProfileResponse>
|
||||
@ -780,7 +780,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Enables users in the native realm.
|
||||
* Enable users. Enable users in the native realm.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-enable-user.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async enableUser (this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnableUserResponse>
|
||||
@ -812,7 +812,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Enables a user profile so it's visible in user profile searches.
|
||||
* Enable a user profile. Enable user profiles to make them visible in user profile searches.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-enable-user-profile.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async enableUserProfile (this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnableUserProfileResponse>
|
||||
@ -844,7 +844,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.
|
||||
* Enroll Kibana. Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-kibana-enrollment.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async enrollKibana (this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnrollKibanaResponse>
|
||||
@ -874,7 +874,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Allows a new node to join an existing cluster with security features enabled.
|
||||
* Enroll a node. Enroll a new node to allow it to join an existing cluster with security features enabled.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-node-enrollment.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async enrollNode (this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnrollNodeResponse>
|
||||
@ -934,7 +934,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
|
||||
* Get builtin privileges. Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-builtin-privileges.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getBuiltinPrivileges (this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetBuiltinPrivilegesResponse>
|
||||
@ -964,7 +964,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves application privileges.
|
||||
* Get application privileges.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-privileges.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getPrivileges (this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetPrivilegesResponse>
|
||||
@ -1008,7 +1008,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files.
|
||||
* Get roles. Get roles in the native realm.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-role.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getRole (this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetRoleResponse>
|
||||
@ -1048,7 +1048,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves role mappings.
|
||||
* Get role mappings. Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The get role mappings API cannot retrieve role mappings that are defined in role mapping files.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-role-mapping.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getRoleMapping (this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetRoleMappingResponse>
|
||||
@ -1088,7 +1088,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* This API returns a list of service accounts that match the provided path parameter(s).
|
||||
* Get service accounts. Get a list of service accounts that match the provided path parameters.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-service-accounts.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getServiceAccounts (this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetServiceAccountsResponse>
|
||||
@ -1132,7 +1132,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves information of all service credentials for a service account.
|
||||
* Get service account credentials.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-service-credentials.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getServiceCredentials (this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetServiceCredentialsResponse>
|
||||
@ -1194,7 +1194,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a bearer token for access without requiring basic authentication.
|
||||
* Get a token. Create a bearer token for access without requiring basic authentication.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-token.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getToken (this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetTokenResponse>
|
||||
@ -1236,7 +1236,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves information about users in the native realm and built-in users.
|
||||
* Get users. Get information about users in the native realm and built-in users.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-user.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getUser (this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserResponse>
|
||||
@ -1276,7 +1276,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves security privileges for the logged in user.
|
||||
* Get user privileges.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-user-privileges.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getUserPrivileges (this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserPrivilegesResponse>
|
||||
@ -1306,7 +1306,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves a user's profile using the unique profile ID.
|
||||
* Get a user profile. Get a user's profile using the unique profile ID.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-user-profile.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getUserProfile (this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserProfileResponse>
|
||||
@ -1338,7 +1338,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an API key on behalf of another user. This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. It is not possible to use this API to create an API key without that user’s credentials. The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. In this case, the API key will be created on behalf of the impersonated user. This API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf. A successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds. By default, API keys never expire. You can specify expiration information when you create the API keys.
|
||||
* Grant an API key. Create an API key on behalf of another user. This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. It is not possible to use this API to create an API key without that user’s credentials. The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. In this case, the API key will be created on behalf of the impersonated user. This API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf. A successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds. By default, API keys never expire. You can specify expiration information when you create the API keys.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-grant-api-key.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async grantApiKey (this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGrantApiKeyResponse>
|
||||
@ -1379,7 +1379,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Check user privileges. Determines whether the specified user has a specified list of privileges.
|
||||
* Check user privileges. Determine whether the specified user has a specified list of privileges.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-has-privileges.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async hasPrivileges (this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityHasPrivilegesResponse>
|
||||
@ -1431,7 +1431,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines whether the users associated with the specified profile IDs have all the requested privileges.
|
||||
* Check user profile privileges. Determine whether the users associated with the specified user profile IDs have all the requested privileges.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-has-privileges-user-profile.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async hasPrivilegesUserProfile (this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityHasPrivilegesUserProfileResponse>
|
||||
@ -1472,7 +1472,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Invalidate API keys. Invalidates one or more API keys. The `manage_api_key` privilege allows deleting any API keys. The `manage_own_api_key` only allows deleting API keys that are owned by the user. In addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats: - Set the parameter `owner=true`. - Or, set both `username` and `realm_name` to match the user’s identity. - Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.
|
||||
* Invalidate API keys. This API invalidates API keys created by the create API key or grant API key APIs. Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. The `manage_api_key` privilege allows deleting any API keys. The `manage_own_api_key` only allows deleting API keys that are owned by the user. In addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats: - Set the parameter `owner=true`. - Or, set both `username` and `realm_name` to match the user’s identity. - Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-invalidate-api-key.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async invalidateApiKey (this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityInvalidateApiKeyResponse>
|
||||
@ -1514,7 +1514,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Invalidates one or more access tokens or refresh tokens.
|
||||
* Invalidate a token. The access tokens returned by the get token API have a finite period of time for which they are valid. After that time period, they can no longer be used. The time period is defined by the `xpack.security.authc.token.timeout` setting. The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-invalidate-token.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async invalidateToken (this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityInvalidateTokenResponse>
|
||||
@ -1643,7 +1643,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds or updates application privileges.
|
||||
* Create or update application privileges.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-put-privileges.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async putPrivileges (this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutPrivilegesResponse>
|
||||
@ -1677,7 +1677,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The create or update roles API cannot update roles that are defined in roles files.
|
||||
* Create or update roles. The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. The create or update roles API cannot update roles that are defined in roles files. File-based role management is not available in Elastic Serverless.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-put-role.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async putRole (this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutRoleResponse>
|
||||
@ -1721,7 +1721,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates and updates role mappings.
|
||||
* Create or update role mappings. Role mappings define which roles are assigned to each user. Each mapping has rules that identify users and a list of roles that are granted to those users. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. This API does not create roles. Rather, it maps users to existing roles. Roles can be created by using the create or update roles API or roles files.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-put-role-mapping.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async putRoleMapping (this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutRoleMappingResponse>
|
||||
@ -1765,7 +1765,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds and updates users in the native realm. These users are commonly referred to as native users.
|
||||
* Create or update users. A password is required for adding a new user but is optional when updating an existing user. To change a user’s password without updating any other fields, use the change password API.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-put-user.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async putUser (this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutUserResponse>
|
||||
@ -1809,7 +1809,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Query API keys. Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query.
|
||||
* Find API keys with a query. Get a paginated list of API keys and their information. You can optionally filter the results with a query.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-query-api-key.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async queryApiKeys (this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityQueryApiKeysResponse>
|
||||
@ -1851,7 +1851,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves roles in a paginated manner. You can optionally filter the results with a query.
|
||||
* Find roles with a query. Get roles in a paginated manner. You can optionally filter the results with a query.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-query-role.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async queryRole (this: That, params?: T.SecurityQueryRoleRequest | TB.SecurityQueryRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityQueryRoleResponse>
|
||||
@ -1893,7 +1893,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves information for Users in a paginated manner. You can optionally filter the results with a query.
|
||||
* Find users with a query. Get information for users in a paginated manner. You can optionally filter the results with a query.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-query-user.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async queryUser (this: That, params?: T.SecurityQueryUserRequest | TB.SecurityQueryUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityQueryUserResponse>
|
||||
@ -1935,7 +1935,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Submits a SAML Response message to Elasticsearch for consumption.
|
||||
* Authenticate SAML. Submits a SAML response message to Elasticsearch for consumption.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-saml-authenticate.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async samlAuthenticate (this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlAuthenticateResponse>
|
||||
@ -1976,7 +1976,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Verifies the logout response sent from the SAML IdP.
|
||||
* Logout of SAML completely. Verifies the logout response sent from the SAML IdP.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-saml-complete-logout.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async samlCompleteLogout (this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlCompleteLogoutResponse>
|
||||
@ -2017,7 +2017,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Submits a SAML LogoutRequest message to Elasticsearch for consumption.
|
||||
* Invalidate SAML. Submits a SAML LogoutRequest message to Elasticsearch for consumption.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-saml-invalidate.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async samlInvalidate (this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlInvalidateResponse>
|
||||
@ -2058,7 +2058,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Submits a request to invalidate an access token and refresh token.
|
||||
* Logout of SAML. Submits a request to invalidate an access token and refresh token.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-saml-logout.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async samlLogout (this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlLogoutResponse>
|
||||
@ -2099,7 +2099,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.
|
||||
* Prepare SAML authentication. Creates a SAML authentication request (`<AuthnRequest>`) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-saml-prepare-authentication.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async samlPrepareAuthentication (this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlPrepareAuthenticationResponse>
|
||||
@ -2141,7 +2141,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate SAML metadata for a SAML 2.0 Service Provider.
|
||||
* Create SAML service provider metadata. Generate SAML metadata for a SAML 2.0 Service Provider.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-saml-sp-metadata.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async samlServiceProviderMetadata (this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlServiceProviderMetadataResponse>
|
||||
@ -2173,7 +2173,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Get suggestions for user profiles that match specified search criteria.
|
||||
* Suggest a user profile. Get suggestions for user profiles that match specified search criteria.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-suggest-user-profile.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async suggestUserProfiles (this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySuggestUserProfilesResponse>
|
||||
@ -2320,7 +2320,7 @@ export default class Security {
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates specific data for the user profile that's associated with the specified unique ID.
|
||||
* Update user profile data. Update specific data for the user profile that is associated with a unique ID.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-update-user-profile-data.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async updateUserProfileData (this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityUpdateUserProfileDataResponse>
|
||||
|
||||
@ -45,7 +45,7 @@ export default class Ssl {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves information about the X.509 certificates used to encrypt communications in the cluster.
|
||||
* Get SSL certificates. Get information about the X.509 certificates that are used to encrypt communications in the cluster. The API returns a list that includes certificates from all TLS contexts including: - Settings for transport and HTTP interfaces - TLS settings that are used within authentication realms - TLS settings for remote monitoring exporters The list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings. It also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`. The list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch. NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration. If Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-ssl.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async certificates (this: That, params?: T.SslCertificatesRequest | TB.SslCertificatesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SslCertificatesResponse>
|
||||
|
||||
@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
|
||||
interface That { transport: Transport }
|
||||
|
||||
/**
|
||||
* The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.
|
||||
* Get terms in an index. Discover terms that match a partial string in an index. This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. If the `complete` property in the response is false, the returned terms set may be incomplete and should be treated as approximate. This can occur due to a few reasons, such as a request timeout or a node error. NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/search-terms-enum.html | Elasticsearch API documentation}
|
||||
*/
|
||||
export default async function TermsEnumApi (this: That, params: T.TermsEnumRequest | TB.TermsEnumRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TermsEnumResponse>
|
||||
|
||||
@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
|
||||
interface That { transport: Transport }
|
||||
|
||||
/**
|
||||
* Changes the number of requests per second for a particular Update By Query operation.
|
||||
* Throttle an update by query operation. Change the number of requests per second for a particular update by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html | Elasticsearch API documentation}
|
||||
*/
|
||||
export default async function UpdateByQueryRethrottleApi (this: That, params: T.UpdateByQueryRethrottleRequest | TB.UpdateByQueryRethrottleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.UpdateByQueryRethrottleResponse>
|
||||
|
||||
179
src/api/types.ts
179
src/api/types.ts
@ -5336,22 +5336,28 @@ export interface MappingDateRangeProperty extends MappingRangePropertyBase {
|
||||
type: 'date_range'
|
||||
}
|
||||
|
||||
export type MappingDenseVectorElementType = 'bit' | 'byte' | 'float'
|
||||
|
||||
export interface MappingDenseVectorIndexOptions {
|
||||
type: string
|
||||
m?: integer
|
||||
ef_construction?: integer
|
||||
confidence_interval?: float
|
||||
ef_construction?: integer
|
||||
m?: integer
|
||||
type: MappingDenseVectorIndexOptionsType
|
||||
}
|
||||
|
||||
export type MappingDenseVectorIndexOptionsType = 'flat' | 'hnsw' | 'int4_flat' | 'int4_hnsw' | 'int8_flat' | 'int8_hnsw'
|
||||
|
||||
export interface MappingDenseVectorProperty extends MappingPropertyBase {
|
||||
type: 'dense_vector'
|
||||
element_type?: string
|
||||
dims?: integer
|
||||
similarity?: string
|
||||
element_type?: MappingDenseVectorElementType
|
||||
index?: boolean
|
||||
index_options?: MappingDenseVectorIndexOptions
|
||||
similarity?: MappingDenseVectorSimilarity
|
||||
}
|
||||
|
||||
export type MappingDenseVectorSimilarity = 'cosine' | 'dot_product' | 'l2_norm' | 'max_inner_product'
|
||||
|
||||
export interface MappingDocValuesPropertyBase extends MappingCorePropertyBase {
|
||||
doc_values?: boolean
|
||||
}
|
||||
@ -8643,18 +8649,20 @@ export type CcrDeleteAutoFollowPatternResponse = AcknowledgedResponseBase
|
||||
export interface CcrFollowRequest extends RequestBase {
|
||||
index: IndexName
|
||||
wait_for_active_shards?: WaitForActiveShards
|
||||
leader_index?: IndexName
|
||||
data_stream_name?: string
|
||||
leader_index: IndexName
|
||||
max_outstanding_read_requests?: long
|
||||
max_outstanding_write_requests?: long
|
||||
max_read_request_operation_count?: long
|
||||
max_read_request_size?: string
|
||||
max_outstanding_write_requests?: integer
|
||||
max_read_request_operation_count?: integer
|
||||
max_read_request_size?: ByteSize
|
||||
max_retry_delay?: Duration
|
||||
max_write_buffer_count?: long
|
||||
max_write_buffer_size?: string
|
||||
max_write_request_operation_count?: long
|
||||
max_write_request_size?: string
|
||||
max_write_buffer_count?: integer
|
||||
max_write_buffer_size?: ByteSize
|
||||
max_write_request_operation_count?: integer
|
||||
max_write_request_size?: ByteSize
|
||||
read_poll_timeout?: Duration
|
||||
remote_cluster?: string
|
||||
remote_cluster: string
|
||||
settings?: IndicesIndexSettings
|
||||
}
|
||||
|
||||
export interface CcrFollowResponse {
|
||||
@ -8672,16 +8680,16 @@ export interface CcrFollowInfoFollowerIndex {
|
||||
}
|
||||
|
||||
export interface CcrFollowInfoFollowerIndexParameters {
|
||||
max_outstanding_read_requests: integer
|
||||
max_outstanding_write_requests: integer
|
||||
max_read_request_operation_count: integer
|
||||
max_read_request_size: string
|
||||
max_retry_delay: Duration
|
||||
max_write_buffer_count: integer
|
||||
max_write_buffer_size: string
|
||||
max_write_request_operation_count: integer
|
||||
max_write_request_size: string
|
||||
read_poll_timeout: Duration
|
||||
max_outstanding_read_requests?: long
|
||||
max_outstanding_write_requests?: integer
|
||||
max_read_request_operation_count?: integer
|
||||
max_read_request_size?: ByteSize
|
||||
max_retry_delay?: Duration
|
||||
max_write_buffer_count?: integer
|
||||
max_write_buffer_size?: ByteSize
|
||||
max_write_request_operation_count?: integer
|
||||
max_write_request_size?: ByteSize
|
||||
read_poll_timeout?: Duration
|
||||
}
|
||||
|
||||
export type CcrFollowInfoFollowerIndexStatus = 'active' | 'paused'
|
||||
@ -9628,7 +9636,7 @@ export interface ConnectorFeatureEnabled {
|
||||
export interface ConnectorFilteringAdvancedSnippet {
|
||||
created_at?: DateTime
|
||||
updated_at?: DateTime
|
||||
value: Record<string, any>
|
||||
value: any
|
||||
}
|
||||
|
||||
export interface ConnectorFilteringConfig {
|
||||
@ -10178,6 +10186,7 @@ export interface EqlSearchRequest extends RequestBase {
|
||||
fields?: QueryDslFieldAndFormat | Field | (QueryDslFieldAndFormat | Field)[]
|
||||
result_position?: EqlSearchResultPosition
|
||||
runtime_mappings?: MappingRuntimeFields
|
||||
max_samples_per_key?: integer
|
||||
}
|
||||
|
||||
export type EqlSearchResponse<TEvent = unknown> = EqlEqlSearchResponseBase<TEvent>
|
||||
@ -10713,6 +10722,7 @@ export interface IndicesDataStreamIndex {
|
||||
export interface IndicesDataStreamLifecycle {
|
||||
data_retention?: Duration
|
||||
downsampling?: IndicesDataStreamLifecycleDownsampling
|
||||
enabled?: boolean
|
||||
}
|
||||
|
||||
export interface IndicesDataStreamLifecycleDownsampling {
|
||||
@ -10732,9 +10742,7 @@ export interface IndicesDataStreamLifecycleRolloverConditions {
|
||||
max_primary_shard_docs?: long
|
||||
}
|
||||
|
||||
export interface IndicesDataStreamLifecycleWithRollover {
|
||||
data_retention?: Duration
|
||||
downsampling?: IndicesDataStreamLifecycleDownsampling
|
||||
export interface IndicesDataStreamLifecycleWithRollover extends IndicesDataStreamLifecycle {
|
||||
rollover?: IndicesDataStreamLifecycleRolloverConditions
|
||||
}
|
||||
|
||||
@ -11592,7 +11600,7 @@ export type IndicesGetAliasResponse = Record<IndexName, IndicesGetAliasIndexAlia
|
||||
|
||||
export interface IndicesGetDataLifecycleDataStreamWithLifecycle {
|
||||
name: DataStreamName
|
||||
lifecycle?: IndicesDataStreamLifecycle
|
||||
lifecycle?: IndicesDataStreamLifecycleWithRollover
|
||||
}
|
||||
|
||||
export interface IndicesGetDataLifecycleRequest extends RequestBase {
|
||||
@ -11755,8 +11763,7 @@ export interface IndicesPutDataLifecycleRequest extends RequestBase {
|
||||
expand_wildcards?: ExpandWildcards
|
||||
master_timeout?: Duration
|
||||
timeout?: Duration
|
||||
data_retention?: Duration
|
||||
downsampling?: IndicesDataStreamLifecycleDownsampling
|
||||
lifecycle?: IndicesDataStreamLifecycle
|
||||
}
|
||||
|
||||
export type IndicesPutDataLifecycleResponse = AcknowledgedResponseBase
|
||||
@ -12484,7 +12491,7 @@ export type InferenceDenseVector = float[]
|
||||
export interface InferenceInferenceEndpoint {
|
||||
service: string
|
||||
service_settings: InferenceServiceSettings
|
||||
task_settings: InferenceTaskSettings
|
||||
task_settings?: InferenceTaskSettings
|
||||
}
|
||||
|
||||
export interface InferenceInferenceEndpointInfo extends InferenceInferenceEndpoint {
|
||||
@ -12594,6 +12601,20 @@ export interface IngestCircleProcessor extends IngestProcessorBase {
|
||||
target_field?: Field
|
||||
}
|
||||
|
||||
export interface IngestCommunityIDProcessor extends IngestProcessorBase {
|
||||
source_ip?: Field
|
||||
source_port?: Field
|
||||
destination_ip?: Field
|
||||
destination_port?: Field
|
||||
iana_number?: Field
|
||||
icmp_type?: Field
|
||||
icmp_code?: Field
|
||||
transport?: Field
|
||||
target_field?: Field
|
||||
seed?: integer
|
||||
ignore_missing?: boolean
|
||||
}
|
||||
|
||||
export interface IngestConvertProcessor extends IngestProcessorBase {
|
||||
field: Field
|
||||
ignore_missing?: boolean
|
||||
@ -12601,7 +12622,7 @@ export interface IngestConvertProcessor extends IngestProcessorBase {
|
||||
type: IngestConvertType
|
||||
}
|
||||
|
||||
export type IngestConvertType = 'integer' | 'long' | 'float' | 'double' | 'string' | 'boolean' | 'auto'
|
||||
export type IngestConvertType = 'integer' | 'long' | 'double' | 'float' | 'boolean' | 'ip' | 'string' | 'auto'
|
||||
|
||||
export interface IngestCsvProcessor extends IngestProcessorBase {
|
||||
empty_value?: any
|
||||
@ -12634,6 +12655,7 @@ export interface IngestDateProcessor extends IngestProcessorBase {
|
||||
locale?: string
|
||||
target_field?: Field
|
||||
timezone?: string
|
||||
output_format?: string
|
||||
}
|
||||
|
||||
export interface IngestDissectProcessor extends IngestProcessorBase {
|
||||
@ -12666,6 +12688,16 @@ export interface IngestFailProcessor extends IngestProcessorBase {
|
||||
message: string
|
||||
}
|
||||
|
||||
export type IngestFingerprintDigest = 'MD5' | 'SHA-1' | 'SHA-256' | 'SHA-512' | 'MurmurHash3'
|
||||
|
||||
export interface IngestFingerprintProcessor extends IngestProcessorBase {
|
||||
fields: Fields
|
||||
target_field?: Field
|
||||
salt?: string
|
||||
method?: IngestFingerprintDigest
|
||||
ignore_missing?: boolean
|
||||
}
|
||||
|
||||
export interface IngestForeachProcessor extends IngestProcessorBase {
|
||||
field: Field
|
||||
ignore_missing?: boolean
|
||||
@ -12699,6 +12731,7 @@ export interface IngestGeoIpProcessor extends IngestProcessorBase {
|
||||
}
|
||||
|
||||
export interface IngestGrokProcessor extends IngestProcessorBase {
|
||||
ecs_compatibility?: string
|
||||
field: Field
|
||||
ignore_missing?: boolean
|
||||
pattern_definitions?: Record<string, string>
|
||||
@ -12785,6 +12818,15 @@ export interface IngestMaxmind {
|
||||
account_id: Id
|
||||
}
|
||||
|
||||
export interface IngestNetworkDirectionProcessor extends IngestProcessorBase {
|
||||
source_ip?: Field
|
||||
destination_ip?: Field
|
||||
target_field?: Field
|
||||
internal_networks?: string[]
|
||||
internal_networks_field?: Field
|
||||
ignore_missing?: boolean
|
||||
}
|
||||
|
||||
export interface IngestPipeline {
|
||||
description?: string
|
||||
on_failure?: IngestProcessorContainer[]
|
||||
@ -12818,6 +12860,7 @@ export interface IngestProcessorContainer {
|
||||
attachment?: IngestAttachmentProcessor
|
||||
bytes?: IngestBytesProcessor
|
||||
circle?: IngestCircleProcessor
|
||||
community_id?: IngestCommunityIDProcessor
|
||||
convert?: IngestConvertProcessor
|
||||
csv?: IngestCsvProcessor
|
||||
date?: IngestDateProcessor
|
||||
@ -12827,6 +12870,7 @@ export interface IngestProcessorContainer {
|
||||
drop?: IngestDropProcessor
|
||||
enrich?: IngestEnrichProcessor
|
||||
fail?: IngestFailProcessor
|
||||
fingerprint?: IngestFingerprintProcessor
|
||||
foreach?: IngestForeachProcessor
|
||||
geo_grid?: IngestGeoGridProcessor
|
||||
geoip?: IngestGeoIpProcessor
|
||||
@ -12838,8 +12882,10 @@ export interface IngestProcessorContainer {
|
||||
json?: IngestJsonProcessor
|
||||
kv?: IngestKeyValueProcessor
|
||||
lowercase?: IngestLowercaseProcessor
|
||||
network_direction?: IngestNetworkDirectionProcessor
|
||||
pipeline?: IngestPipelineProcessor
|
||||
redact?: IngestRedactProcessor
|
||||
registered_domain?: IngestRegisteredDomainProcessor
|
||||
remove?: IngestRemoveProcessor
|
||||
rename?: IngestRenameProcessor
|
||||
reroute?: IngestRerouteProcessor
|
||||
@ -12848,6 +12894,7 @@ export interface IngestProcessorContainer {
|
||||
set_security_user?: IngestSetSecurityUserProcessor
|
||||
sort?: IngestSortProcessor
|
||||
split?: IngestSplitProcessor
|
||||
terminate?: IngestTerminateProcessor
|
||||
trim?: IngestTrimProcessor
|
||||
uppercase?: IngestUppercaseProcessor
|
||||
urldecode?: IngestUrlDecodeProcessor
|
||||
@ -12866,6 +12913,12 @@ export interface IngestRedactProcessor extends IngestProcessorBase {
|
||||
trace_redact?: boolean
|
||||
}
|
||||
|
||||
export interface IngestRegisteredDomainProcessor extends IngestProcessorBase {
|
||||
field: Field
|
||||
target_field?: Field
|
||||
ignore_missing?: boolean
|
||||
}
|
||||
|
||||
export interface IngestRemoveProcessor extends IngestProcessorBase {
|
||||
field: Fields
|
||||
keep?: Fields
|
||||
@ -12921,6 +12974,9 @@ export interface IngestSplitProcessor extends IngestProcessorBase {
|
||||
target_field?: Field
|
||||
}
|
||||
|
||||
export interface IngestTerminateProcessor extends IngestProcessorBase {
|
||||
}
|
||||
|
||||
export interface IngestTrimProcessor extends IngestProcessorBase {
|
||||
field: Field
|
||||
ignore_missing?: boolean
|
||||
@ -16528,7 +16584,7 @@ export interface NodesInfoNodeInfoSettingsIngest {
|
||||
}
|
||||
|
||||
export interface NodesInfoNodeInfoSettingsNetwork {
|
||||
host?: Host
|
||||
host?: Host | Host[]
|
||||
}
|
||||
|
||||
export interface NodesInfoNodeInfoSettingsNode {
|
||||
@ -16561,6 +16617,7 @@ export interface NodesInfoNodeInfoXpack {
|
||||
license?: NodesInfoNodeInfoXpackLicense
|
||||
security: NodesInfoNodeInfoXpackSecurity
|
||||
notification?: Record<string, any>
|
||||
ml?: NodesInfoNodeInfoXpackMl
|
||||
}
|
||||
|
||||
export interface NodesInfoNodeInfoXpackLicense {
|
||||
@ -16571,16 +16628,20 @@ export interface NodesInfoNodeInfoXpackLicenseType {
|
||||
type: string
|
||||
}
|
||||
|
||||
export interface NodesInfoNodeInfoXpackMl {
|
||||
use_auto_machine_memory_percent?: boolean
|
||||
}
|
||||
|
||||
export interface NodesInfoNodeInfoXpackSecurity {
|
||||
http: NodesInfoNodeInfoXpackSecuritySsl
|
||||
http?: NodesInfoNodeInfoXpackSecuritySsl
|
||||
enabled: string
|
||||
transport?: NodesInfoNodeInfoXpackSecuritySsl
|
||||
authc?: NodesInfoNodeInfoXpackSecurityAuthc
|
||||
}
|
||||
|
||||
export interface NodesInfoNodeInfoXpackSecurityAuthc {
|
||||
realms: NodesInfoNodeInfoXpackSecurityAuthcRealms
|
||||
token: NodesInfoNodeInfoXpackSecurityAuthcToken
|
||||
realms?: NodesInfoNodeInfoXpackSecurityAuthcRealms
|
||||
token?: NodesInfoNodeInfoXpackSecurityAuthcToken
|
||||
}
|
||||
|
||||
export interface NodesInfoNodeInfoXpackSecurityAuthcRealms {
|
||||
@ -16809,6 +16870,21 @@ export interface QueryRulesPutRulesetResponse {
|
||||
result: Result
|
||||
}
|
||||
|
||||
export interface QueryRulesTestQueryRulesetMatchedRule {
|
||||
ruleset_id: Id
|
||||
rule_id: Id
|
||||
}
|
||||
|
||||
export interface QueryRulesTestRequest extends RequestBase {
|
||||
ruleset_id: Id
|
||||
match_criteria: Record<string, any>
|
||||
}
|
||||
|
||||
export interface QueryRulesTestResponse {
|
||||
total_matched_rules: integer
|
||||
matched_rules: QueryRulesTestQueryRulesetMatchedRule[]
|
||||
}
|
||||
|
||||
export interface RollupDateHistogramGrouping {
|
||||
delay?: Duration
|
||||
field: Field
|
||||
@ -17004,10 +17080,13 @@ export interface SearchApplicationEventDataStream {
|
||||
name: IndexName
|
||||
}
|
||||
|
||||
export interface SearchApplicationSearchApplication {
|
||||
export interface SearchApplicationSearchApplication extends SearchApplicationSearchApplicationParameters {
|
||||
name: Name
|
||||
indices: IndexName[]
|
||||
updated_at_millis: EpochTime<UnitMillis>
|
||||
}
|
||||
|
||||
export interface SearchApplicationSearchApplicationParameters {
|
||||
indices: IndexName[]
|
||||
analytics_collection_name?: Name
|
||||
template?: SearchApplicationSearchApplicationTemplate
|
||||
}
|
||||
@ -17048,20 +17127,13 @@ export interface SearchApplicationListRequest extends RequestBase {
|
||||
|
||||
export interface SearchApplicationListResponse {
|
||||
count: long
|
||||
results: SearchApplicationListSearchApplicationListItem[]
|
||||
}
|
||||
|
||||
export interface SearchApplicationListSearchApplicationListItem {
|
||||
name: Name
|
||||
indices: IndexName[]
|
||||
updated_at_millis: EpochTime<UnitMillis>
|
||||
analytics_collection_name?: Name
|
||||
results: SearchApplicationSearchApplication[]
|
||||
}
|
||||
|
||||
export interface SearchApplicationPutRequest extends RequestBase {
|
||||
name: Name
|
||||
create?: boolean
|
||||
search_application?: SearchApplicationSearchApplication
|
||||
search_application?: SearchApplicationSearchApplicationParameters
|
||||
}
|
||||
|
||||
export interface SearchApplicationPutResponse {
|
||||
@ -17217,7 +17289,7 @@ export type SecurityIndexPrivilege = 'all' | 'auto_configure' | 'create' | 'crea
|
||||
|
||||
export interface SecurityIndicesPrivileges {
|
||||
field_security?: SecurityFieldSecurity
|
||||
names: Indices
|
||||
names: IndexName[]
|
||||
privileges: SecurityIndexPrivilege[]
|
||||
query?: SecurityIndicesPrivilegesQuery
|
||||
allow_restricted_indices?: boolean
|
||||
@ -17237,7 +17309,7 @@ export interface SecurityRealmInfo {
|
||||
export interface SecurityRemoteIndicesPrivileges {
|
||||
clusters: Names
|
||||
field_security?: SecurityFieldSecurity
|
||||
names: Indices
|
||||
names: IndexName[]
|
||||
privileges: SecurityIndexPrivilege[]
|
||||
query?: SecurityIndicesPrivilegesQuery
|
||||
allow_restricted_indices?: boolean
|
||||
@ -17315,7 +17387,7 @@ export interface SecurityUser {
|
||||
|
||||
export interface SecurityUserIndicesPrivileges {
|
||||
field_security?: SecurityFieldSecurity[]
|
||||
names: Indices
|
||||
names: IndexName[]
|
||||
privileges: SecurityIndexPrivilege[]
|
||||
query?: SecurityIndicesPrivilegesQuery[]
|
||||
allow_restricted_indices: boolean
|
||||
@ -17625,7 +17697,7 @@ export interface SecurityGetBuiltinPrivilegesRequest extends RequestBase {
|
||||
|
||||
export interface SecurityGetBuiltinPrivilegesResponse {
|
||||
cluster: string[]
|
||||
index: Indices
|
||||
index: IndexName[]
|
||||
}
|
||||
|
||||
export interface SecurityGetPrivilegesRequest extends RequestBase {
|
||||
@ -18704,7 +18776,8 @@ export interface SnapshotRestoreRequest extends RequestBase {
|
||||
}
|
||||
|
||||
export interface SnapshotRestoreResponse {
|
||||
snapshot: SnapshotRestoreSnapshotRestore
|
||||
accepted?: boolean
|
||||
snapshot?: SnapshotRestoreSnapshotRestore
|
||||
}
|
||||
|
||||
export interface SnapshotRestoreSnapshotRestore {
|
||||
|
||||
@ -5412,22 +5412,28 @@ export interface MappingDateRangeProperty extends MappingRangePropertyBase {
|
||||
type: 'date_range'
|
||||
}
|
||||
|
||||
export type MappingDenseVectorElementType = 'bit' | 'byte' | 'float'
|
||||
|
||||
export interface MappingDenseVectorIndexOptions {
|
||||
type: string
|
||||
m?: integer
|
||||
ef_construction?: integer
|
||||
confidence_interval?: float
|
||||
ef_construction?: integer
|
||||
m?: integer
|
||||
type: MappingDenseVectorIndexOptionsType
|
||||
}
|
||||
|
||||
export type MappingDenseVectorIndexOptionsType = 'flat' | 'hnsw' | 'int4_flat' | 'int4_hnsw' | 'int8_flat' | 'int8_hnsw'
|
||||
|
||||
export interface MappingDenseVectorProperty extends MappingPropertyBase {
|
||||
type: 'dense_vector'
|
||||
element_type?: string
|
||||
dims?: integer
|
||||
similarity?: string
|
||||
element_type?: MappingDenseVectorElementType
|
||||
index?: boolean
|
||||
index_options?: MappingDenseVectorIndexOptions
|
||||
similarity?: MappingDenseVectorSimilarity
|
||||
}
|
||||
|
||||
export type MappingDenseVectorSimilarity = 'cosine' | 'dot_product' | 'l2_norm' | 'max_inner_product'
|
||||
|
||||
export interface MappingDocValuesPropertyBase extends MappingCorePropertyBase {
|
||||
doc_values?: boolean
|
||||
}
|
||||
@ -8725,18 +8731,20 @@ export interface CcrFollowRequest extends RequestBase {
|
||||
wait_for_active_shards?: WaitForActiveShards
|
||||
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
|
||||
body?: {
|
||||
leader_index?: IndexName
|
||||
data_stream_name?: string
|
||||
leader_index: IndexName
|
||||
max_outstanding_read_requests?: long
|
||||
max_outstanding_write_requests?: long
|
||||
max_read_request_operation_count?: long
|
||||
max_read_request_size?: string
|
||||
max_outstanding_write_requests?: integer
|
||||
max_read_request_operation_count?: integer
|
||||
max_read_request_size?: ByteSize
|
||||
max_retry_delay?: Duration
|
||||
max_write_buffer_count?: long
|
||||
max_write_buffer_size?: string
|
||||
max_write_request_operation_count?: long
|
||||
max_write_request_size?: string
|
||||
max_write_buffer_count?: integer
|
||||
max_write_buffer_size?: ByteSize
|
||||
max_write_request_operation_count?: integer
|
||||
max_write_request_size?: ByteSize
|
||||
read_poll_timeout?: Duration
|
||||
remote_cluster?: string
|
||||
remote_cluster: string
|
||||
settings?: IndicesIndexSettings
|
||||
}
|
||||
}
|
||||
|
||||
@ -8755,16 +8763,16 @@ export interface CcrFollowInfoFollowerIndex {
|
||||
}
|
||||
|
||||
export interface CcrFollowInfoFollowerIndexParameters {
|
||||
max_outstanding_read_requests: integer
|
||||
max_outstanding_write_requests: integer
|
||||
max_read_request_operation_count: integer
|
||||
max_read_request_size: string
|
||||
max_retry_delay: Duration
|
||||
max_write_buffer_count: integer
|
||||
max_write_buffer_size: string
|
||||
max_write_request_operation_count: integer
|
||||
max_write_request_size: string
|
||||
read_poll_timeout: Duration
|
||||
max_outstanding_read_requests?: long
|
||||
max_outstanding_write_requests?: integer
|
||||
max_read_request_operation_count?: integer
|
||||
max_read_request_size?: ByteSize
|
||||
max_retry_delay?: Duration
|
||||
max_write_buffer_count?: integer
|
||||
max_write_buffer_size?: ByteSize
|
||||
max_write_request_operation_count?: integer
|
||||
max_write_request_size?: ByteSize
|
||||
read_poll_timeout?: Duration
|
||||
}
|
||||
|
||||
export type CcrFollowInfoFollowerIndexStatus = 'active' | 'paused'
|
||||
@ -9732,7 +9740,7 @@ export interface ConnectorFeatureEnabled {
|
||||
export interface ConnectorFilteringAdvancedSnippet {
|
||||
created_at?: DateTime
|
||||
updated_at?: DateTime
|
||||
value: Record<string, any>
|
||||
value: any
|
||||
}
|
||||
|
||||
export interface ConnectorFilteringConfig {
|
||||
@ -10335,6 +10343,7 @@ export interface EqlSearchRequest extends RequestBase {
|
||||
fields?: QueryDslFieldAndFormat | Field | (QueryDslFieldAndFormat | Field)[]
|
||||
result_position?: EqlSearchResultPosition
|
||||
runtime_mappings?: MappingRuntimeFields
|
||||
max_samples_per_key?: integer
|
||||
}
|
||||
}
|
||||
|
||||
@ -10890,6 +10899,7 @@ export interface IndicesDataStreamIndex {
|
||||
export interface IndicesDataStreamLifecycle {
|
||||
data_retention?: Duration
|
||||
downsampling?: IndicesDataStreamLifecycleDownsampling
|
||||
enabled?: boolean
|
||||
}
|
||||
|
||||
export interface IndicesDataStreamLifecycleDownsampling {
|
||||
@ -10909,9 +10919,7 @@ export interface IndicesDataStreamLifecycleRolloverConditions {
|
||||
max_primary_shard_docs?: long
|
||||
}
|
||||
|
||||
export interface IndicesDataStreamLifecycleWithRollover {
|
||||
data_retention?: Duration
|
||||
downsampling?: IndicesDataStreamLifecycleDownsampling
|
||||
export interface IndicesDataStreamLifecycleWithRollover extends IndicesDataStreamLifecycle {
|
||||
rollover?: IndicesDataStreamLifecycleRolloverConditions
|
||||
}
|
||||
|
||||
@ -11779,7 +11787,7 @@ export type IndicesGetAliasResponse = Record<IndexName, IndicesGetAliasIndexAlia
|
||||
|
||||
export interface IndicesGetDataLifecycleDataStreamWithLifecycle {
|
||||
name: DataStreamName
|
||||
lifecycle?: IndicesDataStreamLifecycle
|
||||
lifecycle?: IndicesDataStreamLifecycleWithRollover
|
||||
}
|
||||
|
||||
export interface IndicesGetDataLifecycleRequest extends RequestBase {
|
||||
@ -11948,11 +11956,8 @@ export interface IndicesPutDataLifecycleRequest extends RequestBase {
|
||||
expand_wildcards?: ExpandWildcards
|
||||
master_timeout?: Duration
|
||||
timeout?: Duration
|
||||
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
|
||||
body?: {
|
||||
data_retention?: Duration
|
||||
downsampling?: IndicesDataStreamLifecycleDownsampling
|
||||
}
|
||||
/** @deprecated The use of the 'body' key has been deprecated, use 'lifecycle' instead. */
|
||||
body?: IndicesDataStreamLifecycle
|
||||
}
|
||||
|
||||
export type IndicesPutDataLifecycleResponse = AcknowledgedResponseBase
|
||||
@ -12708,7 +12713,7 @@ export type InferenceDenseVector = float[]
|
||||
export interface InferenceInferenceEndpoint {
|
||||
service: string
|
||||
service_settings: InferenceServiceSettings
|
||||
task_settings: InferenceTaskSettings
|
||||
task_settings?: InferenceTaskSettings
|
||||
}
|
||||
|
||||
export interface InferenceInferenceEndpointInfo extends InferenceInferenceEndpoint {
|
||||
@ -12822,6 +12827,20 @@ export interface IngestCircleProcessor extends IngestProcessorBase {
|
||||
target_field?: Field
|
||||
}
|
||||
|
||||
export interface IngestCommunityIDProcessor extends IngestProcessorBase {
|
||||
source_ip?: Field
|
||||
source_port?: Field
|
||||
destination_ip?: Field
|
||||
destination_port?: Field
|
||||
iana_number?: Field
|
||||
icmp_type?: Field
|
||||
icmp_code?: Field
|
||||
transport?: Field
|
||||
target_field?: Field
|
||||
seed?: integer
|
||||
ignore_missing?: boolean
|
||||
}
|
||||
|
||||
export interface IngestConvertProcessor extends IngestProcessorBase {
|
||||
field: Field
|
||||
ignore_missing?: boolean
|
||||
@ -12829,7 +12848,7 @@ export interface IngestConvertProcessor extends IngestProcessorBase {
|
||||
type: IngestConvertType
|
||||
}
|
||||
|
||||
export type IngestConvertType = 'integer' | 'long' | 'float' | 'double' | 'string' | 'boolean' | 'auto'
|
||||
export type IngestConvertType = 'integer' | 'long' | 'double' | 'float' | 'boolean' | 'ip' | 'string' | 'auto'
|
||||
|
||||
export interface IngestCsvProcessor extends IngestProcessorBase {
|
||||
empty_value?: any
|
||||
@ -12862,6 +12881,7 @@ export interface IngestDateProcessor extends IngestProcessorBase {
|
||||
locale?: string
|
||||
target_field?: Field
|
||||
timezone?: string
|
||||
output_format?: string
|
||||
}
|
||||
|
||||
export interface IngestDissectProcessor extends IngestProcessorBase {
|
||||
@ -12894,6 +12914,16 @@ export interface IngestFailProcessor extends IngestProcessorBase {
|
||||
message: string
|
||||
}
|
||||
|
||||
export type IngestFingerprintDigest = 'MD5' | 'SHA-1' | 'SHA-256' | 'SHA-512' | 'MurmurHash3'
|
||||
|
||||
export interface IngestFingerprintProcessor extends IngestProcessorBase {
|
||||
fields: Fields
|
||||
target_field?: Field
|
||||
salt?: string
|
||||
method?: IngestFingerprintDigest
|
||||
ignore_missing?: boolean
|
||||
}
|
||||
|
||||
export interface IngestForeachProcessor extends IngestProcessorBase {
|
||||
field: Field
|
||||
ignore_missing?: boolean
|
||||
@ -12927,6 +12957,7 @@ export interface IngestGeoIpProcessor extends IngestProcessorBase {
|
||||
}
|
||||
|
||||
export interface IngestGrokProcessor extends IngestProcessorBase {
|
||||
ecs_compatibility?: string
|
||||
field: Field
|
||||
ignore_missing?: boolean
|
||||
pattern_definitions?: Record<string, string>
|
||||
@ -13013,6 +13044,15 @@ export interface IngestMaxmind {
|
||||
account_id: Id
|
||||
}
|
||||
|
||||
export interface IngestNetworkDirectionProcessor extends IngestProcessorBase {
|
||||
source_ip?: Field
|
||||
destination_ip?: Field
|
||||
target_field?: Field
|
||||
internal_networks?: string[]
|
||||
internal_networks_field?: Field
|
||||
ignore_missing?: boolean
|
||||
}
|
||||
|
||||
export interface IngestPipeline {
|
||||
description?: string
|
||||
on_failure?: IngestProcessorContainer[]
|
||||
@ -13046,6 +13086,7 @@ export interface IngestProcessorContainer {
|
||||
attachment?: IngestAttachmentProcessor
|
||||
bytes?: IngestBytesProcessor
|
||||
circle?: IngestCircleProcessor
|
||||
community_id?: IngestCommunityIDProcessor
|
||||
convert?: IngestConvertProcessor
|
||||
csv?: IngestCsvProcessor
|
||||
date?: IngestDateProcessor
|
||||
@ -13055,6 +13096,7 @@ export interface IngestProcessorContainer {
|
||||
drop?: IngestDropProcessor
|
||||
enrich?: IngestEnrichProcessor
|
||||
fail?: IngestFailProcessor
|
||||
fingerprint?: IngestFingerprintProcessor
|
||||
foreach?: IngestForeachProcessor
|
||||
geo_grid?: IngestGeoGridProcessor
|
||||
geoip?: IngestGeoIpProcessor
|
||||
@ -13066,8 +13108,10 @@ export interface IngestProcessorContainer {
|
||||
json?: IngestJsonProcessor
|
||||
kv?: IngestKeyValueProcessor
|
||||
lowercase?: IngestLowercaseProcessor
|
||||
network_direction?: IngestNetworkDirectionProcessor
|
||||
pipeline?: IngestPipelineProcessor
|
||||
redact?: IngestRedactProcessor
|
||||
registered_domain?: IngestRegisteredDomainProcessor
|
||||
remove?: IngestRemoveProcessor
|
||||
rename?: IngestRenameProcessor
|
||||
reroute?: IngestRerouteProcessor
|
||||
@ -13076,6 +13120,7 @@ export interface IngestProcessorContainer {
|
||||
set_security_user?: IngestSetSecurityUserProcessor
|
||||
sort?: IngestSortProcessor
|
||||
split?: IngestSplitProcessor
|
||||
terminate?: IngestTerminateProcessor
|
||||
trim?: IngestTrimProcessor
|
||||
uppercase?: IngestUppercaseProcessor
|
||||
urldecode?: IngestUrlDecodeProcessor
|
||||
@ -13094,6 +13139,12 @@ export interface IngestRedactProcessor extends IngestProcessorBase {
|
||||
trace_redact?: boolean
|
||||
}
|
||||
|
||||
export interface IngestRegisteredDomainProcessor extends IngestProcessorBase {
|
||||
field: Field
|
||||
target_field?: Field
|
||||
ignore_missing?: boolean
|
||||
}
|
||||
|
||||
export interface IngestRemoveProcessor extends IngestProcessorBase {
|
||||
field: Fields
|
||||
keep?: Fields
|
||||
@ -13149,6 +13200,9 @@ export interface IngestSplitProcessor extends IngestProcessorBase {
|
||||
target_field?: Field
|
||||
}
|
||||
|
||||
export interface IngestTerminateProcessor extends IngestProcessorBase {
|
||||
}
|
||||
|
||||
export interface IngestTrimProcessor extends IngestProcessorBase {
|
||||
field: Field
|
||||
ignore_missing?: boolean
|
||||
@ -16883,7 +16937,7 @@ export interface NodesInfoNodeInfoSettingsIngest {
|
||||
}
|
||||
|
||||
export interface NodesInfoNodeInfoSettingsNetwork {
|
||||
host?: Host
|
||||
host?: Host | Host[]
|
||||
}
|
||||
|
||||
export interface NodesInfoNodeInfoSettingsNode {
|
||||
@ -16916,6 +16970,7 @@ export interface NodesInfoNodeInfoXpack {
|
||||
license?: NodesInfoNodeInfoXpackLicense
|
||||
security: NodesInfoNodeInfoXpackSecurity
|
||||
notification?: Record<string, any>
|
||||
ml?: NodesInfoNodeInfoXpackMl
|
||||
}
|
||||
|
||||
export interface NodesInfoNodeInfoXpackLicense {
|
||||
@ -16926,16 +16981,20 @@ export interface NodesInfoNodeInfoXpackLicenseType {
|
||||
type: string
|
||||
}
|
||||
|
||||
export interface NodesInfoNodeInfoXpackMl {
|
||||
use_auto_machine_memory_percent?: boolean
|
||||
}
|
||||
|
||||
export interface NodesInfoNodeInfoXpackSecurity {
|
||||
http: NodesInfoNodeInfoXpackSecuritySsl
|
||||
http?: NodesInfoNodeInfoXpackSecuritySsl
|
||||
enabled: string
|
||||
transport?: NodesInfoNodeInfoXpackSecuritySsl
|
||||
authc?: NodesInfoNodeInfoXpackSecurityAuthc
|
||||
}
|
||||
|
||||
export interface NodesInfoNodeInfoXpackSecurityAuthc {
|
||||
realms: NodesInfoNodeInfoXpackSecurityAuthcRealms
|
||||
token: NodesInfoNodeInfoXpackSecurityAuthcToken
|
||||
realms?: NodesInfoNodeInfoXpackSecurityAuthcRealms
|
||||
token?: NodesInfoNodeInfoXpackSecurityAuthcToken
|
||||
}
|
||||
|
||||
export interface NodesInfoNodeInfoXpackSecurityAuthcRealms {
|
||||
@ -17173,6 +17232,24 @@ export interface QueryRulesPutRulesetResponse {
|
||||
result: Result
|
||||
}
|
||||
|
||||
export interface QueryRulesTestQueryRulesetMatchedRule {
|
||||
ruleset_id: Id
|
||||
rule_id: Id
|
||||
}
|
||||
|
||||
export interface QueryRulesTestRequest extends RequestBase {
|
||||
ruleset_id: Id
|
||||
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
|
||||
body?: {
|
||||
match_criteria: Record<string, any>
|
||||
}
|
||||
}
|
||||
|
||||
export interface QueryRulesTestResponse {
|
||||
total_matched_rules: integer
|
||||
matched_rules: QueryRulesTestQueryRulesetMatchedRule[]
|
||||
}
|
||||
|
||||
export interface RollupDateHistogramGrouping {
|
||||
delay?: Duration
|
||||
field: Field
|
||||
@ -17374,10 +17451,13 @@ export interface SearchApplicationEventDataStream {
|
||||
name: IndexName
|
||||
}
|
||||
|
||||
export interface SearchApplicationSearchApplication {
|
||||
export interface SearchApplicationSearchApplication extends SearchApplicationSearchApplicationParameters {
|
||||
name: Name
|
||||
indices: IndexName[]
|
||||
updated_at_millis: EpochTime<UnitMillis>
|
||||
}
|
||||
|
||||
export interface SearchApplicationSearchApplicationParameters {
|
||||
indices: IndexName[]
|
||||
analytics_collection_name?: Name
|
||||
template?: SearchApplicationSearchApplicationTemplate
|
||||
}
|
||||
@ -17418,21 +17498,14 @@ export interface SearchApplicationListRequest extends RequestBase {
|
||||
|
||||
export interface SearchApplicationListResponse {
|
||||
count: long
|
||||
results: SearchApplicationListSearchApplicationListItem[]
|
||||
}
|
||||
|
||||
export interface SearchApplicationListSearchApplicationListItem {
|
||||
name: Name
|
||||
indices: IndexName[]
|
||||
updated_at_millis: EpochTime<UnitMillis>
|
||||
analytics_collection_name?: Name
|
||||
results: SearchApplicationSearchApplication[]
|
||||
}
|
||||
|
||||
export interface SearchApplicationPutRequest extends RequestBase {
|
||||
name: Name
|
||||
create?: boolean
|
||||
/** @deprecated The use of the 'body' key has been deprecated, use 'search_application' instead. */
|
||||
body?: SearchApplicationSearchApplication
|
||||
body?: SearchApplicationSearchApplicationParameters
|
||||
}
|
||||
|
||||
export interface SearchApplicationPutResponse {
|
||||
@ -17594,7 +17667,7 @@ export type SecurityIndexPrivilege = 'all' | 'auto_configure' | 'create' | 'crea
|
||||
|
||||
export interface SecurityIndicesPrivileges {
|
||||
field_security?: SecurityFieldSecurity
|
||||
names: Indices
|
||||
names: IndexName[]
|
||||
privileges: SecurityIndexPrivilege[]
|
||||
query?: SecurityIndicesPrivilegesQuery
|
||||
allow_restricted_indices?: boolean
|
||||
@ -17614,7 +17687,7 @@ export interface SecurityRealmInfo {
|
||||
export interface SecurityRemoteIndicesPrivileges {
|
||||
clusters: Names
|
||||
field_security?: SecurityFieldSecurity
|
||||
names: Indices
|
||||
names: IndexName[]
|
||||
privileges: SecurityIndexPrivilege[]
|
||||
query?: SecurityIndicesPrivilegesQuery
|
||||
allow_restricted_indices?: boolean
|
||||
@ -17692,7 +17765,7 @@ export interface SecurityUser {
|
||||
|
||||
export interface SecurityUserIndicesPrivileges {
|
||||
field_security?: SecurityFieldSecurity[]
|
||||
names: Indices
|
||||
names: IndexName[]
|
||||
privileges: SecurityIndexPrivilege[]
|
||||
query?: SecurityIndicesPrivilegesQuery[]
|
||||
allow_restricted_indices: boolean
|
||||
@ -18017,7 +18090,7 @@ export interface SecurityGetBuiltinPrivilegesRequest extends RequestBase {
|
||||
|
||||
export interface SecurityGetBuiltinPrivilegesResponse {
|
||||
cluster: string[]
|
||||
index: Indices
|
||||
index: IndexName[]
|
||||
}
|
||||
|
||||
export interface SecurityGetPrivilegesRequest extends RequestBase {
|
||||
@ -19174,7 +19247,8 @@ export interface SnapshotRestoreRequest extends RequestBase {
|
||||
}
|
||||
|
||||
export interface SnapshotRestoreResponse {
|
||||
snapshot: SnapshotRestoreSnapshotRestore
|
||||
accepted?: boolean
|
||||
snapshot?: SnapshotRestoreSnapshotRestore
|
||||
}
|
||||
|
||||
export interface SnapshotRestoreSnapshotRestore {
|
||||
|
||||
Reference in New Issue
Block a user