Documentation
¶
Overview ¶
Removes the archived repositories metering information present in the cluster.
Index ¶
- Variables
- type ClearRepositoriesMeteringArchive
- func (r ClearRepositoriesMeteringArchive) Do(providedCtx 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(providedCtx context.Context) (bool, error)
- func (r ClearRepositoriesMeteringArchive) Perform(providedCtx context.Context) (*http.Response, error)
- type NewClearRepositoriesMeteringArchive
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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.
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) Header ¶
func (r *ClearRepositoriesMeteringArchive) Header(key, value string) *ClearRepositoriesMeteringArchive
Header set a key, value pair in the ClearRepositoriesMeteringArchive headers map.
func (*ClearRepositoriesMeteringArchive) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
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.
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 ¶ added in v8.7.0
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
Source Files