class ElastomerClient::Client::Template
Attributes
Public Class Methods
Source
# File lib/elastomer_client/client/template.rb, line 20 def initialize(client, name) @client = client @name = name end
Create a new template client for making API requests that pertain to template management.
client - ElastomerClient::Client
used for HTTP requests to the server name - The name of the template as a String
Public Instance Methods
Source
# File lib/elastomer_client/client/template.rb, line 52 def create(template, params = {}) response = client.put "/_template/{template}", update_params(params, body: template, action: "template.create", rest_api: "indices.put_template") response.body end
Create the template on the cluster. See www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html
template - The template as a Hash or a JSON encoded String params - Parameters Hash
Returns the response body as a Hash
Source
# File lib/elastomer_client/client/template.rb, line 82 def defaults { template: name } end
Internal: Returns a Hash containing default parameters.
Source
# File lib/elastomer_client/client/template.rb, line 63 def delete(params = {}) response = client.delete "/_template/{template}", update_params(params, action: "template.delete", rest_api: "indices.delete_template") response.body end
Delete the template from the cluster. See www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html#delete
params - Parameters Hash
Returns the response body as a Hash
Source
# File lib/elastomer_client/client/template.rb, line 28 def exists?(params = {}) response = client.head "/_template/{template}", update_params(params, action: "template.exists", rest_api: "indices.exists_template") response.success? end
Returns true if the template already exists on the cluster.
Source
# File lib/elastomer_client/client/template.rb, line 40 def get(params = {}) response = client.get "/_template/{template}", update_params(params, action: "template.get", rest_api: "indices.get_template") response.body end
Get the template from the cluster. See www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html#getting
params - Parameters Hash
Returns the response body as a Hash
Source
# File lib/elastomer_client/client/template.rb, line 75 def update_params(params, overrides = nil) h = defaults.update params h.update overrides unless overrides.nil? h end
Internal: Add default parameters to the ‘params` Hash and then apply `overrides` to the params if any are given.
params - Parameters Hash overrides - Optional parameter overrides as a Hash
Returns a new params Hash.