updatename

Documentation

Overview

Update the connector name and description.

Index

• Variables
• type NewUpdateName
  • func NewUpdateNameFunc(tp elastictransport.Interface) NewUpdateName
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type UpdateName
  • func New(tp elastictransport.Interface) *UpdateName
  • func (r *UpdateName) Description(description string) *UpdateName
  • func (r UpdateName) Do(providedCtx context.Context) (*Response, error)
  • func (r *UpdateName) ErrorTrace(errortrace bool) *UpdateName
  • func (r *UpdateName) FilterPath(filterpaths ...string) *UpdateName
  • func (r *UpdateName) Header(key, value string) *UpdateName
  • func (r *UpdateName) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *UpdateName) Human(human bool) *UpdateName
  • func (r *UpdateName) Name(name string) *UpdateName
  • func (r UpdateName) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *UpdateName) Pretty(pretty bool) *UpdateName
  • func (r *UpdateName) Raw(raw io.Reader) *UpdateName
  • func (r *UpdateName) Request(req *Request) *UpdateName

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 NewUpdateName

type NewUpdateName func(connectorid string) *UpdateName

NewUpdateName type alias for index.

func NewUpdateNameFunc

func NewUpdateNameFunc(tp elastictransport.Interface) NewUpdateName

NewUpdateNameFunc returns a new instance of UpdateName 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 {
	Description *string `json:"description,omitempty"`
	Name        *string `json:"name,omitempty"`
}

Request holds the request body struct for the package updatename

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/connector/update_name/ConnectorUpdateNameRequest.ts#L22-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 updatename

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type UpdateName

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

func New

func New(tp elastictransport.Interface) *UpdateName

Update the connector name and description.

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

func (*UpdateName) Description

func (r *UpdateName) Description(description string) *UpdateName

API name: description

func (UpdateName) Do

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

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

func (*UpdateName) ErrorTrace

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

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

func (*UpdateName) FilterPath

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

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

func (*UpdateName) Header

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

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

func (*UpdateName) HttpRequest

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

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

func (*UpdateName) Human

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

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 (*UpdateName) Name

func (r *UpdateName) Name(name string) *UpdateName

API name: name

func (UpdateName) Perform

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

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

func (*UpdateName) Pretty

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

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

func (*UpdateName) Raw

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

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

func (*UpdateName) Request

func (r *UpdateName) Request(req *Request) *UpdateName

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