Documentation ¶
Overview ¶
Verifies a repository.
Index ¶
- Variables
- type NewVerifyRepository
- type Response
- type VerifyRepository
- func (r VerifyRepository) Do(providedCtx context.Context) (*Response, error)
- func (r *VerifyRepository) ErrorTrace(errortrace bool) *VerifyRepository
- func (r *VerifyRepository) FilterPath(filterpaths ...string) *VerifyRepository
- func (r *VerifyRepository) Header(key, value string) *VerifyRepository
- func (r *VerifyRepository) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *VerifyRepository) Human(human bool) *VerifyRepository
- func (r VerifyRepository) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *VerifyRepository) MasterTimeout(duration string) *VerifyRepository
- func (r VerifyRepository) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *VerifyRepository) Pretty(pretty bool) *VerifyRepository
- func (r *VerifyRepository) Timeout(duration string) *VerifyRepository
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 NewVerifyRepository ¶
type NewVerifyRepository func(repository string) *VerifyRepository
NewVerifyRepository type alias for index.
func NewVerifyRepositoryFunc ¶
func NewVerifyRepositoryFunc(tp elastictransport.Interface) NewVerifyRepository
NewVerifyRepositoryFunc returns a new instance of VerifyRepository 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 {
Nodes map[string]types.CompactNodeInfo `json:"nodes"`
}
Response holds the response body struct for the package verifyrepository
type VerifyRepository ¶
type VerifyRepository struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *VerifyRepository
Verifies a repository.
https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
func (VerifyRepository) Do ¶
func (r VerifyRepository) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a verifyrepository.Response
func (*VerifyRepository) ErrorTrace ¶ added in v8.14.0
func (r *VerifyRepository) ErrorTrace(errortrace bool) *VerifyRepository
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*VerifyRepository) FilterPath ¶ added in v8.14.0
func (r *VerifyRepository) FilterPath(filterpaths ...string) *VerifyRepository
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*VerifyRepository) Header ¶
func (r *VerifyRepository) Header(key, value string) *VerifyRepository
Header set a key, value pair in the VerifyRepository headers map.
func (*VerifyRepository) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*VerifyRepository) Human ¶ added in v8.14.0
func (r *VerifyRepository) Human(human bool) *VerifyRepository
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human
func (VerifyRepository) IsSuccess ¶
func (r VerifyRepository) 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 (*VerifyRepository) MasterTimeout ¶
func (r *VerifyRepository) MasterTimeout(duration string) *VerifyRepository
MasterTimeout Explicit operation timeout for connection to master node API name: master_timeout
func (VerifyRepository) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*VerifyRepository) Pretty ¶ added in v8.14.0
func (r *VerifyRepository) Pretty(pretty bool) *VerifyRepository
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*VerifyRepository) Timeout ¶
func (r *VerifyRepository) Timeout(duration string) *VerifyRepository
Timeout Explicit operation timeout API name: timeout