Documentation
¶
Overview ¶
Delete the license.
When the license expires, your subscription level reverts to Basic.
If the operator privileges feature is enabled, only operator users can use this API.
Index ¶
- Variables
- type Delete
- func (r Delete) Do(providedCtx context.Context) (*Response, error)
- func (r *Delete) ErrorTrace(errortrace bool) *Delete
- func (r *Delete) FilterPath(filterpaths ...string) *Delete
- func (r *Delete) Header(key, value string) *Delete
- func (r *Delete) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Delete) Human(human bool) *Delete
- func (r Delete) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *Delete) MasterTimeout(duration string) *Delete
- func (r Delete) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Delete) Pretty(pretty bool) *Delete
- func (r *Delete) Timeout(duration string) *Delete
- type NewDelete
- 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 Delete ¶
type Delete struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Delete
Delete the license.
When the license expires, your subscription level reverts to Basic.
If the operator privileges feature is enabled, only operator users can use this API.
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-delete
func (Delete) Do ¶
Do runs the request through the transport, handle the response and returns a delete.Response
func (*Delete) ErrorTrace ¶
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Delete) FilterPath ¶
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*Delete) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Delete) Human ¶
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human
func (Delete) IsSuccess ¶
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 (*Delete) MasterTimeout ¶
MasterTimeout The period to wait for a connection to the master node. API name: master_timeout
func (Delete) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
type NewDelete ¶
type NewDelete func() *Delete
NewDelete type alias for index.
func NewDeleteFunc ¶
func NewDeleteFunc(tp elastictransport.Interface) NewDelete
NewDeleteFunc returns a new instance of Delete with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files