syncjobcancel

Documentation

Overview

Cancel a connector sync job.

Cancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time. The connector service is then responsible for setting the status of connector sync jobs to cancelled.

Index

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

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 NewSyncJobCancel

type NewSyncJobCancel func(connectorsyncjobid string) *SyncJobCancel

NewSyncJobCancel type alias for index.

func NewSyncJobCancelFunc

func NewSyncJobCancelFunc(tp elastictransport.Interface) NewSyncJobCancel

NewSyncJobCancelFunc returns a new instance of SyncJobCancel 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 syncjobcancel

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/connector/sync_job_cancel/SyncJobCancelResponse.ts#L22-L26

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type SyncJobCancel

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

func New

func New(tp elastictransport.Interface) *SyncJobCancel

Cancel a connector sync job.

Cancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time. The connector service is then responsible for setting the status of connector sync jobs to cancelled.

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

func (SyncJobCancel) Do

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

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

func (*SyncJobCancel) ErrorTrace

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

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

func (*SyncJobCancel) FilterPath

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

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

func (*SyncJobCancel) Header

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

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

func (*SyncJobCancel) HttpRequest

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

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

func (*SyncJobCancel) Human

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

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

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

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

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

func (*SyncJobCancel) Pretty

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

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