close

Documentation

Overview

Closes an index.

Index

• Variables
• type Close
  • func New(tp elastictransport.Interface) *Close
  • func (r *Close) AllowNoIndices(b bool) *Close
  • func (r Close) Do(ctx context.Context) (*Response, error)
  • func (r *Close) ExpandWildcards(v string) *Close
  • func (r *Close) Header(key, value string) *Close
  • func (r *Close) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Close) IgnoreUnavailable(b bool) *Close
  • func (r *Close) Index(v string) *Close
  • func (r Close) IsSuccess(ctx context.Context) (bool, error)
  • func (r *Close) MasterTimeout(v string) *Close
  • func (r Close) Perform(ctx context.Context) (*http.Response, error)
  • func (r *Close) Timeout(v string) *Close
  • func (r *Close) WaitForActiveShards(v 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/master/indices-open-close.html

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) (*Response, error)

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

func (*Close) ExpandWildcards

func (r *Close) ExpandWildcards(v 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(v string) *Close

MasterTimeout Specify timeout for connection to master 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(v string) *Close

Timeout Explicit operation timeout API name: timeout

func (*Close) WaitForActiveShards

func (r *Close) WaitForActiveShards(v 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.

type Response

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response