close

package
v8.6.0 Latest Latest
Warning

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

Go to latest
Published: Jan 11, 2023 License: Apache-2.0 Imports: 11 Imported by: 4

Documentation

Overview

Closes 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 Close

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

func (*Close) AllowNoIndices

func (r *Close) AllowNoIndices(b bool) *Close

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

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

Do runs the http.Request through the provided transport.

func (*Close) ExpandWildcards

func (r *Close) ExpandWildcards(value string) *Close

ExpandWildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. API name: expand_wildcards

func (*Close) Header

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

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

func (*Close) HttpRequest

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

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

func (*Close) IgnoreUnavailable

func (r *Close) IgnoreUnavailable(b bool) *Close

IgnoreUnavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) API name: ignore_unavailable

func (*Close) Index

func (r *Close) Index(v string) *Close

Index A comma separated list of indices to close API Name: index

func (Close) IsSuccess

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

func (r *Close) MasterTimeout(value string) *Close

MasterTimeout Specify timeout for connection to master API name: master_timeout

func (*Close) Timeout

func (r *Close) Timeout(value string) *Close

Timeout Explicit operation timeout API name: timeout

func (*Close) WaitForActiveShards

func (r *Close) WaitForActiveShards(value string) *Close

WaitForActiveShards Sets the number of active shards to wait for before the operation returns. API name: wait_for_active_shards

type NewClose

type NewClose func(index string) *Close

NewClose type alias for index.

func NewCloseFunc

func NewCloseFunc(tp elastictransport.Interface) NewClose

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

Jump to

Keyboard shortcuts

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