Documentation ¶
Overview ¶
Changes the number of requests per second for a particular Delete By Query operation.
Index ¶
- Variables
- type DeleteByQueryRethrottle
- func (r DeleteByQueryRethrottle) Do(providedCtx context.Context) (*Response, error)
- func (r *DeleteByQueryRethrottle) Header(key, value string) *DeleteByQueryRethrottle
- func (r *DeleteByQueryRethrottle) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r DeleteByQueryRethrottle) IsSuccess(providedCtx context.Context) (bool, error)
- func (r DeleteByQueryRethrottle) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *DeleteByQueryRethrottle) RequestsPerSecond(requestspersecond string) *DeleteByQueryRethrottle
- type NewDeleteByQueryRethrottle
- 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 DeleteByQueryRethrottle ¶
type DeleteByQueryRethrottle struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *DeleteByQueryRethrottle
Changes the number of requests per second for a particular Delete By Query operation.
https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html
func (DeleteByQueryRethrottle) Do ¶
func (r DeleteByQueryRethrottle) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a deletebyqueryrethrottle.Response
func (*DeleteByQueryRethrottle) Header ¶
func (r *DeleteByQueryRethrottle) Header(key, value string) *DeleteByQueryRethrottle
Header set a key, value pair in the DeleteByQueryRethrottle headers map.
func (*DeleteByQueryRethrottle) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (DeleteByQueryRethrottle) IsSuccess ¶
func (r DeleteByQueryRethrottle) 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 (DeleteByQueryRethrottle) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeleteByQueryRethrottle) RequestsPerSecond ¶
func (r *DeleteByQueryRethrottle) RequestsPerSecond(requestspersecond string) *DeleteByQueryRethrottle
RequestsPerSecond The throttle for this request in sub-requests per second. API name: requests_per_second
type NewDeleteByQueryRethrottle ¶
type NewDeleteByQueryRethrottle func(taskid string) *DeleteByQueryRethrottle
NewDeleteByQueryRethrottle type alias for index.
func NewDeleteByQueryRethrottleFunc ¶
func NewDeleteByQueryRethrottleFunc(tp elastictransport.Interface) NewDeleteByQueryRethrottle
NewDeleteByQueryRethrottleFunc returns a new instance of DeleteByQueryRethrottle with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶ added in v8.7.0
type Response struct { NodeFailures []types.ErrorCause `json:"node_failures,omitempty"` // Nodes Task information grouped by node, if `group_by` was set to `node` (the // default). Nodes map[string]types.NodeTasks `json:"nodes,omitempty"` TaskFailures []types.TaskFailure `json:"task_failures,omitempty"` // Tasks Either a flat list of tasks if `group_by` was set to `none`, or grouped by // parents if // `group_by` was set to `parents`. Tasks types.TaskInfos `json:"tasks,omitempty"` }
Response holds the response body struct for the package deletebyqueryrethrottle