put

package
v8.13.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2024 License: Apache-2.0 Imports: 13 Imported by: 1

Documentation

Overview

Creates or updates a search application.

Index

Constants

This section is empty.

Variables

View Source
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.

Functions

This section is empty.

Types

type NewPut

type NewPut func(name string) *Put

NewPut type alias for index.

func NewPutFunc

func NewPutFunc(tp elastictransport.Interface) NewPut

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

type Put

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

func (*Put) AnalyticsCollectionName added in v8.11.0

func (r *Put) AnalyticsCollectionName(name string) *Put

AnalyticsCollectionName Analytics collection associated to the Search Application. API name: analytics_collection_name

func (*Put) Create

func (r *Put) Create(create bool) *Put

Create If `true`, this request cannot replace or update existing Search Applications. API name: create

func (Put) Do

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

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

func (*Put) Header

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

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

func (*Put) HttpRequest

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

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

func (*Put) Indices added in v8.11.0

func (r *Put) Indices(indices ...string) *Put

Indices Indices that are part of the Search Application. API name: indices

func (*Put) Name

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

Name Search Application name. API name: name

func (Put) Perform

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

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

func (*Put) Raw

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

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

func (*Put) Request

func (r *Put) Request(req *Request) *Put

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

func (*Put) Template added in v8.11.0

func (r *Put) Template(template *types.SearchApplicationTemplate) *Put

Template Search template to use on search operations. API name: template

func (*Put) UpdatedAtMillis added in v8.11.0

func (r *Put) UpdatedAtMillis(epochtimeunitmillis int64) *Put

UpdatedAtMillis Last time the Search Application was updated. API name: updated_at_millis

type Request added in v8.11.0

type Request = types.SearchApplication

Request holds the request body struct for the package put

https://github.com/elastic/elasticsearch-specification/blob/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/search_application/put/SearchApplicationsPutRequest.ts#L23-L48

func NewRequest added in v8.13.1

func NewRequest() *Request

NewRequest returns a Request

type Response

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

Response holds the response body struct for the package put

https://github.com/elastic/elasticsearch-specification/blob/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/search_application/put/SearchApplicationsPutResponse.ts#L22-L26

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL