transforms

Documentation

Overview

Gets configuration and usage information about transforms.

Index

• Variables
• type NewTransforms
  • func NewTransformsFunc(tp elastictransport.Interface) NewTransforms
• type Transforms
  • func New(tp elastictransport.Interface) *Transforms
  • func (r *Transforms) AllowNoMatch(b bool) *Transforms
  • func (r Transforms) Do(ctx context.Context) (*http.Response, error)
  • func (r *Transforms) From(i int) *Transforms
  • func (r *Transforms) H(value string) *Transforms
  • func (r *Transforms) Header(key, value string) *Transforms
  • func (r *Transforms) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Transforms) IsSuccess(ctx context.Context) (bool, error)
  • func (r *Transforms) S(value string) *Transforms
  • func (r *Transforms) Size(i int) *Transforms
  • func (r *Transforms) Time(enum timeunit.TimeUnit) *Transforms
  • func (r *Transforms) TransformId(v string) *Transforms

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 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 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/{branch}/cat-transforms.html

func (*Transforms) AllowNoMatch

func (r *Transforms) AllowNoMatch(b bool) *Transforms

AllowNoMatch Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) API name: allow_no_match

func (Transforms) Do

func (r Transforms) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*Transforms) From

func (r *Transforms) From(i int) *Transforms

From skips a number of transform configs, defaults to 0 API name: from

func (*Transforms) H

func (r *Transforms) H(value string) *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

func (r *Transforms) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (Transforms) IsSuccess

func (r Transforms) 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 (*Transforms) S

func (r *Transforms) S(value string) *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(i int) *Transforms

Size specifies a max number of transforms to get, defaults to 100 API name: size

func (*Transforms) Time

func (r *Transforms) Time(enum timeunit.TimeUnit) *Transforms

Time Unit used to display time values. API name: time

func (*Transforms) TransformId

func (r *Transforms) TransformId(v string) *Transforms

TransformId The id of the transform for which to get stats. '_all' or '*' implies all transforms API Name: transformid