logsenable

Documentation

Overview

Enable the Logs Streams feature for this cluster

Index

• Variables
• type LogsEnable
  • func New(tp elastictransport.Interface) *LogsEnable
  • func (r LogsEnable) Do(ctx context.Context) (bool, error)
  • func (r *LogsEnable) Header(key, value string) *LogsEnable
  • func (r *LogsEnable) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r LogsEnable) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r LogsEnable) Perform(providedCtx context.Context) (*http.Response, error)
• type NewLogsEnable
  • func NewLogsEnableFunc(tp elastictransport.Interface) NewLogsEnable

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 LogsEnable

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

func New

func New(tp elastictransport.Interface) *LogsEnable

Enable the Logs Streams feature for this cluster

https://www.elastic.co/guide/en/elasticsearch/reference/current/streams-logs-enable.html

func (LogsEnable) Do

func (r LogsEnable) Do(ctx context.Context) (bool, error)

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

func (*LogsEnable) Header

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

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

func (*LogsEnable) HttpRequest

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

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

func (LogsEnable) IsSuccess

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

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

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

type NewLogsEnable

type NewLogsEnable func() *LogsEnable

NewLogsEnable type alias for index.

func NewLogsEnableFunc

func NewLogsEnableFunc(tp elastictransport.Interface) NewLogsEnable

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