post

Documentation

Overview

Create a connector.

Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. Self-managed connectors (Connector clients) are self-managed on your infrastructure.

Index

• Variables
• type NewPost
  • func NewPostFunc(tp elastictransport.Interface) NewPost
• type Post
  • func New(tp elastictransport.Interface) *Post
  • func (r *Post) Description(description string) *Post
  • func (r Post) Do(providedCtx context.Context) (*Response, error)
  • func (r *Post) ErrorTrace(errortrace bool) *Post
  • func (r *Post) FilterPath(filterpaths ...string) *Post
  • func (r *Post) Header(key, value string) *Post
  • func (r *Post) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Post) Human(human bool) *Post
  • func (r *Post) IndexName(indexname string) *Post
  • func (r *Post) IsNative(isnative bool) *Post
  • func (r *Post) Language(language string) *Post
  • func (r *Post) Name(name string) *Post
  • func (r Post) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Post) Pretty(pretty bool) *Post
  • func (r *Post) Raw(raw io.Reader) *Post
  • func (r *Post) Request(req *Request) *Post
  • func (r *Post) ServiceType(servicetype string) *Post
• 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

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 NewPost

type NewPost func() *Post

NewPost type alias for index.

func NewPostFunc

func NewPostFunc(tp elastictransport.Interface) NewPost

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

type Post

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

func New

func New(tp elastictransport.Interface) *Post

Create a connector.

Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. Self-managed connectors (Connector clients) are self-managed on your infrastructure.

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

func (*Post) Description

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

API name: description

func (Post) Do

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

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

func (*Post) ErrorTrace

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

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

func (*Post) FilterPath

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

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

func (*Post) Header

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

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

func (*Post) HttpRequest

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

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

func (*Post) Human

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

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 (*Post) IndexName

func (r *Post) IndexName(indexname string) *Post

API name: index_name

func (*Post) IsNative

func (r *Post) IsNative(isnative bool) *Post

API name: is_native

func (*Post) Language

func (r *Post) Language(language string) *Post

API name: language

func (*Post) Name

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

API name: name

func (Post) Perform

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

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

func (*Post) Pretty

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

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

func (*Post) Raw

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

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

func (*Post) Request

func (r *Post) Request(req *Request) *Post

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

func (*Post) ServiceType

func (r *Post) ServiceType(servicetype string) *Post

API name: service_type

type Request

type Request struct {
	Description *string `json:"description,omitempty"`
	IndexName   *string `json:"index_name,omitempty"`
	IsNative    *bool   `json:"is_native,omitempty"`
	Language    *string `json:"language,omitempty"`
	Name        *string `json:"name,omitempty"`
	ServiceType *string `json:"service_type,omitempty"`
}

Request holds the request body struct for the package post

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/connector/post/ConnectorPostRequest.ts#L22-L46

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"`
	Result result.Result `json:"result"`
}

Response holds the response body struct for the package post

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/connector/post/ConnectorPostResponse.ts#L23-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response