putalias

Documentation

Overview

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

Index

• Variables
• type NewPutAlias
  • func NewPutAliasFunc(tp elastictransport.Interface) NewPutAlias
• type PutAlias
  • func New(tp elastictransport.Interface) *PutAlias
  • func (r PutAlias) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutAlias) ErrorTrace(errortrace bool) *PutAlias
  • func (r *PutAlias) Filter(filter *types.Query) *PutAlias
  • func (r *PutAlias) FilterPath(filterpaths ...string) *PutAlias
  • func (r *PutAlias) Header(key, value string) *PutAlias
  • func (r *PutAlias) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutAlias) Human(human bool) *PutAlias
  • func (r *PutAlias) IndexRouting(routing string) *PutAlias
  • func (r *PutAlias) IsWriteIndex(iswriteindex bool) *PutAlias
  • func (r *PutAlias) MasterTimeout(duration string) *PutAlias
  • func (r PutAlias) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutAlias) Pretty(pretty bool) *PutAlias
  • func (r *PutAlias) Raw(raw io.Reader) *PutAlias
  • func (r *PutAlias) Request(req *Request) *PutAlias
  • func (r *PutAlias) Routing(routing string) *PutAlias
  • func (r *PutAlias) SearchRouting(routing string) *PutAlias
  • func (r *PutAlias) Timeout(duration string) *PutAlias
• 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 NewPutAlias

type NewPutAlias func(index, name string) *PutAlias

NewPutAlias type alias for index.

func NewPutAliasFunc

func NewPutAliasFunc(tp elastictransport.Interface) NewPutAlias

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

type PutAlias

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

func New

func New(tp elastictransport.Interface) *PutAlias

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 (PutAlias) Do

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

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

func (*PutAlias) ErrorTrace

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

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

func (*PutAlias) Filter

func (r *PutAlias) Filter(filter *types.Query) *PutAlias

Filter Query used to limit documents the alias can access. API name: filter

func (*PutAlias) FilterPath

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

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

func (*PutAlias) Header

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

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

func (*PutAlias) HttpRequest

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

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

func (*PutAlias) Human

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

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 (*PutAlias) IndexRouting

func (r *PutAlias) IndexRouting(routing string) *PutAlias

IndexRouting Value used to route indexing operations to a specific shard. If specified, this overwrites the `routing` value for indexing operations. Data stream aliases don’t support this parameter. API name: index_routing

func (*PutAlias) IsWriteIndex

func (r *PutAlias) IsWriteIndex(iswriteindex bool) *PutAlias

IsWriteIndex If `true`, sets the write index or data stream for the alias. If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests. If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index. Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. API name: is_write_index

func (*PutAlias) MasterTimeout

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

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 (PutAlias) Perform

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

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

func (*PutAlias) Pretty

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

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

func (*PutAlias) Raw

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

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

func (*PutAlias) Request

func (r *PutAlias) Request(req *Request) *PutAlias

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

func (*PutAlias) Routing

func (r *PutAlias) Routing(routing string) *PutAlias

Routing Value used to route indexing and search operations to a specific shard. Data stream aliases don’t support this parameter. API name: routing

func (*PutAlias) SearchRouting

func (r *PutAlias) SearchRouting(routing string) *PutAlias

SearchRouting Value used to route search operations to a specific shard. If specified, this overwrites the `routing` value for search operations. Data stream aliases don’t support this parameter. API name: search_routing

func (*PutAlias) Timeout

func (r *PutAlias) Timeout(duration string) *PutAlias

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

type Request

type Request struct {

	// Filter Query used to limit documents the alias can access.
	Filter *types.Query `json:"filter,omitempty"`
	// IndexRouting Value used to route indexing operations to a specific shard.
	// If specified, this overwrites the `routing` value for indexing operations.
	// Data stream aliases don’t support this parameter.
	IndexRouting *string `json:"index_routing,omitempty"`
	// IsWriteIndex If `true`, sets the write index or data stream for the alias.
	// If an alias points to multiple indices or data streams and `is_write_index`
	// isn’t set, the alias rejects write requests.
	// If an index alias points to one index and `is_write_index` isn’t set, the
	// index automatically acts as the write index.
	// Data stream aliases don’t automatically set a write data stream, even if the
	// alias points to one data stream.
	IsWriteIndex *bool `json:"is_write_index,omitempty"`
	// Routing Value used to route indexing and search operations to a specific shard.
	// Data stream aliases don’t support this parameter.
	Routing *string `json:"routing,omitempty"`
	// SearchRouting Value used to route search operations to a specific shard.
	// If specified, this overwrites the `routing` value for search operations.
	// Data stream aliases don’t support this parameter.
	SearchRouting *string `json:"search_routing,omitempty"`
}

Request holds the request body struct for the package putalias

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/indices/put_alias/IndicesPutAliasRequest.ts#L25-L92

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 {

	// 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 putalias

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response