Documentation
¶
Overview ¶
Get license information.
Get information about your Elastic license including its type, its status, when it was issued, and when it expires.
>info > If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response. > If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.
Index ¶
- Variables
- type Get
- func (r *Get) AcceptEnterprise(acceptenterprise bool) *Get
- func (r Get) Do(providedCtx context.Context) (*Response, error)
- func (r *Get) ErrorTrace(errortrace bool) *Get
- func (r *Get) FilterPath(filterpaths ...string) *Get
- func (r *Get) Header(key, value string) *Get
- func (r *Get) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Get) Human(human bool) *Get
- func (r Get) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *Get) Local(local bool) *Get
- func (r Get) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Get) Pretty(pretty bool) *Get
- type NewGet
- type Response
Constants ¶
This section is empty.
Variables ¶
var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")
ErrBuildPath is returned in case of missing parameters within the build of the request.
Functions ¶
This section is empty.
Types ¶
type Get ¶
type Get struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Get
Get license information.
Get information about your Elastic license including its type, its status, when it was issued, and when it expires.
>info > If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response. > If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get
func (*Get) AcceptEnterprise ¶
AcceptEnterprise If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility. This parameter is deprecated and will always be set to true in 8.x. API name: accept_enterprise
func (Get) Do ¶
Do runs the request through the transport, handle the response and returns a get.Response
func (*Get) ErrorTrace ¶
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Get) FilterPath ¶
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*Get) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Get) Human ¶
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human
func (Get) IsSuccess ¶
IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.
func (*Get) Local ¶
Local Specifies whether to retrieve local information. The default value is `false`, which means the information is retrieved from the master node. API name: local
type NewGet ¶
type NewGet func() *Get
NewGet type alias for index.
func NewGetFunc ¶
func NewGetFunc(tp elastictransport.Interface) NewGet
NewGetFunc returns a new instance of Get with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶
type Response struct {
License types.LicenseInformation `json:"license"`
}
Response holds the response body struct for the package get
Source Files