cleanuprepository

Documentation

Overview

Clean up the snapshot repository. Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.

Index

• Variables
• type CleanupRepository
  • func New(tp elastictransport.Interface) *CleanupRepository
  • func (r CleanupRepository) Do(providedCtx context.Context) (*Response, error)
  • func (r *CleanupRepository) ErrorTrace(errortrace bool) *CleanupRepository
  • func (r *CleanupRepository) FilterPath(filterpaths ...string) *CleanupRepository
  • func (r *CleanupRepository) Header(key, value string) *CleanupRepository
  • func (r *CleanupRepository) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *CleanupRepository) Human(human bool) *CleanupRepository
  • func (r CleanupRepository) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *CleanupRepository) MasterTimeout(duration string) *CleanupRepository
  • func (r CleanupRepository) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *CleanupRepository) Pretty(pretty bool) *CleanupRepository
  • func (r *CleanupRepository) Timeout(duration string) *CleanupRepository
• type NewCleanupRepository
  • func NewCleanupRepositoryFunc(tp elastictransport.Interface) NewCleanupRepository
• type Response
  • func NewResponse() *Response

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 CleanupRepository

type CleanupRepository struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *CleanupRepository

Clean up the snapshot repository. Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-cleanup-repository

func (CleanupRepository) Do

func (r CleanupRepository) Do(providedCtx context.Context) (*Response, error)

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

func (*CleanupRepository) ErrorTrace

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

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

func (*CleanupRepository) FilterPath

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

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

func (*CleanupRepository) Header

func (r *CleanupRepository) Header(key, value string) *CleanupRepository

Header set a key, value pair in the CleanupRepository headers map.

func (*CleanupRepository) HttpRequest

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

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

func (*CleanupRepository) Human

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

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_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 (CleanupRepository) IsSuccess

func (r CleanupRepository) 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 (*CleanupRepository) MasterTimeout

func (r *CleanupRepository) MasterTimeout(duration string) *CleanupRepository

MasterTimeout The period to wait for a connection to 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 (CleanupRepository) Perform

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

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

func (*CleanupRepository) Pretty

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

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

func (*CleanupRepository) Timeout

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

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 NewCleanupRepository

type NewCleanupRepository func(repository string) *CleanupRepository

NewCleanupRepository type alias for index.

func NewCleanupRepositoryFunc

func NewCleanupRepositoryFunc(tp elastictransport.Interface) NewCleanupRepository

NewCleanupRepositoryFunc returns a new instance of CleanupRepository 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 {

	// Results Statistics for cleanup operations.
	Results types.CleanupRepositoryResults `json:"results"`
}

Response holds the response body struct for the package cleanuprepository

https://github.com/elastic/elasticsearch-specification/blob/907d11a72a6bfd37b777d526880c56202889609e/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryResponse.ts#L22-L27

func NewResponse

func NewResponse() *Response

NewResponse returns a Response