a _b{@s(ddlmZmZmZGdddeZdS))NamespacedClient _make_path query_paramsc@s&eZdZeddddddddOd d Zed ddddd dddPd dZeddddddQddZeddddddddRddZedddSddZed dddddddd dddd dTddZ eddddd dddUddZ ed ddddddd ddd dVdd Z ed!d d"dddddd dWd#d$Z ed ddddd ddd dXd%d&Z ed ddddddYd'd(Zeddddd ddddZd)d*Zeddddd dd+dd[d,d-Zed dddddd\d.d/Zedddd0dd ddd]d1d2Zeddddd ddd^d3d4Zeddddd ddd_d5d6Zedddd7d dddd`d8d9Zed:d"dddd;dZeddddd dddbd?d@ZedAd dddddddcdBdCZedDdAdddddddddEdFZedGdAd dddddd dedHdIZedAd ddJdddd+dd dfdKdLZedAddJdddd+dd dgdMdNZdS)h CatClientZexpand_wildcardsformathhelplocalsvNcs"|jjdtdd|||dIdHS)a[ Shows information about currently configured aliases to indices including filter and routing infos. :arg name: A comma-separated list of alias names to return :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices: open, closed, hidden, none, all Default: all :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg local: Return local information, do not retrieve the state from master node (default: false) :arg s: Comma-separated list of column names or column aliases to sort by :arg v: Verbose mode. Display column headers GET_cataliasesparamsheadersN transportperform_requestrselfnamerrrE/tmp/pip-target-4jja1joz/lib/python/opensearchpy/_async/client/cat.pyrszCatClient.aliasesbytesZmaster_timeoutcs"|jjdtdd|||dIdHS)a Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. :arg node_id: A comma-separated list of node IDs or names to limit the returned information :arg bytes: The unit in which to display byte values Valid choices: b, k, kb, m, mb, g, gb, t, tb, p, pb :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg local: Return local information, do not retrieve the state from master node (default: false) :arg master_timeout: Explicit operation timeout for connection to master node :arg s: Comma-separated list of column names or column aliases to sort by :arg v: Verbose mode. Display column headers r r allocationrNr)rZnode_idrrrrrr8s  zCatClient.allocationcs"|jjdtdd|||dIdHS)a2 Provides quick access to the document count of the entire cluster, or individual indices. :arg index: A comma-separated list of index names to limit the returned information :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg s: Comma-separated list of column names or column aliases to sort by :arg v: Verbose mode. Display column headers r r countrNrrindexrrrrrrVszCatClient.counttimetscs|jjdd||dIdHS)a[ Returns a concise representation of the cluster health. :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg s: Comma-separated list of column names or column aliases to sort by :arg time: The unit in which to display time values Valid choices: d, h, m, s, ms, micros, nanos :arg ts: Set to false to disable timestamping Default: True :arg v: Verbose mode. Display column headers r z /_cat/healthrNrrrrrrrrhealthkszCatClient.healthcs|jjdd||dIdHS)z Returns help for the Cat APIs. :arg help: Return help information :arg s: Comma-separated list of column names or column aliases to sort by r z/_catrNr!r"rrrrs zCatClient.helpr#Zinclude_unloaded_segmentsprics"|jjdtdd|||dIdHS)a} Returns information about indices: number of primaries and replicas, document counts, disk size, ... :arg index: A comma-separated list of index names to limit the returned information :arg bytes: The unit in which to display byte values Valid choices: b, k, kb, m, mb, g, gb, t, tb, p, pb :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices: open, closed, hidden, none, all Default: all :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg health: A health status ("green", "yellow", or "red" to filter only indices matching the specified health status Valid choices: green, yellow, red :arg help: Return help information :arg include_unloaded_segments: If set to true segment stats will include stats for segments that are not currently loaded into memory :arg local: Return local information, do not retrieve the state from master node (default: false) :arg master_timeout: Explicit operation timeout for connection to master node :arg pri: Set to true to return stats only for primary shards :arg s: Comma-separated list of column names or column aliases to sort by :arg time: The unit in which to display time values Valid choices: d, h, m, s, ms, micros, nanos :arg v: Verbose mode. Display column headers r r indicesrNrrrrrr%s1zCatClient.indicescs|jjdd||dIdHS)ak Returns information about the master node. :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg local: Return local information, do not retrieve the state from master node (default: false) :arg master_timeout: Explicit operation timeout for connection to master node :arg s: Comma-separated list of column names or column aliases to sort by :arg v: Verbose mode. Display column headers r z /_cat/masterrNr!r"rrrmasterszCatClient.masterZfull_idcs|jjdd||dIdHS)a Returns basic statistics about performance of cluster nodes. :arg bytes: The unit in which to display byte values Valid choices: b, k, kb, m, mb, g, gb, t, tb, p, pb :arg format: a short version of the Accept header, e.g. json, yaml :arg full_id: Return the full node ID instead of the shortened version (default: false) :arg h: Comma-separated list of column names to display :arg help: Return help information :arg include_unloaded_segments: If set to true segment stats will include stats for segments that are not currently loaded into memory :arg local: Calculate the selected nodes using the local cluster state rather than the state from master node (default: false) :arg master_timeout: Explicit operation timeout for connection to master node :arg s: Comma-separated list of column names or column aliases to sort by :arg time: The unit in which to display time values Valid choices: d, h, m, s, ms, micros, nanos :arg v: Verbose mode. Display column headers r z /_cat/nodesrNr!r"rrrnodess'zCatClient.nodesZ active_onlyZdetailedcs"|jjdtdd|||dIdHS)a Returns information about index shard recoveries, both on-going completed. :arg index: Comma-separated list or wildcard expression of index names to limit the returned information :arg active_only: If `true`, the response only includes ongoing shard recoveries :arg bytes: The unit in which to display byte values Valid choices: b, k, kb, m, mb, g, gb, t, tb, p, pb :arg detailed: If `true`, the response includes detailed information about shard recoveries :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg s: Comma-separated list of column names or column aliases to sort by :arg time: The unit in which to display time values Valid choices: d, h, m, s, ms, micros, nanos :arg v: Verbose mode. Display column headers r r recoveryrNrrrrrr(szCatClient.recoverycs"|jjdtdd|||dIdHS)a Provides a detailed view of shard allocation on nodes. :arg index: A comma-separated list of index names to limit the returned information :arg bytes: The unit in which to display byte values Valid choices: b, k, kb, m, mb, g, gb, t, tb, p, pb :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg local: Return local information, do not retrieve the state from master node (default: false) :arg master_timeout: Explicit operation timeout for connection to master node :arg s: Comma-separated list of column names or column aliases to sort by :arg time: The unit in which to display time values Valid choices: d, h, m, s, ms, micros, nanos :arg v: Verbose mode. Display column headers r r shardsrNrrrrrr)"szCatClient.shardscs"|jjdtdd|||dIdHS)a Provides low-level information about the segments in the shards of an index. :arg index: A comma-separated list of index names to limit the returned information :arg bytes: The unit in which to display byte values Valid choices: b, k, kb, m, mb, g, gb, t, tb, p, pb :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg s: Comma-separated list of column names or column aliases to sort by :arg v: Verbose mode. Display column headers r r segmentsrNrrrrrr*@szCatClient.segmentscs|jjdd||dIdHS)a Returns a concise representation of the cluster pending tasks. :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg local: Return local information, do not retrieve the state from master node (default: false) :arg master_timeout: Explicit operation timeout for connection to master node :arg s: Comma-separated list of column names or column aliases to sort by :arg time: The unit in which to display time values Valid choices: d, h, m, s, ms, micros, nanos :arg v: Verbose mode. Display column headers r z/_cat/pending_tasksrNr!r"rrr pending_tasksVszCatClient.pending_taskssizecs"|jjdtdd|||dIdHS)a Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools. :arg thread_pool_patterns: A comma-separated list of regular- expressions to filter the thread pools in the output :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg local: Return local information, do not retrieve the state from master node (default: false) :arg master_timeout: Explicit operation timeout for connection to master node :arg s: Comma-separated list of column names or column aliases to sort by :arg size: The multiplier in which to display values Valid choices: , k, m, g, t, p :arg v: Verbose mode. Display column headers r r thread_poolrNr)rZthread_pool_patternsrrrrrr-ns  zCatClient.thread_poolcs"|jjdtdd|||dIdHS)a Shows how much heap memory is currently being used by fielddata on every data node in the cluster. :arg fields: A comma-separated list of fields to return in the output :arg bytes: The unit in which to display byte values Valid choices: b, k, kb, m, mb, g, gb, t, tb, p, pb :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg s: Comma-separated list of column names or column aliases to sort by :arg v: Verbose mode. Display column headers r r fielddatarNr)rfieldsrrrrrr.s  zCatClient.fielddataZinclude_bootstrapcs|jjdd||dIdHS)a Returns information about installed plugins across nodes node. :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg include_bootstrap: Include bootstrap plugins in the response :arg local: Return local information, do not retrieve the state from master node (default: false) :arg master_timeout: Explicit operation timeout for connection to master node :arg s: Comma-separated list of column names or column aliases to sort by :arg v: Verbose mode. Display column headers r z /_cat/pluginsrNr!r"rrrpluginsszCatClient.pluginscs|jjdd||dIdHS)ar Returns information about custom node attributes. :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg local: Return local information, do not retrieve the state from master node (default: false) :arg master_timeout: Explicit operation timeout for connection to master node :arg s: Comma-separated list of column names or column aliases to sort by :arg v: Verbose mode. Display column headers r z/_cat/nodeattrsrNr!r"rrr nodeattrsszCatClient.nodeattrscs|jjdd||dIdHS)az Returns information about snapshot repositories registered in the cluster. :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg local: Return local information, do not retrieve the state from master node :arg master_timeout: Explicit operation timeout for connection to master node :arg s: Comma-separated list of column names or column aliases to sort by :arg v: Verbose mode. Display column headers r z/_cat/repositoriesrNr!r"rrr repositoriesszCatClient.repositoriesZignore_unavailablecs"|jjdtdd|||dIdHS)a. Returns all snapshots in a specific repository. :arg repository: Name of repository from which to fetch the snapshot information :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg ignore_unavailable: Set to true to ignore unavailable snapshots :arg master_timeout: Explicit operation timeout for connection to master node :arg s: Comma-separated list of column names or column aliases to sort by :arg time: The unit in which to display time values Valid choices: d, h, m, s, ms, micros, nanos :arg v: Verbose mode. Display column headers r r snapshotsrNr)r repositoryrrrrrr3s  zCatClient.snapshotsactionsr'Zparent_task_idcs|jjdd||dIdHS)ax Returns information about the tasks currently executing on one or more nodes in the cluster. :arg actions: A comma-separated list of actions that should be returned. Leave empty to return all. :arg detailed: Return detailed task information (default: false) :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg nodes: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes :arg parent_task_id: Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all. :arg s: Comma-separated list of column names or column aliases to sort by :arg time: The unit in which to display time values Valid choices: d, h, m, s, ms, micros, nanos :arg v: Verbose mode. Display column headers r z /_cat/tasksrNr!r"rrrtasks s$zCatClient.taskscs"|jjdtdd|||dIdHS)a Returns information about existing templates. :arg name: A pattern that returned template names must match :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg local: Return local information, do not retrieve the state from master node (default: false) :arg master_timeout: Explicit operation timeout for connection to master node :arg s: Comma-separated list of column names or column aliases to sort by :arg v: Verbose mode. Display column headers r r templatesrNrrrrrr73szCatClient.templatesZallow_no_matchcs&|jjdtdddd|||dIdHS)a Gets configuration and usage information about data frame analytics jobs. :arg id: The ID of the data frame analytics to fetch :arg allow_no_match: Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified) :arg bytes: The unit in which to display byte values Valid choices: b, k, kb, m, mb, g, gb, t, tb, p, pb :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg s: Comma-separated list of column names or column aliases to sort by :arg time: The unit in which to display time values Valid choices: d, h, m, s, ms, micros, nanos :arg v: Verbose mode. Display column headers r r mlZ data_frameZ analyticsrNr)ridrrrrrml_data_frame_analyticsJs z!CatClient.ml_data_frame_analyticsZallow_no_datafeedscs$|jjdtddd|||dIdHS)a Gets configuration and usage information about datafeeds. :arg datafeed_id: The ID of the datafeeds stats to fetch :arg allow_no_datafeeds: Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) :arg allow_no_match: Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg s: Comma-separated list of column names or column aliases to sort by :arg time: The unit in which to display time values Valid choices: d, h, m, s, ms, micros, nanos :arg v: Verbose mode. Display column headers r r r8Z datafeedsrNr)rZ datafeed_idrrrrr ml_datafeedsgs  zCatClient.ml_datafeedsZ allow_no_jobscs$|jjdtddd|||dIdHS)a? Gets configuration and usage information about anomaly detection jobs. :arg job_id: The ID of the jobs stats to fetch :arg allow_no_jobs: Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) :arg allow_no_match: Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) :arg bytes: The unit in which to display byte values Valid choices: b, k, kb, m, mb, g, gb, t, tb, p, pb :arg format: a short version of the Accept header, e.g. json, yaml :arg h: Comma-separated list of column names to display :arg help: Return help information :arg s: Comma-separated list of column names or column aliases to sort by :arg time: The unit in which to display time values Valid choices: d, h, m, s, ms, micros, nanos :arg v: Verbose mode. Display column headers r r r8Zanomaly_detectorsrNr)rZjob_idrrrrrml_jobss # zCatClient.ml_jobsfrom_cs:d|vr|d|d<|jjdtddd|||dIdHS) aO Gets configuration and usage information about inference trained models. :arg model_id: The ID of the trained models stats to fetch :arg allow_no_match: Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) Default: True :arg bytes: The unit in which to display byte values Valid choices: b, k, kb, m, mb, g, gb, t, tb, p, pb :arg format: a short version of the Accept header, e.g. json, yaml :arg from_: skips a number of trained models :arg h: Comma-separated list of column names to display :arg help: Return help information :arg s: Comma-separated list of column names or column aliases to sort by :arg size: specifies a max number of trained models to get Default: 100 :arg time: The unit in which to display time values Valid choices: d, h, m, s, ms, micros, nanos :arg v: Verbose mode. Display column headers r=fromr r r8Ztrained_modelsrNpoprrr)rZmodel_idrrrrrml_trained_modelss% zCatClient.ml_trained_modelscs8d|vr|d|d<|jjdtdd|||dIdHS)a Gets configuration and usage information about transforms. :arg transform_id: The id of the transform for which to get stats. '_all' or '*' implies all transforms :arg allow_no_match: Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) :arg format: a short version of the Accept header, e.g. json, yaml :arg from_: skips a number of transform configs, defaults to 0 :arg h: Comma-separated list of column names to display :arg help: Return help information :arg s: Comma-separated list of column names or column aliases to sort by :arg size: specifies a max number of transforms to get, defaults to 100 :arg time: The unit in which to display time values Valid choices: d, h, m, s, ms, micros, nanos :arg v: Verbose mode. Display column headers r=r>r r transformsrNr?)rZ transform_idrrrrrrBs zCatClient.transforms)NNN)NNN)NNN)NN)NN)NNN)NN)NN)NNN)NNN)NNN)NN)NNN)NNN)NN)NN)NN)NNN)NN)NNN)NNN)NNN)NNN)NNN)NNN)__name__ __module__ __qualname__rrrrr#rr%r&r'r(r)r*r+r-r.r0r1r2r3r6r7r:r;r<rArBrrrrrs      &                  #rN)utilsrrrrrrrrs