.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Search::Elasticsearch::Client::6_0::Direct::XPack::License 3pm" .TH Search::Elasticsearch::Client::6_0::Direct::XPack::License 3pm "2020-06-29" "perl v5.30.3" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Search::Elasticsearch::Client::6_0::Direct::XPack::License \- Plugin providing License API for Search::Elasticsearch 6.x .SH "VERSION" .IX Header "VERSION" version 6.81 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& my $response = $es\->xpack\->license\->get(); .Ve .SS "\s-1DESCRIPTION\s0" .IX Subsection "DESCRIPTION" This class extends the Search::Elasticsearch client with a \f(CW\*(C`license\*(C'\fR namespace, to support the \s-1API\s0 for the License plugin for Elasticsearch. .SH "METHODS" .IX Header "METHODS" The full documentation for the License plugin is available here: .ie n .SS """get()""" .el .SS "\f(CWget()\fP" .IX Subsection "get()" .Vb 1 \& $response = $es\->xpack\->license\->get() .Ve .PP The \f(CW\*(C`get()\*(C'\fR method returns the currently installed license. .PP See the license.get docs for more information. .PP Query string parameters: \f(CW\*(C`error_trace\*(C'\fR, \f(CW\*(C`human\*(C'\fR, \f(CW\*(C`local\*(C'\fR .ie n .SS """post()""" .el .SS "\f(CWpost()\fP" .IX Subsection "post()" .Vb 3 \& $response = $es\->xpack\->license\->post( \& body => {...} # required \& ); .Ve .PP The \f(CW\*(C`post()\*(C'\fR method adds or updates the license for the cluster. The \f(CW\*(C`body\*(C'\fR can be passed as \s-1JSON\s0 or as a string. .PP See the license.put docs for more information. .PP Query string parameters: \f(CW\*(C`acknowledge\*(C'\fR, \f(CW\*(C`error_trace\*(C'\fR, \f(CW\*(C`human\*(C'\fR .ie n .SS """get_basic_status()""" .el .SS "\f(CWget_basic_status()\fP" .IX Subsection "get_basic_status()" .Vb 1 \& $response = $es\->xpack\->license\->get_basic_status() .Ve .PP This \s-1API\s0 enables you to check the status of your basic license. .PP Query string parameters: \f(CW\*(C`error_trace\*(C'\fR, \f(CW\*(C`filter_path\*(C'\fR, \f(CW\*(C`human\*(C'\fR .PP See the get-basic-status docs for more. .ie n .SS """post_start_basic()""" .el .SS "\f(CWpost_start_basic()\fP" .IX Subsection "post_start_basic()" .Vb 1 \& $response = $es\->xpack\->license\->post_start_basic() .Ve .PP This \s-1API\s0 enables you to initiate an indefinite basic license, which gives access to all the basic features. .PP Query string parameters: \f(CW\*(C`acknowledge\*(C'\fR, \f(CW\*(C`error_trace\*(C'\fR, \f(CW\*(C`filter_path\*(C'\fR, \f(CW\*(C`human\*(C'\fR .PP See the post-start-basic docs for more. .ie n .SS """get_trial_status()""" .el .SS "\f(CWget_trial_status()\fP" .IX Subsection "get_trial_status()" .Vb 1 \& $response = $es\->xpack\->license\->get_trial_status() .Ve .PP This \s-1API\s0 enables you to check the status of your trial license. .PP Query string parameters: \f(CW\*(C`error_trace\*(C'\fR, \f(CW\*(C`filter_path\*(C'\fR, \f(CW\*(C`human\*(C'\fR .PP See the get-trial-status docs for more. .ie n .SS """post_start_trial()""" .el .SS "\f(CWpost_start_trial()\fP" .IX Subsection "post_start_trial()" .Vb 1 \& $response = $es\->xpack\->license\->post_start_trial() .Ve .PP This \s-1API\s0 enables you to upgrade from a basic license to a 30\-day trial license, which gives access to the platinum features. .PP Query string parameters: \f(CW\*(C`acknowledge\*(C'\fR, \f(CW\*(C`error_trace\*(C'\fR, \f(CW\*(C`filter_path\*(C'\fR, \f(CW\*(C`human\*(C'\fR .PP See the post-start-trial docs for more. .SH "AUTHOR" .IX Header "AUTHOR" Enrico Zimuel .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is Copyright (c) 2020 by Elasticsearch \s-1BV.\s0 .PP This is free software, licensed under: .PP .Vb 1 \& The Apache License, Version 2.0, January 2004 .Ve