verifyrepository

Documentation

Overview

Verifies a repository.

Index

• Variables
• type NewVerifyRepository
  • func NewVerifyRepositoryFunc(tp elastictransport.Interface) NewVerifyRepository
• type Response
  • func NewResponse() *Response
• type VerifyRepository
  • func New(tp elastictransport.Interface) *VerifyRepository
  • func (r VerifyRepository) Do(ctx context.Context) (*Response, error)
  • func (r *VerifyRepository) Header(key, value string) *VerifyRepository
  • func (r *VerifyRepository) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r VerifyRepository) IsSuccess(ctx context.Context) (bool, error)
  • func (r *VerifyRepository) MasterTimeout(duration string) *VerifyRepository
  • func (r VerifyRepository) Perform(ctx context.Context) (*http.Response, error)
  • func (r *VerifyRepository) Repository(repository string) *VerifyRepository
  • func (r *VerifyRepository) Timeout(duration string) *VerifyRepository

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

type Response struct {
	Nodes map[string]types.CompactNodeInfo `json:"nodes"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

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/master/modules-snapshots.html

func (VerifyRepository) Do

func (r VerifyRepository) Do(ctx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a verifyrepository.Response

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

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

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

func (VerifyRepository) IsSuccess

func (r VerifyRepository) IsSuccess(ctx 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

func (r VerifyRepository) Perform(ctx context.Context) (*http.Response, error)

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

func (*VerifyRepository) Repository

func (r *VerifyRepository) Repository(repository string) *VerifyRepository

Repository A repository name API Name: repository

func (*VerifyRepository) Timeout

func (r *VerifyRepository) Timeout(duration string) *VerifyRepository

Timeout Explicit operation timeout API name: timeout