Documentation ¶
Overview ¶
Deletes a repository.
Index ¶
- Variables
- type DeleteRepository
- func (r DeleteRepository) Do(ctx context.Context) (*Response, error)
- func (r *DeleteRepository) Header(key, value string) *DeleteRepository
- func (r *DeleteRepository) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r DeleteRepository) IsSuccess(ctx context.Context) (bool, error)
- func (r *DeleteRepository) MasterTimeout(duration string) *DeleteRepository
- func (r DeleteRepository) Perform(ctx context.Context) (*http.Response, error)
- func (r *DeleteRepository) Timeout(duration string) *DeleteRepository
- type NewDeleteRepository
- 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 DeleteRepository ¶
type DeleteRepository struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *DeleteRepository
Deletes a repository.
https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
func (DeleteRepository) Do ¶
func (r DeleteRepository) Do(ctx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a deleterepository.Response
func (*DeleteRepository) Header ¶
func (r *DeleteRepository) Header(key, value string) *DeleteRepository
Header set a key, value pair in the DeleteRepository headers map.
func (*DeleteRepository) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (DeleteRepository) IsSuccess ¶
func (r DeleteRepository) 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 (*DeleteRepository) MasterTimeout ¶
func (r *DeleteRepository) MasterTimeout(duration string) *DeleteRepository
MasterTimeout Explicit operation timeout for connection to master node API name: master_timeout
func (DeleteRepository) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeleteRepository) Timeout ¶
func (r *DeleteRepository) Timeout(duration string) *DeleteRepository
Timeout Explicit operation timeout API name: timeout
type NewDeleteRepository ¶
type NewDeleteRepository func(repository string) *DeleteRepository
NewDeleteRepository type alias for index.
func NewDeleteRepositoryFunc ¶
func NewDeleteRepositoryFunc(tp elastictransport.Interface) NewDeleteRepository
NewDeleteRepositoryFunc returns a new instance of DeleteRepository with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.