syncjobpost

Documentation

Overview

Create a connector sync job.

Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.

Index

• Variables
• type NewSyncJobPost
  • func NewSyncJobPostFunc(tp elastictransport.Interface) NewSyncJobPost
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• type Response
  • func NewResponse() *Response
• type SyncJobPost
  • func New(tp elastictransport.Interface) *SyncJobPost
  • func (r SyncJobPost) Do(providedCtx context.Context) (*Response, error)
  • func (r *SyncJobPost) ErrorTrace(errortrace bool) *SyncJobPost
  • func (r *SyncJobPost) FilterPath(filterpaths ...string) *SyncJobPost
  • func (r *SyncJobPost) Header(key, value string) *SyncJobPost
  • func (r *SyncJobPost) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *SyncJobPost) Human(human bool) *SyncJobPost
  • func (r *SyncJobPost) Id(id string) *SyncJobPost
  • func (r *SyncJobPost) JobType(jobtype syncjobtype.SyncJobType) *SyncJobPost
  • func (r SyncJobPost) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *SyncJobPost) Pretty(pretty bool) *SyncJobPost
  • func (r *SyncJobPost) Raw(raw io.Reader) *SyncJobPost
  • func (r *SyncJobPost) Request(req *Request) *SyncJobPost
  • func (r *SyncJobPost) TriggerMethod(triggermethod syncjobtriggermethod.SyncJobTriggerMethod) *SyncJobPost

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 NewSyncJobPost

type NewSyncJobPost func() *SyncJobPost

NewSyncJobPost type alias for index.

func NewSyncJobPostFunc

func NewSyncJobPostFunc(tp elastictransport.Interface) NewSyncJobPost

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

type Request

type Request struct {

	// Id The id of the associated connector
	Id            string                                     `json:"id"`
	JobType       *syncjobtype.SyncJobType                   `json:"job_type,omitempty"`
	TriggerMethod *syncjobtriggermethod.SyncJobTriggerMethod `json:"trigger_method,omitempty"`
}

Request holds the request body struct for the package syncjobpost

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/connector/sync_job_post/SyncJobPostRequest.ts#L23-L45

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

type Response

type Response struct {
	Id string `json:"id"`
}

Response holds the response body struct for the package syncjobpost

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type SyncJobPost

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

func New

func New(tp elastictransport.Interface) *SyncJobPost

Create a connector sync job.

Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.

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

func (SyncJobPost) Do

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

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

func (*SyncJobPost) ErrorTrace

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

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

func (*SyncJobPost) FilterPath

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

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

func (*SyncJobPost) Header

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

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

func (*SyncJobPost) HttpRequest

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

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

func (*SyncJobPost) Human

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

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 (*SyncJobPost) Id

func (r *SyncJobPost) Id(id string) *SyncJobPost

Id The id of the associated connector API name: id

func (*SyncJobPost) JobType

func (r *SyncJobPost) JobType(jobtype syncjobtype.SyncJobType) *SyncJobPost

API name: job_type

func (SyncJobPost) Perform

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

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

func (*SyncJobPost) Pretty

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

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

func (*SyncJobPost) Raw

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

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

func (*SyncJobPost) Request

func (r *SyncJobPost) Request(req *Request) *SyncJobPost

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

func (*SyncJobPost) TriggerMethod

func (r *SyncJobPost) TriggerMethod(triggermethod syncjobtriggermethod.SyncJobTriggerMethod) *SyncJobPost

API name: trigger_method