getrepositoriesmeteringinfo

Documentation

Overview

Get cluster repositories metering. Get repositories metering information for a cluster. This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.

Index

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

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

func New

func New(tp elastictransport.Interface) *GetRepositoriesMeteringInfo

Get cluster repositories metering. Get repositories metering information for a cluster. This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.

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

func (GetRepositoriesMeteringInfo) Do

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

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

func (*GetRepositoriesMeteringInfo) ErrorTrace

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

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

func (*GetRepositoriesMeteringInfo) FilterPath

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

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

func (*GetRepositoriesMeteringInfo) Header

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

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

func (*GetRepositoriesMeteringInfo) HttpRequest

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

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

func (*GetRepositoriesMeteringInfo) Human

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

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

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

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

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

func (*GetRepositoriesMeteringInfo) Pretty

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

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

type NewGetRepositoriesMeteringInfo

type NewGetRepositoriesMeteringInfo func(nodeid string) *GetRepositoriesMeteringInfo

NewGetRepositoriesMeteringInfo type alias for index.

func NewGetRepositoriesMeteringInfoFunc

func NewGetRepositoriesMeteringInfoFunc(tp elastictransport.Interface) NewGetRepositoriesMeteringInfo

NewGetRepositoriesMeteringInfoFunc returns a new instance of GetRepositoriesMeteringInfo 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 getrepositoriesmeteringinfo

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoResponse.ts#L36-L38

func NewResponse

func NewResponse() *Response

NewResponse returns a Response