updatestatus

Documentation

Overview

Update the connector status.

Index

• Variables
• type NewUpdateStatus
  • func NewUpdateStatusFunc(tp elastictransport.Interface) NewUpdateStatus
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type UpdateStatus
  • func New(tp elastictransport.Interface) *UpdateStatus
  • func (r UpdateStatus) Do(providedCtx context.Context) (*Response, error)
  • func (r *UpdateStatus) ErrorTrace(errortrace bool) *UpdateStatus
  • func (r *UpdateStatus) FilterPath(filterpaths ...string) *UpdateStatus
  • func (r *UpdateStatus) Header(key, value string) *UpdateStatus
  • func (r *UpdateStatus) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *UpdateStatus) Human(human bool) *UpdateStatus
  • func (r UpdateStatus) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *UpdateStatus) Pretty(pretty bool) *UpdateStatus
  • func (r *UpdateStatus) Raw(raw io.Reader) *UpdateStatus
  • func (r *UpdateStatus) Request(req *Request) *UpdateStatus
  • func (r *UpdateStatus) Status(status connectorstatus.ConnectorStatus) *UpdateStatus

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 NewUpdateStatus

type NewUpdateStatus func(connectorid string) *UpdateStatus

NewUpdateStatus type alias for index.

func NewUpdateStatusFunc

func NewUpdateStatusFunc(tp elastictransport.Interface) NewUpdateStatus

NewUpdateStatusFunc returns a new instance of UpdateStatus 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 {
	Status connectorstatus.ConnectorStatus `json:"status"`
}

Request holds the request body struct for the package updatestatus

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/connector/update_status/ConnectorUpdateStatusRequest.ts#L23-L43

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 updatestatus

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type UpdateStatus

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

func New

func New(tp elastictransport.Interface) *UpdateStatus

Update the connector status.

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

func (UpdateStatus) Do

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

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

func (*UpdateStatus) ErrorTrace

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

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

func (*UpdateStatus) FilterPath

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

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

func (*UpdateStatus) Header

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

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

func (*UpdateStatus) HttpRequest

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

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

func (*UpdateStatus) Human

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

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

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

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

func (*UpdateStatus) Pretty

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

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

func (*UpdateStatus) Raw

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

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

func (*UpdateStatus) Request

func (r *UpdateStatus) Request(req *Request) *UpdateStatus

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

func (*UpdateStatus) Status

func (r *UpdateStatus) Status(status connectorstatus.ConnectorStatus) *UpdateStatus

API name: status