Documentation
¶
Overview ¶
Creates or updates an alias.
Index ¶
- Variables
- type NewPutAlias
- type PutAlias
- func (r PutAlias) Do(providedCtx context.Context) (*Response, error)
- func (r *PutAlias) Filter(filter *types.Query) *PutAlias
- func (r *PutAlias) Header(key, value string) *PutAlias
- func (r *PutAlias) HttpRequest(ctx context.Context) (*http.Request, error)
- 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) 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
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type NewPutAlias ¶
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/current/indices-aliases.html
func (PutAlias) Do ¶
Do runs the request through the transport, handle the response and returns a putalias.Response
func (*PutAlias) Filter ¶ added in v8.9.0
Filter Query used to limit documents the alias can access. API name: filter
func (*PutAlias) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*PutAlias) IndexRouting ¶ added in v8.9.0
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 ¶ added in v8.9.0
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 ¶
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 ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*PutAlias) Raw ¶
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) Routing ¶ added in v8.9.0
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 ¶ added in v8.9.0
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
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
func (*Request) FromJSON ¶ added in v8.5.0
FromJSON allows to load an arbitrary json into the request structure
Source Files