clearrepositoriesmeteringarchive

Documentation

Overview

You can use this API to clear the archived repositories metering information in the cluster.

Index

• Variables
• type ClearRepositoriesMeteringArchive
  • func New(tp elastictransport.Interface) *ClearRepositoriesMeteringArchive
  • func (r ClearRepositoriesMeteringArchive) Do(providedCtx context.Context) (*Response, error)
  • func (r *ClearRepositoriesMeteringArchive) ErrorTrace(errortrace bool) *ClearRepositoriesMeteringArchive
  • func (r *ClearRepositoriesMeteringArchive) FilterPath(filterpaths ...string) *ClearRepositoriesMeteringArchive
  • func (r *ClearRepositoriesMeteringArchive) Header(key, value string) *ClearRepositoriesMeteringArchive
  • func (r *ClearRepositoriesMeteringArchive) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ClearRepositoriesMeteringArchive) Human(human bool) *ClearRepositoriesMeteringArchive
  • func (r ClearRepositoriesMeteringArchive) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r ClearRepositoriesMeteringArchive) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ClearRepositoriesMeteringArchive) Pretty(pretty bool) *ClearRepositoriesMeteringArchive
• type NewClearRepositoriesMeteringArchive
  • func NewClearRepositoriesMeteringArchiveFunc(tp elastictransport.Interface) NewClearRepositoriesMeteringArchive
• 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 ClearRepositoriesMeteringArchive

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

func New

func New(tp elastictransport.Interface) *ClearRepositoriesMeteringArchive

You can use this API to clear the archived repositories metering information in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html

func (ClearRepositoriesMeteringArchive) Do

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

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

func (*ClearRepositoriesMeteringArchive) ErrorTrace

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

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

func (*ClearRepositoriesMeteringArchive) FilterPath

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

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

func (*ClearRepositoriesMeteringArchive) Header

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

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

func (*ClearRepositoriesMeteringArchive) HttpRequest

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

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

func (*ClearRepositoriesMeteringArchive) Human

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

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

func (r ClearRepositoriesMeteringArchive) 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 (ClearRepositoriesMeteringArchive) Perform

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

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

func (*ClearRepositoriesMeteringArchive) Pretty

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

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

type NewClearRepositoriesMeteringArchive

type NewClearRepositoriesMeteringArchive func(nodeid, maxarchiveversion string) *ClearRepositoriesMeteringArchive

NewClearRepositoriesMeteringArchive type alias for index.

func NewClearRepositoriesMeteringArchiveFunc

func NewClearRepositoriesMeteringArchiveFunc(tp elastictransport.Interface) NewClearRepositoriesMeteringArchive

NewClearRepositoriesMeteringArchiveFunc returns a new instance of ClearRepositoriesMeteringArchive 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 {

	// ClusterName Name of the cluster. Based on the [Cluster name
	// setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name).
	ClusterName string `json:"cluster_name"`
	// NodeStats Contains statistics about the number of nodes selected by the request’s node
	// filters.
	NodeStats *types.NodeStatistics `json:"_nodes,omitempty"`
	// Nodes Contains repositories metering information for the nodes selected by the
	// request.
	Nodes map[string]types.RepositoryMeteringInformation `json:"nodes"`
}

Response holds the response body struct for the package clearrepositoriesmeteringarchive

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveResponse.ts#L36-L38

func NewResponse

func NewResponse() *Response

NewResponse returns a Response