File: //home/arjun/projects/env/lib/python3.10/site-packages/elasticsearch/_sync/client/ingest.py
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
import typing as t
from elastic_transport import ObjectApiResponse
from ._base import NamespacedClient
from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
class IngestClient(NamespacedClient):
@_rewrite_parameters()
def delete_pipeline(
self,
*,
id: str,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
master_timeout: t.Optional[
t.Union["t.Literal[-1]", "t.Literal[0]", str]
] = None,
pretty: t.Optional[bool] = None,
timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
) -> ObjectApiResponse[t.Any]:
"""
Deletes a pipeline.
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/delete-pipeline-api.html>`_
:param id: Pipeline ID or wildcard expression of pipeline IDs used to limit the
request. To delete all ingest pipelines in a cluster, use a value of `*`.
:param master_timeout: 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.
:param timeout: Period to wait for a response. If no response is received before
the timeout expires, the request fails and returns an error.
"""
if id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'id'")
__path = f"/_ingest/pipeline/{_quote(id)}"
__query: t.Dict[str, t.Any] = {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if master_timeout is not None:
__query["master_timeout"] = master_timeout
if pretty is not None:
__query["pretty"] = pretty
if timeout is not None:
__query["timeout"] = timeout
__headers = {"accept": "application/json"}
return self.perform_request( # type: ignore[return-value]
"DELETE", __path, params=__query, headers=__headers
)
@_rewrite_parameters()
def geo_ip_stats(
self,
*,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Returns statistical information about geoip databases
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/geoip-processor.html>`_
"""
__path = "/_ingest/geoip/stats"
__query: t.Dict[str, t.Any] = {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
__headers = {"accept": "application/json"}
return self.perform_request( # type: ignore[return-value]
"GET", __path, params=__query, headers=__headers
)
@_rewrite_parameters()
def get_pipeline(
self,
*,
id: t.Optional[str] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
master_timeout: t.Optional[
t.Union["t.Literal[-1]", "t.Literal[0]", str]
] = None,
pretty: t.Optional[bool] = None,
summary: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Returns a pipeline.
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/get-pipeline-api.html>`_
:param id: Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions
are supported. To get all ingest pipelines, omit this parameter or use `*`.
:param master_timeout: 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.
:param summary: Return pipelines without their definitions (default: false)
"""
if id not in SKIP_IN_PATH:
__path = f"/_ingest/pipeline/{_quote(id)}"
else:
__path = "/_ingest/pipeline"
__query: t.Dict[str, t.Any] = {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if master_timeout is not None:
__query["master_timeout"] = master_timeout
if pretty is not None:
__query["pretty"] = pretty
if summary is not None:
__query["summary"] = summary
__headers = {"accept": "application/json"}
return self.perform_request( # type: ignore[return-value]
"GET", __path, params=__query, headers=__headers
)
@_rewrite_parameters()
def processor_grok(
self,
*,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Returns a list of the built-in patterns.
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/grok-processor.html>`_
"""
__path = "/_ingest/processor/grok"
__query: t.Dict[str, t.Any] = {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
__headers = {"accept": "application/json"}
return self.perform_request( # type: ignore[return-value]
"GET", __path, params=__query, headers=__headers
)
@_rewrite_parameters(
body_fields=True,
parameter_aliases={"_meta": "meta"},
)
def put_pipeline(
self,
*,
id: str,
description: t.Optional[str] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
if_version: t.Optional[int] = None,
master_timeout: t.Optional[
t.Union["t.Literal[-1]", "t.Literal[0]", str]
] = None,
meta: t.Optional[t.Mapping[str, t.Any]] = None,
on_failure: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
pretty: t.Optional[bool] = None,
processors: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
version: t.Optional[int] = None,
) -> ObjectApiResponse[t.Any]:
"""
Creates or updates a pipeline.
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/ingest.html>`_
:param id: ID of the ingest pipeline to create or update.
:param description: Description of the ingest pipeline.
:param if_version: Required version for optimistic concurrency control for pipeline
updates
:param master_timeout: 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.
:param meta: Optional metadata about the ingest pipeline. May have any contents.
This map is not automatically generated by Elasticsearch.
:param on_failure: Processors to run immediately after a processor failure. Each
processor supports a processor-level `on_failure` value. If a processor without
an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter
as a fallback. The processors in this parameter run sequentially in the order
specified. Elasticsearch will not attempt to run the pipeline's remaining
processors.
:param processors: Processors used to perform transformations on documents before
indexing. Processors run sequentially in the order specified.
:param timeout: Period to wait for a response. If no response is received before
the timeout expires, the request fails and returns an error.
:param version: Version number used by external systems to track ingest pipelines.
This parameter is intended for external systems only. Elasticsearch does
not use or validate pipeline version numbers.
"""
if id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'id'")
__path = f"/_ingest/pipeline/{_quote(id)}"
__body: t.Dict[str, t.Any] = {}
__query: t.Dict[str, t.Any] = {}
if description is not None:
__body["description"] = description
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if if_version is not None:
__query["if_version"] = if_version
if master_timeout is not None:
__query["master_timeout"] = master_timeout
if meta is not None:
__body["_meta"] = meta
if on_failure is not None:
__body["on_failure"] = on_failure
if pretty is not None:
__query["pretty"] = pretty
if processors is not None:
__body["processors"] = processors
if timeout is not None:
__query["timeout"] = timeout
if version is not None:
__body["version"] = version
__headers = {"accept": "application/json", "content-type": "application/json"}
return self.perform_request( # type: ignore[return-value]
"PUT", __path, params=__query, headers=__headers, body=__body
)
@_rewrite_parameters(
body_fields=True,
)
def simulate(
self,
*,
id: t.Optional[str] = None,
docs: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
pipeline: t.Optional[t.Mapping[str, t.Any]] = None,
pretty: t.Optional[bool] = None,
verbose: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Allows to simulate a pipeline with example documents.
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/simulate-pipeline-api.html>`_
:param id: Pipeline to test. If you don’t specify a `pipeline` in the request
body, this parameter is required.
:param docs: Sample documents to test in the pipeline.
:param pipeline: Pipeline to test. If you don’t specify the `pipeline` request
path parameter, this parameter is required. If you specify both this and
the request path parameter, the API only uses the request path parameter.
:param verbose: If `true`, the response includes output data for each processor
in the executed pipeline.
"""
if id not in SKIP_IN_PATH:
__path = f"/_ingest/pipeline/{_quote(id)}/_simulate"
else:
__path = "/_ingest/pipeline/_simulate"
__body: t.Dict[str, t.Any] = {}
__query: t.Dict[str, t.Any] = {}
if docs is not None:
__body["docs"] = docs
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pipeline is not None:
__body["pipeline"] = pipeline
if pretty is not None:
__query["pretty"] = pretty
if verbose is not None:
__query["verbose"] = verbose
__headers = {"accept": "application/json", "content-type": "application/json"}
return self.perform_request( # type: ignore[return-value]
"POST", __path, params=__query, headers=__headers, body=__body
)