get

Documentation

Overview

Get license information. Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).

Index

• Variables
• type Get
  • func New(tp elastictransport.Interface) *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
  • func NewGetFunc(tp elastictransport.Interface) NewGet
• type Response
  • func NewResponse() *Response

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.

Types

type Get

type Get struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *Get

Get license information. Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).

https://www.elastic.co/guide/en/elasticsearch/reference/current/get-license.html

func (*Get) AcceptEnterprise

func (r *Get) AcceptEnterprise(acceptenterprise bool) *Get

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

func (r Get) Do(providedCtx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a get.Response

func (*Get) ErrorTrace

func (r *Get) ErrorTrace(errortrace bool) *Get

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*Get) FilterPath

func (r *Get) FilterPath(filterpaths ...string) *Get

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*Get) Header

func (r *Get) Header(key, value string) *Get

Header set a key, value pair in the Get headers map.

func (*Get) HttpRequest

func (r *Get) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*Get) Human

func (r *Get) Human(human bool) *Get

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_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

func (r Get) IsSuccess(providedCtx context.Context) (bool, error)

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

func (r *Get) Local(local bool) *Get

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

func (Get) Perform

func (r Get) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*Get) Pretty

func (r *Get) Pretty(pretty bool) *Get

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

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

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/license/get/GetLicenseResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response