Search...License(3pm)

📦 version 7.715, in ubuntu jammy

💖 Search...License(3pm) 💖

okay bestie, so this whole page is the manual for Search::Elasticsearch::Client::7_0::Direct::License — that's the License plugin API situation for Search::Elasticsearch 7.x, and it's filed under the manual name Search...License(3pm). it's giving "let me manage your Elasticsearch licenses" and honestly? iconic. 🌸

✨ NAME ✨

Search::Elasticsearch::Client::7_0::Direct::License — the plugin that hands you the License API for Search::Elasticsearch 7.x 🎀

🦋 VERSION 🦋

version 7.715

🌈 SYNOPSIS 🌈

like, the tiniest taste:

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

💅 DESCRIPTION 💅

so this class extends the Search::Elasticsearch client with a "license" namespace, and that namespace exists to support the API for the License plugin for Elasticsearch. that's the whole vibe. periodt. ✨

👑 METHODS 👑

the full documentation for the License plugin lives right here, no gatekeeping:

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

🌸 get() 🌸

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

the "get()" method returns the currently installed license. that's it, that's the method. lowkey the easiest one here 🫶

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

query string parameters you can throw at it:

  • "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 choice, bestie, both are valid 💜

heads up: body is required here, no skipping it 🙈

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

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. casual little vibe check on your license 💅

query string parameters:

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

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

⭐ 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!! main character license energy fr fr 👑

query string parameters:

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

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

🧚 get_trial_status() 🧚

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

this API enables you to check the status of your trial license. same energy as the basic one but make it trial ✨

query string parameters:

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

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

💖 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!! not me getting emotional over license tiers 😭 that's the glow-up arc 🦋

query string parameters:

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

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

🌟 AUTHOR 🌟

Enrico Zimuel <enrico.zimuel@elastic.co>

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

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

and that's the whole page, bestie 🫶 this was perl v5.32.1, dated 2021-10-23, and it's the Search...License(3pm) page — stay slay, go manage those licenses 💅✨

📦 where this page comes from