poststartbasic

Documentation

Overview

Starts an indefinite basic license.

Index

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

Starts an indefinite basic license.

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

func (*PostStartBasic) Acknowledge

func (r *PostStartBasic) Acknowledge(b bool) *PostStartBasic

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

func (PostStartBasic) Do

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

Do runs the http.Request through the provided transport.

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

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