close

Documentation

Overview

Closes an index.

Index

• Variables
• type Close
  • func New(tp elastictransport.Interface) *Close
  • func (r *Close) AllowNoIndices(allownoindices bool) *Close
  • func (r Close) Do(ctx context.Context) (*Response, error)
  • func (r *Close) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Close
  • func (r *Close) Header(key, value string) *Close
  • func (r *Close) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Close) IgnoreUnavailable(ignoreunavailable bool) *Close
  • func (r Close) IsSuccess(ctx context.Context) (bool, error)
  • func (r *Close) MasterTimeout(duration string) *Close
  • func (r Close) Perform(ctx context.Context) (*http.Response, error)
  • func (r *Close) Timeout(duration string) *Close
  • func (r *Close) WaitForActiveShards(waitforactiveshards string) *Close
• type NewClose
  • func NewCloseFunc(tp elastictransport.Interface) NewClose
• type Response
  • func NewResponse() *Response

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.

Types

type Close

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

func New

func New(tp elastictransport.Interface) *Close

Closes an index.

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

func (*Close) AllowNoIndices

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

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

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

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

func (*Close) ExpandWildcards

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

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 (*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(ignoreunavailable bool) *Close

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

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(duration string) *Close

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

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

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

func (*Close) Timeout

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

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 (*Close) WaitForActiveShards

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

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 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.

type Response

type Response struct {
	Acknowledged       bool                              `json:"acknowledged"`
	Indices            map[string]types.CloseIndexResult `json:"indices"`
	ShardsAcknowledged bool                              `json:"shards_acknowledged"`
}

Response holds the response body struct for the package close

https://github.com/elastic/elasticsearch-specification/blob/5fea44e006349579bf3561a82e997002e5716117/specification/indices/close/CloseIndexResponse.ts#L24-L30

func NewResponse

func NewResponse() *Response

NewResponse returns a Response