delete

package

v8.13.1 Latest Latest Go to latest Published: Apr 11, 2024 License: Apache-2.0 Imports: 11 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/elastic/go-elasticsearch

Links

Open Source Insights

Documentation ¶

Overview ¶

Deletes a query ruleset.

Index ¶

Variables
type Delete
- func New(tp elastictransport.Interface) *Delete
type NewDelete
- func NewDeleteFunc(tp elastictransport.Interface) NewDelete
type Response
- func NewResponse() *Response

Constants ¶

This section is empty.

Variables ¶

View Source

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

Deletes a query ruleset.

https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-query-ruleset.html

func (Delete) Do ¶

func (r Delete) Do(providedCtx context.Context) (*Response, error)

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

func (r *Delete) Header(key, value string) *Delete

Header set a key, value pair in the Delete headers map.

func (*Delete) HttpRequest ¶

func (r *Delete) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (Delete) IsSuccess ¶

func (r Delete) IsSuccess(providedCtx 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 (Delete) Perform ¶

func (r Delete) Perform(providedCtx context.Context) (*http.Response, error)

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

type NewDelete ¶

type NewDelete func(rulesetid string) *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.

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

Response holds the response body struct for the package delete

https://github.com/elastic/elasticsearch-specification/blob/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/query_ruleset/delete/QueryRulesetDeleteResponse.ts#L22-L24

func NewResponse ¶

func NewResponse() *Response

NewResponse returns a Response

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL