getbasicstatus

Documentation

Overview

Retrieves information about the status of the basic license.

Index

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

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

func New

func New(tp elastictransport.Interface) *GetBasicStatus

Retrieves information about the status of the basic license.

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

func (GetBasicStatus) Do

func (r GetBasicStatus) Do(ctx context.Context) (*Response, error)

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

func (*GetBasicStatus) Header

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

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

func (*GetBasicStatus) HttpRequest

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

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

func (GetBasicStatus) IsSuccess

func (r GetBasicStatus) 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 (GetBasicStatus) Perform

func (r GetBasicStatus) Perform(ctx context.Context) (*http.Response, error)

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

type NewGetBasicStatus

type NewGetBasicStatus func() *GetBasicStatus

NewGetBasicStatus type alias for index.

func NewGetBasicStatusFunc

func NewGetBasicStatusFunc(tp elastictransport.Interface) NewGetBasicStatus

NewGetBasicStatusFunc returns a new instance of GetBasicStatus 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 {
	EligibleToStartBasic bool `json:"eligible_to_start_basic"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response