clearrepositoriesmeteringarchive

Documentation

Overview

Removes the archived repositories metering information present in the cluster.

Index

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

Removes the archived repositories metering information present 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(ctx context.Context) (*Response, error)

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

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

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

func (r *ClearRepositoriesMeteringArchive) MaxArchiveVersion(v string) *ClearRepositoriesMeteringArchive

MaxArchiveVersion Specifies the maximum [archive_version](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html#get-repositories-metering-api-response-body) to be cleared from the archive. API Name: maxarchiveversion

func (*ClearRepositoriesMeteringArchive) NodeId

func (r *ClearRepositoriesMeteringArchive) NodeId(v string) *ClearRepositoriesMeteringArchive

NodeId Comma-separated list of node IDs or names used to limit returned information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes). API Name: nodeid

func (ClearRepositoriesMeteringArchive) Perform

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

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

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"`
	// Nodes Contains repositories metering information for the nodes selected by the
	// request.
	Nodes map[string]types.RepositoryMeteringInformation `json:"nodes"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response