gettrialstatus

Documentation

Overview

Retrieves information about the status of the trial license.

Index

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

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

func New

func New(tp elastictransport.Interface) *GetTrialStatus

Retrieves information about the status of the trial license.

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

func (GetTrialStatus) Do

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

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

func (*GetTrialStatus) Header

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

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

func (*GetTrialStatus) HttpRequest

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

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

func (GetTrialStatus) IsSuccess

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

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

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

type NewGetTrialStatus

type NewGetTrialStatus func() *GetTrialStatus

NewGetTrialStatus type alias for index.

func NewGetTrialStatusFunc

func NewGetTrialStatusFunc(tp elastictransport.Interface) NewGetTrialStatus

NewGetTrialStatusFunc returns a new instance of GetTrialStatus 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 {
	EligibleToStartTrial bool `json:"eligible_to_start_trial"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response