Documentation
¶
Overview ¶
Get the snapshot lifecycle management status.
Index ¶
- Variables
- type GetStatus
- func (r GetStatus) Do(providedCtx context.Context) (*Response, error)
- func (r *GetStatus) ErrorTrace(errortrace bool) *GetStatus
- func (r *GetStatus) FilterPath(filterpaths ...string) *GetStatus
- func (r *GetStatus) Header(key, value string) *GetStatus
- func (r *GetStatus) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *GetStatus) Human(human bool) *GetStatus
- func (r GetStatus) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *GetStatus) MasterTimeout(duration string) *GetStatus
- func (r GetStatus) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetStatus) Pretty(pretty bool) *GetStatus
- func (r *GetStatus) Timeout(duration string) *GetStatus
- type NewGetStatus
- 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 GetStatus ¶
type GetStatus struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetStatus
Get the snapshot lifecycle management status.
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-get-status
func (GetStatus) Do ¶
Do runs the request through the transport, handle the response and returns a getstatus.Response
func (*GetStatus) ErrorTrace ¶
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*GetStatus) FilterPath ¶
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*GetStatus) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*GetStatus) Human ¶
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_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 (GetStatus) 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 (*GetStatus) MasterTimeout ¶
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. To indicate that the request should never timeout, set it to `-1`. API name: master_timeout
func (GetStatus) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*GetStatus) Pretty ¶
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
type NewGetStatus ¶
type NewGetStatus func() *GetStatus
NewGetStatus type alias for index.
func NewGetStatusFunc ¶
func NewGetStatusFunc(tp elastictransport.Interface) NewGetStatus
NewGetStatusFunc returns a new instance of GetStatus 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 {
OperationMode lifecycleoperationmode.LifecycleOperationMode `json:"operation_mode"`
}
Response holds the response body struct for the package getstatus
Source Files