syncjobdelete

Documentation

Overview

Delete a connector sync job.

Remove a connector sync job and its associated data. This is a destructive action that is not recoverable.

Index

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

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 NewSyncJobDelete

type NewSyncJobDelete func(connectorsyncjobid string) *SyncJobDelete

NewSyncJobDelete type alias for index.

func NewSyncJobDeleteFunc

func NewSyncJobDeleteFunc(tp elastictransport.Interface) NewSyncJobDelete

NewSyncJobDeleteFunc returns a new instance of SyncJobDelete 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 {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package syncjobdelete

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/connector/sync_job_delete/SyncJobDeleteResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type SyncJobDelete

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

func New

func New(tp elastictransport.Interface) *SyncJobDelete

Delete a connector sync job.

Remove a connector sync job and its associated data. This is a destructive action that is not recoverable.

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

func (SyncJobDelete) Do

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

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

func (*SyncJobDelete) ErrorTrace

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

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

func (*SyncJobDelete) FilterPath

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

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

func (*SyncJobDelete) Header

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

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

func (*SyncJobDelete) HttpRequest

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

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

func (*SyncJobDelete) Human

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

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

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

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

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

func (*SyncJobDelete) Pretty

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

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