status

package
v8.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 13, 2023 License: Apache-2.0 Imports: 13 Imported by: 4

Documentation

Overview

Returns information about the status of a snapshot.

Index

Constants

This section is empty.

Variables

View Source
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 v8.7.0

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

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

type Status

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

func (Status) Do

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

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

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) 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(ctx 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 added in v8.7.0

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

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL