putalias

Documentation

Overview

Creates or updates an alias.

Index

• Variables
• type NewPutAlias
  • func NewPutAliasFunc(tp elastictransport.Interface) NewPutAlias
• type PutAlias
  • func New(tp elastictransport.Interface) *PutAlias
  • func (r PutAlias) Do(ctx context.Context) (*http.Response, error)
  • func (r *PutAlias) Header(key, value string) *PutAlias
  • func (r *PutAlias) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutAlias) Index(v string) *PutAlias
  • func (r *PutAlias) MasterTimeout(value string) *PutAlias
  • func (r *PutAlias) Name(v string) *PutAlias
  • func (r *PutAlias) Raw(raw json.RawMessage) *PutAlias
  • func (r *PutAlias) Request(req *Request) *PutAlias
  • func (r *PutAlias) Timeout(value string) *PutAlias
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) Filter(filter *types.QueryContainerBuilder) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) IndexRouting(indexrouting types.Routing) *RequestBuilder
  • func (rb *RequestBuilder) IsWriteIndex(iswriteindex bool) *RequestBuilder
  • func (rb *RequestBuilder) Routing(routing types.Routing) *RequestBuilder
  • func (rb *RequestBuilder) SearchRouting(searchrouting types.Routing) *RequestBuilder

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

Creates or updates an alias.

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

func (PutAlias) Do

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

Do runs the http.Request through the provided transport.

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

func (r *PutAlias) Index(v string) *PutAlias

Index A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. API Name: index

func (*PutAlias) MasterTimeout

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

MasterTimeout Specify timeout for connection to master API name: master_timeout

func (*PutAlias) Name

func (r *PutAlias) Name(v string) *PutAlias

Name The name of the alias to be created or updated API Name: name

func (*PutAlias) Raw

func (r *PutAlias) Raw(raw json.RawMessage) *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) Timeout

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

Timeout Explicit timestamp for the document API name: timeout

type Request

type Request struct {
	Filter *types.QueryContainer `json:"filter,omitempty"`

	IndexRouting *types.Routing `json:"index_routing,omitempty"`

	IsWriteIndex *bool `json:"is_write_index,omitempty"`

	Routing *types.Routing `json:"routing,omitempty"`

	SearchRouting *types.Routing `json:"search_routing,omitempty"`
}

Request holds the request body struct for the package putalias

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/indices/put_alias/IndicesPutAliasRequest.ts#L25-L46

type RequestBuilder

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

RequestBuilder is the builder API for the putalias.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

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

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) Filter

func (rb *RequestBuilder) Filter(filter *types.QueryContainerBuilder) *RequestBuilder

func (*RequestBuilder) FromJSON

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

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) IndexRouting

func (rb *RequestBuilder) IndexRouting(indexrouting types.Routing) *RequestBuilder

func (*RequestBuilder) IsWriteIndex

func (rb *RequestBuilder) IsWriteIndex(iswriteindex bool) *RequestBuilder

func (*RequestBuilder) Routing

func (rb *RequestBuilder) Routing(routing types.Routing) *RequestBuilder

func (*RequestBuilder) SearchRouting

func (rb *RequestBuilder) SearchRouting(searchrouting types.Routing) *RequestBuilder