Documentation
¶
Overview ¶
Enable logs stream.
Turn on the logs stream feature for this cluster.
NOTE: To protect existing data, this feature can be turned on only if the cluster does not have existing indices or data streams that match the pattern `logs|logs.*`. If those indices or data streams exist, a `409 - Conflict` response and error is returned.
Index ¶
- Variables
- type LogsEnable
- func (r LogsEnable) Do(providedCtx context.Context) (*Response, error)
- func (r *LogsEnable) ErrorTrace(errortrace bool) *LogsEnable
- func (r *LogsEnable) FilterPath(filterpaths ...string) *LogsEnable
- func (r *LogsEnable) Header(key, value string) *LogsEnable
- func (r *LogsEnable) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *LogsEnable) Human(human bool) *LogsEnable
- func (r LogsEnable) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *LogsEnable) MasterTimeout(duration string) *LogsEnable
- func (r LogsEnable) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *LogsEnable) Pretty(pretty bool) *LogsEnable
- func (r *LogsEnable) Timeout(duration string) *LogsEnable
- type NewLogsEnable
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type LogsEnable ¶
type LogsEnable struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *LogsEnable
Enable logs stream.
Turn on the logs stream feature for this cluster.
NOTE: To protect existing data, this feature can be turned on only if the cluster does not have existing indices or data streams that match the pattern `logs|logs.*`. If those indices or data streams exist, a `409 - Conflict` response and error is returned.
func (LogsEnable) Do ¶
func (r LogsEnable) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a logsenable.Response
func (*LogsEnable) ErrorTrace ¶ added in v9.2.0
func (r *LogsEnable) ErrorTrace(errortrace bool) *LogsEnable
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*LogsEnable) FilterPath ¶ added in v9.2.0
func (r *LogsEnable) FilterPath(filterpaths ...string) *LogsEnable
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
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 ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*LogsEnable) Human ¶ added in v9.2.0
func (r *LogsEnable) Human(human bool) *LogsEnable
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 (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) MasterTimeout ¶ added in v9.2.0
func (r *LogsEnable) MasterTimeout(duration string) *LogsEnable
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 (LogsEnable) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*LogsEnable) Pretty ¶ added in v9.2.0
func (r *LogsEnable) Pretty(pretty bool) *LogsEnable
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*LogsEnable) Timeout ¶ added in v9.2.0
func (r *LogsEnable) Timeout(duration string) *LogsEnable
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 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.
Source Files