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) (*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(v string) *PutAlias
  • func (r *PutAlias) Name(v string) *PutAlias
  • func (r PutAlias) Perform(ctx context.Context) (*http.Response, error)
  • func (r *PutAlias) Raw(raw io.Reader) *PutAlias
  • func (r *PutAlias) Request(req *Request) *PutAlias
  • func (r *PutAlias) Timeout(v string) *PutAlias
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, 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

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) (*Response, error)

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

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

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

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

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

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

Timeout Explicit timestamp for the document API name: timeout

type Request

type Request struct {
	Filter        *types.Query `json:"filter,omitempty"`
	IndexRouting  *string      `json:"index_routing,omitempty"`
	IsWriteIndex  *bool        `json:"is_write_index,omitempty"`
	Routing       *string      `json:"routing,omitempty"`
	SearchRouting *string      `json:"search_routing,omitempty"`
}

Request holds the request body struct for the package putalias

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

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"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response