findfieldstructure

Documentation

Overview

Finds the structure of a text field in an index.

Index

• Variables
• type FindFieldStructure
  • func New(tp elastictransport.Interface) *FindFieldStructure
  • func (r FindFieldStructure) Do(ctx context.Context) (bool, error)
  • func (r *FindFieldStructure) Header(key, value string) *FindFieldStructure
  • func (r *FindFieldStructure) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r FindFieldStructure) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r FindFieldStructure) Perform(providedCtx context.Context) (*http.Response, error)
• type NewFindFieldStructure
  • func NewFindFieldStructureFunc(tp elastictransport.Interface) NewFindFieldStructure

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.

Types

type FindFieldStructure

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

func New

func New(tp elastictransport.Interface) *FindFieldStructure

Finds the structure of a text field in an index.

https://www.elastic.co/guide/en/elasticsearch/reference/current/find-field-structure.html

func (FindFieldStructure) Do

func (r FindFieldStructure) Do(ctx context.Context) (bool, error)

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

func (*FindFieldStructure) Header

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

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

func (*FindFieldStructure) HttpRequest

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

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

func (FindFieldStructure) IsSuccess

func (r FindFieldStructure) 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 (FindFieldStructure) Perform

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

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

type NewFindFieldStructure

type NewFindFieldStructure func() *FindFieldStructure

NewFindFieldStructure type alias for index.

func NewFindFieldStructureFunc

func NewFindFieldStructureFunc(tp elastictransport.Interface) NewFindFieldStructure

NewFindFieldStructureFunc returns a new instance of FindFieldStructure with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.