habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Auto-generated code for 8.16 (#2470)

Browse Source
This commit is contained in:
Elastic Machine
2024-11-18 18:27:50 +01:00
committed by GitHub
parent 1e103baec1
commit 47de886973
17 changed files with 290 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/doc_examples/19d60e4890cc57151d596326484d9076.asciidoc
View File

@ -1,11 +0,0 @@
// 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.transport.request({
method: "DELETE",
path: "/_ingest/geoip/database/my-database-id",
});
console.log(response);
----

2
docs/doc_examples/3fab530a2e43807929c0ef3ebf7d268c.asciidoc → docs/doc_examples/216e24f05cbb82c1718713fbab8623d2.asciidoc
View File

@ -5,7 +5,7 @@
----
const response = await client.ingest.putPipeline({
id: "geoip",
description: "Add geoip info",
description: "Add ip geolocation info",
processors: [
{
geoip: {

2
docs/doc_examples/d3a558ef226e9dccc1c7c61e1167547f.asciidoc → docs/doc_examples/334811cfceb6858aeec5b3461717dd63.asciidoc
View File

@ -5,7 +5,7 @@
----
const response = await client.ingest.putPipeline({
id: "geoip",
description: "Add geoip info",
description: "Add ip geolocation info",
processors: [
{
geoip: {

11
docs/doc_examples/3b6718257421b5419bf4cd6a7303c57e.asciidoc
View File

@ -1,11 +0,0 @@
// 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.transport.request({
method: "GET",
path: "/_ingest/geoip/database/my-database-id",
});
console.log(response);
----

11
docs/doc_examples/533087d787b48878a0bf3fa8d0851b64.asciidoc
View File

@ -1,11 +0,0 @@
// 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.transport.request({
method: "DELETE",
path: "/_ingest/geoip/database/example-database-id",
});
console.log(response);
----

8
docs/doc_examples/4b113c7f475cfe484a150ddbb8e6c5c7.asciidoc → docs/doc_examples/5e021307d331a4483a5aa2198168451b.asciidoc
View File

@ -4,7 +4,7 @@
[source, js]
----
const response = await client.security.putRole({
name: "role_with_remote_indices",
name: "only_remote_access_role",
remote_indices: [
{
clusters: ["my_remote"],
@ -12,6 +12,12 @@ const response = await client.security.putRole({
privileges: ["read", "read_cross_cluster", "view_index_metadata"],
},
],
remote_cluster: [
{
clusters: ["my_remote"],
privileges: ["monitor_stats"],
},
],
});
console.log(response);
----

34
docs/doc_examples/7f1fade93225f8cf6000b93334d76ce4.asciidoc Normal file
View File

@ -0,0 +1,34 @@
// 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.ingest.putPipeline({
id: "ip_location",
description: "Add ip geolocation info",
processors: [
{
ip_location: {
field: "ip",
},
},
],
});
console.log(response);
const response1 = await client.index({
index: "my-index-000001",
id: "my_id",
pipeline: "ip_location",
document: {
ip: "80.231.5.0",
},
});
console.log(response1);
const response2 = await client.get({
index: "my-index-000001",
id: "my_id",
});
console.log(response2);
----

13
docs/doc_examples/9313f534e1aa266cde7d4af74665497f.asciidoc Normal file
View File

@ -0,0 +1,13 @@
// 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.connector.put({
connector_id: "my-{service-name-stub}-connector",
index_name: "my-elasticsearch-index",
name: "Content synced from {service-name}",
service_type: "{service-name-stub}",
});
console.log(response);
----

34
docs/doc_examples/a3779f21f132787c48681bfb50453592.asciidoc Normal file
View File

@ -0,0 +1,34 @@
// 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.ingest.putPipeline({
id: "ip_location",
description: "Add ip geolocation info",
processors: [
{
ip_location: {
field: "ip",
},
},
],
});
console.log(response);
const response1 = await client.index({
index: "my-index-000001",
id: "my_id",
pipeline: "ip_location",
document: {
ip: "89.160.20.128",
},
});
console.log(response1);
const response2 = await client.get({
index: "my-index-000001",
id: "my_id",
});
console.log(response2);
----

14
docs/doc_examples/ae3473adaf1515afcf7773f26c018e5c.asciidoc Normal file
View 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.connector.put({
connector_id: "my-{service-name-stub}-connector",
index_name: "my-elasticsearch-index",
name: "Content synced from {service-name}",
service_type: "{service-name-stub}",
is_native: true,
});
console.log(response);
----

2
docs/doc_examples/b577e7e7eb5ce9d16cb582356e2cc45c.asciidoc → docs/doc_examples/b0ee6f19875fe5bad8aab02d60e3532c.asciidoc
View File

@ -5,7 +5,7 @@
----
const response = await client.ingest.putPipeline({
id: "geoip",
description: "Add geoip info",
description: "Add ip geolocation info",
processors: [
{
geoip: {

9
docs/doc_examples/981b331db1404b39c1a612a135e4e76d.asciidoc → docs/doc_examples/e22a1da3c622611be6855e534c0709ae.asciidoc
View File

@ -4,12 +4,11 @@
[source, js]
----
const response = await client.transport.request({
method: "PUT",
path: "/_ingest/geoip/database/my-database-id",
method: "POST",
path: "/_query_rules/my-ruleset/_test",
body: {
name: "GeoIP2-Domain",
maxmind: {
account_id: "1025402",
match_criteria: {
query_string: "puggles",
},
},
});

36
docs/doc_examples/e308899a306e61d1a590868308689955.asciidoc Normal file
View File

@ -0,0 +1,36 @@
// 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.ingest.putPipeline({
id: "ip_location",
description: "Add ip geolocation info",
processors: [
{
ip_location: {
field: "ip",
target_field: "geo",
database_file: "GeoLite2-Country.mmdb",
},
},
],
});
console.log(response);
const response1 = await client.index({
index: "my-index-000001",
id: "my_id",
pipeline: "ip_location",
document: {
ip: "89.160.20.128",
},
});
console.log(response1);
const response2 = await client.get({
index: "my-index-000001",
id: "my_id",
});
console.log(response2);
----

35
docs/reference.asciidoc
View File

@ -5884,6 +5884,17 @@ client.ingest.deleteGeoipDatabase({ id })
If no response is received before the timeout expires, the request fails and returns an error.
** *`timeout` (Optional, string | -1 | 0)*: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
[discrete]
==== delete_ip_location_database
Deletes an ip location database configuration
{ref}/delete-ip-location-database-api.html[Endpoint documentation]
[source,ts]
----
client.ingest.deleteIpLocationDatabase()
----
[discrete]
==== delete_pipeline
Deletes one or more existing ingest pipeline.
@ -5936,6 +5947,17 @@ To get all database configurations, omit this parameter or use `*`.
** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error.
[discrete]
==== get_ip_location_database
Returns the specified ip location database configuration
{ref}/get-ip-location-database-api.html[Endpoint documentation]
[source,ts]
----
client.ingest.getIpLocationDatabase()
----
[discrete]
==== get_pipeline
Returns information about one or more ingest pipelines.
@ -5993,6 +6015,17 @@ At present, the only supported provider is maxmind, and the maxmind provider req
If no response is received before the timeout expires, the request fails and returns an error.
** *`timeout` (Optional, string | -1 | 0)*: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
[discrete]
==== put_ip_location_database
Puts the configuration for a ip location database to be downloaded
{ref}/put-ip-location-database-api.html[Endpoint documentation]
[source,ts]
----
client.ingest.putIpLocationDatabase()
----
[discrete]
==== put_pipeline
Creates or updates an ingest pipeline.
@ -11214,7 +11247,7 @@ client.tasks.list({ ... })
** *`actions` (Optional, string | string[])*: List or wildcard expression of actions used to limit the request.
** *`detailed` (Optional, boolean)*: If `true`, the response includes detailed information about shard recoveries.
** *`group_by` (Optional, Enum("nodes" | "parents" | "none"))*: Key used to group tasks in the response.
** *`node_id` (Optional, string[])*: List of node IDs or names used to limit returned information.
** *`nodes` (Optional, string | string[])*: List of node IDs or names used to limit returned information.
** *`parent_task_id` (Optional, string)*: Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of `-1`.
** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
** *`timeout` (Optional, string | -1 | 0)*: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

103
src/api/api/ingest.ts
View File

@ -76,6 +76,38 @@ export default class Ingest {
return await this.transport.request({ path, method, querystring, body, meta }, options)
}
/**
* Deletes an ip location database configuration
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-ip-location-database-api.html | Elasticsearch API documentation}
*/
async deleteIpLocationDatabase (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async deleteIpLocationDatabase (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
async deleteIpLocationDatabase (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
async deleteIpLocationDatabase (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['id']
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]
}
}
const method = 'DELETE'
const path = `/_ingest/ip_location/database/${encodeURIComponent(params.id.toString())}`
const meta: TransportRequestMetadata = {
name: 'ingest.delete_ip_location_database',
pathParts: {
id: params.id
}
}
return await this.transport.request({ path, method, querystring, body, meta }, options)
}
/**
* Deletes one or more existing ingest pipeline.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-pipeline-api.html | Elasticsearch API documentation}
@ -178,6 +210,45 @@ export default class Ingest {
return await this.transport.request({ path, method, querystring, body, meta }, options)
}
/**
* Returns the specified ip location database configuration
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-ip-location-database-api.html | Elasticsearch API documentation}
*/
async getIpLocationDatabase (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async getIpLocationDatabase (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
async getIpLocationDatabase (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
async getIpLocationDatabase (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['id']
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.id != null) {
method = 'GET'
path = `/_ingest/ip_location/database/${encodeURIComponent(params.id.toString())}`
} else {
method = 'GET'
path = '/_ingest/ip_location/database'
}
const meta: TransportRequestMetadata = {
name: 'ingest.get_ip_location_database',
pathParts: {
id: params.id
}
}
return await this.transport.request({ path, method, querystring, body, meta }, options)
}
/**
* Returns information about one or more ingest pipelines. This API returns a local reference of the pipeline.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-pipeline-api.html | Elasticsearch API documentation}
@ -292,6 +363,38 @@ export default class Ingest {
return await this.transport.request({ path, method, querystring, body, meta }, options)
}
/**
* Puts the configuration for a ip location database to be downloaded
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-ip-location-database-api.html | Elasticsearch API documentation}
*/
async putIpLocationDatabase (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async putIpLocationDatabase (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
async putIpLocationDatabase (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
async putIpLocationDatabase (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['id']
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]
}
}
const method = 'PUT'
const path = `/_ingest/ip_location/database/${encodeURIComponent(params.id.toString())}`
const meta: TransportRequestMetadata = {
name: 'ingest.put_ip_location_database',
pathParts: {
id: params.id
}
}
return await this.transport.request({ path, method, querystring, body, meta }, options)
}
/**
* Creates or updates an ingest pipeline. Changes made using this API take effect immediately.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ingest.html | Elasticsearch API documentation}

5
src/api/types.ts
View File

@ -10932,6 +10932,8 @@ export interface IndicesIndexTemplate {
_meta?: Metadata
allow_auto_create?: boolean
data_stream?: IndicesIndexTemplateDataStreamConfiguration
deprecated?: boolean
ignore_missing_component_templates?: Names
}
export interface IndicesIndexTemplateDataStreamConfiguration {
@ -17336,6 +17338,7 @@ export interface SecurityRemoteIndicesPrivileges {
export interface SecurityReplicationAccess {
names: IndexName[]
allow_restricted_indices?: boolean
}
export interface SecurityRoleDescriptor {
@ -19130,7 +19133,7 @@ export interface TasksListRequest extends RequestBase {
actions?: string | string[]
detailed?: boolean
group_by?: TasksGroupBy
node_id?: string[]
nodes?: NodeIds
parent_task_id?: Id
master_timeout?: Duration
timeout?: Duration

5
src/api/typesWithBodyKey.ts
View File

@ -11109,6 +11109,8 @@ export interface IndicesIndexTemplate {
_meta?: Metadata
allow_auto_create?: boolean
data_stream?: IndicesIndexTemplateDataStreamConfiguration
deprecated?: boolean
ignore_missing_component_templates?: Names
}
export interface IndicesIndexTemplateDataStreamConfiguration {
@ -17716,6 +17718,7 @@ export interface SecurityRemoteIndicesPrivileges {
export interface SecurityReplicationAccess {
names: IndexName[]
allow_restricted_indices?: boolean
}
export interface SecurityRoleDescriptor {
@ -19624,7 +19627,7 @@ export interface TasksListRequest extends RequestBase {
actions?: string | string[]
detailed?: boolean
group_by?: TasksGroupBy
node_id?: string[]
nodes?: NodeIds
parent_task_id?: Id
master_timeout?: Duration
timeout?: Duration