addblock

package
v8.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 13, 2023 License: Apache-2.0 Imports: 14 Imported by: 4

Documentation

Overview

Adds a block to an index.

Index

Constants

This section is empty.

Variables

View Source
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.

Functions

This section is empty.

Types

type AddBlock

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

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

func (r *AddBlock) Block(block string) *AddBlock

Block The block to add (one of read, write, read_only or metadata) API Name: block

func (AddBlock) Do

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

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

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

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

Index A comma separated list of indices to add a block to API Name: index

func (AddBlock) IsSuccess

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

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

MasterTimeout Specify timeout for connection to master API name: master_timeout

func (AddBlock) Perform added in v8.7.0

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

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

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 added in v8.7.0

type Response struct {
	Acknowledged       bool                       `json:"acknowledged"`
	Indices            []types.IndicesBlockStatus `json:"indices"`
	ShardsAcknowledged bool                       `json:"shards_acknowledged"`
}

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL