# 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. from .utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params class RollupClient(NamespacedClient): @query_params() def delete_job(self, id, params=None, headers=None): """ Deletes an existing rollup job. ``_ .. warning:: This API is **experimental** so may include breaking changes or be removed in a future version :arg id: The ID of the job to delete """ if id in SKIP_IN_PATH: raise ValueError("Empty value passed for a required argument 'id'.") return self.transport.perform_request( "DELETE", _make_path("_rollup", "job", id), params=params, headers=headers ) @query_params() def get_jobs(self, id=None, params=None, headers=None): """ Retrieves the configuration, stats, and status of rollup jobs. ``_ .. warning:: This API is **experimental** so may include breaking changes or be removed in a future version :arg id: The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs """ return self.transport.perform_request( "GET", _make_path("_rollup", "job", id), params=params, headers=headers ) @query_params() def get_rollup_caps(self, id=None, params=None, headers=None): """ Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. ``_ .. warning:: This API is **experimental** so may include breaking changes or be removed in a future version :arg id: The ID of the index to check rollup capabilities on, or left blank for all jobs """ return self.transport.perform_request( "GET", _make_path("_rollup", "data", id), params=params, headers=headers ) @query_params() def get_rollup_index_caps(self, index, params=None, headers=None): """ Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored). ``_ .. warning:: This API is **experimental** so may include breaking changes or be removed in a future version :arg index: The rollup index or index pattern to obtain rollup capabilities from. """ if index in SKIP_IN_PATH: raise ValueError("Empty value passed for a required argument 'index'.") return self.transport.perform_request( "GET", _make_path(index, "_rollup", "data"), params=params, headers=headers ) @query_params() def put_job(self, id, body, params=None, headers=None): """ Creates a rollup job. ``_ .. warning:: This API is **experimental** so may include breaking changes or be removed in a future version :arg id: The ID of the job to create :arg body: The job configuration """ for param in (id, body): if param in SKIP_IN_PATH: raise ValueError("Empty value passed for a required argument.") return self.transport.perform_request( "PUT", _make_path("_rollup", "job", id), params=params, headers=headers, body=body, ) @query_params("rest_total_hits_as_int", "typed_keys") def rollup_search(self, index, body, doc_type=None, params=None, headers=None): """ Enables searching rolled-up data using the standard query DSL. ``_ .. warning:: This API is **experimental** so may include breaking changes or be removed in a future version :arg index: The indices or index-pattern(s) (containing rollup or regular data) that should be searched :arg body: The search request body :arg doc_type: The doc type inside the index :arg rest_total_hits_as_int: Indicates whether hits.total should be rendered as an integer or an object in the rest search response :arg typed_keys: Specify whether aggregation and suggester names should be prefixed by their respective types in the response """ for param in (index, body): if param in SKIP_IN_PATH: raise ValueError("Empty value passed for a required argument.") return self.transport.perform_request( "POST", _make_path(index, doc_type, "_rollup_search"), params=params, headers=headers, body=body, ) @query_params() def start_job(self, id, params=None, headers=None): """ Starts an existing, stopped rollup job. ``_ .. warning:: This API is **experimental** so may include breaking changes or be removed in a future version :arg id: The ID of the job to start """ if id in SKIP_IN_PATH: raise ValueError("Empty value passed for a required argument 'id'.") return self.transport.perform_request( "POST", _make_path("_rollup", "job", id, "_start"), params=params, headers=headers, ) @query_params("timeout", "wait_for_completion") def stop_job(self, id, params=None, headers=None): """ Stops an existing, started rollup job. ``_ .. warning:: This API is **experimental** so may include breaking changes or be removed in a future version :arg id: The ID of the job to stop :arg timeout: Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s. :arg wait_for_completion: True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false. """ if id in SKIP_IN_PATH: raise ValueError("Empty value passed for a required argument 'id'.") return self.transport.perform_request( "POST", _make_path("_rollup", "job", id, "_stop"), params=params, headers=headers, ) @query_params() def rollup(self, index, rollup_index, body, params=None, headers=None): """ Rollup an index ``_ .. warning:: This API is **experimental** so may include breaking changes or be removed in a future version :arg index: The index to roll up :arg rollup_index: The name of the rollup index to create :arg body: The rollup configuration """ for param in (index, rollup_index, body): if param in SKIP_IN_PATH: raise ValueError("Empty value passed for a required argument.") return self.transport.perform_request( "POST", _make_path(index, "_rollup", rollup_index), params=params, headers=headers, body=body, )