getmapping

Documentation

Overview

Returns mappings for one or more indices.

Index

• Variables
• type GetMapping
  • func New(tp elastictransport.Interface) *GetMapping
  • func (r *GetMapping) AllowNoIndices(allownoindices bool) *GetMapping
  • func (r GetMapping) Do(ctx context.Context) (Response, error)
  • func (r *GetMapping) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *GetMapping
  • func (r *GetMapping) Header(key, value string) *GetMapping
  • func (r *GetMapping) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetMapping) IgnoreUnavailable(ignoreunavailable bool) *GetMapping
  • func (r *GetMapping) Index(index string) *GetMapping
  • func (r GetMapping) IsSuccess(ctx context.Context) (bool, error)
  • func (r *GetMapping) Local(local bool) *GetMapping
  • func (r *GetMapping) MasterTimeout(duration string) *GetMapping
  • func (r GetMapping) Perform(ctx context.Context) (*http.Response, error)
• type NewGetMapping
  • func NewGetMappingFunc(tp elastictransport.Interface) NewGetMapping
• 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 GetMapping

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

func New

func New(tp elastictransport.Interface) *GetMapping

Returns mappings for one or more indices.

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

func (*GetMapping) AllowNoIndices

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

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 (GetMapping) Do

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

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

func (*GetMapping) ExpandWildcards

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

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 (*GetMapping) Header

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

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

func (*GetMapping) HttpRequest

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

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

func (*GetMapping) IgnoreUnavailable

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

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

func (*GetMapping) Index

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

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 (GetMapping) IsSuccess

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

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

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

func (*GetMapping) MasterTimeout

func (r *GetMapping) MasterTimeout(duration string) *GetMapping

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 (GetMapping) Perform

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

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

type NewGetMapping

type NewGetMapping func() *GetMapping

NewGetMapping type alias for index.

func NewGetMappingFunc

func NewGetMappingFunc(tp elastictransport.Interface) NewGetMapping

NewGetMappingFunc returns a new instance of GetMapping 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.IndexMappingRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response