poststarttrial

Documentation

Overview

The start trial API enables you to start a 30-day trial, which gives access to all subscription features.

Index

• Variables
• type NewPostStartTrial
  • func NewPostStartTrialFunc(tp elastictransport.Interface) NewPostStartTrial
• type PostStartTrial
  • func New(tp elastictransport.Interface) *PostStartTrial
  • func (r *PostStartTrial) Acknowledge(acknowledge bool) *PostStartTrial
  • func (r PostStartTrial) Do(providedCtx context.Context) (*Response, error)
  • func (r *PostStartTrial) ErrorTrace(errortrace bool) *PostStartTrial
  • func (r *PostStartTrial) FilterPath(filterpaths ...string) *PostStartTrial
  • func (r *PostStartTrial) Header(key, value string) *PostStartTrial
  • func (r *PostStartTrial) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PostStartTrial) Human(human bool) *PostStartTrial
  • func (r PostStartTrial) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r PostStartTrial) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PostStartTrial) Pretty(pretty bool) *PostStartTrial
  • func (r *PostStartTrial) TypeQueryString(typequerystring string) *PostStartTrial
• 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 NewPostStartTrial

type NewPostStartTrial func() *PostStartTrial

NewPostStartTrial type alias for index.

func NewPostStartTrialFunc

func NewPostStartTrialFunc(tp elastictransport.Interface) NewPostStartTrial

NewPostStartTrialFunc returns a new instance of PostStartTrial with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type PostStartTrial

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

func New

func New(tp elastictransport.Interface) *PostStartTrial

The start trial API enables you to start a 30-day trial, which gives access to all subscription features.

https://www.elastic.co/guide/en/elasticsearch/reference/current/start-trial.html

func (*PostStartTrial) Acknowledge

func (r *PostStartTrial) Acknowledge(acknowledge bool) *PostStartTrial

Acknowledge whether the user has acknowledged acknowledge messages (default: false) API name: acknowledge

func (PostStartTrial) Do

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

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

func (*PostStartTrial) ErrorTrace

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

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

func (*PostStartTrial) FilterPath

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

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

func (*PostStartTrial) Header

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

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

func (*PostStartTrial) HttpRequest

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

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

func (*PostStartTrial) Human

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

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

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

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

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

func (*PostStartTrial) Pretty

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

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

func (*PostStartTrial) TypeQueryString

func (r *PostStartTrial) TypeQueryString(typequerystring string) *PostStartTrial

API name: type_query_string

type Response

type Response struct {
	Acknowledged    bool                     `json:"acknowledged"`
	ErrorMessage    *string                  `json:"error_message,omitempty"`
	TrialWasStarted bool                     `json:"trial_was_started"`
	Type            *licensetype.LicenseType `json:"type,omitempty"`
}

Response holds the response body struct for the package poststarttrial

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/license/post_start_trial/StartTrialLicenseResponse.ts#L22-L29

func NewResponse

func NewResponse() *Response

NewResponse returns a Response