Documentation
¶
Overview ¶
Returns information about a repository.
Index ¶
- Variables
- type GetRepository
- func (r GetRepository) Do(providedCtx context.Context) (Response, error)
- func (r *GetRepository) Header(key, value string) *GetRepository
- func (r *GetRepository) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetRepository) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *GetRepository) Local(local bool) *GetRepository
- func (r *GetRepository) MasterTimeout(duration string) *GetRepository
- func (r GetRepository) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetRepository) Repository(repository string) *GetRepository
- type NewGetRepository
- 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 GetRepository ¶
type GetRepository struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetRepository
Returns information about a repository.
https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
func (GetRepository) Do ¶
func (r GetRepository) Do(providedCtx context.Context) (Response, error)
Do runs the request through the transport, handle the response and returns a getrepository.Response
func (*GetRepository) Header ¶
func (r *GetRepository) Header(key, value string) *GetRepository
Header set a key, value pair in the GetRepository headers map.
func (*GetRepository) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (GetRepository) IsSuccess ¶
func (r GetRepository) 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 (*GetRepository) Local ¶
func (r *GetRepository) Local(local bool) *GetRepository
Local Return local information, do not retrieve the state from master node (default: false) API name: local
func (*GetRepository) MasterTimeout ¶
func (r *GetRepository) MasterTimeout(duration string) *GetRepository
MasterTimeout Explicit operation timeout for connection to master node API name: master_timeout
func (GetRepository) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*GetRepository) Repository ¶
func (r *GetRepository) Repository(repository string) *GetRepository
Repository A comma-separated list of repository names API Name: repository
type NewGetRepository ¶
type NewGetRepository func() *GetRepository
NewGetRepository type alias for index.
func NewGetRepositoryFunc ¶
func NewGetRepositoryFunc(tp elastictransport.Interface) NewGetRepository
NewGetRepositoryFunc returns a new instance of GetRepository 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 map[string]types.Repository
Source Files