Documentation
¶
Overview ¶
Returns cluster repositories metering information.
Index ¶
- Variables
- type GetRepositoriesMeteringInfo
- func (r GetRepositoriesMeteringInfo) Do(providedCtx context.Context) (*Response, error)
- func (r *GetRepositoriesMeteringInfo) Header(key, value string) *GetRepositoriesMeteringInfo
- func (r *GetRepositoriesMeteringInfo) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetRepositoriesMeteringInfo) IsSuccess(providedCtx context.Context) (bool, error)
- func (r GetRepositoriesMeteringInfo) Perform(providedCtx context.Context) (*http.Response, error)
- type NewGetRepositoriesMeteringInfo
- 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 GetRepositoriesMeteringInfo ¶
type GetRepositoriesMeteringInfo struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetRepositoriesMeteringInfo
Returns cluster repositories metering information.
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) Header ¶
func (r *GetRepositoriesMeteringInfo) Header(key, value string) *GetRepositoriesMeteringInfo
Header set a key, value pair in the GetRepositoriesMeteringInfo headers map.
func (*GetRepositoriesMeteringInfo) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
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.
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 ¶ 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 getrepositoriesmeteringinfo
Source Files