status

Documentation

Overview

Returns information about the status of a snapshot.

Index

• Variables
• type NewStatus
  • func NewStatusFunc(tp elastictransport.Interface) NewStatus
• type Response
  • func NewResponse() *Response
• type Status
  • func New(tp elastictransport.Interface) *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) IgnoreUnavailable(ignoreunavailable 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
  • func (r *Status) Repository(repository string) *Status
  • func (r *Status) Snapshot(snapshot string) *Status

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 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

type Response struct {
	Snapshots []types.Status `json:"snapshots"`
}

Response holds the response body struct for the package status

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/snapshot/status/SnapshotStatusResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type Status

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

func New

func New(tp elastictransport.Interface) *Status

Returns information about the status of a snapshot.

https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html

func (Status) Do

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

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

func (*Status) ErrorTrace

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

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

func (*Status) FilterPath

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

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

func (*Status) Header

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

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

func (*Status) HttpRequest

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

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

func (*Status) Human

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

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 (*Status) IgnoreUnavailable

func (r *Status) IgnoreUnavailable(ignoreunavailable bool) *Status

IgnoreUnavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown API name: ignore_unavailable

func (Status) IsSuccess

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

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

MasterTimeout Explicit operation timeout for connection to master node API name: master_timeout

func (Status) Perform

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

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

func (*Status) Pretty

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

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

func (*Status) Repository

func (r *Status) Repository(repository string) *Status

Repository A repository name API Name: repository

func (*Status) Snapshot

func (r *Status) Snapshot(snapshot string) *Status

Snapshot A comma-separated list of snapshot names API Name: snapshot