Documentation
¶
Overview ¶
Returns information about snapshot repositories registered in the cluster.
Index ¶
- Variables
- type NewRepositories
- type Repositories
- func (r Repositories) Do(providedCtx context.Context) (Response, error)
- func (r *Repositories) Header(key, value string) *Repositories
- func (r *Repositories) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r Repositories) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Repositories) Perform(providedCtx context.Context) (*http.Response, error)
- 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 NewRepositories ¶
type NewRepositories func() *Repositories
NewRepositories type alias for index.
func NewRepositoriesFunc ¶
func NewRepositoriesFunc(tp elastictransport.Interface) NewRepositories
NewRepositoriesFunc returns a new instance of Repositories with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Repositories ¶
type Repositories struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Repositories
Returns information about snapshot repositories registered in the cluster.
https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-repositories.html
func (Repositories) Do ¶
func (r Repositories) Do(providedCtx context.Context) (Response, error)
Do runs the request through the transport, handle the response and returns a repositories.Response
func (*Repositories) Header ¶
func (r *Repositories) Header(key, value string) *Repositories
Header set a key, value pair in the Repositories headers map.
func (*Repositories) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
type Response ¶ added in v8.7.0
type Response []types.RepositoriesRecord
Source Files