Documentation ¶
Overview ¶
Deletes an alias.
Index ¶
- Variables
- type DeleteAlias
- func (r DeleteAlias) Do(ctx context.Context) (*Response, error)
- func (r *DeleteAlias) Header(key, value string) *DeleteAlias
- func (r *DeleteAlias) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r DeleteAlias) IsSuccess(ctx context.Context) (bool, error)
- func (r *DeleteAlias) MasterTimeout(duration string) *DeleteAlias
- func (r DeleteAlias) Perform(ctx context.Context) (*http.Response, error)
- func (r *DeleteAlias) Timeout(duration string) *DeleteAlias
- type NewDeleteAlias
- 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 DeleteAlias ¶
type DeleteAlias struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *DeleteAlias
Deletes an alias.
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
func (DeleteAlias) Do ¶
func (r DeleteAlias) Do(ctx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a deletealias.Response
func (*DeleteAlias) Header ¶
func (r *DeleteAlias) Header(key, value string) *DeleteAlias
Header set a key, value pair in the DeleteAlias headers map.
func (*DeleteAlias) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (DeleteAlias) IsSuccess ¶
func (r DeleteAlias) IsSuccess(ctx context.Context) (bool, error)
IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.
func (*DeleteAlias) MasterTimeout ¶
func (r *DeleteAlias) MasterTimeout(duration string) *DeleteAlias
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 (DeleteAlias) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeleteAlias) Timeout ¶
func (r *DeleteAlias) Timeout(duration string) *DeleteAlias
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 NewDeleteAlias ¶
type NewDeleteAlias func(index, name string) *DeleteAlias
NewDeleteAlias type alias for index.
func NewDeleteAliasFunc ¶
func NewDeleteAliasFunc(tp elastictransport.Interface) NewDeleteAlias
NewDeleteAliasFunc returns a new instance of DeleteAlias with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.