updatealiases

Documentation

Overview

Updates index aliases.

Index

• Variables
• type NewUpdateAliases
  • func NewUpdateAliasesFunc(tp elastictransport.Interface) NewUpdateAliases
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Actions(actions []types.ActionBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
• type UpdateAliases
  • func New(tp elastictransport.Interface) *UpdateAliases
  • func (r UpdateAliases) Do(ctx context.Context) (*http.Response, error)
  • func (r *UpdateAliases) Header(key, value string) *UpdateAliases
  • func (r *UpdateAliases) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *UpdateAliases) MasterTimeout(value string) *UpdateAliases
  • func (r *UpdateAliases) Raw(raw json.RawMessage) *UpdateAliases
  • func (r *UpdateAliases) Request(req *Request) *UpdateAliases
  • func (r *UpdateAliases) Timeout(value string) *UpdateAliases

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 NewUpdateAliases

type NewUpdateAliases func() *UpdateAliases

NewUpdateAliases type alias for index.

func NewUpdateAliasesFunc

func NewUpdateAliasesFunc(tp elastictransport.Interface) NewUpdateAliases

NewUpdateAliasesFunc returns a new instance of UpdateAliases 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 {
	Actions []types.Action `json:"actions,omitempty"`
}

Request holds the request body struct for the package updatealiases

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts#L24-L37

type RequestBuilder

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

RequestBuilder is the builder API for the updatealiases.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Actions

func (rb *RequestBuilder) Actions(actions []types.ActionBuilder) *RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type UpdateAliases

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

func New

func New(tp elastictransport.Interface) *UpdateAliases

Updates index aliases.

https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html

func (UpdateAliases) Do

func (r UpdateAliases) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*UpdateAliases) Header

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

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

func (*UpdateAliases) HttpRequest

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

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

func (*UpdateAliases) MasterTimeout

func (r *UpdateAliases) MasterTimeout(value string) *UpdateAliases

MasterTimeout Specify timeout for connection to master API name: master_timeout

func (*UpdateAliases) Raw

func (r *UpdateAliases) Raw(raw json.RawMessage) *UpdateAliases

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

func (*UpdateAliases) Request

func (r *UpdateAliases) Request(req *Request) *UpdateAliases

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

func (*UpdateAliases) Timeout

func (r *UpdateAliases) Timeout(value string) *UpdateAliases

Timeout Request timeout API name: timeout