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
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Aliases(values map[types.IndexName]*types.AliasBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Settings(value map[string]interface{}) *RequestBuilder
• type Shrink
  • func New(tp elastictransport.Interface) *Shrink
  • func (r Shrink) Do(ctx context.Context) (*http.Response, error)
  • func (r *Shrink) Header(key, value string) *Shrink
  • func (r *Shrink) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Shrink) Index(v string) *Shrink
  • func (r *Shrink) MasterTimeout(value string) *Shrink
  • func (r *Shrink) Raw(raw json.RawMessage) *Shrink
  • func (r *Shrink) Request(req *Request) *Shrink
  • func (r *Shrink) Target(v string) *Shrink
  • func (r *Shrink) Timeout(value string) *Shrink
  • func (r *Shrink) WaitForActiveShards(value 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 map[types.IndexName]types.Alias `json:"aliases,omitempty"`

	Settings map[string]interface{} `json:"settings,omitempty"`
}

Request holds the request body struct for the package shrink

https://github.com/elastic/elasticsearch-specification/blob/1b56d7e58f5c59f05d1641c6d6a8117c5e01d741/specification/indices/shrink/IndicesShrinkRequest.ts#L27-L46

type RequestBuilder

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

RequestBuilder is the builder API for the shrink.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Aliases

func (rb *RequestBuilder) Aliases(values map[types.IndexName]*types.AliasBuilder) *RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Settings

func (rb *RequestBuilder) Settings(value map[string]interface{}) *RequestBuilder

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/master/indices-shrink-index.html

func (Shrink) Do

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

Do runs the http.Request through the provided transport.

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

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

Index The name of the source index to shrink API Name: index

func (*Shrink) MasterTimeout

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

MasterTimeout Specify timeout for connection to master API name: master_timeout

func (*Shrink) Raw

func (r *Shrink) Raw(raw json.RawMessage) *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) Target

func (r *Shrink) Target(v string) *Shrink

Target The name of the target index to shrink into API Name: target

func (*Shrink) Timeout

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

Timeout Explicit operation timeout API name: timeout

func (*Shrink) WaitForActiveShards

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

WaitForActiveShards Set the number of active shards to wait for on the shrunken index before the operation returns. API name: wait_for_active_shards