type NewPostStartBasic func() *PostStartBasic

funcNewPostStartBasicFunc¶

func NewPostStartBasicFunc(tpelastictransport.Interface)NewPostStartBasic

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

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

funcNew¶

func New(tpelastictransport.Interface) *PostStartBasic

Start a basic license.

Start an indefinite basic license, which gives access to all the basicfeatures.

NOTE: In order to start a basic license, you must not currently have a basiclicense.

If the basic license does not support all of the features that are availablewith your current license, however, you are notified in the response.You must then re-submit the API request with the `acknowledge` parameter setto `true`.

To check the status of your basic license, use the get basic license API.

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

func (*PostStartBasic)Acknowledge¶

func (r *PostStartBasic) Acknowledge(acknowledgebool) *PostStartBasic

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

func (PostStartBasic)Do¶

func (rPostStartBasic) Do(providedCtxcontext.Context) (*Response,error)

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

func (*PostStartBasic)ErrorTrace¶added inv8.14.0

func (r *PostStartBasic) ErrorTrace(errortracebool) *PostStartBasic

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

func (*PostStartBasic)FilterPath¶added inv8.14.0

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

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

func (*PostStartBasic)Header¶

func (r *PostStartBasic) Header(key, valuestring) *PostStartBasic

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

func (*PostStartBasic)HttpRequest¶

func (r *PostStartBasic) HttpRequest(ctxcontext.Context) (*http.Request,error)

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

func (*PostStartBasic)Human¶added inv8.14.0

func (r *PostStartBasic) Human(humanbool) *PostStartBasic

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 humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human

func (PostStartBasic)IsSuccess¶

func (rPostStartBasic) IsSuccess(providedCtxcontext.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 (*PostStartBasic)MasterTimeout¶added inv8.18.0

func (r *PostStartBasic) MasterTimeout(durationstring) *PostStartBasic

MasterTimeout Period to wait for a connection to the master node.API name: master_timeout

func (PostStartBasic)Perform¶added inv8.7.0

func (rPostStartBasic) Perform(providedCtxcontext.Context) (*http.Response,error)

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

func (*PostStartBasic)Pretty¶added inv8.14.0

func (r *PostStartBasic) Pretty(prettybool) *PostStartBasic

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

func (*PostStartBasic)Timeout¶added inv8.18.0

func (r *PostStartBasic) Timeout(durationstring) *PostStartBasic

Timeout Period to wait for a response. If no response is received before the timeoutexpires, the request fails and returns an error.API name: timeout

type Response struct {Acknowledge     map[string][]string      `json:"acknowledge,omitempty"`Acknowledgedbool                     `json:"acknowledged"`BasicWasStartedbool                     `json:"basic_was_started"`ErrorMessage    *string                  `json:"error_message,omitempty"`Type            *licensetype.LicenseType `json:"type,omitempty"`}

funcNewResponse¶added inv8.7.0

func NewResponse() *Response

NewResponse returns a Response

func (*Response)UnmarshalJSON¶added inv8.7.1

func (s *Response) UnmarshalJSON(data []byte)error