Documentation
¶
Overview ¶
Changes the number of requests per second for a particular Reindex operation.
Index ¶
- Variables
- type NewReindexRethrottle
- type ReindexRethrottle
- func (r ReindexRethrottle) Do(providedCtx context.Context) (*Response, error)
- func (r *ReindexRethrottle) Header(key, value string) *ReindexRethrottle
- func (r *ReindexRethrottle) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r ReindexRethrottle) IsSuccess(providedCtx context.Context) (bool, error)
- func (r ReindexRethrottle) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *ReindexRethrottle) RequestsPerSecond(requestspersecond string) *ReindexRethrottle
- type Response
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 NewReindexRethrottle ¶
type NewReindexRethrottle func(taskid string) *ReindexRethrottle
NewReindexRethrottle type alias for index.
func NewReindexRethrottleFunc ¶
func NewReindexRethrottleFunc(tp elastictransport.Interface) NewReindexRethrottle
NewReindexRethrottleFunc returns a new instance of ReindexRethrottle with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type ReindexRethrottle ¶
type ReindexRethrottle struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *ReindexRethrottle
Changes the number of requests per second for a particular Reindex operation.
https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
func (ReindexRethrottle) Do ¶
func (r ReindexRethrottle) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a reindexrethrottle.Response
func (*ReindexRethrottle) Header ¶
func (r *ReindexRethrottle) Header(key, value string) *ReindexRethrottle
Header set a key, value pair in the ReindexRethrottle headers map.
func (*ReindexRethrottle) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (ReindexRethrottle) IsSuccess ¶
func (r ReindexRethrottle) 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 (ReindexRethrottle) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*ReindexRethrottle) RequestsPerSecond ¶
func (r *ReindexRethrottle) RequestsPerSecond(requestspersecond string) *ReindexRethrottle
RequestsPerSecond The throttle for this request in sub-requests per second. API name: requests_per_second
type Response ¶ added in v8.7.0
type Response struct {
Nodes map[string]types.ReindexNode `json:"nodes"`
}
Response holds the response body struct for the package reindexrethrottle
Source Files