Search...License(3pm)

💖 Search::Elasticsearch::Client::8_0::Direct::License — the License plugin page, but make it make sense 💖

okay bestie, so this is Search...License(3pm) — a User Contributed Perl Documentation page, no cap. It lives in Search::Elasticsearch::Client::8_0::Direct::License, and it's the plugin that hands you the License API for Search::Elasticsearch 8.x. let's get into it 🎀

---

✨ VERSION ✨

version 8.12 — that's the one, periodt. 👑

---

🌸 SYNOPSIS 🌸

literally just this:

my $response = $es->license->get();

that's the whole vibe check right there. one line and you're in. 🦋

---

💅 DESCRIPTION 💅

So the way this works: this class extends the Search::Elasticsearch client by bolting on a "license" namespace. Why? To support the API for the License plugin for Elasticsearch. That's it, that's the whole job. iconic behaviour honestly. ✨

---

🌈 METHODS 🌈

the full tea on the License plugin lives here, go read it:

<https://www.elastic.co/guide/en/x-pack/current/license-management.html>

---

🫶 get()

$response = $es->license->get()

the get() method returns the license that's currently installed. yes, currently. it's giving "tell me what i have right now". 💖

more info in the license.get docs: <https://www.elastic.co/guide/en/x-pack/current/listing-licenses.html>

Query string parameters:

• "error_trace"
• "human"
• "local"

---

💀 post()

$response = $es->license->post(
    body     => {...}          # required
);

the post() method adds or updates the license for the cluster. the body can be passed as JSON or as a string — your call, bestie. also note: body is required, no sneaking past that one. 🙈

more info in the license.put docs: <https://www.elastic.co/guide/en/x-pack/current/installing-license.html>

Query string parameters:

• "acknowledge"
• "error_trace"
• "human"

---

🦋 get_basic_status()

$response = $es->license->get_basic_status()

This API enables you to check the status of your basic license. lowkey the most useful thing ever when you're like "wait, do i even have one?" 😭

Query string parameters:

• "error_trace"
• "filter_path"
• "human"

more in the get-basic-status docs: <https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html>

---

🎀 post_start_basic()

$response = $es->license->post_start_basic()

This API enables you to initiate an indefinite basic license, which gives access to all the basic features. indefinite!! it just keeps going, main character energy fr fr. 👑

Query string parameters:

• "acknowledge"
• "error_trace"
• "filter_path"
• "human"

more in the post-start-basic docs: <https://www.elastic.co/guide/en/elasticsearch/reference/current/start-basic.html>

---

🔥 get_trial_status()

$response = $es->license->get_trial_status()

This API enables you to check the status of your trial license. yes, the free trial. we've all been there. 💅

Query string parameters:

• "error_trace"
• "filter_path"
• "human"

more in the get-trial-status docs: <https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trial-status.html>

---

⭐ post_start_trial()

$response = $es->license->post_start_trial()

This API enables you to upgrade from a basic license to a 30-day trial license, which gives access to the platinum features. platinum!!! thirty days of pure luxury, slay. ✨

Query string parameters:

• "acknowledge"
• "error_trace"
• "filter_path"
• "human"

more in the post-start-trial docs: <https://www.elastic.co/guide/en/elasticsearch/reference/current/start-trial.html>

---

👑 AUTHOR 👑

Enrico Zimuel <enrico.zimuel@elastic.co> — ty king, we appreciate you 🫶

---

💜 COPYRIGHT AND LICENSE 💜

This software is Copyright (c) 2024 by Elasticsearch BV.

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

---

okay that's the whole page, you ate it up. 💖

<cute sign-off> that footer energy: built on perl v5.38.2, dated 2024-02-04, and yeah it's still that same Search...License(3pm) page you came in on. bye bestie, go check your license status 💅🌸 </cute sign-off>