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(providedCtx context.Context) (Response, error)
  • func (r *GetFieldMapping) ErrorTrace(errortrace bool) *GetFieldMapping
  • func (r *GetFieldMapping) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *GetFieldMapping
  • func (r *GetFieldMapping) FilterPath(filterpaths ...string) *GetFieldMapping
  • func (r *GetFieldMapping) Header(key, value string) *GetFieldMapping
  • func (r *GetFieldMapping) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetFieldMapping) Human(human bool) *GetFieldMapping
  • 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(providedCtx context.Context) (bool, error)
  • func (r *GetFieldMapping) Local(local bool) *GetFieldMapping
  • func (r GetFieldMapping) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetFieldMapping) Pretty(pretty bool) *GetFieldMapping
• 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/current/indices-get-field-mapping.html

func (*GetFieldMapping) AllowNoIndices

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

AllowNoIndices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. API name: allow_no_indices

func (GetFieldMapping) Do

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

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

func (*GetFieldMapping) ErrorTrace

func (r *GetFieldMapping) ErrorTrace(errortrace bool) *GetFieldMapping

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*GetFieldMapping) ExpandWildcards

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

ExpandWildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. API name: expand_wildcards

func (*GetFieldMapping) FilterPath

func (r *GetFieldMapping) FilterPath(filterpaths ...string) *GetFieldMapping

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

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) Human

func (r *GetFieldMapping) Human(human bool) *GetFieldMapping

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 (*GetFieldMapping) IgnoreUnavailable

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

IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable

func (*GetFieldMapping) IncludeDefaults

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

IncludeDefaults If `true`, return all default settings in the response. API name: include_defaults

func (*GetFieldMapping) Index

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

Index Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. API Name: index

func (GetFieldMapping) IsSuccess

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

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

Local If `true`, the request retrieves information from the local node only. API name: local

func (GetFieldMapping) Perform

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

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

func (*GetFieldMapping) Pretty

func (r *GetFieldMapping) Pretty(pretty bool) *GetFieldMapping

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

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