unfreeze

Documentation

Overview

Unfreezes an index.

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(allownoindices bool) *Unfreeze
  • func (r Unfreeze) Do(providedCtx context.Context) (*Response, error)
  • func (r *Unfreeze) ErrorTrace(errortrace bool) *Unfreeze
  • func (r *Unfreeze) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Unfreeze
  • func (r *Unfreeze) FilterPath(filterpaths ...string) *Unfreeze
  • func (r *Unfreeze) Header(key, value string) *Unfreeze
  • func (r *Unfreeze) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Unfreeze) Human(human bool) *Unfreeze
  • func (r *Unfreeze) IgnoreUnavailable(ignoreunavailable bool) *Unfreeze
  • func (r Unfreeze) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *Unfreeze) MasterTimeout(duration string) *Unfreeze
  • func (r Unfreeze) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Unfreeze) Pretty(pretty bool) *Unfreeze
  • func (r *Unfreeze) Timeout(duration string) *Unfreeze
  • func (r *Unfreeze) WaitForActiveShards(waitforactiveshards 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"`
}

Response holds the response body struct for the package unfreeze

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/indices/unfreeze/IndicesUnfreezeResponse.ts#L20-L25

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.

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

func (*Unfreeze) AllowNoIndices

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

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

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

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

func (*Unfreeze) ErrorTrace

func (r *Unfreeze) ErrorTrace(errortrace bool) *Unfreeze

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*Unfreeze) ExpandWildcards

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

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 (*Unfreeze) FilterPath

func (r *Unfreeze) FilterPath(filterpaths ...string) *Unfreeze

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

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

func (r *Unfreeze) Human(human bool) *Unfreeze

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (*Unfreeze) IgnoreUnavailable

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

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

func (Unfreeze) IsSuccess

func (r Unfreeze) IsSuccess(providedCtx 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(duration string) *Unfreeze

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

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

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

func (*Unfreeze) Pretty

func (r *Unfreeze) Pretty(pretty bool) *Unfreeze

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*Unfreeze) Timeout

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

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

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

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