Documentation ¶
Overview ¶
Allows you to split an existing index into a new index with more primary shards.
Index ¶
- Variables
- type NewSplit
- type Request
- type Response
- type Split
- func (r Split) Do(ctx context.Context) (*Response, error)
- func (r *Split) Header(key, value string) *Split
- func (r *Split) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Split) Index(v string) *Split
- func (r *Split) MasterTimeout(v string) *Split
- func (r Split) Perform(ctx context.Context) (*http.Response, error)
- func (r *Split) Raw(raw io.Reader) *Split
- func (r *Split) Request(req *Request) *Split
- func (r *Split) Target(v string) *Split
- func (r *Split) Timeout(v string) *Split
- func (r *Split) WaitForActiveShards(v string) *Split
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type NewSplit ¶
NewSplit type alias for index.
func NewSplitFunc ¶
func NewSplitFunc(tp elastictransport.Interface) NewSplit
NewSplitFunc returns a new instance of Split 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[string]types.Alias `json:"aliases,omitempty"` Settings map[string]json.RawMessage `json:"settings,omitempty"` }
Request holds the request body struct for the package split
type Response ¶ added in v8.7.0
type Split ¶
type Split struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Split
Allows you to split an existing index into a new index with more primary shards.
https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html
func (Split) Do ¶
Do runs the request through the transport, handle the response and returns a split.Response
func (*Split) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Split) MasterTimeout ¶
MasterTimeout Specify timeout for connection to master API name: master_timeout
func (Split) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Split) Raw ¶
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*Split) WaitForActiveShards ¶
WaitForActiveShards Set the number of active shards to wait for on the shrunken index before the operation returns. API name: wait_for_active_shards