Documentation
¶
Overview ¶
Retrieves usage information for transforms.
Index ¶
- Variables
- type GetTransformStats
- func (r *GetTransformStats) AllowNoMatch(allownomatch bool) *GetTransformStats
- func (r GetTransformStats) Do(providedCtx context.Context) (*Response, error)
- func (r *GetTransformStats) From(from string) *GetTransformStats
- func (r *GetTransformStats) Header(key, value string) *GetTransformStats
- func (r *GetTransformStats) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetTransformStats) IsSuccess(providedCtx context.Context) (bool, error)
- func (r GetTransformStats) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetTransformStats) Size(size string) *GetTransformStats
- func (r *GetTransformStats) Timeout(duration string) *GetTransformStats
- type NewGetTransformStats
- 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 GetTransformStats ¶
type GetTransformStats struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetTransformStats
Retrieves usage information for transforms.
https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html
func (*GetTransformStats) AllowNoMatch ¶
func (r *GetTransformStats) AllowNoMatch(allownomatch bool) *GetTransformStats
AllowNoMatch Specifies what to do when the request:
1. Contains wildcard expressions and there are no transforms that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches.
If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches. API name: allow_no_match
func (GetTransformStats) Do ¶
func (r GetTransformStats) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a gettransformstats.Response
func (*GetTransformStats) From ¶
func (r *GetTransformStats) From(from string) *GetTransformStats
From Skips the specified number of transforms. API name: from
func (*GetTransformStats) Header ¶
func (r *GetTransformStats) Header(key, value string) *GetTransformStats
Header set a key, value pair in the GetTransformStats headers map.
func (*GetTransformStats) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (GetTransformStats) IsSuccess ¶
func (r GetTransformStats) 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 (GetTransformStats) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*GetTransformStats) Size ¶
func (r *GetTransformStats) Size(size string) *GetTransformStats
Size Specifies the maximum number of transforms to obtain. API name: size
func (*GetTransformStats) Timeout ¶ added in v8.7.0
func (r *GetTransformStats) Timeout(duration string) *GetTransformStats
Timeout Controls the time to wait for the stats API name: timeout
type NewGetTransformStats ¶
type NewGetTransformStats func(transformid string) *GetTransformStats
NewGetTransformStats type alias for index.
func NewGetTransformStatsFunc ¶
func NewGetTransformStatsFunc(tp elastictransport.Interface) NewGetTransformStats
NewGetTransformStatsFunc returns a new instance of GetTransformStats 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 {
Count int64 `json:"count"`
Transforms []types.TransformStats `json:"transforms"`
}
Response holds the response body struct for the package gettransformstats
Source Files