get

Documentation

Overview

Retrieves licensing information for the cluster

Index

• Variables
• type Get
  • func New(tp elastictransport.Interface) *Get
  • func (r *Get) AcceptEnterprise(b bool) *Get
  • func (r Get) Do(ctx context.Context) (*Response, error)
  • func (r *Get) Header(key, value string) *Get
  • func (r *Get) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Get) IsSuccess(ctx context.Context) (bool, error)
  • func (r *Get) Local(b bool) *Get
  • func (r Get) Perform(ctx context.Context) (*http.Response, error)
• 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

Retrieves licensing information for the cluster

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

func (*Get) AcceptEnterprise

func (r *Get) AcceptEnterprise(b 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(ctx context.Context) (*Response, error)

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

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) IsSuccess

func (r Get) IsSuccess(ctx 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(b 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(ctx context.Context) (*http.Response, error)

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

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"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response