updatescheduling

Documentation

Overview

Update the connector scheduling.

Index

• Variables
• type NewUpdateScheduling
  • func NewUpdateSchedulingFunc(tp elastictransport.Interface) NewUpdateScheduling
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type UpdateScheduling
  • func New(tp elastictransport.Interface) *UpdateScheduling
  • func (r UpdateScheduling) Do(providedCtx context.Context) (*Response, error)
  • func (r *UpdateScheduling) ErrorTrace(errortrace bool) *UpdateScheduling
  • func (r *UpdateScheduling) FilterPath(filterpaths ...string) *UpdateScheduling
  • func (r *UpdateScheduling) Header(key, value string) *UpdateScheduling
  • func (r *UpdateScheduling) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *UpdateScheduling) Human(human bool) *UpdateScheduling
  • func (r UpdateScheduling) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *UpdateScheduling) Pretty(pretty bool) *UpdateScheduling
  • func (r *UpdateScheduling) Raw(raw io.Reader) *UpdateScheduling
  • func (r *UpdateScheduling) Request(req *Request) *UpdateScheduling
  • func (r *UpdateScheduling) Scheduling(scheduling *types.SchedulingConfiguration) *UpdateScheduling

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 NewUpdateScheduling

type NewUpdateScheduling func(connectorid string) *UpdateScheduling

NewUpdateScheduling type alias for index.

func NewUpdateSchedulingFunc

func NewUpdateSchedulingFunc(tp elastictransport.Interface) NewUpdateScheduling

NewUpdateSchedulingFunc returns a new instance of UpdateScheduling 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 {
	Scheduling types.SchedulingConfiguration `json:"scheduling"`
}

Request holds the request body struct for the package updatescheduling

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts#L23-L44

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

type Response

type Response struct {
	Result result.Result `json:"result"`
}

Response holds the response body struct for the package updatescheduling

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type UpdateScheduling

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

func New

func New(tp elastictransport.Interface) *UpdateScheduling

Update the connector scheduling.

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

func (UpdateScheduling) Do

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

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

func (*UpdateScheduling) ErrorTrace

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

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

func (*UpdateScheduling) FilterPath

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

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

func (*UpdateScheduling) Header

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

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

func (*UpdateScheduling) HttpRequest

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

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

func (*UpdateScheduling) Human

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

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 (UpdateScheduling) Perform

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

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

func (*UpdateScheduling) Pretty

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

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

func (*UpdateScheduling) Raw

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

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

func (*UpdateScheduling) Request

func (r *UpdateScheduling) Request(req *Request) *UpdateScheduling

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

func (*UpdateScheduling) Scheduling

func (r *UpdateScheduling) Scheduling(scheduling *types.SchedulingConfiguration) *UpdateScheduling

API name: scheduling