bulk

Documentation

Overview

Used by the monitoring features to send monitoring data.

Index

• Variables
• type Bulk
  • func New(tp elastictransport.Interface) *Bulk
  • func (r Bulk) Do(ctx context.Context) (*Response, error)
  • func (r *Bulk) Header(key, value string) *Bulk
  • func (r *Bulk) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Bulk) Interval(duration string) *Bulk
  • func (r Bulk) Perform(ctx context.Context) (*http.Response, error)
  • func (r *Bulk) Raw(raw io.Reader) *Bulk
  • func (r *Bulk) Request(req []interface{}) *Bulk
  • func (r *Bulk) SystemApiVersion(systemapiversion string) *Bulk
  • func (r *Bulk) SystemId(systemid string) *Bulk
  • func (r *Bulk) Type(type_ string) *Bulk
• type NewBulk
  • func NewBulkFunc(tp elastictransport.Interface) NewBulk
• type Response
  • func NewResponse() *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 Bulk

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

func New

func New(tp elastictransport.Interface) *Bulk

Used by the monitoring features to send monitoring data.

https://www.elastic.co/guide/en/elasticsearch/reference/master/monitor-elasticsearch-cluster.html

func (Bulk) Do

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

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

func (*Bulk) Header

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

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

func (*Bulk) HttpRequest

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

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

func (*Bulk) Interval

func (r *Bulk) Interval(duration string) *Bulk

Interval Collection interval (e.g., '10s' or '10000ms') of the payload API name: interval

func (Bulk) Perform

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

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

func (*Bulk) Raw

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

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

func (*Bulk) Request

func (r *Bulk) Request(req []interface{}) *Bulk

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

func (*Bulk) SystemApiVersion

func (r *Bulk) SystemApiVersion(systemapiversion string) *Bulk

API name: system_api_version

func (*Bulk) SystemId

func (r *Bulk) SystemId(systemid string) *Bulk

SystemId Identifier of the monitored system API name: system_id

func (*Bulk) Type

func (r *Bulk) Type(type_ string) *Bulk

Type Default document type for items which don't provide one API Name: type_

type NewBulk

type NewBulk func() *Bulk

NewBulk type alias for index.

func NewBulkFunc

func NewBulkFunc(tp elastictransport.Interface) NewBulk

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

type Response

type Response struct {
	Error *types.ErrorCause `json:"error,omitempty"`
	// Errors True if there is was an error
	Errors bool `json:"errors"`
	// Ignored Was collection disabled?
	Ignored bool  `json:"ignored"`
	Took    int64 `json:"took"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response