Documentation
¶
Overview ¶
Downsample an index
Index ¶
- Variables
- type Downsample
- func (r Downsample) Do(providedCtx context.Context) (Response, error)
- func (r *Downsample) FixedInterval(durationlarge string) *Downsample
- func (r *Downsample) Header(key, value string) *Downsample
- func (r *Downsample) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r Downsample) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Downsample) Raw(raw io.Reader) *Downsample
- func (r *Downsample) Request(req *Request) *Downsample
- type NewDownsample
- type Request
- 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 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/indices-downsample-data-stream.html
func (Downsample) Do ¶
func (r Downsample) Do(providedCtx context.Context) (Response, error)
Do runs the request through the transport, handle the response and returns a downsample.Response
func (*Downsample) FixedInterval ¶ added in v8.11.0
func (r *Downsample) FixedInterval(durationlarge string) *Downsample
FixedInterval The interval at which to aggregate the original time series index. API name: fixed_interval
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 ¶
HttpRequest returns the http.Request object built from the given parameters.
func (Downsample) Perform ¶ added in v8.7.0
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 *Request) *Downsample
Request allows to set the request property with the appropriate payload.
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 Request ¶ added in v8.11.0
type Request = types.DownsampleConfig
Request holds the request body struct for the package downsample
type Response ¶ added in v8.7.0
type Response = json.RawMessage
func NewResponse ¶ added in v8.7.1
func NewResponse() *Response
Source Files