Documentation
¶
Overview ¶
Opens an index.
Index ¶
- Variables
- type NewOpen
- type Open
- func (r *Open) AllowNoIndices(allownoindices bool) *Open
- func (r Open) Do(providedCtx context.Context) (*Response, error)
- func (r *Open) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Open
- func (r *Open) Header(key, value string) *Open
- func (r *Open) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Open) IgnoreUnavailable(ignoreunavailable bool) *Open
- func (r Open) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *Open) MasterTimeout(duration string) *Open
- func (r Open) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Open) Timeout(duration string) *Open
- func (r *Open) WaitForActiveShards(waitforactiveshards string) *Open
- 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 NewOpen ¶
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 ¶
func New(tp elastictransport.Interface) *Open
Opens an index.
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html
func (*Open) AllowNoIndices ¶
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 ¶
Do runs the request through the transport, handle the response and returns a open.Response
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) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Open) IgnoreUnavailable ¶
IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable
func (Open) 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 (*Open) MasterTimeout ¶
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
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Open) Timeout ¶
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 ¶
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
Source Files