cleanuprepository

Documentation

Overview

Removes stale data from repository.

Index

• Variables
• type CleanupRepository
  • func New(tp elastictransport.Interface) *CleanupRepository
  • func (r CleanupRepository) Do(ctx context.Context) (*Response, error)
  • func (r *CleanupRepository) Header(key, value string) *CleanupRepository
  • func (r *CleanupRepository) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r CleanupRepository) IsSuccess(ctx context.Context) (bool, error)
  • func (r *CleanupRepository) MasterTimeout(duration string) *CleanupRepository
  • func (r CleanupRepository) Perform(ctx context.Context) (*http.Response, error)
  • 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

Removes stale data from repository.

https://www.elastic.co/guide/en/elasticsearch/reference/master/clean-up-snapshot-repo-api.html

func (CleanupRepository) Do

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

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

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

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

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

MasterTimeout Period to wait for a connection to the master node. API name: master_timeout

func (CleanupRepository) Perform

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

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

func (*CleanupRepository) Timeout

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

Timeout Period to wait for a response. 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"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response