downsample

Documentation

Overview

Downsample an index

Index

• Variables
• type Downsample
  • func New(tp elastictransport.Interface) *Downsample
  • func (r Downsample) Do(ctx context.Context) (Response, error)
  • func (r *Downsample) Header(key, value string) *Downsample
  • func (r *Downsample) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Downsample) Index(v string) *Downsample
  • func (r Downsample) Perform(ctx context.Context) (*http.Response, error)
  • func (r *Downsample) Raw(raw io.Reader) *Downsample
  • func (r *Downsample) Request(req *types.DownsampleConfig) *Downsample
  • func (r *Downsample) TargetIndex(v string) *Downsample
• type NewDownsample
  • func NewDownsampleFunc(tp elastictransport.Interface) NewDownsample
• type Response

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 Downsample

type Downsample struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *Downsample

Downsample an index

https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html

func (Downsample) Do

func (r Downsample) Do(ctx context.Context) (Response, error)

Do runs the request through the transport, handle the response and returns a downsample.Response

func (*Downsample) Header

func (r *Downsample) Header(key, value string) *Downsample

Header set a key, value pair in the Downsample headers map.

func (*Downsample) HttpRequest

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

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

func (*Downsample) Index

func (r *Downsample) Index(v string) *Downsample

Index The index to downsample API Name: index

func (Downsample) Perform

func (r Downsample) Perform(ctx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*Downsample) Raw

func (r *Downsample) Raw(raw io.Reader) *Downsample

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*Downsample) Request

func (r *Downsample) Request(req *types.DownsampleConfig) *Downsample

Request allows to set the request property with the appropriate payload.

func (*Downsample) TargetIndex

func (r *Downsample) TargetIndex(v string) *Downsample

TargetIndex The name of the target index to store downsampled data API Name: targetindex

type NewDownsample

type NewDownsample func(index, targetindex string) *Downsample

NewDownsample type alias for index.

func NewDownsampleFunc

func NewDownsampleFunc(tp elastictransport.Interface) NewDownsample

NewDownsampleFunc returns a new instance of Downsample with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Response

type Response json.RawMessage