addblock

Documentation

Overview

Add an index block. Limits the operations allowed on an index by blocking specific operation types.

Index

• Variables
• type AddBlock
  • func New(tp elastictransport.Interface) *AddBlock
  • func (r *AddBlock) AllowNoIndices(allownoindices bool) *AddBlock
  • func (r AddBlock) Do(providedCtx context.Context) (*Response, error)
  • func (r *AddBlock) ErrorTrace(errortrace bool) *AddBlock
  • func (r *AddBlock) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *AddBlock
  • func (r *AddBlock) FilterPath(filterpaths ...string) *AddBlock
  • func (r *AddBlock) Header(key, value string) *AddBlock
  • func (r *AddBlock) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *AddBlock) Human(human bool) *AddBlock
  • func (r *AddBlock) IgnoreUnavailable(ignoreunavailable bool) *AddBlock
  • func (r AddBlock) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *AddBlock) MasterTimeout(duration string) *AddBlock
  • func (r AddBlock) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *AddBlock) Pretty(pretty bool) *AddBlock
  • func (r *AddBlock) Timeout(duration string) *AddBlock
• type NewAddBlock
  • func NewAddBlockFunc(tp elastictransport.Interface) NewAddBlock
• 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 AddBlock

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

func New

func New(tp elastictransport.Interface) *AddBlock

Add an index block. Limits the operations allowed on an index by blocking specific operation types.

https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-blocks.html

func (*AddBlock) AllowNoIndices

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

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

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

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

func (*AddBlock) ErrorTrace

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

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

func (*AddBlock) ExpandWildcards

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

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

func (*AddBlock) FilterPath

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

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

func (*AddBlock) Header

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

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

func (*AddBlock) HttpRequest

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

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

func (*AddBlock) Human

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

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

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

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

func (AddBlock) IsSuccess

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

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

MasterTimeout Specify timeout for connection to master API name: master_timeout

func (AddBlock) Perform

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

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

func (*AddBlock) Pretty

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

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

func (*AddBlock) Timeout

func (r *AddBlock) Timeout(duration string) *AddBlock

Timeout Explicit operation timeout API name: timeout

type NewAddBlock

type NewAddBlock func(index, block string) *AddBlock

NewAddBlock type alias for index.

func NewAddBlockFunc

func NewAddBlockFunc(tp elastictransport.Interface) NewAddBlock

NewAddBlockFunc returns a new instance of AddBlock 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       bool                       `json:"acknowledged"`
	Indices            []types.IndicesBlockStatus `json:"indices"`
	ShardsAcknowledged bool                       `json:"shards_acknowledged"`
}

Response holds the response body struct for the package addblock

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/indices/add_block/IndicesAddBlockResponse.ts#L22-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response