Documentation
¶
Overview ¶
Gets configuration and usage information about transforms.
Index ¶
- Variables
- type NewTransforms
- type Response
- type Transforms
- func (r *Transforms) AllowNoMatch(allownomatch bool) *Transforms
- func (r Transforms) Do(providedCtx context.Context) (Response, error)
- func (r *Transforms) From(from int) *Transforms
- func (r *Transforms) H(cattransformcolumns ...cattransformcolumn.CatTransformColumn) *Transforms
- func (r *Transforms) Header(key, value string) *Transforms
- func (r *Transforms) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r Transforms) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Transforms) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Transforms) S(cattransformcolumns ...cattransformcolumn.CatTransformColumn) *Transforms
- func (r *Transforms) Size(size int) *Transforms
- func (r *Transforms) Time(time timeunit.TimeUnit) *Transforms
- func (r *Transforms) TransformId(transformid string) *Transforms
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 NewTransforms ¶
type NewTransforms func() *Transforms
NewTransforms type alias for index.
func NewTransformsFunc ¶
func NewTransformsFunc(tp elastictransport.Interface) NewTransforms
NewTransformsFunc returns a new instance of Transforms 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 []types.TransformsRecord
type Transforms ¶
type Transforms struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Transforms
Gets configuration and usage information about transforms.
https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html
func (*Transforms) AllowNoMatch ¶
func (r *Transforms) AllowNoMatch(allownomatch bool) *Transforms
AllowNoMatch Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If `false`, the request returns a 404 status code when there are no matches or only partial matches. API name: allow_no_match
func (Transforms) Do ¶
func (r Transforms) Do(providedCtx context.Context) (Response, error)
Do runs the request through the transport, handle the response and returns a transforms.Response
func (*Transforms) From ¶
func (r *Transforms) From(from int) *Transforms
From Skips the specified number of transforms. API name: from
func (*Transforms) H ¶
func (r *Transforms) H(cattransformcolumns ...cattransformcolumn.CatTransformColumn) *Transforms
H Comma-separated list of column names to display. API name: h
func (*Transforms) Header ¶
func (r *Transforms) Header(key, value string) *Transforms
Header set a key, value pair in the Transforms headers map.
func (*Transforms) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (Transforms) IsSuccess ¶
func (r Transforms) 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 (Transforms) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Transforms) S ¶
func (r *Transforms) S(cattransformcolumns ...cattransformcolumn.CatTransformColumn) *Transforms
S Comma-separated list of column names or column aliases used to sort the response. API name: s
func (*Transforms) Size ¶
func (r *Transforms) Size(size int) *Transforms
Size The maximum number of transforms to obtain. API name: size
func (*Transforms) Time ¶
func (r *Transforms) Time(time timeunit.TimeUnit) *Transforms
Time The unit used to display time values. API name: time
func (*Transforms) TransformId ¶
func (r *Transforms) TransformId(transformid string) *Transforms
TransformId A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms. API Name: transformid
Source Files