shrink

Documentation

Overview

Allow to shrink an existing index into a new index with fewer primary shards.

Index

• Variables
• type NewShrink
  • func NewShrinkFunc(tp elastictransport.Interface) NewShrink
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type Shrink
  • func New(tp elastictransport.Interface) *Shrink
  • func (r *Shrink) Aliases(aliases map[string]types.Alias) *Shrink
  • func (r Shrink) Do(providedCtx context.Context) (*Response, error)
  • func (r *Shrink) Header(key, value string) *Shrink
  • func (r *Shrink) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Shrink) MasterTimeout(duration string) *Shrink
  • func (r Shrink) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Shrink) Raw(raw io.Reader) *Shrink
  • func (r *Shrink) Request(req *Request) *Shrink
  • func (r *Shrink) Settings(settings map[string]json.RawMessage) *Shrink
  • func (r *Shrink) Timeout(duration string) *Shrink
  • func (r *Shrink) WaitForActiveShards(waitforactiveshards string) *Shrink

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 NewShrink

type NewShrink func(index, target string) *Shrink

NewShrink type alias for index.

func NewShrinkFunc

func NewShrinkFunc(tp elastictransport.Interface) NewShrink

NewShrinkFunc returns a new instance of Shrink with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Request

type Request struct {

	// Aliases The key is the alias name.
	// Index alias names support date math.
	Aliases map[string]types.Alias `json:"aliases,omitempty"`
	// Settings Configuration options for the target index.
	Settings map[string]json.RawMessage `json:"settings,omitempty"`
}

Request holds the request body struct for the package shrink

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/indices/shrink/IndicesShrinkRequest.ts#L27-L75

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {
	Acknowledged       bool   `json:"acknowledged"`
	Index              string `json:"index"`
	ShardsAcknowledged bool   `json:"shards_acknowledged"`
}

Response holds the response body struct for the package shrink

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/indices/shrink/IndicesShrinkResponse.ts#L22-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type Shrink

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

func New

func New(tp elastictransport.Interface) *Shrink

Allow to shrink an existing index into a new index with fewer primary shards.

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

func (*Shrink) Aliases

func (r *Shrink) Aliases(aliases map[string]types.Alias) *Shrink

Aliases The key is the alias name. Index alias names support date math. API name: aliases

func (Shrink) Do

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

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

func (*Shrink) Header

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

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

func (*Shrink) HttpRequest

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

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

func (*Shrink) MasterTimeout

func (r *Shrink) MasterTimeout(duration string) *Shrink

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

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

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

func (*Shrink) Raw

func (r *Shrink) Raw(raw io.Reader) *Shrink

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*Shrink) Request

func (r *Shrink) Request(req *Request) *Shrink

Request allows to set the request property with the appropriate payload.

func (*Shrink) Settings

func (r *Shrink) Settings(settings map[string]json.RawMessage) *Shrink

Settings Configuration options for the target index. API name: settings

func (*Shrink) Timeout

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

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

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

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