repositories

Documentation

Overview

Returns information about snapshot repositories registered in the cluster.

Index

• Variables
• type NewRepositories
  • func NewRepositoriesFunc(tp elastictransport.Interface) NewRepositories
• type Repositories
  • func New(tp elastictransport.Interface) *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
  • func NewResponse() Response

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

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

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

func (Repositories) IsSuccess

func (r Repositories) 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 (Repositories) Perform

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

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

type Response

type Response []types.RepositoriesRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response