Documentation
¶
Overview ¶
Get the snapshot status. Get a detailed description of the current state for each shard participating in the snapshot.
Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.
If you omit the `<snapshot>` request path parameter, the request retrieves information only for currently running snapshots. This usage is preferred. If needed, you can specify `<repository>` and `<snapshot>` to retrieve information for specific snapshots, even if they're not currently running.
WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. The API requires a read from the repository for each shard in each snapshot. For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).
Depending on the latency of your storage, such requests can take an extremely long time to return results. These requests can also tax machine resources and, when using cloud storage, incur high processing costs.
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) 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
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 Status ¶
type Status struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Status
Get the snapshot status. Get a detailed description of the current state for each shard participating in the snapshot.
Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.
If you omit the `<snapshot>` request path parameter, the request retrieves information only for currently running snapshots. This usage is preferred. If needed, you can specify `<repository>` and `<snapshot>` to retrieve information for specific snapshots, even if they're not currently running.
WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. The API requires a read from the repository for each shard in each snapshot. For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).
Depending on the latency of your storage, such requests can take an extremely long time to return results. These requests can also tax machine resources and, when using cloud storage, incur high processing costs.
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-status
func (Status) Do ¶
Do runs the request through the transport, handle the response and returns a status.Response
func (*Status) ErrorTrace ¶
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Status) FilterPath ¶
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 ¶
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 ¶
IgnoreUnavailable If `false`, the request returns an error for any snapshots that are unavailable. If `true`, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned. API name: ignore_unavailable
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 ¶
MasterTimeout The period to wait for the master node. If the master node is not available 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 (Status) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Status) Pretty ¶
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 ¶
Repository The snapshot repository name used to limit the request. It supports wildcards (`*`) if `<snapshot>` isn't specified. API Name: repository
Source Files