open

Documentation

Overview

Opens an index.

Index

• Variables
• type NewOpen
  • func NewOpenFunc(tp elastictransport.Interface) NewOpen
• type Open
  • func New(tp elastictransport.Interface) *Open
  • func (r *Open) AllowNoIndices(b bool) *Open
  • func (r Open) Do(ctx context.Context) (*http.Response, error)
  • func (r *Open) ExpandWildcards(value string) *Open
  • func (r *Open) Header(key, value string) *Open
  • func (r *Open) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Open) IgnoreUnavailable(b bool) *Open
  • func (r *Open) Index(v string) *Open
  • func (r Open) IsSuccess(ctx context.Context) (bool, error)
  • func (r *Open) MasterTimeout(value string) *Open
  • func (r *Open) Timeout(value string) *Open
  • func (r *Open) WaitForActiveShards(value string) *Open

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

func New(tp elastictransport.Interface) *Open

Opens an index.

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

func (*Open) AllowNoIndices

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

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

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

Do runs the http.Request through the provided transport.

func (*Open) ExpandWildcards

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

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

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) IgnoreUnavailable

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

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

func (*Open) Index

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

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

func (Open) IsSuccess

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

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

MasterTimeout Specify timeout for connection to master API name: master_timeout

func (*Open) Timeout

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

Timeout Explicit operation timeout API name: timeout

func (*Open) WaitForActiveShards

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

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