Documentation
¶
Overview ¶
Allow to shrink an existing index into a new index with fewer primary shards.
Index ¶
- Variables
- type NewShrink
- type Request
- type Response
- type 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
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 NewShrink ¶
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
type Response ¶ added in v8.7.0
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
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 ¶ added in v8.9.0
Aliases The key is the alias name. Index alias names support date math. API name: aliases
func (Shrink) Do ¶
Do runs the request through the transport, handle the response and returns a shrink.Response
func (*Shrink) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Shrink) MasterTimeout ¶
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 ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Shrink) 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 (*Shrink) Settings ¶ added in v8.9.0
func (r *Shrink) Settings(settings map[string]json.RawMessage) *Shrink
Settings Configuration options for the target index. API name: settings
func (*Shrink) Timeout ¶
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 ¶
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
Source Files