unfreeze

Documentation

Overview

Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.

Index

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

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 NewUnfreeze

type NewUnfreeze func(index string) *Unfreeze

NewUnfreeze type alias for index.

func NewUnfreezeFunc

func NewUnfreezeFunc(tp elastictransport.Interface) NewUnfreeze

NewUnfreezeFunc returns a new instance of Unfreeze 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"`
	ShardsAcknowledged bool `json:"shards_acknowledged"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type Unfreeze

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

func New

func New(tp elastictransport.Interface) *Unfreeze

Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.

https://www.elastic.co/guide/en/elasticsearch/reference/current/unfreeze-index-api.html

func (*Unfreeze) AllowNoIndices

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

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

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

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

func (*Unfreeze) ExpandWildcards

func (r *Unfreeze) ExpandWildcards(v string) *Unfreeze

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

func (*Unfreeze) Header

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

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

func (*Unfreeze) HttpRequest

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

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

func (*Unfreeze) IgnoreUnavailable

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

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

func (*Unfreeze) Index

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

Index The name of the index to unfreeze API Name: index

func (Unfreeze) IsSuccess

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

func (r *Unfreeze) MasterTimeout(v string) *Unfreeze

MasterTimeout Specify timeout for connection to master API name: master_timeout

func (Unfreeze) Perform

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

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

func (*Unfreeze) Timeout

func (r *Unfreeze) Timeout(v string) *Unfreeze

Timeout Explicit operation timeout API name: timeout

func (*Unfreeze) WaitForActiveShards

func (r *Unfreeze) WaitForActiveShards(v string) *Unfreeze

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