deleteindextemplate

package
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 19, 2023 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Deletes an index template.

Index

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 DeleteIndexTemplate

type DeleteIndexTemplate struct {
	// contains filtered or unexported fields
}

func (DeleteIndexTemplate) Do

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

func (*DeleteIndexTemplate) Header

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

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

func (*DeleteIndexTemplate) HttpRequest

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

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

func (DeleteIndexTemplate) IsSuccess

func (r DeleteIndexTemplate) 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 (*DeleteIndexTemplate) MasterTimeout

func (r *DeleteIndexTemplate) MasterTimeout(v string) *DeleteIndexTemplate

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 (*DeleteIndexTemplate) Name

Name Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. API Name: name

func (DeleteIndexTemplate) Perform

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

func (*DeleteIndexTemplate) Timeout

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 NewDeleteIndexTemplate

type NewDeleteIndexTemplate func(name string) *DeleteIndexTemplate

NewDeleteIndexTemplate type alias for index.

func NewDeleteIndexTemplateFunc

func NewDeleteIndexTemplateFunc(tp elastictransport.Interface) NewDeleteIndexTemplate

NewDeleteIndexTemplateFunc returns a new instance of DeleteIndexTemplate 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"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

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