syncjobcheckin

Documentation

Overview

Check in a connector sync job. Check in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index.

To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.

Index

• Variables
• type NewSyncJobCheckIn
  • func NewSyncJobCheckInFunc(tp elastictransport.Interface) NewSyncJobCheckIn
• type Response
  • func NewResponse() *Response
• type SyncJobCheckIn
  • func New(tp elastictransport.Interface) *SyncJobCheckIn
  • func (r SyncJobCheckIn) Do(providedCtx context.Context) (*Response, error)
  • func (r *SyncJobCheckIn) ErrorTrace(errortrace bool) *SyncJobCheckIn
  • func (r *SyncJobCheckIn) FilterPath(filterpaths ...string) *SyncJobCheckIn
  • func (r *SyncJobCheckIn) Header(key, value string) *SyncJobCheckIn
  • func (r *SyncJobCheckIn) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *SyncJobCheckIn) Human(human bool) *SyncJobCheckIn
  • func (r SyncJobCheckIn) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r SyncJobCheckIn) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *SyncJobCheckIn) Pretty(pretty bool) *SyncJobCheckIn

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 NewSyncJobCheckIn

type NewSyncJobCheckIn func(connectorsyncjobid string) *SyncJobCheckIn

NewSyncJobCheckIn type alias for index.

func NewSyncJobCheckInFunc

func NewSyncJobCheckInFunc(tp elastictransport.Interface) NewSyncJobCheckIn

NewSyncJobCheckInFunc returns a new instance of SyncJobCheckIn 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 {
}

Response holds the response body struct for the package syncjobcheckin

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/sync_job_check_in/SyncJobCheckInResponse.ts#L20-L22

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type SyncJobCheckIn

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

func New

func New(tp elastictransport.Interface) *SyncJobCheckIn

Check in a connector sync job. Check in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index.

To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.

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

func (SyncJobCheckIn) Do

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

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

func (*SyncJobCheckIn) ErrorTrace

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

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

func (*SyncJobCheckIn) FilterPath

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

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

func (*SyncJobCheckIn) Header

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

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

func (*SyncJobCheckIn) HttpRequest

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

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

func (*SyncJobCheckIn) Human

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

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 (SyncJobCheckIn) IsSuccess

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

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

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

func (*SyncJobCheckIn) Pretty

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

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