logsdisable

Documentation

Overview

Disable logs stream.

Turn off the logs stream feature for this cluster.

Index

• Variables
• type LogsDisable
  • func New(tp elastictransport.Interface) *LogsDisable
  • func (r LogsDisable) Do(providedCtx context.Context) (*Response, error)
  • func (r *LogsDisable) ErrorTrace(errortrace bool) *LogsDisable
  • func (r *LogsDisable) FilterPath(filterpaths ...string) *LogsDisable
  • func (r *LogsDisable) Header(key, value string) *LogsDisable
  • func (r *LogsDisable) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *LogsDisable) Human(human bool) *LogsDisable
  • func (r LogsDisable) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *LogsDisable) MasterTimeout(duration string) *LogsDisable
  • func (r LogsDisable) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *LogsDisable) Pretty(pretty bool) *LogsDisable
  • func (r *LogsDisable) Timeout(duration string) *LogsDisable
• type NewLogsDisable
  • func NewLogsDisableFunc(tp elastictransport.Interface) NewLogsDisable
• 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 LogsDisable

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

func New

func New(tp elastictransport.Interface) *LogsDisable

Disable logs stream.

Turn off the logs stream feature for this cluster.

https://www.elastic.co/docs/api/doc/elasticsearch#TODO

func (LogsDisable) Do

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

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

func (*LogsDisable) ErrorTrace

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

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

func (*LogsDisable) FilterPath

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

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

func (*LogsDisable) Header

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

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

func (*LogsDisable) HttpRequest

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

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

func (*LogsDisable) Human

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

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_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 (LogsDisable) IsSuccess

func (r LogsDisable) 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 (*LogsDisable) MasterTimeout

func (r *LogsDisable) MasterTimeout(duration string) *LogsDisable

MasterTimeout The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (LogsDisable) Perform

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

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

func (*LogsDisable) Pretty

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

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

func (*LogsDisable) Timeout

func (r *LogsDisable) Timeout(duration string) *LogsDisable

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

type NewLogsDisable

type NewLogsDisable func() *LogsDisable

NewLogsDisable type alias for index.

func NewLogsDisableFunc

func NewLogsDisableFunc(tp elastictransport.Interface) NewLogsDisable

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

type Response

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package logsdisable

https://github.com/elastic/elasticsearch-specification/blob/d520d9e8cf14cad487de5e0654007686c395b494/specification/streams/logs_disable/StreamsLogsDisableResponse.ts#L22-L25

func NewResponse

func NewResponse() *Response

NewResponse returns a Response