Documentation
¶
Overview ¶
Returns all snapshots in a specific repository.
Index ¶
- Variables
- type NewSnapshots
- type Response
- type Snapshots
- func (r Snapshots) Do(providedCtx context.Context) (Response, error)
- func (r *Snapshots) Header(key, value string) *Snapshots
- func (r *Snapshots) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Snapshots) IgnoreUnavailable(ignoreunavailable bool) *Snapshots
- func (r Snapshots) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Snapshots) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Snapshots) Repository(repository string) *Snapshots
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 NewSnapshots ¶
type NewSnapshots func() *Snapshots
NewSnapshots type alias for index.
func NewSnapshotsFunc ¶
func NewSnapshotsFunc(tp elastictransport.Interface) NewSnapshots
NewSnapshotsFunc returns a new instance of Snapshots with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶ added in v8.7.0
type Response []types.SnapshotsRecord
type Snapshots ¶
type Snapshots struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Snapshots
Returns all snapshots in a specific repository.
https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html
func (Snapshots) Do ¶
Do runs the request through the transport, handle the response and returns a snapshots.Response
func (*Snapshots) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Snapshots) IgnoreUnavailable ¶
IgnoreUnavailable If `true`, the response does not include information from unavailable snapshots. API name: ignore_unavailable
func (Snapshots) 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 (Snapshots) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Snapshots) Repository ¶
Repository A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, Elasticsearch returns an error. API Name: repository
Source Files