Documentation
¶
Overview ¶
Adds a block to an index.
Index ¶
- Variables
- type AddBlock
- func (r *AddBlock) AllowNoIndices(allownoindices bool) *AddBlock
- func (r AddBlock) Do(providedCtx context.Context) (*Response, error)
- func (r *AddBlock) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *AddBlock
- func (r *AddBlock) Header(key, value string) *AddBlock
- func (r *AddBlock) HttpRequest(ctx context.Context) (*http.Request, error)
- 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) Timeout(duration string) *AddBlock
- type NewAddBlock
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type AddBlock ¶
type AddBlock struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *AddBlock
Adds a block to an index.
https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-blocks.html
func (*AddBlock) AllowNoIndices ¶
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 ¶
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) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*AddBlock) IgnoreUnavailable ¶
IgnoreUnavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) API name: ignore_unavailable
func (AddBlock) IsSuccess ¶
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 ¶
MasterTimeout Specify timeout for connection to master API name: master_timeout
type NewAddBlock ¶
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.
Source Files