poststartbasic

Documentation

Overview

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

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

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

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

Index

• Variables
• type NewPostStartBasic
  • func NewPostStartBasicFunc(tp elastictransport.Interface) NewPostStartBasic
• type PostStartBasic
  • func New(tp elastictransport.Interface) *PostStartBasic
  • func (r *PostStartBasic) Acknowledge(acknowledge bool) *PostStartBasic
  • func (r PostStartBasic) Do(providedCtx context.Context) (*Response, error)
  • func (r *PostStartBasic) ErrorTrace(errortrace bool) *PostStartBasic
  • func (r *PostStartBasic) FilterPath(filterpaths ...string) *PostStartBasic
  • func (r *PostStartBasic) Header(key, value string) *PostStartBasic
  • func (r *PostStartBasic) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PostStartBasic) Human(human bool) *PostStartBasic
  • func (r PostStartBasic) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r PostStartBasic) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PostStartBasic) Pretty(pretty bool) *PostStartBasic
• type Response
  • func NewResponse() *Response
  • func (s *Response) UnmarshalJSON(data []byte) error

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 NewPostStartBasic

type NewPostStartBasic func() *PostStartBasic

NewPostStartBasic type alias for index.

func NewPostStartBasicFunc

func NewPostStartBasicFunc(tp elastictransport.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

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

func New

func New(tp elastictransport.Interface) *PostStartBasic

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

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

If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the `acknowledge` parameter set to `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(acknowledge bool) *PostStartBasic

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

func (PostStartBasic) Do

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

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

func (*PostStartBasic) ErrorTrace

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

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

func (*PostStartBasic) FilterPath

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

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

func (*PostStartBasic) Header

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

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

func (*PostStartBasic) HttpRequest

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

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

func (*PostStartBasic) Human

func (r *PostStartBasic) Human(human bool) *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 human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (PostStartBasic) IsSuccess

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

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

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

func (*PostStartBasic) Pretty

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

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

type Response

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

Response holds the response body struct for the package poststartbasic

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/license/post_start_basic/StartBasicLicenseResponse.ts#L23-L31

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

func (*Response) UnmarshalJSON

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