Documentation
¶
Overview ¶
Get the status of streams.
Get the current status for all types of streams.
Index ¶
- Variables
- type NewStatus
- type Response
- type Status
- func (r Status) Do(providedCtx context.Context) (*Response, error)
- func (r *Status) ErrorTrace(errortrace bool) *Status
- func (r *Status) FilterPath(filterpaths ...string) *Status
- func (r *Status) Header(key, value string) *Status
- func (r *Status) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Status) Human(human bool) *Status
- func (r Status) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *Status) MasterTimeout(duration string) *Status
- func (r Status) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Status) Pretty(pretty bool) *Status
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 NewStatus ¶
type NewStatus func() *Status
NewStatus type alias for index.
func NewStatusFunc ¶
func NewStatusFunc(tp elastictransport.Interface) NewStatus
NewStatusFunc returns a new instance of Status with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶ added in v9.2.0
type Response struct {
Logs types.LogsStatus `json:"logs"`
}
Response holds the response body struct for the package status
type Status ¶
type Status struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Status
Get the status of streams.
Get the current status for all types of streams.
func (Status) Do ¶
Do runs the request through the transport, handle the response and returns a status.Response
func (*Status) ErrorTrace ¶ added in v9.2.0
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Status) FilterPath ¶ added in v9.2.0
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*Status) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Status) Human ¶ added in v9.2.0
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 (Status) IsSuccess ¶
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 (*Status) MasterTimeout ¶ added in v9.2.0
MasterTimeout 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
Source Files