open

package
v8.17.0 Latest Latest
Warning

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

Go to latest
Published: Dec 17, 2024 License: Apache-2.0 Imports: 12 Imported by: 4

Documentation

Overview

Opens a closed index. For data streams, the API opens any closed backing indices.

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 NewOpen

type NewOpen func(index string) *Open

NewOpen type alias for index.

func NewOpenFunc

func NewOpenFunc(tp elastictransport.Interface) NewOpen

NewOpenFunc returns a new instance of Open with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Open

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

func New

Opens a closed index. For data streams, the API opens any closed backing indices.

https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html

func (*Open) AllowNoIndices

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

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

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

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

func (*Open) ErrorTrace added in v8.14.0

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

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

func (*Open) ExpandWildcards

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

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 (*Open) FilterPath added in v8.14.0

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

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

func (*Open) Header

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

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

func (*Open) HttpRequest

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

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

func (*Open) Human added in v8.14.0

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

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

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

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

func (Open) IsSuccess

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

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

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 (Open) Perform added in v8.7.0

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

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

func (*Open) Pretty added in v8.14.0

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

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

func (*Open) Timeout

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

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

func (*Open) WaitForActiveShards

func (r *Open) WaitForActiveShards(waitforactiveshards string) *Open

WaitForActiveShards The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). API name: wait_for_active_shards

type Response added in v8.7.0

type Response struct {
	Acknowledged       bool `json:"acknowledged"`
	ShardsAcknowledged bool `json:"shards_acknowledged"`
}

Response holds the response body struct for the package open

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/indices/open/IndicesOpenResponse.ts#L20-L25

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