Documentation
¶
Overview ¶
Remove an index block.
Remove an index block from an index. Index blocks limit the operations allowed on an index by blocking specific operation types.
Index ¶
- Variables
- type NewRemoveBlock
- type RemoveBlock
- func (r *RemoveBlock) AllowNoIndices(allownoindices bool) *RemoveBlock
- func (r RemoveBlock) Do(providedCtx context.Context) (*Response, error)
- func (r *RemoveBlock) ErrorTrace(errortrace bool) *RemoveBlock
- func (r *RemoveBlock) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *RemoveBlock
- func (r *RemoveBlock) FilterPath(filterpaths ...string) *RemoveBlock
- func (r *RemoveBlock) Header(key, value string) *RemoveBlock
- func (r *RemoveBlock) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *RemoveBlock) Human(human bool) *RemoveBlock
- func (r *RemoveBlock) IgnoreUnavailable(ignoreunavailable bool) *RemoveBlock
- func (r RemoveBlock) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *RemoveBlock) MasterTimeout(duration string) *RemoveBlock
- func (r RemoveBlock) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *RemoveBlock) Pretty(pretty bool) *RemoveBlock
- func (r *RemoveBlock) Timeout(duration string) *RemoveBlock
- 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 NewRemoveBlock ¶
type NewRemoveBlock func(index, block string) *RemoveBlock
NewRemoveBlock type alias for index.
func NewRemoveBlockFunc ¶
func NewRemoveBlockFunc(tp elastictransport.Interface) NewRemoveBlock
NewRemoveBlockFunc returns a new instance of RemoveBlock with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type RemoveBlock ¶
type RemoveBlock struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *RemoveBlock
Remove an index block.
Remove an index block from an index. Index blocks limit the operations allowed on an index by blocking specific operation types.
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-remove-block
func (*RemoveBlock) AllowNoIndices ¶
func (r *RemoveBlock) AllowNoIndices(allownoindices bool) *RemoveBlock
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. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. API name: allow_no_indices
func (RemoveBlock) Do ¶
func (r RemoveBlock) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a removeblock.Response
func (*RemoveBlock) ErrorTrace ¶
func (r *RemoveBlock) ErrorTrace(errortrace bool) *RemoveBlock
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*RemoveBlock) ExpandWildcards ¶
func (r *RemoveBlock) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *RemoveBlock
ExpandWildcards The 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. It supports comma-separated values, such as `open,hidden`. API name: expand_wildcards
func (*RemoveBlock) FilterPath ¶
func (r *RemoveBlock) FilterPath(filterpaths ...string) *RemoveBlock
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*RemoveBlock) Header ¶
func (r *RemoveBlock) Header(key, value string) *RemoveBlock
Header set a key, value pair in the RemoveBlock headers map.
func (*RemoveBlock) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*RemoveBlock) Human ¶
func (r *RemoveBlock) Human(human bool) *RemoveBlock
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_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 (*RemoveBlock) IgnoreUnavailable ¶
func (r *RemoveBlock) IgnoreUnavailable(ignoreunavailable bool) *RemoveBlock
IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable
func (RemoveBlock) IsSuccess ¶
func (r RemoveBlock) 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 (*RemoveBlock) MasterTimeout ¶
func (r *RemoveBlock) MasterTimeout(duration string) *RemoveBlock
MasterTimeout The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. API name: master_timeout
func (RemoveBlock) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*RemoveBlock) Pretty ¶
func (r *RemoveBlock) Pretty(pretty bool) *RemoveBlock
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*RemoveBlock) Timeout ¶
func (r *RemoveBlock) Timeout(duration string) *RemoveBlock
Timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. It can also be set to `-1` to indicate that the request should never timeout. API name: timeout
type Response ¶
type Response struct {
Acknowledged bool `json:"acknowledged"`
Indices []types.RemoveIndicesBlockStatus `json:"indices"`
}
Response holds the response body struct for the package removeblock
Source Files