checkin

Documentation

Overview

Check in a connector.

Update the `last_seen` field in the connector and set it to the current timestamp.

Index

• Variables
• type CheckIn
  • func New(tp elastictransport.Interface) *CheckIn
  • func (r CheckIn) Do(providedCtx context.Context) (*Response, error)
  • func (r *CheckIn) ErrorTrace(errortrace bool) *CheckIn
  • func (r *CheckIn) FilterPath(filterpaths ...string) *CheckIn
  • func (r *CheckIn) Header(key, value string) *CheckIn
  • func (r *CheckIn) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *CheckIn) Human(human bool) *CheckIn
  • func (r CheckIn) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r CheckIn) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *CheckIn) Pretty(pretty bool) *CheckIn
• type NewCheckIn
  • func NewCheckInFunc(tp elastictransport.Interface) NewCheckIn
• 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 CheckIn

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

func New

func New(tp elastictransport.Interface) *CheckIn

Check in a connector.

Update the `last_seen` field in the connector and set it to the current timestamp.

https://www.elastic.co/guide/en/elasticsearch/reference/current/check-in-connector-api.html

func (CheckIn) Do

func (r CheckIn) Do(providedCtx context.Context) (*Response, error)

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

func (*CheckIn) ErrorTrace

func (r *CheckIn) ErrorTrace(errortrace bool) *CheckIn

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*CheckIn) FilterPath

func (r *CheckIn) FilterPath(filterpaths ...string) *CheckIn

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*CheckIn) Header

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

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

func (*CheckIn) HttpRequest

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

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

func (*CheckIn) Human

func (r *CheckIn) Human(human bool) *CheckIn

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (CheckIn) IsSuccess

func (r CheckIn) 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 (CheckIn) Perform

func (r CheckIn) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*CheckIn) Pretty

func (r *CheckIn) Pretty(pretty bool) *CheckIn

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

type NewCheckIn

type NewCheckIn func(connectorid string) *CheckIn

NewCheckIn type alias for index.

func NewCheckInFunc

func NewCheckInFunc(tp elastictransport.Interface) NewCheckIn

NewCheckInFunc returns a new instance of CheckIn 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 {
	Result result.Result `json:"result"`
}

Response holds the response body struct for the package checkin

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/connector/check_in/ConnectorCheckInResponse.ts#L22-L26

func NewResponse

func NewResponse() *Response

NewResponse returns a Response