getrepository

Documentation

Overview

Returns information about a repository.

Index

• Variables
• type GetRepository
  • func New(tp elastictransport.Interface) *GetRepository
  • func (r GetRepository) Do(providedCtx context.Context) (Response, error)
  • func (r *GetRepository) ErrorTrace(errortrace bool) *GetRepository
  • func (r *GetRepository) FilterPath(filterpaths ...string) *GetRepository
  • func (r *GetRepository) Header(key, value string) *GetRepository
  • func (r *GetRepository) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetRepository) Human(human bool) *GetRepository
  • 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) Pretty(pretty bool) *GetRepository
  • func (r *GetRepository) Repository(repository string) *GetRepository
• type NewGetRepository
  • func NewGetRepositoryFunc(tp elastictransport.Interface) NewGetRepository
• type Response
  • func NewResponse() Response
  • func (r Response) UnmarshalJSON(data []byte) error

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

func (r *GetRepository) ErrorTrace(errortrace bool) *GetRepository

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*GetRepository) FilterPath

func (r *GetRepository) FilterPath(filterpaths ...string) *GetRepository

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

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

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

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

func (*GetRepository) Human

func (r *GetRepository) Human(human bool) *GetRepository

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

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

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

func (*GetRepository) Pretty

func (r *GetRepository) Pretty(pretty bool) *GetRepository

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

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

type Response map[string]types.Repository

func NewResponse

func NewResponse() Response

NewResponse returns a Response

func (Response) UnmarshalJSON

func (r Response) UnmarshalJSON(data []byte) error