getfieldmapping

Documentation

Overview

Returns mapping for one or more fields.

Index

• Variables
• type GetFieldMapping
  • func New(tp elastictransport.Interface) *GetFieldMapping
  • func (r *GetFieldMapping) AllowNoIndices(allownoindices bool) *GetFieldMapping
  • func (r GetFieldMapping) Do(ctx context.Context) (Response, error)
  • func (r *GetFieldMapping) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *GetFieldMapping
  • func (r *GetFieldMapping) Fields(fields string) *GetFieldMapping
  • func (r *GetFieldMapping) Header(key, value string) *GetFieldMapping
  • func (r *GetFieldMapping) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetFieldMapping) IgnoreUnavailable(ignoreunavailable bool) *GetFieldMapping
  • func (r *GetFieldMapping) IncludeDefaults(includedefaults bool) *GetFieldMapping
  • func (r *GetFieldMapping) Index(index string) *GetFieldMapping
  • func (r GetFieldMapping) IsSuccess(ctx context.Context) (bool, error)
  • func (r *GetFieldMapping) Local(local bool) *GetFieldMapping
  • func (r GetFieldMapping) Perform(ctx context.Context) (*http.Response, error)
• type NewGetFieldMapping
  • func NewGetFieldMappingFunc(tp elastictransport.Interface) NewGetFieldMapping
• type Response
  • func NewResponse() Response

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 GetFieldMapping

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

func New

func New(tp elastictransport.Interface) *GetFieldMapping

Returns mapping for one or more fields.

https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html

func (*GetFieldMapping) AllowNoIndices

func (r *GetFieldMapping) AllowNoIndices(allownoindices bool) *GetFieldMapping

AllowNoIndices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) API name: allow_no_indices

func (GetFieldMapping) Do

func (r GetFieldMapping) Do(ctx context.Context) (Response, error)

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

func (*GetFieldMapping) ExpandWildcards

func (r *GetFieldMapping) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *GetFieldMapping

ExpandWildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. API name: expand_wildcards

func (*GetFieldMapping) Fields

func (r *GetFieldMapping) Fields(fields string) *GetFieldMapping

Fields A comma-separated list of fields API Name: fields

func (*GetFieldMapping) Header

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

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

func (*GetFieldMapping) HttpRequest

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

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

func (*GetFieldMapping) IgnoreUnavailable

func (r *GetFieldMapping) IgnoreUnavailable(ignoreunavailable bool) *GetFieldMapping

IgnoreUnavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) API name: ignore_unavailable

func (*GetFieldMapping) IncludeDefaults

func (r *GetFieldMapping) IncludeDefaults(includedefaults bool) *GetFieldMapping

IncludeDefaults Whether the default mapping values should be returned as well API name: include_defaults

func (*GetFieldMapping) Index

func (r *GetFieldMapping) Index(index string) *GetFieldMapping

Index A comma-separated list of index names API Name: index

func (GetFieldMapping) IsSuccess

func (r GetFieldMapping) 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 (*GetFieldMapping) Local

func (r *GetFieldMapping) Local(local bool) *GetFieldMapping

Local Return local information, do not retrieve the state from master node (default: false) API name: local

func (GetFieldMapping) Perform

func (r GetFieldMapping) Perform(ctx context.Context) (*http.Response, error)

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

type NewGetFieldMapping

type NewGetFieldMapping func(fields string) *GetFieldMapping

NewGetFieldMapping type alias for index.

func NewGetFieldMappingFunc

func NewGetFieldMappingFunc(tp elastictransport.Interface) NewGetFieldMapping

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

type Response

type Response map[string]types.TypeFieldMappings

func NewResponse

func NewResponse() Response

NewResponse returns a Response