Documentation
¶
Overview ¶
Updates index aliases.
Index ¶
- Variables
- type NewUpdateAliases
- type Request
- type Response
- type UpdateAliases
- func (r *UpdateAliases) Actions(actions ...types.IndicesAction) *UpdateAliases
- func (r UpdateAliases) Do(providedCtx context.Context) (*Response, error)
- func (r *UpdateAliases) Header(key, value string) *UpdateAliases
- func (r *UpdateAliases) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *UpdateAliases) MasterTimeout(duration string) *UpdateAliases
- func (r UpdateAliases) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *UpdateAliases) Raw(raw io.Reader) *UpdateAliases
- func (r *UpdateAliases) Request(req *Request) *UpdateAliases
- func (r *UpdateAliases) Timeout(duration string) *UpdateAliases
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 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
type Response ¶ added in v8.7.0
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
type UpdateAliases ¶
type UpdateAliases struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *UpdateAliases
Updates index aliases.
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
func (*UpdateAliases) Actions ¶ added in v8.9.0
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) Header ¶
func (r *UpdateAliases) Header(key, value string) *UpdateAliases
Header set a key, value pair in the UpdateAliases headers map.
func (*UpdateAliases) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
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 ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
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
Source Files