Documentation
¶
Overview ¶
Delete snapshot repositories. When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. The snapshots themselves are left untouched and in place.
Index ¶
- Variables
- type DeleteRepository
- func (r DeleteRepository) Do(providedCtx context.Context) (*Response, error)
- func (r *DeleteRepository) ErrorTrace(errortrace bool) *DeleteRepository
- func (r *DeleteRepository) FilterPath(filterpaths ...string) *DeleteRepository
- func (r *DeleteRepository) Header(key, value string) *DeleteRepository
- func (r *DeleteRepository) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *DeleteRepository) Human(human bool) *DeleteRepository
- func (r DeleteRepository) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *DeleteRepository) MasterTimeout(duration string) *DeleteRepository
- func (r DeleteRepository) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *DeleteRepository) Pretty(pretty bool) *DeleteRepository
- 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
Delete snapshot repositories. When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. The snapshots themselves are left untouched and in place.
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-delete-repository
func (DeleteRepository) Do ¶
func (r DeleteRepository) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a deleterepository.Response
func (*DeleteRepository) ErrorTrace ¶
func (r *DeleteRepository) ErrorTrace(errortrace bool) *DeleteRepository
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*DeleteRepository) FilterPath ¶
func (r *DeleteRepository) FilterPath(filterpaths ...string) *DeleteRepository
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
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) Human ¶
func (r *DeleteRepository) Human(human bool) *DeleteRepository
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 (DeleteRepository) IsSuccess ¶
func (r DeleteRepository) 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 (*DeleteRepository) MasterTimeout ¶
func (r *DeleteRepository) MasterTimeout(duration string) *DeleteRepository
MasterTimeout The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. API name: master_timeout
func (DeleteRepository) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeleteRepository) Pretty ¶
func (r *DeleteRepository) Pretty(pretty bool) *DeleteRepository
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*DeleteRepository) Timeout ¶
func (r *DeleteRepository) Timeout(duration string) *DeleteRepository
Timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. To indicate that the request should never timeout, set it to `-1`. 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.