Skip to content

Commit 0ae0d13

Browse files
kosabogikosabogi
committed
Adds cat-h values
1 parent 3f5684d commit 0ae0d13

File tree

6 files changed

+212
-16
lines changed

6 files changed

+212
-16
lines changed

‎specification/cat/_types/CatBase.ts‎

Lines changed: 197 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ export enum CatAnomalyDetectorColumn {
399399
*/
400400
state
401401
}
402-
export type CatAnonalyDetectorColumns =
402+
export type CatAnomalyDetectorColumns =
403403
| CatAnomalyDetectorColumn
404404
| CatAnomalyDetectorColumn[]
405405
export enum CatDatafeedColumn {
@@ -1280,12 +1280,208 @@ export enum CatSnapshotsColumn {
12801280
reason
12811281
}
12821282

1283+
/** @non_exhaustive */
1284+
export enum CatAliasesColumn {
1285+
/**
1286+
* The name of the alias.
1287+
* @aliases a
1288+
*/
1289+
alias,
1290+
/**
1291+
* The name of the index the alias points to.
1292+
* @aliases i, idx
1293+
*/
1294+
index,
1295+
/**
1296+
* The filter applied to the alias.
1297+
* @aliases f, fi
1298+
*/
1299+
filter,
1300+
/**
1301+
* Index routing value for the alias.
1302+
* @aliases ri, routingIndex
1303+
*/
1304+
'routing.index',
1305+
/**
1306+
* Search routing value for the alias.
1307+
* @aliases rs, routingSearch
1308+
*/
1309+
'routing.search',
1310+
/**
1311+
* Indicates if the index is the write index for the alias.
1312+
* @aliases w, isWriteIndex
1313+
*/
1314+
'is_write_index'
1315+
}
1316+
1317+
/** @non_exhaustive */
1318+
export enum CatAllocationColumn {
1319+
/**
1320+
* The number of shards on the node.
1321+
* @aliases s
1322+
*/
1323+
shards,
1324+
/**
1325+
* The number of shards scheduled to be moved elsewhere in the cluster.
1326+
*/
1327+
'shards.undesired',
1328+
/**
1329+
* The sum of index write load forecasts.
1330+
* @aliases wlf, writeLoadForecast
1331+
*/
1332+
'write_load.forecast',
1333+
/**
1334+
* The sum of shard size forecasts.
1335+
* @aliases dif, diskIndicesForecast
1336+
*/
1337+
'disk.indices.forecast',
1338+
/**
1339+
* The disk space used by Elasticsearch indices.
1340+
* @aliases di, diskIndices
1341+
*/
1342+
'disk.indices',
1343+
/**
1344+
* The total disk space used on the node.
1345+
* @aliases du,diskUsed
1346+
*/
1347+
'disk.used',
1348+
/**
1349+
* The available disk space on the node.
1350+
* @aliases da, diskAvail
1351+
*/
1352+
'disk.avail',
1353+
/**
1354+
* The total disk capacity of all volumes on the node.
1355+
* @aliases dt, diskTotal
1356+
*/
1357+
'disk.total',
1358+
/**
1359+
* The percentage of disk space used on the node.
1360+
* @aliases dp, diskPercent
1361+
*/
1362+
'disk.percent',
1363+
/**
1364+
* IThe host of the node.
1365+
* @aliases h
1366+
*/
1367+
host,
1368+
/**
1369+
* The IP address of the node.
1370+
*/
1371+
ip,
1372+
/**
1373+
* The name of the node.
1374+
* @aliases n
1375+
*/
1376+
node,
1377+
/**
1378+
* The roles assigned to the node.
1379+
* @aliases r, role, nodeRole
1380+
*/
1381+
'node.role'
1382+
}
1383+
1384+
/** @non_exhaustive */
1385+
export enum CatComponentColumn {
1386+
/**
1387+
* The name of the component template.
1388+
* @aliases n
1389+
*/
1390+
name,
1391+
/**
1392+
* The version number of the component template.
1393+
* @aliases v
1394+
*/
1395+
version,
1396+
/**
1397+
* The number of aliases in the component template.
1398+
* @aliases a
1399+
*/
1400+
'alias_count',
1401+
/**
1402+
* The number of mappings in the component template.
1403+
* @aliases m
1404+
*/
1405+
'mapping_count',
1406+
/**
1407+
* The number of settings in the component template.
1408+
* @aliases s
1409+
*/
1410+
'settings_count',
1411+
/**
1412+
* The number of metadata entries in the component template.
1413+
* @aliases me
1414+
*/
1415+
'metadata_count',
1416+
/**
1417+
* The index templates that include this component template.
1418+
* @aliases i
1419+
*/
1420+
'included_in'
1421+
}
1422+
1423+
/** @non_exhaustive */
1424+
export enum CatCountColumn {
1425+
/**
1426+
* The Unix epoch time in seconds since 1970-01-01 00:00:00.
1427+
* @aliases t,time
1428+
*/
1429+
epoch,
1430+
/**
1431+
* The current time in HH:MM:SS format.
1432+
* @aliases ts,hms,hhmmss
1433+
*/
1434+
timestamp,
1435+
/**
1436+
* The document count in the cluster or index.
1437+
* @aliases dc,docs.count,docsCount
1438+
*/
1439+
count
1440+
}
1441+
1442+
/** @non_exhaustive */
1443+
export enum CatFieldDataColumn {
1444+
/**
1445+
* The node ID.
1446+
*/
1447+
id,
1448+
/**
1449+
* The host name of the node.
1450+
* @aliases h
1451+
*/
1452+
host,
1453+
/**
1454+
* The IP address of the node.
1455+
*/
1456+
ip,
1457+
/**
1458+
* The node name.
1459+
* @aliases n
1460+
*/
1461+
node,
1462+
/**
1463+
* The field name.
1464+
* @aliases f
1465+
*/
1466+
field,
1467+
/**
1468+
* The field data usage.
1469+
* @aliases s
1470+
*/
1471+
size
1472+
}
1473+
12831474
export type CatDfaColumns = CatDfaColumn | CatDfaColumn[]
12841475
export type CatDatafeedColumns = CatDatafeedColumn | CatDatafeedColumn[]
12851476
export type CatNodeColumns = CatNodeColumn | CatNodeColumn[]
12861477
export type CatRecoveryColumns = CatRecoveryColumn | CatRecoveryColumn[]
12871478
export type CatSegmentsColumns = CatSegmentsColumn | CatSegmentsColumn[]
12881479
export type CatSnapshotsColumns = CatSnapshotsColumn | CatSnapshotsColumn[]
1480+
export type CatAliasesColumns = CatAliasesColumn | CatAliasesColumn[]
1481+
export type CatAllocationColumns = CatAllocationColumn | CatAllocationColumn[]
1482+
export type CatComponentColumns = CatComponentColumn | CatComponentColumn[]
1483+
export type CatCountColumns = CatCountColumn | CatCountColumn[]
1484+
export type CatFieldDataColumns = CatFieldDataColumn | CatFieldDataColumn[]
12891485

12901486
export enum CatTrainedModelsColumn {
12911487
/**

‎specification/cat/aliases/CatAliasesRequest.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
import { ExpandWildcards, Names } from '@_types/common'
2121
import { Duration } from '@_types/Time'
22-
import { CatRequestBase } from '@cat/_types/CatBase'
22+
import { CatAliasesColumns, CatRequestBase } from '@cat/_types/CatBase'
2323

2424
/**
2525
* Get aliases.
@@ -51,9 +51,9 @@ export interface Request extends CatRequestBase {
5151
}
5252
query_parameters: {
5353
/**
54-
* List of columns to appear in the response. Supports simple wildcards.
54+
* A comma-separated list of columns names to display. It supports simple wildcards.
5555
*/
56-
h?: Names
56+
h?: CatAliasesColumns
5757
/**
5858
* List of columns that determine how the table should be sorted.
5959
* Sorting defaults to ascending and can be changed by setting `:asc`

‎specification/cat/allocation/CatAllocationRequest.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
import { Bytes, Names, NodeIds } from '@_types/common'
2121
import { Duration } from '@_types/Time'
22-
import { CatRequestBase } from '@cat/_types/CatBase'
22+
import { CatAllocationColumns, CatRequestBase } from '@cat/_types/CatBase'
2323

2424
/**
2525
* Get shard allocation information.
@@ -52,9 +52,9 @@ export interface Request extends CatRequestBase {
5252
/** The unit used to display byte values. */
5353
bytes?: Bytes
5454
/**
55-
* List of columns to appear in the response. Supports simple wildcards.
55+
* A comma-separated list of columns names to display. It supports simple wildcards.
5656
*/
57-
h?: Names
57+
h?: CatAllocationColumns
5858
/**
5959
* List of columns that determine how the table should be sorted.
6060
* Sorting defaults to ascending and can be changed by setting `:asc`

‎specification/cat/component_templates/CatComponentTemplatesRequest.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
import { Names } from '@_types/common'
2121
import { Duration } from '@_types/Time'
22-
import { CatRequestBase } from '@cat/_types/CatBase'
22+
import { CatComponentColumns, CatRequestBase } from '@cat/_types/CatBase'
2323

2424
/**
2525
* Get component templates.
@@ -55,9 +55,9 @@ export interface Request extends CatRequestBase {
5555
}
5656
query_parameters: {
5757
/**
58-
* List of columns to appear in the response. Supports simple wildcards.
58+
* A comma-separated list of columns names to display. It supports simple wildcards.
5959
*/
60-
h?: Names
60+
h?: CatComponentColumns
6161
/**
6262
* List of columns that determine how the table should be sorted.
6363
* Sorting defaults to ascending and can be changed by setting `:asc`

‎specification/cat/count/CatCountRequest.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
*/
1919

2020
import { Indices, Names } from '@_types/common'
21-
import { CatRequestBase } from '@cat/_types/CatBase'
21+
import { CatCountColumns, CatRequestBase } from '@cat/_types/CatBase'
2222

2323
/**
2424
* Get a document count.
@@ -55,9 +55,9 @@ export interface Request extends CatRequestBase {
5555
}
5656
query_parameters: {
5757
/**
58-
* List of columns to appear in the response. Supports simple wildcards.
58+
* A comma-separated list of columns names to display. It supports simple wildcards.
5959
*/
60-
h?: Names
60+
h?: CatCountColumns
6161
/**
6262
* List of columns that determine how the table should be sorted.
6363
* Sorting defaults to ascending and can be changed by setting `:asc`

‎specification/cat/fielddata/CatFielddataRequest.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
*/
1919

2020
import { Bytes, Fields, Names } from '@_types/common'
21-
import { CatRequestBase } from '@cat/_types/CatBase'
21+
import { CatFieldDataColumns, CatRequestBase } from '@cat/_types/CatBase'
2222

2323
/**
2424
* Get field data cache information.
@@ -57,9 +57,9 @@ export interface Request extends CatRequestBase {
5757
/** Comma-separated list of fields used to limit returned information. */
5858
fields?: Fields
5959
/**
60-
* List of columns to appear in the response. Supports simple wildcards.
60+
* A comma-separated list of columns names to display. It supports simple wildcards.
6161
*/
62-
h?: Names
62+
h?: CatFieldDataColumns
6363
/**
6464
* List of columns that determine how the table should be sorted.
6565
* Sorting defaults to ascending and can be changed by setting `:asc`

0 commit comments

Comments
 (0)