updatealiases

Documentation

Overview

Create or update an alias. Adds a data stream or index to an alias.

Index

• Variables
• type NewUpdateAliases
  • func NewUpdateAliasesFunc(tp elastictransport.Interface) NewUpdateAliases
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type UpdateAliases
  • func New(tp elastictransport.Interface) *UpdateAliases
  • func (r *UpdateAliases) Actions(actions ...types.IndicesAction) *UpdateAliases
  • func (r UpdateAliases) Do(providedCtx context.Context) (*Response, error)
  • func (r *UpdateAliases) ErrorTrace(errortrace bool) *UpdateAliases
  • func (r *UpdateAliases) FilterPath(filterpaths ...string) *UpdateAliases
  • func (r *UpdateAliases) Header(key, value string) *UpdateAliases
  • func (r *UpdateAliases) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *UpdateAliases) Human(human bool) *UpdateAliases
  • func (r *UpdateAliases) MasterTimeout(duration string) *UpdateAliases
  • func (r UpdateAliases) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *UpdateAliases) Pretty(pretty bool) *UpdateAliases
  • func (r *UpdateAliases) Raw(raw io.Reader) *UpdateAliases
  • func (r *UpdateAliases) Request(req *Request) *UpdateAliases
  • func (r *UpdateAliases) Timeout(duration 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 Actions to perform.
	Actions []types.IndicesAction `json:"actions,omitempty"`
}

Request holds the request body struct for the package updatealiases

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts#L24-L52

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 {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package updatealiases

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/indices/update_aliases/IndicesUpdateAliasesResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type UpdateAliases

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

func New

func New(tp elastictransport.Interface) *UpdateAliases

Create or update an alias. Adds a data stream or index to an alias.

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

func (*UpdateAliases) Actions

func (r *UpdateAliases) Actions(actions ...types.IndicesAction) *UpdateAliases

Actions Actions to perform. API name: actions

func (UpdateAliases) Do

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

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

func (*UpdateAliases) ErrorTrace

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

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

func (*UpdateAliases) FilterPath

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

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

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) Human

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

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 (*UpdateAliases) MasterTimeout

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

MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (UpdateAliases) Perform

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

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

func (*UpdateAliases) Pretty

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

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

func (*UpdateAliases) Raw

func (r *UpdateAliases) Raw(raw io.Reader) *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(duration string) *UpdateAliases

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout