import "github.com/elastic/go-elasticsearch/esapi"
Package esapi provides the Go API for Elasticsearch.
It is automatically included in the client provided by the github.com/elastic/go-elasticsearch package:
es, _ := elasticsearch.NewDefaultClient() res, _ := es.Info() log.Println(res)
For each Elasticsearch API, such as "Index", the package exports two corresponding types: a function and a struct.
The function type allows you to call the Elasticsearch API as a method on the client, passing the parameters as arguments:
res, err := es.Index(
"test", // Index name
strings.NewReader(`{"title" : "Test"}`), // Document body
es.Index.WithDocumentID("1"), // Document ID
es.Index.WithRefresh("true"), // Refresh
)
if err != nil {
log.Fatalf("ERROR: %s", err)
}
defer res.Body.Close()
log.Println(res)
// => [201 Created] {"_index":"test","_type":"_doc","_id":"1" ...
The struct type allows for a more hands-on approach, where you create a new struct, with the request configuration as fields, and call the Do() method with a context and the client as arguments:
req := esapi.IndexRequest{
Index: "test", // Index name
Body: strings.NewReader(`{"title" : "Test"}`), // Document body
DocumentID: "1", // Document ID
Refresh: "true", // Refresh
}
res, err := req.Do(context.Background(), es)
if err != nil {
log.Fatalf("Error getting response: %s", err)
}
defer res.Body.Close()
log.Println(res)
// => [200 OK] {"_index":"test","_type":"_doc","_id":"1","_version":2 ...
The function type is a wrapper around the struct, and allows to configure and perform the request in a more expressive way. It has a minor overhead compared to using a struct directly; refer to the esapi_benchmark_test.go suite for concrete numbers.
See the documentation for each API function or struct at https://godoc.org/github.com/elastic/go-elasticsearch, or locally by:
go doc github.com/elastic/go-elasticsearch/v8/esapi Index go doc github.com/elastic/go-elasticsearch/v8/esapi IndexRequest
The esapi.Response type is a lightweight wrapper around http.Response.
The res.Body field is an io.ReadCloser, leaving the JSON parsing to the calling code, in the interest of performance and flexibility (eg. to allow using a custom JSON parser).
It is imperative to close the response body for a non-nil response.
The Response type implements a couple of convenience methods for accessing the status, checking an error status code or printing the response body for debugging purposes.
See the Elasticsearch documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/api-conventions.html for detailed information about the API endpoints and parameters.
The Go API is generated from the Elasticsearch JSON specification at https://github.com/elastic/elasticsearch/tree/master/rest-api-spec/src/main/resources/rest-api-spec/api by the internal package available at https://github.com/elastic/go-elasticsearch/tree/master/internal/cmd/generate/commands.
The API is tested by integration tests common to all Elasticsearch official clients, generated from the source at https://github.com/elastic/elasticsearch/tree/master/rest-api-spec/src/main/resources/rest-api-spec/test. The generator is provided by the internal package internal/cmd/generate.
api._.go api.bulk.go api.cat.aliases.go api.cat.allocation.go api.cat.count.go api.cat.fielddata.go api.cat.health.go api.cat.help.go api.cat.indices.go api.cat.master.go api.cat.nodeattrs.go api.cat.nodes.go api.cat.pending_tasks.go api.cat.plugins.go api.cat.recovery.go api.cat.repositories.go api.cat.segments.go api.cat.shards.go api.cat.snapshots.go api.cat.tasks.go api.cat.templates.go api.cat.thread_pool.go api.clear_scroll.go api.cluster.allocation_explain.go api.cluster.get_settings.go api.cluster.health.go api.cluster.pending_tasks.go api.cluster.put_settings.go api.cluster.remote_info.go api.cluster.reroute.go api.cluster.state.go api.cluster.stats.go api.count.go api.create.go api.delete.go api.delete_by_query.go api.delete_by_query_rethrottle.go api.delete_script.go api.exists.go api.exists_source.go api.explain.go api.field_caps.go api.get.go api.get_script.go api.get_source.go api.index.go api.indices.analyze.go api.indices.clear_cache.go api.indices.clone.go api.indices.close.go api.indices.create.go api.indices.delete.go api.indices.delete_alias.go api.indices.delete_template.go api.indices.exists.go api.indices.exists_alias.go api.indices.exists_template.go api.indices.exists_type.go api.indices.flush.go api.indices.flush_synced.go api.indices.forcemerge.go api.indices.get.go api.indices.get_alias.go api.indices.get_field_mapping.go api.indices.get_mapping.go api.indices.get_settings.go api.indices.get_template.go api.indices.get_upgrade.go api.indices.open.go api.indices.put_alias.go api.indices.put_mapping.go api.indices.put_settings.go api.indices.put_template.go api.indices.recovery.go api.indices.refresh.go api.indices.rollover.go api.indices.segments.go api.indices.shard_stores.go api.indices.shrink.go api.indices.split.go api.indices.stats.go api.indices.update_aliases.go api.indices.upgrade.go api.indices.validate_query.go api.info.go api.ingest.delete_pipeline.go api.ingest.get_pipeline.go api.ingest.processor_grok.go api.ingest.put_pipeline.go api.ingest.simulate.go api.mget.go api.msearch.go api.msearch_template.go api.mtermvectors.go api.nodes.hot_threads.go api.nodes.info.go api.nodes.reload_secure_settings.go api.nodes.stats.go api.nodes.usage.go api.ping.go api.put_script.go api.rank_eval.go api.reindex.go api.reindex_rethrottle.go api.render_search_template.go api.scripts_painless_context.go api.scripts_painless_execute.go api.scroll.go api.search.go api.search_shards.go api.search_template.go api.snapshot.create.go api.snapshot.create_repository.go api.snapshot.delete.go api.snapshot.delete_repository.go api.snapshot.get.go api.snapshot.get_repository.go api.snapshot.restore.go api.snapshot.status.go api.snapshot.verify_repository.go api.tasks.cancel.go api.tasks.get.go api.tasks.list.go api.termvectors.go api.update.go api.update_by_query.go api.update_by_query_rethrottle.go api.xpack.ccr.delete_auto_follow_pattern.go api.xpack.ccr.follow.go api.xpack.ccr.follow_info.go api.xpack.ccr.follow_stats.go api.xpack.ccr.forget_follower.go api.xpack.ccr.get_auto_follow_pattern.go api.xpack.ccr.pause_follow.go api.xpack.ccr.put_auto_follow_pattern.go api.xpack.ccr.resume_follow.go api.xpack.ccr.stats.go api.xpack.ccr.unfollow.go api.xpack.data_frame.delete_data_frame_transform.go api.xpack.data_frame.get_data_frame_transform.go api.xpack.data_frame.get_data_frame_transform_stats.go api.xpack.data_frame.preview_data_frame_transform.go api.xpack.data_frame.put_data_frame_transform.go api.xpack.data_frame.start_data_frame_transform.go api.xpack.data_frame.stop_data_frame_transform.go api.xpack.graph.explore.go api.xpack.ilm.delete_lifecycle.go api.xpack.ilm.explain_lifecycle.go api.xpack.ilm.get_lifecycle.go api.xpack.ilm.get_status.go api.xpack.ilm.move_to_step.go api.xpack.ilm.put_lifecycle.go api.xpack.ilm.remove_policy.go api.xpack.ilm.retry.go api.xpack.ilm.start.go api.xpack.ilm.stop.go api.xpack.indices.freeze.go api.xpack.indices.reload_search_analyzers.go api.xpack.indices.unfreeze.go api.xpack.license.delete.go api.xpack.license.get.go api.xpack.license.get_basic_status.go api.xpack.license.get_trial_status.go api.xpack.license.post.go api.xpack.license.post_start_basic.go api.xpack.license.post_start_trial.go api.xpack.migration.deprecations.go api.xpack.ml.close_job.go api.xpack.ml.delete_calendar.go api.xpack.ml.delete_calendar_event.go api.xpack.ml.delete_calendar_job.go api.xpack.ml.delete_data_frame_analytics.go api.xpack.ml.delete_datafeed.go api.xpack.ml.delete_expired_data.go api.xpack.ml.delete_filter.go api.xpack.ml.delete_forecast.go api.xpack.ml.delete_job.go api.xpack.ml.delete_model_snapshot.go api.xpack.ml.evaluate_data_frame.go api.xpack.ml.find_file_structure.go api.xpack.ml.flush_job.go api.xpack.ml.forecast.go api.xpack.ml.get_buckets.go api.xpack.ml.get_calendar_events.go api.xpack.ml.get_calendars.go api.xpack.ml.get_categories.go api.xpack.ml.get_data_frame_analytics.go api.xpack.ml.get_data_frame_analytics_stats.go api.xpack.ml.get_datafeed_stats.go api.xpack.ml.get_datafeeds.go api.xpack.ml.get_filters.go api.xpack.ml.get_influencers.go api.xpack.ml.get_job_stats.go api.xpack.ml.get_jobs.go api.xpack.ml.get_model_snapshots.go api.xpack.ml.get_overall_buckets.go api.xpack.ml.get_records.go api.xpack.ml.info.go api.xpack.ml.open_job.go api.xpack.ml.post_calendar_events.go api.xpack.ml.post_data.go api.xpack.ml.preview_datafeed.go api.xpack.ml.put_calendar.go api.xpack.ml.put_calendar_job.go api.xpack.ml.put_data_frame_analytics.go api.xpack.ml.put_datafeed.go api.xpack.ml.put_filter.go api.xpack.ml.put_job.go api.xpack.ml.revert_model_snapshot.go api.xpack.ml.set_upgrade_mode.go api.xpack.ml.start_data_frame_analytics.go api.xpack.ml.start_datafeed.go api.xpack.ml.stop_data_frame_analytics.go api.xpack.ml.stop_datafeed.go api.xpack.ml.update_datafeed.go api.xpack.ml.update_filter.go api.xpack.ml.update_job.go api.xpack.ml.update_model_snapshot.go api.xpack.ml.validate.go api.xpack.ml.validate_detector.go api.xpack.monitoring.bulk.go api.xpack.rollup.delete_job.go api.xpack.rollup.get_jobs.go api.xpack.rollup.get_rollup_caps.go api.xpack.rollup.get_rollup_index_caps.go api.xpack.rollup.put_job.go api.xpack.rollup.rollup_search.go api.xpack.rollup.start_job.go api.xpack.rollup.stop_job.go api.xpack.security.authenticate.go api.xpack.security.change_password.go api.xpack.security.clear_cached_realms.go api.xpack.security.clear_cached_roles.go api.xpack.security.create_api_key.go api.xpack.security.delete_privileges.go api.xpack.security.delete_role.go api.xpack.security.delete_role_mapping.go api.xpack.security.delete_user.go api.xpack.security.disable_user.go api.xpack.security.enable_user.go api.xpack.security.get_api_key.go api.xpack.security.get_builtin_privileges.go api.xpack.security.get_privileges.go api.xpack.security.get_role.go api.xpack.security.get_role_mapping.go api.xpack.security.get_token.go api.xpack.security.get_user.go api.xpack.security.get_user_privileges.go api.xpack.security.has_privileges.go api.xpack.security.invalidate_api_key.go api.xpack.security.invalidate_token.go api.xpack.security.put_privileges.go api.xpack.security.put_role.go api.xpack.security.put_role_mapping.go api.xpack.security.put_user.go api.xpack.slm.delete_lifecycle.go api.xpack.slm.execute_lifecycle.go api.xpack.slm.get_lifecycle.go api.xpack.slm.put_lifecycle.go api.xpack.sql.clear_cursor.go api.xpack.sql.query.go api.xpack.sql.translate.go api.xpack.ssl.certificates.go api.xpack.watcher.ack_watch.go api.xpack.watcher.activate_watch.go api.xpack.watcher.deactivate_watch.go api.xpack.watcher.delete_watch.go api.xpack.watcher.execute_watch.go api.xpack.watcher.get_watch.go api.xpack.watcher.put_watch.go api.xpack.watcher.start.go api.xpack.watcher.stats.go api.xpack.watcher.stop.go api.xpack.xpack.info.go api.xpack.xpack.usage.go doc.go esapi.go esapi.request.go esapi.response.go
Version returns the package version as a string.
BoolPtr returns a pointer to v.
It is used as a convenience function for converting a bool value into a pointer when passing the value to a function or struct field which expects a pointer.
IntPtr returns a pointer to v.
It is used as a convenience function for converting an int value into a pointer when passing the value to a function or struct field which expects a pointer.
type API struct {
Cat *Cat
Cluster *Cluster
Indices *Indices
Ingest *Ingest
Nodes *Nodes
Remote *Remote
Snapshot *Snapshot
Tasks *Tasks
CCR *CCR
ILM *ILM
License *License
Migration *Migration
ML *ML
Monitoring *Monitoring
Rollup *Rollup
Security *Security
SQL *SQL
SSL *SSL
Watcher *Watcher
XPack *XPack
Bulk Bulk
ClearScroll ClearScroll
Count Count
Create Create
DataFrameDeleteDataFrameTransform DataFrameDeleteDataFrameTransform
DataFrameGetDataFrameTransform DataFrameGetDataFrameTransform
DataFrameGetDataFrameTransformStats DataFrameGetDataFrameTransformStats
DataFramePreviewDataFrameTransform DataFramePreviewDataFrameTransform
DataFramePutDataFrameTransform DataFramePutDataFrameTransform
DataFrameStartDataFrameTransform DataFrameStartDataFrameTransform
DataFrameStopDataFrameTransform DataFrameStopDataFrameTransform
DeleteByQuery DeleteByQuery
DeleteByQueryRethrottle DeleteByQueryRethrottle
Delete Delete
DeleteScript DeleteScript
Exists Exists
ExistsSource ExistsSource
Explain Explain
FieldCaps FieldCaps
Get Get
GetScript GetScript
GetSource GetSource
GraphExplore GraphExplore
Index Index
Info Info
Mget Mget
Msearch Msearch
MsearchTemplate MsearchTemplate
Mtermvectors Mtermvectors
Ping Ping
PutScript PutScript
RankEval RankEval
Reindex Reindex
ReindexRethrottle ReindexRethrottle
RenderSearchTemplate RenderSearchTemplate
ScriptsPainlessContext ScriptsPainlessContext
ScriptsPainlessExecute ScriptsPainlessExecute
Scroll Scroll
Search Search
SearchShards SearchShards
SearchTemplate SearchTemplate
SlmDeleteLifecycle SlmDeleteLifecycle
SlmExecuteLifecycle SlmExecuteLifecycle
SlmGetLifecycle SlmGetLifecycle
SlmPutLifecycle SlmPutLifecycle
Termvectors Termvectors
UpdateByQuery UpdateByQuery
UpdateByQueryRethrottle UpdateByQueryRethrottle
Update Update
}API contains the Elasticsearch APIs
New creates new API
Bulk allows to perform multiple index/update/delete operations in a single request.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html.
func (f Bulk) WithContext(v context.Context) func(*BulkRequest)
WithContext sets the request context.
func (f Bulk) WithDocumentType(v string) func(*BulkRequest)
WithDocumentType - default document type for items which don't provide one.
func (f Bulk) WithErrorTrace() func(*BulkRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Bulk) WithFilterPath(v ...string) func(*BulkRequest)
WithFilterPath filters the properties of the response body.
func (f Bulk) WithHeader(h map[string]string) func(*BulkRequest)
WithHeader adds the headers to the HTTP request.
func (f Bulk) WithHuman() func(*BulkRequest)
WithHuman makes statistical values human-readable.
func (f Bulk) WithIndex(v string) func(*BulkRequest)
WithIndex - default index for items which don't provide one.
func (f Bulk) WithPipeline(v string) func(*BulkRequest)
WithPipeline - the pipeline ID to preprocess incoming documents with.
func (f Bulk) WithPretty() func(*BulkRequest)
WithPretty makes the response body pretty-printed.
func (f Bulk) WithRefresh(v string) func(*BulkRequest)
WithRefresh - if `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes..
func (f Bulk) WithRouting(v string) func(*BulkRequest)
WithRouting - specific routing value.
func (f Bulk) WithSource(v ...string) func(*BulkRequest)
WithSource - true or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request.
func (f Bulk) WithSourceExcludes(v ...string) func(*BulkRequest)
WithSourceExcludes - default list of fields to exclude from the returned _source field, can be overridden on each sub-request.
func (f Bulk) WithSourceIncludes(v ...string) func(*BulkRequest)
WithSourceIncludes - default list of fields to extract and return from the _source field, can be overridden on each sub-request.
func (f Bulk) WithTimeout(v time.Duration) func(*BulkRequest)
WithTimeout - explicit operation timeout.
func (f Bulk) WithWaitForActiveShards(v string) func(*BulkRequest)
WithWaitForActiveShards - sets the number of shard copies that must be active before proceeding with the bulk operation. defaults to 1, meaning the primary shard only. set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).
type BulkRequest struct {
Index string
DocumentType string
Body io.Reader
Pipeline string
Refresh string
Routing string
Source []string
SourceExcludes []string
SourceIncludes []string
Timeout time.Duration
WaitForActiveShards string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}BulkRequest configures the Bulk API request.
Do executes the request and returns response or error.
type CCR struct {
DeleteAutoFollowPattern CCRDeleteAutoFollowPattern
FollowInfo CCRFollowInfo
Follow CCRFollow
FollowStats CCRFollowStats
ForgetFollower CCRForgetFollower
GetAutoFollowPattern CCRGetAutoFollowPattern
PauseFollow CCRPauseFollow
PutAutoFollowPattern CCRPutAutoFollowPattern
ResumeFollow CCRResumeFollow
Stats CCRStats
Unfollow CCRUnfollow
}CCR contains the CCR APIs
type CCRDeleteAutoFollowPattern func(name string, o ...func(*CCRDeleteAutoFollowPatternRequest)) (*Response, error)
CCRDeleteAutoFollowPattern - https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html
func (f CCRDeleteAutoFollowPattern) WithContext(v context.Context) func(*CCRDeleteAutoFollowPatternRequest)
WithContext sets the request context.
func (f CCRDeleteAutoFollowPattern) WithErrorTrace() func(*CCRDeleteAutoFollowPatternRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CCRDeleteAutoFollowPattern) WithFilterPath(v ...string) func(*CCRDeleteAutoFollowPatternRequest)
WithFilterPath filters the properties of the response body.
func (f CCRDeleteAutoFollowPattern) WithHeader(h map[string]string) func(*CCRDeleteAutoFollowPatternRequest)
WithHeader adds the headers to the HTTP request.
func (f CCRDeleteAutoFollowPattern) WithHuman() func(*CCRDeleteAutoFollowPatternRequest)
WithHuman makes statistical values human-readable.
func (f CCRDeleteAutoFollowPattern) WithPretty() func(*CCRDeleteAutoFollowPatternRequest)
WithPretty makes the response body pretty-printed.
type CCRDeleteAutoFollowPatternRequest struct {
Name string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CCRDeleteAutoFollowPatternRequest configures the CCR Delete Auto Follow Pattern API request.
func (r CCRDeleteAutoFollowPatternRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
CCRFollow - https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html
func (f CCRFollow) WithContext(v context.Context) func(*CCRFollowRequest)
WithContext sets the request context.
func (f CCRFollow) WithErrorTrace() func(*CCRFollowRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CCRFollow) WithFilterPath(v ...string) func(*CCRFollowRequest)
WithFilterPath filters the properties of the response body.
func (f CCRFollow) WithHeader(h map[string]string) func(*CCRFollowRequest)
WithHeader adds the headers to the HTTP request.
func (f CCRFollow) WithHuman() func(*CCRFollowRequest)
WithHuman makes statistical values human-readable.
func (f CCRFollow) WithPretty() func(*CCRFollowRequest)
WithPretty makes the response body pretty-printed.
func (f CCRFollow) WithWaitForActiveShards(v string) func(*CCRFollowRequest)
WithWaitForActiveShards - sets the number of shard copies that must be active before returning. defaults to 0. set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).
type CCRFollowInfo func(o ...func(*CCRFollowInfoRequest)) (*Response, error)
CCRFollowInfo - https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html
func (f CCRFollowInfo) WithContext(v context.Context) func(*CCRFollowInfoRequest)
WithContext sets the request context.
func (f CCRFollowInfo) WithErrorTrace() func(*CCRFollowInfoRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CCRFollowInfo) WithFilterPath(v ...string) func(*CCRFollowInfoRequest)
WithFilterPath filters the properties of the response body.
func (f CCRFollowInfo) WithHeader(h map[string]string) func(*CCRFollowInfoRequest)
WithHeader adds the headers to the HTTP request.
func (f CCRFollowInfo) WithHuman() func(*CCRFollowInfoRequest)
WithHuman makes statistical values human-readable.
func (f CCRFollowInfo) WithIndex(v ...string) func(*CCRFollowInfoRequest)
WithIndex - a list of index patterns; use `_all` to perform the operation on all indices.
func (f CCRFollowInfo) WithPretty() func(*CCRFollowInfoRequest)
WithPretty makes the response body pretty-printed.
type CCRFollowInfoRequest struct {
Index []string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CCRFollowInfoRequest configures the CCR Follow Info API request.
Do executes the request and returns response or error.
type CCRFollowRequest struct {
Index string
Body io.Reader
WaitForActiveShards string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CCRFollowRequest configures the CCR Follow API request.
Do executes the request and returns response or error.
type CCRFollowStats func(index []string, o ...func(*CCRFollowStatsRequest)) (*Response, error)
CCRFollowStats - https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html
func (f CCRFollowStats) WithContext(v context.Context) func(*CCRFollowStatsRequest)
WithContext sets the request context.
func (f CCRFollowStats) WithErrorTrace() func(*CCRFollowStatsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CCRFollowStats) WithFilterPath(v ...string) func(*CCRFollowStatsRequest)
WithFilterPath filters the properties of the response body.
func (f CCRFollowStats) WithHeader(h map[string]string) func(*CCRFollowStatsRequest)
WithHeader adds the headers to the HTTP request.
func (f CCRFollowStats) WithHuman() func(*CCRFollowStatsRequest)
WithHuman makes statistical values human-readable.
func (f CCRFollowStats) WithPretty() func(*CCRFollowStatsRequest)
WithPretty makes the response body pretty-printed.
type CCRFollowStatsRequest struct {
Index []string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CCRFollowStatsRequest configures the CCR Follow Stats API request.
Do executes the request and returns response or error.
type CCRForgetFollower func(index string, body io.Reader, o ...func(*CCRForgetFollowerRequest)) (*Response, error)
CCRForgetFollower - http://www.elastic.co/guide/en/elasticsearch/reference/current
func (f CCRForgetFollower) WithContext(v context.Context) func(*CCRForgetFollowerRequest)
WithContext sets the request context.
func (f CCRForgetFollower) WithErrorTrace() func(*CCRForgetFollowerRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CCRForgetFollower) WithFilterPath(v ...string) func(*CCRForgetFollowerRequest)
WithFilterPath filters the properties of the response body.
func (f CCRForgetFollower) WithHeader(h map[string]string) func(*CCRForgetFollowerRequest)
WithHeader adds the headers to the HTTP request.
func (f CCRForgetFollower) WithHuman() func(*CCRForgetFollowerRequest)
WithHuman makes statistical values human-readable.
func (f CCRForgetFollower) WithPretty() func(*CCRForgetFollowerRequest)
WithPretty makes the response body pretty-printed.
type CCRForgetFollowerRequest struct {
Index string
Body io.Reader
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CCRForgetFollowerRequest configures the CCR Forget Follower API request.
Do executes the request and returns response or error.
type CCRGetAutoFollowPattern func(o ...func(*CCRGetAutoFollowPatternRequest)) (*Response, error)
CCRGetAutoFollowPattern - https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html
func (f CCRGetAutoFollowPattern) WithContext(v context.Context) func(*CCRGetAutoFollowPatternRequest)
WithContext sets the request context.
func (f CCRGetAutoFollowPattern) WithErrorTrace() func(*CCRGetAutoFollowPatternRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CCRGetAutoFollowPattern) WithFilterPath(v ...string) func(*CCRGetAutoFollowPatternRequest)
WithFilterPath filters the properties of the response body.
func (f CCRGetAutoFollowPattern) WithHeader(h map[string]string) func(*CCRGetAutoFollowPatternRequest)
WithHeader adds the headers to the HTTP request.
func (f CCRGetAutoFollowPattern) WithHuman() func(*CCRGetAutoFollowPatternRequest)
WithHuman makes statistical values human-readable.
func (f CCRGetAutoFollowPattern) WithName(v string) func(*CCRGetAutoFollowPatternRequest)
WithName - the name of the auto follow pattern..
func (f CCRGetAutoFollowPattern) WithPretty() func(*CCRGetAutoFollowPatternRequest)
WithPretty makes the response body pretty-printed.
type CCRGetAutoFollowPatternRequest struct {
Name string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CCRGetAutoFollowPatternRequest configures the CCR Get Auto Follow Pattern API request.
func (r CCRGetAutoFollowPatternRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type CCRPauseFollow func(index string, o ...func(*CCRPauseFollowRequest)) (*Response, error)
CCRPauseFollow - https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-follow.html
func (f CCRPauseFollow) WithContext(v context.Context) func(*CCRPauseFollowRequest)
WithContext sets the request context.
func (f CCRPauseFollow) WithErrorTrace() func(*CCRPauseFollowRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CCRPauseFollow) WithFilterPath(v ...string) func(*CCRPauseFollowRequest)
WithFilterPath filters the properties of the response body.
func (f CCRPauseFollow) WithHeader(h map[string]string) func(*CCRPauseFollowRequest)
WithHeader adds the headers to the HTTP request.
func (f CCRPauseFollow) WithHuman() func(*CCRPauseFollowRequest)
WithHuman makes statistical values human-readable.
func (f CCRPauseFollow) WithPretty() func(*CCRPauseFollowRequest)
WithPretty makes the response body pretty-printed.
type CCRPauseFollowRequest struct {
Index string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CCRPauseFollowRequest configures the CCR Pause Follow API request.
Do executes the request and returns response or error.
type CCRPutAutoFollowPattern func(name string, body io.Reader, o ...func(*CCRPutAutoFollowPatternRequest)) (*Response, error)
CCRPutAutoFollowPattern - https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-follow-pattern.html
func (f CCRPutAutoFollowPattern) WithContext(v context.Context) func(*CCRPutAutoFollowPatternRequest)
WithContext sets the request context.
func (f CCRPutAutoFollowPattern) WithErrorTrace() func(*CCRPutAutoFollowPatternRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CCRPutAutoFollowPattern) WithFilterPath(v ...string) func(*CCRPutAutoFollowPatternRequest)
WithFilterPath filters the properties of the response body.
func (f CCRPutAutoFollowPattern) WithHeader(h map[string]string) func(*CCRPutAutoFollowPatternRequest)
WithHeader adds the headers to the HTTP request.
func (f CCRPutAutoFollowPattern) WithHuman() func(*CCRPutAutoFollowPatternRequest)
WithHuman makes statistical values human-readable.
func (f CCRPutAutoFollowPattern) WithPretty() func(*CCRPutAutoFollowPatternRequest)
WithPretty makes the response body pretty-printed.
type CCRPutAutoFollowPatternRequest struct {
Body io.Reader
Name string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CCRPutAutoFollowPatternRequest configures the CCR Put Auto Follow Pattern API request.
func (r CCRPutAutoFollowPatternRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type CCRResumeFollow func(index string, o ...func(*CCRResumeFollowRequest)) (*Response, error)
CCRResumeFollow - https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html
func (f CCRResumeFollow) WithBody(v io.Reader) func(*CCRResumeFollowRequest)
WithBody - The name of the leader index and other optional ccr related parameters.
func (f CCRResumeFollow) WithContext(v context.Context) func(*CCRResumeFollowRequest)
WithContext sets the request context.
func (f CCRResumeFollow) WithErrorTrace() func(*CCRResumeFollowRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CCRResumeFollow) WithFilterPath(v ...string) func(*CCRResumeFollowRequest)
WithFilterPath filters the properties of the response body.
func (f CCRResumeFollow) WithHeader(h map[string]string) func(*CCRResumeFollowRequest)
WithHeader adds the headers to the HTTP request.
func (f CCRResumeFollow) WithHuman() func(*CCRResumeFollowRequest)
WithHuman makes statistical values human-readable.
func (f CCRResumeFollow) WithPretty() func(*CCRResumeFollowRequest)
WithPretty makes the response body pretty-printed.
type CCRResumeFollowRequest struct {
Index string
Body io.Reader
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CCRResumeFollowRequest configures the CCR Resume Follow API request.
Do executes the request and returns response or error.
type CCRStats func(o ...func(*CCRStatsRequest)) (*Response, error)
CCRStats - https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html
func (f CCRStats) WithContext(v context.Context) func(*CCRStatsRequest)
WithContext sets the request context.
func (f CCRStats) WithErrorTrace() func(*CCRStatsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CCRStats) WithFilterPath(v ...string) func(*CCRStatsRequest)
WithFilterPath filters the properties of the response body.
func (f CCRStats) WithHeader(h map[string]string) func(*CCRStatsRequest)
WithHeader adds the headers to the HTTP request.
func (f CCRStats) WithHuman() func(*CCRStatsRequest)
WithHuman makes statistical values human-readable.
func (f CCRStats) WithPretty() func(*CCRStatsRequest)
WithPretty makes the response body pretty-printed.
type CCRStatsRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CCRStatsRequest configures the CCR Stats API request.
Do executes the request and returns response or error.
type CCRUnfollow func(index string, o ...func(*CCRUnfollowRequest)) (*Response, error)
CCRUnfollow - http://www.elastic.co/guide/en/elasticsearch/reference/current
func (f CCRUnfollow) WithContext(v context.Context) func(*CCRUnfollowRequest)
WithContext sets the request context.
func (f CCRUnfollow) WithErrorTrace() func(*CCRUnfollowRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CCRUnfollow) WithFilterPath(v ...string) func(*CCRUnfollowRequest)
WithFilterPath filters the properties of the response body.
func (f CCRUnfollow) WithHeader(h map[string]string) func(*CCRUnfollowRequest)
WithHeader adds the headers to the HTTP request.
func (f CCRUnfollow) WithHuman() func(*CCRUnfollowRequest)
WithHuman makes statistical values human-readable.
func (f CCRUnfollow) WithPretty() func(*CCRUnfollowRequest)
WithPretty makes the response body pretty-printed.
type CCRUnfollowRequest struct {
Index string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CCRUnfollowRequest configures the CCR Unfollow API request.
Do executes the request and returns response or error.
type Cat struct {
Aliases CatAliases
Allocation CatAllocation
Count CatCount
Fielddata CatFielddata
Health CatHealth
Help CatHelp
Indices CatIndices
Master CatMaster
Nodeattrs CatNodeattrs
Nodes CatNodes
PendingTasks CatPendingTasks
Plugins CatPlugins
Recovery CatRecovery
Repositories CatRepositories
Segments CatSegments
Shards CatShards
Snapshots CatSnapshots
Tasks CatTasks
Templates CatTemplates
ThreadPool CatThreadPool
}Cat contains the Cat APIs
type CatAliases func(o ...func(*CatAliasesRequest)) (*Response, error)
CatAliases shows information about currently configured aliases to indices including filter and routing infos.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html.
func (f CatAliases) WithContext(v context.Context) func(*CatAliasesRequest)
WithContext sets the request context.
func (f CatAliases) WithErrorTrace() func(*CatAliasesRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatAliases) WithFilterPath(v ...string) func(*CatAliasesRequest)
WithFilterPath filters the properties of the response body.
func (f CatAliases) WithFormat(v string) func(*CatAliasesRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatAliases) WithH(v ...string) func(*CatAliasesRequest)
WithH - comma-separated list of column names to display.
func (f CatAliases) WithHeader(h map[string]string) func(*CatAliasesRequest)
WithHeader adds the headers to the HTTP request.
func (f CatAliases) WithHelp(v bool) func(*CatAliasesRequest)
WithHelp - return help information.
func (f CatAliases) WithHuman() func(*CatAliasesRequest)
WithHuman makes statistical values human-readable.
func (f CatAliases) WithLocal(v bool) func(*CatAliasesRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f CatAliases) WithMasterTimeout(v time.Duration) func(*CatAliasesRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f CatAliases) WithName(v ...string) func(*CatAliasesRequest)
WithName - a list of alias names to return.
func (f CatAliases) WithPretty() func(*CatAliasesRequest)
WithPretty makes the response body pretty-printed.
func (f CatAliases) WithS(v ...string) func(*CatAliasesRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatAliases) WithV(v bool) func(*CatAliasesRequest)
WithV - verbose mode. display column headers.
type CatAliasesRequest struct {
Name []string
Format string
H []string
Help *bool
Local *bool
MasterTimeout time.Duration
S []string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatAliasesRequest configures the Cat Aliases API request.
Do executes the request and returns response or error.
type CatAllocation func(o ...func(*CatAllocationRequest)) (*Response, error)
CatAllocation provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html.
func (f CatAllocation) WithBytes(v string) func(*CatAllocationRequest)
WithBytes - the unit in which to display byte values.
func (f CatAllocation) WithContext(v context.Context) func(*CatAllocationRequest)
WithContext sets the request context.
func (f CatAllocation) WithErrorTrace() func(*CatAllocationRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatAllocation) WithFilterPath(v ...string) func(*CatAllocationRequest)
WithFilterPath filters the properties of the response body.
func (f CatAllocation) WithFormat(v string) func(*CatAllocationRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatAllocation) WithH(v ...string) func(*CatAllocationRequest)
WithH - comma-separated list of column names to display.
func (f CatAllocation) WithHeader(h map[string]string) func(*CatAllocationRequest)
WithHeader adds the headers to the HTTP request.
func (f CatAllocation) WithHelp(v bool) func(*CatAllocationRequest)
WithHelp - return help information.
func (f CatAllocation) WithHuman() func(*CatAllocationRequest)
WithHuman makes statistical values human-readable.
func (f CatAllocation) WithLocal(v bool) func(*CatAllocationRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f CatAllocation) WithMasterTimeout(v time.Duration) func(*CatAllocationRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f CatAllocation) WithNodeID(v ...string) func(*CatAllocationRequest)
WithNodeID - a list of node ids or names to limit the returned information.
func (f CatAllocation) WithPretty() func(*CatAllocationRequest)
WithPretty makes the response body pretty-printed.
func (f CatAllocation) WithS(v ...string) func(*CatAllocationRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatAllocation) WithV(v bool) func(*CatAllocationRequest)
WithV - verbose mode. display column headers.
type CatAllocationRequest struct {
NodeID []string
Bytes string
Format string
H []string
Help *bool
Local *bool
MasterTimeout time.Duration
S []string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatAllocationRequest configures the Cat Allocation API request.
Do executes the request and returns response or error.
type CatCount func(o ...func(*CatCountRequest)) (*Response, error)
CatCount provides quick access to the document count of the entire cluster, or individual indices.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html.
func (f CatCount) WithContext(v context.Context) func(*CatCountRequest)
WithContext sets the request context.
func (f CatCount) WithErrorTrace() func(*CatCountRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatCount) WithFilterPath(v ...string) func(*CatCountRequest)
WithFilterPath filters the properties of the response body.
func (f CatCount) WithFormat(v string) func(*CatCountRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatCount) WithH(v ...string) func(*CatCountRequest)
WithH - comma-separated list of column names to display.
func (f CatCount) WithHeader(h map[string]string) func(*CatCountRequest)
WithHeader adds the headers to the HTTP request.
func (f CatCount) WithHelp(v bool) func(*CatCountRequest)
WithHelp - return help information.
func (f CatCount) WithHuman() func(*CatCountRequest)
WithHuman makes statistical values human-readable.
func (f CatCount) WithIndex(v ...string) func(*CatCountRequest)
WithIndex - a list of index names to limit the returned information.
func (f CatCount) WithLocal(v bool) func(*CatCountRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f CatCount) WithMasterTimeout(v time.Duration) func(*CatCountRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f CatCount) WithPretty() func(*CatCountRequest)
WithPretty makes the response body pretty-printed.
func (f CatCount) WithS(v ...string) func(*CatCountRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatCount) WithV(v bool) func(*CatCountRequest)
WithV - verbose mode. display column headers.
type CatCountRequest struct {
Index []string
Format string
H []string
Help *bool
Local *bool
MasterTimeout time.Duration
S []string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatCountRequest configures the Cat Count API request.
Do executes the request and returns response or error.
type CatFielddata func(o ...func(*CatFielddataRequest)) (*Response, error)
CatFielddata shows how much heap memory is currently being used by fielddata on every data node in the cluster.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html.
func (f CatFielddata) WithBytes(v string) func(*CatFielddataRequest)
WithBytes - the unit in which to display byte values.
func (f CatFielddata) WithContext(v context.Context) func(*CatFielddataRequest)
WithContext sets the request context.
func (f CatFielddata) WithErrorTrace() func(*CatFielddataRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatFielddata) WithFields(v ...string) func(*CatFielddataRequest)
WithFields - a list of fields to return the fielddata size.
func (f CatFielddata) WithFilterPath(v ...string) func(*CatFielddataRequest)
WithFilterPath filters the properties of the response body.
func (f CatFielddata) WithFormat(v string) func(*CatFielddataRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatFielddata) WithH(v ...string) func(*CatFielddataRequest)
WithH - comma-separated list of column names to display.
func (f CatFielddata) WithHeader(h map[string]string) func(*CatFielddataRequest)
WithHeader adds the headers to the HTTP request.
func (f CatFielddata) WithHelp(v bool) func(*CatFielddataRequest)
WithHelp - return help information.
func (f CatFielddata) WithHuman() func(*CatFielddataRequest)
WithHuman makes statistical values human-readable.
func (f CatFielddata) WithLocal(v bool) func(*CatFielddataRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f CatFielddata) WithMasterTimeout(v time.Duration) func(*CatFielddataRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f CatFielddata) WithPretty() func(*CatFielddataRequest)
WithPretty makes the response body pretty-printed.
func (f CatFielddata) WithS(v ...string) func(*CatFielddataRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatFielddata) WithV(v bool) func(*CatFielddataRequest)
WithV - verbose mode. display column headers.
type CatFielddataRequest struct {
Fields []string
Bytes string
Format string
H []string
Help *bool
Local *bool
MasterTimeout time.Duration
S []string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatFielddataRequest configures the Cat Fielddata API request.
Do executes the request and returns response or error.
type CatHealth func(o ...func(*CatHealthRequest)) (*Response, error)
CatHealth returns a concise representation of the cluster health.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html.
func (f CatHealth) WithContext(v context.Context) func(*CatHealthRequest)
WithContext sets the request context.
func (f CatHealth) WithErrorTrace() func(*CatHealthRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatHealth) WithFilterPath(v ...string) func(*CatHealthRequest)
WithFilterPath filters the properties of the response body.
func (f CatHealth) WithFormat(v string) func(*CatHealthRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatHealth) WithH(v ...string) func(*CatHealthRequest)
WithH - comma-separated list of column names to display.
func (f CatHealth) WithHeader(h map[string]string) func(*CatHealthRequest)
WithHeader adds the headers to the HTTP request.
func (f CatHealth) WithHelp(v bool) func(*CatHealthRequest)
WithHelp - return help information.
func (f CatHealth) WithHuman() func(*CatHealthRequest)
WithHuman makes statistical values human-readable.
func (f CatHealth) WithLocal(v bool) func(*CatHealthRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f CatHealth) WithMasterTimeout(v time.Duration) func(*CatHealthRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f CatHealth) WithPretty() func(*CatHealthRequest)
WithPretty makes the response body pretty-printed.
func (f CatHealth) WithS(v ...string) func(*CatHealthRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatHealth) WithTs(v bool) func(*CatHealthRequest)
WithTs - set to false to disable timestamping.
func (f CatHealth) WithV(v bool) func(*CatHealthRequest)
WithV - verbose mode. display column headers.
type CatHealthRequest struct {
Format string
H []string
Help *bool
Local *bool
MasterTimeout time.Duration
S []string
Ts *bool
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatHealthRequest configures the Cat Health API request.
Do executes the request and returns response or error.
type CatHelp func(o ...func(*CatHelpRequest)) (*Response, error)
CatHelp returns help for the Cat APIs.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html.
func (f CatHelp) WithContext(v context.Context) func(*CatHelpRequest)
WithContext sets the request context.
func (f CatHelp) WithErrorTrace() func(*CatHelpRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatHelp) WithFilterPath(v ...string) func(*CatHelpRequest)
WithFilterPath filters the properties of the response body.
func (f CatHelp) WithHeader(h map[string]string) func(*CatHelpRequest)
WithHeader adds the headers to the HTTP request.
func (f CatHelp) WithHelp(v bool) func(*CatHelpRequest)
WithHelp - return help information.
func (f CatHelp) WithHuman() func(*CatHelpRequest)
WithHuman makes statistical values human-readable.
func (f CatHelp) WithPretty() func(*CatHelpRequest)
WithPretty makes the response body pretty-printed.
func (f CatHelp) WithS(v ...string) func(*CatHelpRequest)
WithS - comma-separated list of column names or column aliases to sort by.
type CatHelpRequest struct {
Help *bool
S []string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatHelpRequest configures the Cat Help API request.
Do executes the request and returns response or error.
type CatIndices func(o ...func(*CatIndicesRequest)) (*Response, error)
CatIndices returns information about indices: number of primaries and replicas, document counts, disk size, ...
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html.
func (f CatIndices) WithBytes(v string) func(*CatIndicesRequest)
WithBytes - the unit in which to display byte values.
func (f CatIndices) WithContext(v context.Context) func(*CatIndicesRequest)
WithContext sets the request context.
func (f CatIndices) WithErrorTrace() func(*CatIndicesRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatIndices) WithFilterPath(v ...string) func(*CatIndicesRequest)
WithFilterPath filters the properties of the response body.
func (f CatIndices) WithFormat(v string) func(*CatIndicesRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatIndices) WithH(v ...string) func(*CatIndicesRequest)
WithH - comma-separated list of column names to display.
func (f CatIndices) WithHeader(h map[string]string) func(*CatIndicesRequest)
WithHeader adds the headers to the HTTP request.
func (f CatIndices) WithHealth(v string) func(*CatIndicesRequest)
WithHealth - a health status ("green", "yellow", or "red" to filter only indices matching the specified health status.
func (f CatIndices) WithHelp(v bool) func(*CatIndicesRequest)
WithHelp - return help information.
func (f CatIndices) WithHuman() func(*CatIndicesRequest)
WithHuman makes statistical values human-readable.
func (f CatIndices) WithIncludeUnloadedSegments(v bool) func(*CatIndicesRequest)
WithIncludeUnloadedSegments - if set to true segment stats will include stats for segments that are not currently loaded into memory.
func (f CatIndices) WithIndex(v ...string) func(*CatIndicesRequest)
WithIndex - a list of index names to limit the returned information.
func (f CatIndices) WithLocal(v bool) func(*CatIndicesRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f CatIndices) WithMasterTimeout(v time.Duration) func(*CatIndicesRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f CatIndices) WithPretty() func(*CatIndicesRequest)
WithPretty makes the response body pretty-printed.
func (f CatIndices) WithPri(v bool) func(*CatIndicesRequest)
WithPri - set to true to return stats only for primary shards.
func (f CatIndices) WithS(v ...string) func(*CatIndicesRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatIndices) WithV(v bool) func(*CatIndicesRequest)
WithV - verbose mode. display column headers.
type CatIndicesRequest struct {
Index []string
Bytes string
Format string
H []string
Health string
Help *bool
IncludeUnloadedSegments *bool
Local *bool
MasterTimeout time.Duration
Pri *bool
S []string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatIndicesRequest configures the Cat Indices API request.
Do executes the request and returns response or error.
type CatMaster func(o ...func(*CatMasterRequest)) (*Response, error)
CatMaster returns information about the master node.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html.
func (f CatMaster) WithContext(v context.Context) func(*CatMasterRequest)
WithContext sets the request context.
func (f CatMaster) WithErrorTrace() func(*CatMasterRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatMaster) WithFilterPath(v ...string) func(*CatMasterRequest)
WithFilterPath filters the properties of the response body.
func (f CatMaster) WithFormat(v string) func(*CatMasterRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatMaster) WithH(v ...string) func(*CatMasterRequest)
WithH - comma-separated list of column names to display.
func (f CatMaster) WithHeader(h map[string]string) func(*CatMasterRequest)
WithHeader adds the headers to the HTTP request.
func (f CatMaster) WithHelp(v bool) func(*CatMasterRequest)
WithHelp - return help information.
func (f CatMaster) WithHuman() func(*CatMasterRequest)
WithHuman makes statistical values human-readable.
func (f CatMaster) WithLocal(v bool) func(*CatMasterRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f CatMaster) WithMasterTimeout(v time.Duration) func(*CatMasterRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f CatMaster) WithPretty() func(*CatMasterRequest)
WithPretty makes the response body pretty-printed.
func (f CatMaster) WithS(v ...string) func(*CatMasterRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatMaster) WithV(v bool) func(*CatMasterRequest)
WithV - verbose mode. display column headers.
type CatMasterRequest struct {
Format string
H []string
Help *bool
Local *bool
MasterTimeout time.Duration
S []string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatMasterRequest configures the Cat Master API request.
Do executes the request and returns response or error.
type CatNodeattrs func(o ...func(*CatNodeattrsRequest)) (*Response, error)
CatNodeattrs returns information about custom node attributes.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html.
func (f CatNodeattrs) WithContext(v context.Context) func(*CatNodeattrsRequest)
WithContext sets the request context.
func (f CatNodeattrs) WithErrorTrace() func(*CatNodeattrsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatNodeattrs) WithFilterPath(v ...string) func(*CatNodeattrsRequest)
WithFilterPath filters the properties of the response body.
func (f CatNodeattrs) WithFormat(v string) func(*CatNodeattrsRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatNodeattrs) WithH(v ...string) func(*CatNodeattrsRequest)
WithH - comma-separated list of column names to display.
func (f CatNodeattrs) WithHeader(h map[string]string) func(*CatNodeattrsRequest)
WithHeader adds the headers to the HTTP request.
func (f CatNodeattrs) WithHelp(v bool) func(*CatNodeattrsRequest)
WithHelp - return help information.
func (f CatNodeattrs) WithHuman() func(*CatNodeattrsRequest)
WithHuman makes statistical values human-readable.
func (f CatNodeattrs) WithLocal(v bool) func(*CatNodeattrsRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f CatNodeattrs) WithMasterTimeout(v time.Duration) func(*CatNodeattrsRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f CatNodeattrs) WithPretty() func(*CatNodeattrsRequest)
WithPretty makes the response body pretty-printed.
func (f CatNodeattrs) WithS(v ...string) func(*CatNodeattrsRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatNodeattrs) WithV(v bool) func(*CatNodeattrsRequest)
WithV - verbose mode. display column headers.
type CatNodeattrsRequest struct {
Format string
H []string
Help *bool
Local *bool
MasterTimeout time.Duration
S []string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatNodeattrsRequest configures the Cat Nodeattrs API request.
Do executes the request and returns response or error.
type CatNodes func(o ...func(*CatNodesRequest)) (*Response, error)
CatNodes returns basic statistics about performance of cluster nodes.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html.
func (f CatNodes) WithContext(v context.Context) func(*CatNodesRequest)
WithContext sets the request context.
func (f CatNodes) WithErrorTrace() func(*CatNodesRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatNodes) WithFilterPath(v ...string) func(*CatNodesRequest)
WithFilterPath filters the properties of the response body.
func (f CatNodes) WithFormat(v string) func(*CatNodesRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatNodes) WithFullID(v bool) func(*CatNodesRequest)
WithFullID - return the full node ID instead of the shortened version (default: false).
func (f CatNodes) WithH(v ...string) func(*CatNodesRequest)
WithH - comma-separated list of column names to display.
func (f CatNodes) WithHeader(h map[string]string) func(*CatNodesRequest)
WithHeader adds the headers to the HTTP request.
func (f CatNodes) WithHelp(v bool) func(*CatNodesRequest)
WithHelp - return help information.
func (f CatNodes) WithHuman() func(*CatNodesRequest)
WithHuman makes statistical values human-readable.
func (f CatNodes) WithLocal(v bool) func(*CatNodesRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f CatNodes) WithMasterTimeout(v time.Duration) func(*CatNodesRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f CatNodes) WithPretty() func(*CatNodesRequest)
WithPretty makes the response body pretty-printed.
func (f CatNodes) WithS(v ...string) func(*CatNodesRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatNodes) WithV(v bool) func(*CatNodesRequest)
WithV - verbose mode. display column headers.
type CatNodesRequest struct {
Format string
FullID *bool
H []string
Help *bool
Local *bool
MasterTimeout time.Duration
S []string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatNodesRequest configures the Cat Nodes API request.
Do executes the request and returns response or error.
type CatPendingTasks func(o ...func(*CatPendingTasksRequest)) (*Response, error)
CatPendingTasks returns a concise representation of the cluster pending tasks.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html.
func (f CatPendingTasks) WithContext(v context.Context) func(*CatPendingTasksRequest)
WithContext sets the request context.
func (f CatPendingTasks) WithErrorTrace() func(*CatPendingTasksRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatPendingTasks) WithFilterPath(v ...string) func(*CatPendingTasksRequest)
WithFilterPath filters the properties of the response body.
func (f CatPendingTasks) WithFormat(v string) func(*CatPendingTasksRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatPendingTasks) WithH(v ...string) func(*CatPendingTasksRequest)
WithH - comma-separated list of column names to display.
func (f CatPendingTasks) WithHeader(h map[string]string) func(*CatPendingTasksRequest)
WithHeader adds the headers to the HTTP request.
func (f CatPendingTasks) WithHelp(v bool) func(*CatPendingTasksRequest)
WithHelp - return help information.
func (f CatPendingTasks) WithHuman() func(*CatPendingTasksRequest)
WithHuman makes statistical values human-readable.
func (f CatPendingTasks) WithLocal(v bool) func(*CatPendingTasksRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f CatPendingTasks) WithMasterTimeout(v time.Duration) func(*CatPendingTasksRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f CatPendingTasks) WithPretty() func(*CatPendingTasksRequest)
WithPretty makes the response body pretty-printed.
func (f CatPendingTasks) WithS(v ...string) func(*CatPendingTasksRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatPendingTasks) WithV(v bool) func(*CatPendingTasksRequest)
WithV - verbose mode. display column headers.
type CatPendingTasksRequest struct {
Format string
H []string
Help *bool
Local *bool
MasterTimeout time.Duration
S []string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatPendingTasksRequest configures the Cat Pending Tasks API request.
Do executes the request and returns response or error.
type CatPlugins func(o ...func(*CatPluginsRequest)) (*Response, error)
CatPlugins returns information about installed plugins across nodes node.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html.
func (f CatPlugins) WithContext(v context.Context) func(*CatPluginsRequest)
WithContext sets the request context.
func (f CatPlugins) WithErrorTrace() func(*CatPluginsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatPlugins) WithFilterPath(v ...string) func(*CatPluginsRequest)
WithFilterPath filters the properties of the response body.
func (f CatPlugins) WithFormat(v string) func(*CatPluginsRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatPlugins) WithH(v ...string) func(*CatPluginsRequest)
WithH - comma-separated list of column names to display.
func (f CatPlugins) WithHeader(h map[string]string) func(*CatPluginsRequest)
WithHeader adds the headers to the HTTP request.
func (f CatPlugins) WithHelp(v bool) func(*CatPluginsRequest)
WithHelp - return help information.
func (f CatPlugins) WithHuman() func(*CatPluginsRequest)
WithHuman makes statistical values human-readable.
func (f CatPlugins) WithLocal(v bool) func(*CatPluginsRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f CatPlugins) WithMasterTimeout(v time.Duration) func(*CatPluginsRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f CatPlugins) WithPretty() func(*CatPluginsRequest)
WithPretty makes the response body pretty-printed.
func (f CatPlugins) WithS(v ...string) func(*CatPluginsRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatPlugins) WithV(v bool) func(*CatPluginsRequest)
WithV - verbose mode. display column headers.
type CatPluginsRequest struct {
Format string
H []string
Help *bool
Local *bool
MasterTimeout time.Duration
S []string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatPluginsRequest configures the Cat Plugins API request.
Do executes the request and returns response or error.
type CatRecovery func(o ...func(*CatRecoveryRequest)) (*Response, error)
CatRecovery returns information about index shard recoveries, both on-going completed.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html.
func (f CatRecovery) WithBytes(v string) func(*CatRecoveryRequest)
WithBytes - the unit in which to display byte values.
func (f CatRecovery) WithContext(v context.Context) func(*CatRecoveryRequest)
WithContext sets the request context.
func (f CatRecovery) WithErrorTrace() func(*CatRecoveryRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatRecovery) WithFilterPath(v ...string) func(*CatRecoveryRequest)
WithFilterPath filters the properties of the response body.
func (f CatRecovery) WithFormat(v string) func(*CatRecoveryRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatRecovery) WithH(v ...string) func(*CatRecoveryRequest)
WithH - comma-separated list of column names to display.
func (f CatRecovery) WithHeader(h map[string]string) func(*CatRecoveryRequest)
WithHeader adds the headers to the HTTP request.
func (f CatRecovery) WithHelp(v bool) func(*CatRecoveryRequest)
WithHelp - return help information.
func (f CatRecovery) WithHuman() func(*CatRecoveryRequest)
WithHuman makes statistical values human-readable.
func (f CatRecovery) WithIndex(v ...string) func(*CatRecoveryRequest)
WithIndex - a list of index names to limit the returned information.
func (f CatRecovery) WithMasterTimeout(v time.Duration) func(*CatRecoveryRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f CatRecovery) WithPretty() func(*CatRecoveryRequest)
WithPretty makes the response body pretty-printed.
func (f CatRecovery) WithS(v ...string) func(*CatRecoveryRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatRecovery) WithV(v bool) func(*CatRecoveryRequest)
WithV - verbose mode. display column headers.
type CatRecoveryRequest struct {
Index []string
Bytes string
Format string
H []string
Help *bool
MasterTimeout time.Duration
S []string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatRecoveryRequest configures the Cat Recovery API request.
Do executes the request and returns response or error.
type CatRepositories func(o ...func(*CatRepositoriesRequest)) (*Response, error)
CatRepositories returns information about snapshot repositories registered in the cluster.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html.
func (f CatRepositories) WithContext(v context.Context) func(*CatRepositoriesRequest)
WithContext sets the request context.
func (f CatRepositories) WithErrorTrace() func(*CatRepositoriesRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatRepositories) WithFilterPath(v ...string) func(*CatRepositoriesRequest)
WithFilterPath filters the properties of the response body.
func (f CatRepositories) WithFormat(v string) func(*CatRepositoriesRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatRepositories) WithH(v ...string) func(*CatRepositoriesRequest)
WithH - comma-separated list of column names to display.
func (f CatRepositories) WithHeader(h map[string]string) func(*CatRepositoriesRequest)
WithHeader adds the headers to the HTTP request.
func (f CatRepositories) WithHelp(v bool) func(*CatRepositoriesRequest)
WithHelp - return help information.
func (f CatRepositories) WithHuman() func(*CatRepositoriesRequest)
WithHuman makes statistical values human-readable.
func (f CatRepositories) WithLocal(v bool) func(*CatRepositoriesRequest)
WithLocal - return local information, do not retrieve the state from master node.
func (f CatRepositories) WithMasterTimeout(v time.Duration) func(*CatRepositoriesRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f CatRepositories) WithPretty() func(*CatRepositoriesRequest)
WithPretty makes the response body pretty-printed.
func (f CatRepositories) WithS(v ...string) func(*CatRepositoriesRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatRepositories) WithV(v bool) func(*CatRepositoriesRequest)
WithV - verbose mode. display column headers.
type CatRepositoriesRequest struct {
Format string
H []string
Help *bool
Local *bool
MasterTimeout time.Duration
S []string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatRepositoriesRequest configures the Cat Repositories API request.
Do executes the request and returns response or error.
type CatSegments func(o ...func(*CatSegmentsRequest)) (*Response, error)
CatSegments provides low-level information about the segments in the shards of an index.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html.
func (f CatSegments) WithBytes(v string) func(*CatSegmentsRequest)
WithBytes - the unit in which to display byte values.
func (f CatSegments) WithContext(v context.Context) func(*CatSegmentsRequest)
WithContext sets the request context.
func (f CatSegments) WithErrorTrace() func(*CatSegmentsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatSegments) WithFilterPath(v ...string) func(*CatSegmentsRequest)
WithFilterPath filters the properties of the response body.
func (f CatSegments) WithFormat(v string) func(*CatSegmentsRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatSegments) WithH(v ...string) func(*CatSegmentsRequest)
WithH - comma-separated list of column names to display.
func (f CatSegments) WithHeader(h map[string]string) func(*CatSegmentsRequest)
WithHeader adds the headers to the HTTP request.
func (f CatSegments) WithHelp(v bool) func(*CatSegmentsRequest)
WithHelp - return help information.
func (f CatSegments) WithHuman() func(*CatSegmentsRequest)
WithHuman makes statistical values human-readable.
func (f CatSegments) WithIndex(v ...string) func(*CatSegmentsRequest)
WithIndex - a list of index names to limit the returned information.
func (f CatSegments) WithPretty() func(*CatSegmentsRequest)
WithPretty makes the response body pretty-printed.
func (f CatSegments) WithS(v ...string) func(*CatSegmentsRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatSegments) WithV(v bool) func(*CatSegmentsRequest)
WithV - verbose mode. display column headers.
type CatSegmentsRequest struct {
Index []string
Bytes string
Format string
H []string
Help *bool
S []string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatSegmentsRequest configures the Cat Segments API request.
Do executes the request and returns response or error.
type CatShards func(o ...func(*CatShardsRequest)) (*Response, error)
CatShards provides a detailed view of shard allocation on nodes.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html.
func (f CatShards) WithBytes(v string) func(*CatShardsRequest)
WithBytes - the unit in which to display byte values.
func (f CatShards) WithContext(v context.Context) func(*CatShardsRequest)
WithContext sets the request context.
func (f CatShards) WithErrorTrace() func(*CatShardsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatShards) WithFilterPath(v ...string) func(*CatShardsRequest)
WithFilterPath filters the properties of the response body.
func (f CatShards) WithFormat(v string) func(*CatShardsRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatShards) WithH(v ...string) func(*CatShardsRequest)
WithH - comma-separated list of column names to display.
func (f CatShards) WithHeader(h map[string]string) func(*CatShardsRequest)
WithHeader adds the headers to the HTTP request.
func (f CatShards) WithHelp(v bool) func(*CatShardsRequest)
WithHelp - return help information.
func (f CatShards) WithHuman() func(*CatShardsRequest)
WithHuman makes statistical values human-readable.
func (f CatShards) WithIndex(v ...string) func(*CatShardsRequest)
WithIndex - a list of index names to limit the returned information.
func (f CatShards) WithLocal(v bool) func(*CatShardsRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f CatShards) WithMasterTimeout(v time.Duration) func(*CatShardsRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f CatShards) WithPretty() func(*CatShardsRequest)
WithPretty makes the response body pretty-printed.
func (f CatShards) WithS(v ...string) func(*CatShardsRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatShards) WithV(v bool) func(*CatShardsRequest)
WithV - verbose mode. display column headers.
type CatShardsRequest struct {
Index []string
Bytes string
Format string
H []string
Help *bool
Local *bool
MasterTimeout time.Duration
S []string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatShardsRequest configures the Cat Shards API request.
Do executes the request and returns response or error.
type CatSnapshots func(o ...func(*CatSnapshotsRequest)) (*Response, error)
CatSnapshots returns all snapshots in a specific repository.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html.
func (f CatSnapshots) WithContext(v context.Context) func(*CatSnapshotsRequest)
WithContext sets the request context.
func (f CatSnapshots) WithErrorTrace() func(*CatSnapshotsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatSnapshots) WithFilterPath(v ...string) func(*CatSnapshotsRequest)
WithFilterPath filters the properties of the response body.
func (f CatSnapshots) WithFormat(v string) func(*CatSnapshotsRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatSnapshots) WithH(v ...string) func(*CatSnapshotsRequest)
WithH - comma-separated list of column names to display.
func (f CatSnapshots) WithHeader(h map[string]string) func(*CatSnapshotsRequest)
WithHeader adds the headers to the HTTP request.
func (f CatSnapshots) WithHelp(v bool) func(*CatSnapshotsRequest)
WithHelp - return help information.
func (f CatSnapshots) WithHuman() func(*CatSnapshotsRequest)
WithHuman makes statistical values human-readable.
func (f CatSnapshots) WithIgnoreUnavailable(v bool) func(*CatSnapshotsRequest)
WithIgnoreUnavailable - set to true to ignore unavailable snapshots.
func (f CatSnapshots) WithMasterTimeout(v time.Duration) func(*CatSnapshotsRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f CatSnapshots) WithPretty() func(*CatSnapshotsRequest)
WithPretty makes the response body pretty-printed.
func (f CatSnapshots) WithRepository(v ...string) func(*CatSnapshotsRequest)
WithRepository - name of repository from which to fetch the snapshot information.
func (f CatSnapshots) WithS(v ...string) func(*CatSnapshotsRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatSnapshots) WithV(v bool) func(*CatSnapshotsRequest)
WithV - verbose mode. display column headers.
type CatSnapshotsRequest struct {
Repository []string
Format string
H []string
Help *bool
*bool
MasterTimeout time.Duration
S []string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatSnapshotsRequest configures the Cat Snapshots API request.
Do executes the request and returns response or error.
type CatTasks func(o ...func(*CatTasksRequest)) (*Response, error)
CatTasks returns information about the tasks currently executing on one or more nodes in the cluster.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html.
func (f CatTasks) WithActions(v ...string) func(*CatTasksRequest)
WithActions - a list of actions that should be returned. leave empty to return all..
func (f CatTasks) WithContext(v context.Context) func(*CatTasksRequest)
WithContext sets the request context.
func (f CatTasks) WithDetailed(v bool) func(*CatTasksRequest)
WithDetailed - return detailed task information (default: false).
func (f CatTasks) WithErrorTrace() func(*CatTasksRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatTasks) WithFilterPath(v ...string) func(*CatTasksRequest)
WithFilterPath filters the properties of the response body.
func (f CatTasks) WithFormat(v string) func(*CatTasksRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatTasks) WithH(v ...string) func(*CatTasksRequest)
WithH - comma-separated list of column names to display.
func (f CatTasks) WithHeader(h map[string]string) func(*CatTasksRequest)
WithHeader adds the headers to the HTTP request.
func (f CatTasks) WithHelp(v bool) func(*CatTasksRequest)
WithHelp - return help information.
func (f CatTasks) WithHuman() func(*CatTasksRequest)
WithHuman makes statistical values human-readable.
func (f CatTasks) WithNodeID(v ...string) func(*CatTasksRequest)
WithNodeID - a list of node ids or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
func (f CatTasks) WithParentTask(v int) func(*CatTasksRequest)
WithParentTask - return tasks with specified parent task ID. set to -1 to return all..
func (f CatTasks) WithPretty() func(*CatTasksRequest)
WithPretty makes the response body pretty-printed.
func (f CatTasks) WithS(v ...string) func(*CatTasksRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatTasks) WithV(v bool) func(*CatTasksRequest)
WithV - verbose mode. display column headers.
type CatTasksRequest struct {
Actions []string
Detailed *bool
Format string
H []string
Help *bool
NodeID []string
ParentTask *int
S []string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatTasksRequest configures the Cat Tasks API request.
Do executes the request and returns response or error.
type CatTemplates func(o ...func(*CatTemplatesRequest)) (*Response, error)
CatTemplates returns information about existing templates.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html.
func (f CatTemplates) WithContext(v context.Context) func(*CatTemplatesRequest)
WithContext sets the request context.
func (f CatTemplates) WithErrorTrace() func(*CatTemplatesRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatTemplates) WithFilterPath(v ...string) func(*CatTemplatesRequest)
WithFilterPath filters the properties of the response body.
func (f CatTemplates) WithFormat(v string) func(*CatTemplatesRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatTemplates) WithH(v ...string) func(*CatTemplatesRequest)
WithH - comma-separated list of column names to display.
func (f CatTemplates) WithHeader(h map[string]string) func(*CatTemplatesRequest)
WithHeader adds the headers to the HTTP request.
func (f CatTemplates) WithHelp(v bool) func(*CatTemplatesRequest)
WithHelp - return help information.
func (f CatTemplates) WithHuman() func(*CatTemplatesRequest)
WithHuman makes statistical values human-readable.
func (f CatTemplates) WithLocal(v bool) func(*CatTemplatesRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f CatTemplates) WithMasterTimeout(v time.Duration) func(*CatTemplatesRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f CatTemplates) WithName(v string) func(*CatTemplatesRequest)
WithName - a pattern that returned template names must match.
func (f CatTemplates) WithPretty() func(*CatTemplatesRequest)
WithPretty makes the response body pretty-printed.
func (f CatTemplates) WithS(v ...string) func(*CatTemplatesRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatTemplates) WithV(v bool) func(*CatTemplatesRequest)
WithV - verbose mode. display column headers.
type CatTemplatesRequest struct {
Name string
Format string
H []string
Help *bool
Local *bool
MasterTimeout time.Duration
S []string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatTemplatesRequest configures the Cat Templates API request.
Do executes the request and returns response or error.
type CatThreadPool func(o ...func(*CatThreadPoolRequest)) (*Response, error)
CatThreadPool returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html.
func (f CatThreadPool) WithContext(v context.Context) func(*CatThreadPoolRequest)
WithContext sets the request context.
func (f CatThreadPool) WithErrorTrace() func(*CatThreadPoolRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f CatThreadPool) WithFilterPath(v ...string) func(*CatThreadPoolRequest)
WithFilterPath filters the properties of the response body.
func (f CatThreadPool) WithFormat(v string) func(*CatThreadPoolRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f CatThreadPool) WithH(v ...string) func(*CatThreadPoolRequest)
WithH - comma-separated list of column names to display.
func (f CatThreadPool) WithHeader(h map[string]string) func(*CatThreadPoolRequest)
WithHeader adds the headers to the HTTP request.
func (f CatThreadPool) WithHelp(v bool) func(*CatThreadPoolRequest)
WithHelp - return help information.
func (f CatThreadPool) WithHuman() func(*CatThreadPoolRequest)
WithHuman makes statistical values human-readable.
func (f CatThreadPool) WithLocal(v bool) func(*CatThreadPoolRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f CatThreadPool) WithMasterTimeout(v time.Duration) func(*CatThreadPoolRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f CatThreadPool) WithPretty() func(*CatThreadPoolRequest)
WithPretty makes the response body pretty-printed.
func (f CatThreadPool) WithS(v ...string) func(*CatThreadPoolRequest)
WithS - comma-separated list of column names or column aliases to sort by.
func (f CatThreadPool) WithSize(v string) func(*CatThreadPoolRequest)
WithSize - the multiplier in which to display values.
func (f CatThreadPool) WithThreadPoolPatterns(v ...string) func(*CatThreadPoolRequest)
WithThreadPoolPatterns - a list of regular-expressions to filter the thread pools in the output.
func (f CatThreadPool) WithV(v bool) func(*CatThreadPoolRequest)
WithV - verbose mode. display column headers.
type CatThreadPoolRequest struct {
ThreadPoolPatterns []string
Format string
H []string
Help *bool
Local *bool
MasterTimeout time.Duration
S []string
Size string
V *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CatThreadPoolRequest configures the Cat Thread Pool API request.
Do executes the request and returns response or error.
type ClearScroll func(o ...func(*ClearScrollRequest)) (*Response, error)
ClearScroll explicitly clears the search context for a scroll.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#_clear_scroll_api.
func (f ClearScroll) WithBody(v io.Reader) func(*ClearScrollRequest)
WithBody - A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter.
func (f ClearScroll) WithContext(v context.Context) func(*ClearScrollRequest)
WithContext sets the request context.
func (f ClearScroll) WithErrorTrace() func(*ClearScrollRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ClearScroll) WithFilterPath(v ...string) func(*ClearScrollRequest)
WithFilterPath filters the properties of the response body.
func (f ClearScroll) WithHeader(h map[string]string) func(*ClearScrollRequest)
WithHeader adds the headers to the HTTP request.
func (f ClearScroll) WithHuman() func(*ClearScrollRequest)
WithHuman makes statistical values human-readable.
func (f ClearScroll) WithPretty() func(*ClearScrollRequest)
WithPretty makes the response body pretty-printed.
func (f ClearScroll) WithScrollID(v ...string) func(*ClearScrollRequest)
WithScrollID - a list of scroll ids to clear.
type ClearScrollRequest struct {
Body io.Reader
ScrollID []string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ClearScrollRequest configures the Clear Scroll API request.
Do executes the request and returns response or error.
type Cluster struct {
AllocationExplain ClusterAllocationExplain
GetSettings ClusterGetSettings
Health ClusterHealth
PendingTasks ClusterPendingTasks
PutSettings ClusterPutSettings
RemoteInfo ClusterRemoteInfo
Reroute ClusterReroute
State ClusterState
Stats ClusterStats
}Cluster contains the Cluster APIs
type ClusterAllocationExplain func(o ...func(*ClusterAllocationExplainRequest)) (*Response, error)
ClusterAllocationExplain provides explanations for shard allocations in the cluster.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html.
func (f ClusterAllocationExplain) WithBody(v io.Reader) func(*ClusterAllocationExplainRequest)
WithBody - The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'.
func (f ClusterAllocationExplain) WithContext(v context.Context) func(*ClusterAllocationExplainRequest)
WithContext sets the request context.
func (f ClusterAllocationExplain) WithErrorTrace() func(*ClusterAllocationExplainRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ClusterAllocationExplain) WithFilterPath(v ...string) func(*ClusterAllocationExplainRequest)
WithFilterPath filters the properties of the response body.
func (f ClusterAllocationExplain) WithHeader(h map[string]string) func(*ClusterAllocationExplainRequest)
WithHeader adds the headers to the HTTP request.
func (f ClusterAllocationExplain) WithHuman() func(*ClusterAllocationExplainRequest)
WithHuman makes statistical values human-readable.
func (f ClusterAllocationExplain) WithIncludeDiskInfo(v bool) func(*ClusterAllocationExplainRequest)
WithIncludeDiskInfo - return information about disk usage and shard sizes (default: false).
func (f ClusterAllocationExplain) WithIncludeYesDecisions(v bool) func(*ClusterAllocationExplainRequest)
WithIncludeYesDecisions - return 'yes' decisions in explanation (default: false).
func (f ClusterAllocationExplain) WithPretty() func(*ClusterAllocationExplainRequest)
WithPretty makes the response body pretty-printed.
type ClusterAllocationExplainRequest struct {
Body io.Reader
IncludeDiskInfo *bool
IncludeYesDecisions *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ClusterAllocationExplainRequest configures the Cluster Allocation Explain API request.
func (r ClusterAllocationExplainRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type ClusterGetSettings func(o ...func(*ClusterGetSettingsRequest)) (*Response, error)
ClusterGetSettings returns cluster settings.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html.
func (f ClusterGetSettings) WithContext(v context.Context) func(*ClusterGetSettingsRequest)
WithContext sets the request context.
func (f ClusterGetSettings) WithErrorTrace() func(*ClusterGetSettingsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ClusterGetSettings) WithFilterPath(v ...string) func(*ClusterGetSettingsRequest)
WithFilterPath filters the properties of the response body.
func (f ClusterGetSettings) WithFlatSettings(v bool) func(*ClusterGetSettingsRequest)
WithFlatSettings - return settings in flat format (default: false).
func (f ClusterGetSettings) WithHeader(h map[string]string) func(*ClusterGetSettingsRequest)
WithHeader adds the headers to the HTTP request.
func (f ClusterGetSettings) WithHuman() func(*ClusterGetSettingsRequest)
WithHuman makes statistical values human-readable.
func (f ClusterGetSettings) WithIncludeDefaults(v bool) func(*ClusterGetSettingsRequest)
WithIncludeDefaults - whether to return all default clusters setting..
func (f ClusterGetSettings) WithMasterTimeout(v time.Duration) func(*ClusterGetSettingsRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f ClusterGetSettings) WithPretty() func(*ClusterGetSettingsRequest)
WithPretty makes the response body pretty-printed.
func (f ClusterGetSettings) WithTimeout(v time.Duration) func(*ClusterGetSettingsRequest)
WithTimeout - explicit operation timeout.
type ClusterGetSettingsRequest struct {
FlatSettings *bool
IncludeDefaults *bool
MasterTimeout time.Duration
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ClusterGetSettingsRequest configures the Cluster Get Settings API request.
Do executes the request and returns response or error.
type ClusterHealth func(o ...func(*ClusterHealthRequest)) (*Response, error)
ClusterHealth returns basic information about the health of the cluster.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html.
func (f ClusterHealth) WithContext(v context.Context) func(*ClusterHealthRequest)
WithContext sets the request context.
func (f ClusterHealth) WithErrorTrace() func(*ClusterHealthRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ClusterHealth) WithExpandWildcards(v string) func(*ClusterHealthRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f ClusterHealth) WithFilterPath(v ...string) func(*ClusterHealthRequest)
WithFilterPath filters the properties of the response body.
func (f ClusterHealth) WithHeader(h map[string]string) func(*ClusterHealthRequest)
WithHeader adds the headers to the HTTP request.
func (f ClusterHealth) WithHuman() func(*ClusterHealthRequest)
WithHuman makes statistical values human-readable.
func (f ClusterHealth) WithIndex(v ...string) func(*ClusterHealthRequest)
WithIndex - limit the information returned to a specific index.
func (f ClusterHealth) WithLevel(v string) func(*ClusterHealthRequest)
WithLevel - specify the level of detail for returned information.
func (f ClusterHealth) WithLocal(v bool) func(*ClusterHealthRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f ClusterHealth) WithMasterTimeout(v time.Duration) func(*ClusterHealthRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f ClusterHealth) WithPretty() func(*ClusterHealthRequest)
WithPretty makes the response body pretty-printed.
func (f ClusterHealth) WithTimeout(v time.Duration) func(*ClusterHealthRequest)
WithTimeout - explicit operation timeout.
func (f ClusterHealth) WithWaitForActiveShards(v string) func(*ClusterHealthRequest)
WithWaitForActiveShards - wait until the specified number of shards is active.
func (f ClusterHealth) WithWaitForEvents(v string) func(*ClusterHealthRequest)
WithWaitForEvents - wait until all currently queued events with the given priority are processed.
func (f ClusterHealth) WithWaitForNoInitializingShards(v bool) func(*ClusterHealthRequest)
WithWaitForNoInitializingShards - whether to wait until there are no initializing shards in the cluster.
func (f ClusterHealth) WithWaitForNoRelocatingShards(v bool) func(*ClusterHealthRequest)
WithWaitForNoRelocatingShards - whether to wait until there are no relocating shards in the cluster.
func (f ClusterHealth) WithWaitForNodes(v string) func(*ClusterHealthRequest)
WithWaitForNodes - wait until the specified number of nodes is available.
func (f ClusterHealth) WithWaitForStatus(v string) func(*ClusterHealthRequest)
WithWaitForStatus - wait until cluster is in a specific state.
type ClusterHealthRequest struct {
Index []string
ExpandWildcards string
Level string
Local *bool
MasterTimeout time.Duration
Timeout time.Duration
WaitForActiveShards string
WaitForEvents string
WaitForNoInitializingShards *bool
WaitForNoRelocatingShards *bool
WaitForNodes string
WaitForStatus string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ClusterHealthRequest configures the Cluster Health API request.
Do executes the request and returns response or error.
type ClusterPendingTasks func(o ...func(*ClusterPendingTasksRequest)) (*Response, error)
ClusterPendingTasks returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html.
func (f ClusterPendingTasks) WithContext(v context.Context) func(*ClusterPendingTasksRequest)
WithContext sets the request context.
func (f ClusterPendingTasks) WithErrorTrace() func(*ClusterPendingTasksRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ClusterPendingTasks) WithFilterPath(v ...string) func(*ClusterPendingTasksRequest)
WithFilterPath filters the properties of the response body.
func (f ClusterPendingTasks) WithHeader(h map[string]string) func(*ClusterPendingTasksRequest)
WithHeader adds the headers to the HTTP request.
func (f ClusterPendingTasks) WithHuman() func(*ClusterPendingTasksRequest)
WithHuman makes statistical values human-readable.
func (f ClusterPendingTasks) WithLocal(v bool) func(*ClusterPendingTasksRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f ClusterPendingTasks) WithMasterTimeout(v time.Duration) func(*ClusterPendingTasksRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f ClusterPendingTasks) WithPretty() func(*ClusterPendingTasksRequest)
WithPretty makes the response body pretty-printed.
type ClusterPendingTasksRequest struct {
Local *bool
MasterTimeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ClusterPendingTasksRequest configures the Cluster Pending Tasks API request.
func (r ClusterPendingTasksRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type ClusterPutSettings func(body io.Reader, o ...func(*ClusterPutSettingsRequest)) (*Response, error)
ClusterPutSettings updates the cluster settings.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html.
func (f ClusterPutSettings) WithContext(v context.Context) func(*ClusterPutSettingsRequest)
WithContext sets the request context.
func (f ClusterPutSettings) WithErrorTrace() func(*ClusterPutSettingsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ClusterPutSettings) WithFilterPath(v ...string) func(*ClusterPutSettingsRequest)
WithFilterPath filters the properties of the response body.
func (f ClusterPutSettings) WithFlatSettings(v bool) func(*ClusterPutSettingsRequest)
WithFlatSettings - return settings in flat format (default: false).
func (f ClusterPutSettings) WithHeader(h map[string]string) func(*ClusterPutSettingsRequest)
WithHeader adds the headers to the HTTP request.
func (f ClusterPutSettings) WithHuman() func(*ClusterPutSettingsRequest)
WithHuman makes statistical values human-readable.
func (f ClusterPutSettings) WithMasterTimeout(v time.Duration) func(*ClusterPutSettingsRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f ClusterPutSettings) WithPretty() func(*ClusterPutSettingsRequest)
WithPretty makes the response body pretty-printed.
func (f ClusterPutSettings) WithTimeout(v time.Duration) func(*ClusterPutSettingsRequest)
WithTimeout - explicit operation timeout.
type ClusterPutSettingsRequest struct {
Body io.Reader
FlatSettings *bool
MasterTimeout time.Duration
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ClusterPutSettingsRequest configures the Cluster Put Settings API request.
Do executes the request and returns response or error.
type ClusterRemoteInfo func(o ...func(*ClusterRemoteInfoRequest)) (*Response, error)
ClusterRemoteInfo returns the information about configured remote clusters.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html.
func (f ClusterRemoteInfo) WithContext(v context.Context) func(*ClusterRemoteInfoRequest)
WithContext sets the request context.
func (f ClusterRemoteInfo) WithErrorTrace() func(*ClusterRemoteInfoRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ClusterRemoteInfo) WithFilterPath(v ...string) func(*ClusterRemoteInfoRequest)
WithFilterPath filters the properties of the response body.
func (f ClusterRemoteInfo) WithHeader(h map[string]string) func(*ClusterRemoteInfoRequest)
WithHeader adds the headers to the HTTP request.
func (f ClusterRemoteInfo) WithHuman() func(*ClusterRemoteInfoRequest)
WithHuman makes statistical values human-readable.
func (f ClusterRemoteInfo) WithPretty() func(*ClusterRemoteInfoRequest)
WithPretty makes the response body pretty-printed.
type ClusterRemoteInfoRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ClusterRemoteInfoRequest configures the Cluster Remote Info API request.
Do executes the request and returns response or error.
type ClusterReroute func(o ...func(*ClusterRerouteRequest)) (*Response, error)
ClusterReroute allows to manually change the allocation of individual shards in the cluster.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html.
func (f ClusterReroute) WithBody(v io.Reader) func(*ClusterRerouteRequest)
WithBody - The definition of `commands` to perform (`move`, `cancel`, `allocate`).
func (f ClusterReroute) WithContext(v context.Context) func(*ClusterRerouteRequest)
WithContext sets the request context.
func (f ClusterReroute) WithDryRun(v bool) func(*ClusterRerouteRequest)
WithDryRun - simulate the operation only and return the resulting state.
func (f ClusterReroute) WithErrorTrace() func(*ClusterRerouteRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ClusterReroute) WithExplain(v bool) func(*ClusterRerouteRequest)
WithExplain - return an explanation of why the commands can or cannot be executed.
func (f ClusterReroute) WithFilterPath(v ...string) func(*ClusterRerouteRequest)
WithFilterPath filters the properties of the response body.
func (f ClusterReroute) WithHeader(h map[string]string) func(*ClusterRerouteRequest)
WithHeader adds the headers to the HTTP request.
func (f ClusterReroute) WithHuman() func(*ClusterRerouteRequest)
WithHuman makes statistical values human-readable.
func (f ClusterReroute) WithMasterTimeout(v time.Duration) func(*ClusterRerouteRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f ClusterReroute) WithMetric(v ...string) func(*ClusterRerouteRequest)
WithMetric - limit the information returned to the specified metrics. defaults to all but metadata.
func (f ClusterReroute) WithPretty() func(*ClusterRerouteRequest)
WithPretty makes the response body pretty-printed.
func (f ClusterReroute) WithRetryFailed(v bool) func(*ClusterRerouteRequest)
WithRetryFailed - retries allocation of shards that are blocked due to too many subsequent allocation failures.
func (f ClusterReroute) WithTimeout(v time.Duration) func(*ClusterRerouteRequest)
WithTimeout - explicit operation timeout.
type ClusterRerouteRequest struct {
Body io.Reader
DryRun *bool
Explain *bool
MasterTimeout time.Duration
Metric []string
RetryFailed *bool
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ClusterRerouteRequest configures the Cluster Reroute API request.
Do executes the request and returns response or error.
type ClusterState func(o ...func(*ClusterStateRequest)) (*Response, error)
ClusterState returns a comprehensive information about the state of the cluster.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html.
func (f ClusterState) WithAllowNoIndices(v bool) func(*ClusterStateRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f ClusterState) WithContext(v context.Context) func(*ClusterStateRequest)
WithContext sets the request context.
func (f ClusterState) WithErrorTrace() func(*ClusterStateRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ClusterState) WithExpandWildcards(v string) func(*ClusterStateRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f ClusterState) WithFilterPath(v ...string) func(*ClusterStateRequest)
WithFilterPath filters the properties of the response body.
func (f ClusterState) WithFlatSettings(v bool) func(*ClusterStateRequest)
WithFlatSettings - return settings in flat format (default: false).
func (f ClusterState) WithHeader(h map[string]string) func(*ClusterStateRequest)
WithHeader adds the headers to the HTTP request.
func (f ClusterState) WithHuman() func(*ClusterStateRequest)
WithHuman makes statistical values human-readable.
func (f ClusterState) WithIgnoreUnavailable(v bool) func(*ClusterStateRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f ClusterState) WithIndex(v ...string) func(*ClusterStateRequest)
WithIndex - a list of index names; use _all to perform the operation on all indices.
func (f ClusterState) WithLocal(v bool) func(*ClusterStateRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f ClusterState) WithMasterTimeout(v time.Duration) func(*ClusterStateRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f ClusterState) WithMetric(v ...string) func(*ClusterStateRequest)
WithMetric - limit the information returned to the specified metrics.
func (f ClusterState) WithPretty() func(*ClusterStateRequest)
WithPretty makes the response body pretty-printed.
func (f ClusterState) WithWaitForMetadataVersion(v int) func(*ClusterStateRequest)
WithWaitForMetadataVersion - wait for the metadata version to be equal or greater than the specified metadata version.
func (f ClusterState) WithWaitForTimeout(v time.Duration) func(*ClusterStateRequest)
WithWaitForTimeout - the maximum time to wait for wait_for_metadata_version before timing out.
type ClusterStateRequest struct {
Index []string
Metric []string
AllowNoIndices *bool
ExpandWildcards string
FlatSettings *bool
*bool
Local *bool
MasterTimeout time.Duration
WaitForMetadataVersion *int
WaitForTimeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ClusterStateRequest configures the Cluster State API request.
Do executes the request and returns response or error.
type ClusterStats func(o ...func(*ClusterStatsRequest)) (*Response, error)
ClusterStats returns high-level overview of cluster statistics.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html.
func (f ClusterStats) WithContext(v context.Context) func(*ClusterStatsRequest)
WithContext sets the request context.
func (f ClusterStats) WithErrorTrace() func(*ClusterStatsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ClusterStats) WithFilterPath(v ...string) func(*ClusterStatsRequest)
WithFilterPath filters the properties of the response body.
func (f ClusterStats) WithFlatSettings(v bool) func(*ClusterStatsRequest)
WithFlatSettings - return settings in flat format (default: false).
func (f ClusterStats) WithHeader(h map[string]string) func(*ClusterStatsRequest)
WithHeader adds the headers to the HTTP request.
func (f ClusterStats) WithHuman() func(*ClusterStatsRequest)
WithHuman makes statistical values human-readable.
func (f ClusterStats) WithNodeID(v ...string) func(*ClusterStatsRequest)
WithNodeID - a list of node ids or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
func (f ClusterStats) WithPretty() func(*ClusterStatsRequest)
WithPretty makes the response body pretty-printed.
func (f ClusterStats) WithTimeout(v time.Duration) func(*ClusterStatsRequest)
WithTimeout - explicit operation timeout.
type ClusterStatsRequest struct {
NodeID []string
FlatSettings *bool
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ClusterStatsRequest configures the Cluster Stats API request.
Do executes the request and returns response or error.
type Count func(o ...func(*CountRequest)) (*Response, error)
Count returns number of documents matching a query.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html.
func (f Count) WithAllowNoIndices(v bool) func(*CountRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f Count) WithAnalyzeWildcard(v bool) func(*CountRequest)
WithAnalyzeWildcard - specify whether wildcard and prefix queries should be analyzed (default: false).
func (f Count) WithAnalyzer(v string) func(*CountRequest)
WithAnalyzer - the analyzer to use for the query string.
func (f Count) WithBody(v io.Reader) func(*CountRequest)
WithBody - A query to restrict the results specified with the Query DSL (optional).
func (f Count) WithContext(v context.Context) func(*CountRequest)
WithContext sets the request context.
func (f Count) WithDefaultOperator(v string) func(*CountRequest)
WithDefaultOperator - the default operator for query string query (and or or).
func (f Count) WithDf(v string) func(*CountRequest)
WithDf - the field to use as default where no field prefix is given in the query string.
func (f Count) WithDocumentType(v ...string) func(*CountRequest)
WithDocumentType - a list of types to restrict the results.
func (f Count) WithErrorTrace() func(*CountRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Count) WithExpandWildcards(v string) func(*CountRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f Count) WithFilterPath(v ...string) func(*CountRequest)
WithFilterPath filters the properties of the response body.
func (f Count) WithHeader(h map[string]string) func(*CountRequest)
WithHeader adds the headers to the HTTP request.
func (f Count) WithHuman() func(*CountRequest)
WithHuman makes statistical values human-readable.
func (f Count) WithIgnoreThrottled(v bool) func(*CountRequest)
WithIgnoreThrottled - whether specified concrete, expanded or aliased indices should be ignored when throttled.
func (f Count) WithIgnoreUnavailable(v bool) func(*CountRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f Count) WithIndex(v ...string) func(*CountRequest)
WithIndex - a list of indices to restrict the results.
func (f Count) WithLenient(v bool) func(*CountRequest)
WithLenient - specify whether format-based query failures (such as providing text to a numeric field) should be ignored.
func (f Count) WithMinScore(v int) func(*CountRequest)
WithMinScore - include only documents with a specific `_score` value in the result.
func (f Count) WithPreference(v string) func(*CountRequest)
WithPreference - specify the node or shard the operation should be performed on (default: random).
func (f Count) WithPretty() func(*CountRequest)
WithPretty makes the response body pretty-printed.
func (f Count) WithQuery(v string) func(*CountRequest)
WithQuery - query in the lucene query string syntax.
func (f Count) WithRouting(v ...string) func(*CountRequest)
WithRouting - a list of specific routing values.
func (f Count) WithTerminateAfter(v int) func(*CountRequest)
WithTerminateAfter - the maximum count for each shard, upon reaching which the query execution will terminate early.
type CountRequest struct {
Index []string
DocumentType []string
Body io.Reader
AllowNoIndices *bool
Analyzer string
AnalyzeWildcard *bool
DefaultOperator string
Df string
ExpandWildcards string
IgnoreThrottled *bool
*bool
Lenient *bool
MinScore *int
Preference string
Query string
Routing []string
TerminateAfter *int
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CountRequest configures the Count API request.
Do executes the request and returns response or error.
type Create func(index string, id string, body io.Reader, o ...func(*CreateRequest)) (*Response, error)
Create creates a new document in the index.
Returns a 409 response when a document with a same ID already exists in the index.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html.
func (f Create) WithContext(v context.Context) func(*CreateRequest)
WithContext sets the request context.
func (f Create) WithDocumentType(v string) func(*CreateRequest)
WithDocumentType - the type of the document.
func (f Create) WithErrorTrace() func(*CreateRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Create) WithFilterPath(v ...string) func(*CreateRequest)
WithFilterPath filters the properties of the response body.
func (f Create) WithHeader(h map[string]string) func(*CreateRequest)
WithHeader adds the headers to the HTTP request.
func (f Create) WithHuman() func(*CreateRequest)
WithHuman makes statistical values human-readable.
func (f Create) WithPipeline(v string) func(*CreateRequest)
WithPipeline - the pipeline ID to preprocess incoming documents with.
func (f Create) WithPretty() func(*CreateRequest)
WithPretty makes the response body pretty-printed.
func (f Create) WithRefresh(v string) func(*CreateRequest)
WithRefresh - if `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes..
func (f Create) WithRouting(v string) func(*CreateRequest)
WithRouting - specific routing value.
func (f Create) WithTimeout(v time.Duration) func(*CreateRequest)
WithTimeout - explicit operation timeout.
func (f Create) WithVersion(v int) func(*CreateRequest)
WithVersion - explicit version number for concurrency control.
func (f Create) WithVersionType(v string) func(*CreateRequest)
WithVersionType - specific version type.
func (f Create) WithWaitForActiveShards(v string) func(*CreateRequest)
WithWaitForActiveShards - sets the number of shard copies that must be active before proceeding with the index operation. defaults to 1, meaning the primary shard only. set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).
type CreateRequest struct {
Index string
DocumentType string
DocumentID string
Body io.Reader
Pipeline string
Refresh string
Routing string
Timeout time.Duration
Version *int
VersionType string
WaitForActiveShards string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}CreateRequest configures the Create API request.
Do executes the request and returns response or error.
type DataFrameDeleteDataFrameTransform func(transform_id string, o ...func(*DataFrameDeleteDataFrameTransformRequest)) (*Response, error)
DataFrameDeleteDataFrameTransform - https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-data-frame-transform.html
func (f DataFrameDeleteDataFrameTransform) WithContext(v context.Context) func(*DataFrameDeleteDataFrameTransformRequest)
WithContext sets the request context.
func (f DataFrameDeleteDataFrameTransform) WithErrorTrace() func(*DataFrameDeleteDataFrameTransformRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f DataFrameDeleteDataFrameTransform) WithFilterPath(v ...string) func(*DataFrameDeleteDataFrameTransformRequest)
WithFilterPath filters the properties of the response body.
func (f DataFrameDeleteDataFrameTransform) WithForce(v bool) func(*DataFrameDeleteDataFrameTransformRequest)
WithForce - when `true`, the transform is deleted regardless of its current state. the default value is `false`, meaning that the transform must be `stopped` before it can be deleted..
func (f DataFrameDeleteDataFrameTransform) WithHeader(h map[string]string) func(*DataFrameDeleteDataFrameTransformRequest)
WithHeader adds the headers to the HTTP request.
func (f DataFrameDeleteDataFrameTransform) WithHuman() func(*DataFrameDeleteDataFrameTransformRequest)
WithHuman makes statistical values human-readable.
func (f DataFrameDeleteDataFrameTransform) WithPretty() func(*DataFrameDeleteDataFrameTransformRequest)
WithPretty makes the response body pretty-printed.
type DataFrameDeleteDataFrameTransformRequest struct {
TransformID string
Force *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}DataFrameDeleteDataFrameTransformRequest configures the Data Frame Delete Data Frame Transform API request.
func (r DataFrameDeleteDataFrameTransformRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type DataFrameGetDataFrameTransform func(o ...func(*DataFrameGetDataFrameTransformRequest)) (*Response, error)
DataFrameGetDataFrameTransform - https://www.elastic.co/guide/en/elasticsearch/reference/current/get-data-frame-transform.html
func (f DataFrameGetDataFrameTransform) WithAllowNoMatch(v bool) func(*DataFrameGetDataFrameTransformRequest)
WithAllowNoMatch - whether to ignore if a wildcard expression matches no data frame transforms. (this includes `_all` string or when no data frame transforms have been specified).
func (f DataFrameGetDataFrameTransform) WithContext(v context.Context) func(*DataFrameGetDataFrameTransformRequest)
WithContext sets the request context.
func (f DataFrameGetDataFrameTransform) WithErrorTrace() func(*DataFrameGetDataFrameTransformRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f DataFrameGetDataFrameTransform) WithFilterPath(v ...string) func(*DataFrameGetDataFrameTransformRequest)
WithFilterPath filters the properties of the response body.
func (f DataFrameGetDataFrameTransform) WithFrom(v int) func(*DataFrameGetDataFrameTransformRequest)
WithFrom - skips a number of transform configs, defaults to 0.
func (f DataFrameGetDataFrameTransform) WithHeader(h map[string]string) func(*DataFrameGetDataFrameTransformRequest)
WithHeader adds the headers to the HTTP request.
func (f DataFrameGetDataFrameTransform) WithHuman() func(*DataFrameGetDataFrameTransformRequest)
WithHuman makes statistical values human-readable.
func (f DataFrameGetDataFrameTransform) WithPretty() func(*DataFrameGetDataFrameTransformRequest)
WithPretty makes the response body pretty-printed.
func (f DataFrameGetDataFrameTransform) WithSize(v int) func(*DataFrameGetDataFrameTransformRequest)
WithSize - specifies a max number of transforms to get, defaults to 100.
func (f DataFrameGetDataFrameTransform) WithTransformID(v string) func(*DataFrameGetDataFrameTransformRequest)
WithTransformID - the ID or comma delimited list of ID expressions of the transforms to get, '_all' or '*' implies get all transforms.
type DataFrameGetDataFrameTransformRequest struct {
TransformID string
AllowNoMatch *bool
From *int
Size *int
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}DataFrameGetDataFrameTransformRequest configures the Data Frame Get Data Frame Transform API request.
func (r DataFrameGetDataFrameTransformRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type DataFrameGetDataFrameTransformStats func(o ...func(*DataFrameGetDataFrameTransformStatsRequest)) (*Response, error)
DataFrameGetDataFrameTransformStats - https://www.elastic.co/guide/en/elasticsearch/reference/current/get-data-frame-transform-stats.html
func (f DataFrameGetDataFrameTransformStats) WithAllowNoMatch(v bool) func(*DataFrameGetDataFrameTransformStatsRequest)
WithAllowNoMatch - whether to ignore if a wildcard expression matches no data frame transforms. (this includes `_all` string or when no data frame transforms have been specified).
func (f DataFrameGetDataFrameTransformStats) WithContext(v context.Context) func(*DataFrameGetDataFrameTransformStatsRequest)
WithContext sets the request context.
func (f DataFrameGetDataFrameTransformStats) WithErrorTrace() func(*DataFrameGetDataFrameTransformStatsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f DataFrameGetDataFrameTransformStats) WithFilterPath(v ...string) func(*DataFrameGetDataFrameTransformStatsRequest)
WithFilterPath filters the properties of the response body.
func (f DataFrameGetDataFrameTransformStats) WithFrom(v int) func(*DataFrameGetDataFrameTransformStatsRequest)
WithFrom - skips a number of transform stats, defaults to 0.
func (f DataFrameGetDataFrameTransformStats) WithHeader(h map[string]string) func(*DataFrameGetDataFrameTransformStatsRequest)
WithHeader adds the headers to the HTTP request.
func (f DataFrameGetDataFrameTransformStats) WithHuman() func(*DataFrameGetDataFrameTransformStatsRequest)
WithHuman makes statistical values human-readable.
func (f DataFrameGetDataFrameTransformStats) WithPretty() func(*DataFrameGetDataFrameTransformStatsRequest)
WithPretty makes the response body pretty-printed.
func (f DataFrameGetDataFrameTransformStats) WithSize(v int) func(*DataFrameGetDataFrameTransformStatsRequest)
WithSize - specifies a max number of transform stats to get, defaults to 100.
func (f DataFrameGetDataFrameTransformStats) WithTransformID(v string) func(*DataFrameGetDataFrameTransformStatsRequest)
WithTransformID - the ID of the transform for which to get stats. '_all' or '*' implies all transforms.
type DataFrameGetDataFrameTransformStatsRequest struct {
TransformID string
AllowNoMatch *bool
From *int
Size *int
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}DataFrameGetDataFrameTransformStatsRequest configures the Data Frame Get Data Frame Transform Stats API request.
func (r DataFrameGetDataFrameTransformStatsRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type DataFramePreviewDataFrameTransform func(body io.Reader, o ...func(*DataFramePreviewDataFrameTransformRequest)) (*Response, error)
DataFramePreviewDataFrameTransform - https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-data-frame-transform.html
func (f DataFramePreviewDataFrameTransform) WithContext(v context.Context) func(*DataFramePreviewDataFrameTransformRequest)
WithContext sets the request context.
func (f DataFramePreviewDataFrameTransform) WithErrorTrace() func(*DataFramePreviewDataFrameTransformRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f DataFramePreviewDataFrameTransform) WithFilterPath(v ...string) func(*DataFramePreviewDataFrameTransformRequest)
WithFilterPath filters the properties of the response body.
func (f DataFramePreviewDataFrameTransform) WithHeader(h map[string]string) func(*DataFramePreviewDataFrameTransformRequest)
WithHeader adds the headers to the HTTP request.
func (f DataFramePreviewDataFrameTransform) WithHuman() func(*DataFramePreviewDataFrameTransformRequest)
WithHuman makes statistical values human-readable.
func (f DataFramePreviewDataFrameTransform) WithPretty() func(*DataFramePreviewDataFrameTransformRequest)
WithPretty makes the response body pretty-printed.
type DataFramePreviewDataFrameTransformRequest struct {
Body io.Reader
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}DataFramePreviewDataFrameTransformRequest configures the Data Frame Preview Data Frame Transform API request.
func (r DataFramePreviewDataFrameTransformRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type DataFramePutDataFrameTransform func(body io.Reader, transform_id string, o ...func(*DataFramePutDataFrameTransformRequest)) (*Response, error)
DataFramePutDataFrameTransform - https://www.elastic.co/guide/en/elasticsearch/reference/current/put-data-frame-transform.html
func (f DataFramePutDataFrameTransform) WithContext(v context.Context) func(*DataFramePutDataFrameTransformRequest)
WithContext sets the request context.
func (f DataFramePutDataFrameTransform) WithDeferValidation(v bool) func(*DataFramePutDataFrameTransformRequest)
WithDeferValidation - if validations should be deferred until data frame transform starts, defaults to false..
func (f DataFramePutDataFrameTransform) WithErrorTrace() func(*DataFramePutDataFrameTransformRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f DataFramePutDataFrameTransform) WithFilterPath(v ...string) func(*DataFramePutDataFrameTransformRequest)
WithFilterPath filters the properties of the response body.
func (f DataFramePutDataFrameTransform) WithHeader(h map[string]string) func(*DataFramePutDataFrameTransformRequest)
WithHeader adds the headers to the HTTP request.
func (f DataFramePutDataFrameTransform) WithHuman() func(*DataFramePutDataFrameTransformRequest)
WithHuman makes statistical values human-readable.
func (f DataFramePutDataFrameTransform) WithPretty() func(*DataFramePutDataFrameTransformRequest)
WithPretty makes the response body pretty-printed.
type DataFramePutDataFrameTransformRequest struct {
Body io.Reader
TransformID string
DeferValidation *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}DataFramePutDataFrameTransformRequest configures the Data Frame Put Data Frame Transform API request.
func (r DataFramePutDataFrameTransformRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type DataFrameStartDataFrameTransform func(transform_id string, o ...func(*DataFrameStartDataFrameTransformRequest)) (*Response, error)
DataFrameStartDataFrameTransform - https://www.elastic.co/guide/en/elasticsearch/reference/current/start-data-frame-transform.html
func (f DataFrameStartDataFrameTransform) WithContext(v context.Context) func(*DataFrameStartDataFrameTransformRequest)
WithContext sets the request context.
func (f DataFrameStartDataFrameTransform) WithErrorTrace() func(*DataFrameStartDataFrameTransformRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f DataFrameStartDataFrameTransform) WithFilterPath(v ...string) func(*DataFrameStartDataFrameTransformRequest)
WithFilterPath filters the properties of the response body.
func (f DataFrameStartDataFrameTransform) WithHeader(h map[string]string) func(*DataFrameStartDataFrameTransformRequest)
WithHeader adds the headers to the HTTP request.
func (f DataFrameStartDataFrameTransform) WithHuman() func(*DataFrameStartDataFrameTransformRequest)
WithHuman makes statistical values human-readable.
func (f DataFrameStartDataFrameTransform) WithPretty() func(*DataFrameStartDataFrameTransformRequest)
WithPretty makes the response body pretty-printed.
func (f DataFrameStartDataFrameTransform) WithTimeout(v time.Duration) func(*DataFrameStartDataFrameTransformRequest)
WithTimeout - controls the time to wait for the transform to start.
type DataFrameStartDataFrameTransformRequest struct {
TransformID string
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}DataFrameStartDataFrameTransformRequest configures the Data Frame Start Data Frame Transform API request.
func (r DataFrameStartDataFrameTransformRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type DataFrameStopDataFrameTransform func(transform_id string, o ...func(*DataFrameStopDataFrameTransformRequest)) (*Response, error)
DataFrameStopDataFrameTransform - https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-data-frame-transform.html
func (f DataFrameStopDataFrameTransform) WithAllowNoMatch(v bool) func(*DataFrameStopDataFrameTransformRequest)
WithAllowNoMatch - whether to ignore if a wildcard expression matches no data frame transforms. (this includes `_all` string or when no data frame transforms have been specified).
func (f DataFrameStopDataFrameTransform) WithContext(v context.Context) func(*DataFrameStopDataFrameTransformRequest)
WithContext sets the request context.
func (f DataFrameStopDataFrameTransform) WithErrorTrace() func(*DataFrameStopDataFrameTransformRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f DataFrameStopDataFrameTransform) WithFilterPath(v ...string) func(*DataFrameStopDataFrameTransformRequest)
WithFilterPath filters the properties of the response body.
func (f DataFrameStopDataFrameTransform) WithHeader(h map[string]string) func(*DataFrameStopDataFrameTransformRequest)
WithHeader adds the headers to the HTTP request.
func (f DataFrameStopDataFrameTransform) WithHuman() func(*DataFrameStopDataFrameTransformRequest)
WithHuman makes statistical values human-readable.
func (f DataFrameStopDataFrameTransform) WithPretty() func(*DataFrameStopDataFrameTransformRequest)
WithPretty makes the response body pretty-printed.
func (f DataFrameStopDataFrameTransform) WithTimeout(v time.Duration) func(*DataFrameStopDataFrameTransformRequest)
WithTimeout - controls the time to wait until the transform has stopped. default to 30 seconds.
func (f DataFrameStopDataFrameTransform) WithWaitForCompletion(v bool) func(*DataFrameStopDataFrameTransformRequest)
WithWaitForCompletion - whether to wait for the transform to fully stop before returning or not. default to false.
type DataFrameStopDataFrameTransformRequest struct {
TransformID string
AllowNoMatch *bool
Timeout time.Duration
WaitForCompletion *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}DataFrameStopDataFrameTransformRequest configures the Data Frame Stop Data Frame Transform API request.
func (r DataFrameStopDataFrameTransformRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
Delete removes a document from the index.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html.
func (f Delete) WithContext(v context.Context) func(*DeleteRequest)
WithContext sets the request context.
func (f Delete) WithDocumentType(v string) func(*DeleteRequest)
WithDocumentType - the type of the document.
func (f Delete) WithErrorTrace() func(*DeleteRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Delete) WithFilterPath(v ...string) func(*DeleteRequest)
WithFilterPath filters the properties of the response body.
func (f Delete) WithHeader(h map[string]string) func(*DeleteRequest)
WithHeader adds the headers to the HTTP request.
func (f Delete) WithHuman() func(*DeleteRequest)
WithHuman makes statistical values human-readable.
func (f Delete) WithIfPrimaryTerm(v int) func(*DeleteRequest)
WithIfPrimaryTerm - only perform the delete operation if the last operation that has changed the document has the specified primary term.
func (f Delete) WithIfSeqNo(v int) func(*DeleteRequest)
WithIfSeqNo - only perform the delete operation if the last operation that has changed the document has the specified sequence number.
func (f Delete) WithPretty() func(*DeleteRequest)
WithPretty makes the response body pretty-printed.
func (f Delete) WithRefresh(v string) func(*DeleteRequest)
WithRefresh - if `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes..
func (f Delete) WithRouting(v string) func(*DeleteRequest)
WithRouting - specific routing value.
func (f Delete) WithTimeout(v time.Duration) func(*DeleteRequest)
WithTimeout - explicit operation timeout.
func (f Delete) WithVersion(v int) func(*DeleteRequest)
WithVersion - explicit version number for concurrency control.
func (f Delete) WithVersionType(v string) func(*DeleteRequest)
WithVersionType - specific version type.
func (f Delete) WithWaitForActiveShards(v string) func(*DeleteRequest)
WithWaitForActiveShards - sets the number of shard copies that must be active before proceeding with the delete operation. defaults to 1, meaning the primary shard only. set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).
type DeleteByQuery func(index []string, body io.Reader, o ...func(*DeleteByQueryRequest)) (*Response, error)
DeleteByQuery deletes documents matching the provided query.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html.
func (f DeleteByQuery) WithAllowNoIndices(v bool) func(*DeleteByQueryRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f DeleteByQuery) WithAnalyzeWildcard(v bool) func(*DeleteByQueryRequest)
WithAnalyzeWildcard - specify whether wildcard and prefix queries should be analyzed (default: false).
func (f DeleteByQuery) WithAnalyzer(v string) func(*DeleteByQueryRequest)
WithAnalyzer - the analyzer to use for the query string.
func (f DeleteByQuery) WithConflicts(v string) func(*DeleteByQueryRequest)
WithConflicts - what to do when the delete by query hits version conflicts?.
func (f DeleteByQuery) WithContext(v context.Context) func(*DeleteByQueryRequest)
WithContext sets the request context.
func (f DeleteByQuery) WithDefaultOperator(v string) func(*DeleteByQueryRequest)
WithDefaultOperator - the default operator for query string query (and or or).
func (f DeleteByQuery) WithDf(v string) func(*DeleteByQueryRequest)
WithDf - the field to use as default where no field prefix is given in the query string.
func (f DeleteByQuery) WithErrorTrace() func(*DeleteByQueryRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f DeleteByQuery) WithExpandWildcards(v string) func(*DeleteByQueryRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f DeleteByQuery) WithFilterPath(v ...string) func(*DeleteByQueryRequest)
WithFilterPath filters the properties of the response body.
func (f DeleteByQuery) WithFrom(v int) func(*DeleteByQueryRequest)
WithFrom - starting offset (default: 0).
func (f DeleteByQuery) WithHeader(h map[string]string) func(*DeleteByQueryRequest)
WithHeader adds the headers to the HTTP request.
func (f DeleteByQuery) WithHuman() func(*DeleteByQueryRequest)
WithHuman makes statistical values human-readable.
func (f DeleteByQuery) WithIgnoreUnavailable(v bool) func(*DeleteByQueryRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f DeleteByQuery) WithLenient(v bool) func(*DeleteByQueryRequest)
WithLenient - specify whether format-based query failures (such as providing text to a numeric field) should be ignored.
func (f DeleteByQuery) WithMaxDocs(v int) func(*DeleteByQueryRequest)
WithMaxDocs - maximum number of documents to process (default: all documents).
func (f DeleteByQuery) WithPreference(v string) func(*DeleteByQueryRequest)
WithPreference - specify the node or shard the operation should be performed on (default: random).
func (f DeleteByQuery) WithPretty() func(*DeleteByQueryRequest)
WithPretty makes the response body pretty-printed.
func (f DeleteByQuery) WithQuery(v string) func(*DeleteByQueryRequest)
WithQuery - query in the lucene query string syntax.
func (f DeleteByQuery) WithRefresh(v bool) func(*DeleteByQueryRequest)
WithRefresh - should the effected indexes be refreshed?.
func (f DeleteByQuery) WithRequestCache(v bool) func(*DeleteByQueryRequest)
WithRequestCache - specify if request cache should be used for this request or not, defaults to index level setting.
func (f DeleteByQuery) WithRequestsPerSecond(v int) func(*DeleteByQueryRequest)
WithRequestsPerSecond - the throttle for this request in sub-requests per second. -1 means no throttle..
func (f DeleteByQuery) WithRouting(v ...string) func(*DeleteByQueryRequest)
WithRouting - a list of specific routing values.
func (f DeleteByQuery) WithScroll(v time.Duration) func(*DeleteByQueryRequest)
WithScroll - specify how long a consistent view of the index should be maintained for scrolled search.
func (f DeleteByQuery) WithScrollSize(v int) func(*DeleteByQueryRequest)
WithScrollSize - size on the scroll request powering the delete by query.
func (f DeleteByQuery) WithSearchTimeout(v time.Duration) func(*DeleteByQueryRequest)
WithSearchTimeout - explicit timeout for each search request. defaults to no timeout..
func (f DeleteByQuery) WithSearchType(v string) func(*DeleteByQueryRequest)
WithSearchType - search operation type.
func (f DeleteByQuery) WithSlices(v int) func(*DeleteByQueryRequest)
WithSlices - the number of slices this task should be divided into. defaults to 1 meaning the task isn't sliced into subtasks..
func (f DeleteByQuery) WithSort(v ...string) func(*DeleteByQueryRequest)
WithSort - a list of <field>:<direction> pairs.
func (f DeleteByQuery) WithSource(v ...string) func(*DeleteByQueryRequest)
WithSource - true or false to return the _source field or not, or a list of fields to return.
func (f DeleteByQuery) WithSourceExcludes(v ...string) func(*DeleteByQueryRequest)
WithSourceExcludes - a list of fields to exclude from the returned _source field.
func (f DeleteByQuery) WithSourceIncludes(v ...string) func(*DeleteByQueryRequest)
WithSourceIncludes - a list of fields to extract and return from the _source field.
func (f DeleteByQuery) WithStats(v ...string) func(*DeleteByQueryRequest)
WithStats - specific 'tag' of the request for logging and statistical purposes.
func (f DeleteByQuery) WithTerminateAfter(v int) func(*DeleteByQueryRequest)
WithTerminateAfter - the maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early..
func (f DeleteByQuery) WithTimeout(v time.Duration) func(*DeleteByQueryRequest)
WithTimeout - time each individual bulk request should wait for shards that are unavailable..
func (f DeleteByQuery) WithVersion(v bool) func(*DeleteByQueryRequest)
WithVersion - specify whether to return document version as part of a hit.
func (f DeleteByQuery) WithWaitForActiveShards(v string) func(*DeleteByQueryRequest)
WithWaitForActiveShards - sets the number of shard copies that must be active before proceeding with the delete by query operation. defaults to 1, meaning the primary shard only. set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).
func (f DeleteByQuery) WithWaitForCompletion(v bool) func(*DeleteByQueryRequest)
WithWaitForCompletion - should the request should block until the delete by query is complete..
type DeleteByQueryRequest struct {
Index []string
Body io.Reader
AllowNoIndices *bool
Analyzer string
AnalyzeWildcard *bool
Conflicts string
DefaultOperator string
Df string
ExpandWildcards string
From *int
*bool
Lenient *bool
MaxDocs *int
Preference string
Query string
Refresh *bool
RequestCache *bool
RequestsPerSecond *int
Routing []string
Scroll time.Duration
ScrollSize *int
SearchTimeout time.Duration
SearchType string
Slices *int
Sort []string
Source []string
SourceExcludes []string
SourceIncludes []string
Stats []string
TerminateAfter *int
Timeout time.Duration
Version *bool
WaitForActiveShards string
WaitForCompletion *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}DeleteByQueryRequest configures the Delete By Query API request.
Do executes the request and returns response or error.
type DeleteByQueryRethrottle func(task_id string, requests_per_second *int, o ...func(*DeleteByQueryRethrottleRequest)) (*Response, error)
DeleteByQueryRethrottle changes the number of requests per second for a particular Delete By Query operation.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html.
func (f DeleteByQueryRethrottle) WithContext(v context.Context) func(*DeleteByQueryRethrottleRequest)
WithContext sets the request context.
func (f DeleteByQueryRethrottle) WithErrorTrace() func(*DeleteByQueryRethrottleRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f DeleteByQueryRethrottle) WithFilterPath(v ...string) func(*DeleteByQueryRethrottleRequest)
WithFilterPath filters the properties of the response body.
func (f DeleteByQueryRethrottle) WithHeader(h map[string]string) func(*DeleteByQueryRethrottleRequest)
WithHeader adds the headers to the HTTP request.
func (f DeleteByQueryRethrottle) WithHuman() func(*DeleteByQueryRethrottleRequest)
WithHuman makes statistical values human-readable.
func (f DeleteByQueryRethrottle) WithPretty() func(*DeleteByQueryRethrottleRequest)
WithPretty makes the response body pretty-printed.
func (f DeleteByQueryRethrottle) WithRequestsPerSecond(v int) func(*DeleteByQueryRethrottleRequest)
WithRequestsPerSecond - the throttle to set on this request in floating sub-requests per second. -1 means set no throttle..
type DeleteByQueryRethrottleRequest struct {
TaskID string
RequestsPerSecond *int
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}DeleteByQueryRethrottleRequest configures the Delete By Query Rethrottle API request.
func (r DeleteByQueryRethrottleRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type DeleteRequest struct {
Index string
DocumentType string
DocumentID string
IfPrimaryTerm *int
IfSeqNo *int
Refresh string
Routing string
Timeout time.Duration
Version *int
VersionType string
WaitForActiveShards string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}DeleteRequest configures the Delete API request.
Do executes the request and returns response or error.
type DeleteScript func(id string, o ...func(*DeleteScriptRequest)) (*Response, error)
DeleteScript deletes a script.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html.
func (f DeleteScript) WithContext(v context.Context) func(*DeleteScriptRequest)
WithContext sets the request context.
func (f DeleteScript) WithErrorTrace() func(*DeleteScriptRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f DeleteScript) WithFilterPath(v ...string) func(*DeleteScriptRequest)
WithFilterPath filters the properties of the response body.
func (f DeleteScript) WithHeader(h map[string]string) func(*DeleteScriptRequest)
WithHeader adds the headers to the HTTP request.
func (f DeleteScript) WithHuman() func(*DeleteScriptRequest)
WithHuman makes statistical values human-readable.
func (f DeleteScript) WithMasterTimeout(v time.Duration) func(*DeleteScriptRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f DeleteScript) WithPretty() func(*DeleteScriptRequest)
WithPretty makes the response body pretty-printed.
func (f DeleteScript) WithTimeout(v time.Duration) func(*DeleteScriptRequest)
WithTimeout - explicit operation timeout.
type DeleteScriptRequest struct {
ScriptID string
MasterTimeout time.Duration
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}DeleteScriptRequest configures the Delete Script API request.
Do executes the request and returns response or error.
Exists returns information about whether a document exists in an index.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html.
func (f Exists) WithContext(v context.Context) func(*ExistsRequest)
WithContext sets the request context.
func (f Exists) WithDocumentType(v string) func(*ExistsRequest)
WithDocumentType - the type of the document (use `_all` to fetch the first document matching the ID across all types).
func (f Exists) WithErrorTrace() func(*ExistsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Exists) WithFilterPath(v ...string) func(*ExistsRequest)
WithFilterPath filters the properties of the response body.
func (f Exists) WithHeader(h map[string]string) func(*ExistsRequest)
WithHeader adds the headers to the HTTP request.
func (f Exists) WithHuman() func(*ExistsRequest)
WithHuman makes statistical values human-readable.
func (f Exists) WithPreference(v string) func(*ExistsRequest)
WithPreference - specify the node or shard the operation should be performed on (default: random).
func (f Exists) WithPretty() func(*ExistsRequest)
WithPretty makes the response body pretty-printed.
func (f Exists) WithRealtime(v bool) func(*ExistsRequest)
WithRealtime - specify whether to perform the operation in realtime or search mode.
func (f Exists) WithRefresh(v bool) func(*ExistsRequest)
WithRefresh - refresh the shard containing the document before performing the operation.
func (f Exists) WithRouting(v string) func(*ExistsRequest)
WithRouting - specific routing value.
func (f Exists) WithSource(v ...string) func(*ExistsRequest)
WithSource - true or false to return the _source field or not, or a list of fields to return.
func (f Exists) WithSourceExcludes(v ...string) func(*ExistsRequest)
WithSourceExcludes - a list of fields to exclude from the returned _source field.
func (f Exists) WithSourceIncludes(v ...string) func(*ExistsRequest)
WithSourceIncludes - a list of fields to extract and return from the _source field.
func (f Exists) WithStoredFields(v ...string) func(*ExistsRequest)
WithStoredFields - a list of stored fields to return in the response.
func (f Exists) WithVersion(v int) func(*ExistsRequest)
WithVersion - explicit version number for concurrency control.
func (f Exists) WithVersionType(v string) func(*ExistsRequest)
WithVersionType - specific version type.
type ExistsRequest struct {
Index string
DocumentType string
DocumentID string
Preference string
Realtime *bool
Refresh *bool
Routing string
Source []string
SourceExcludes []string
SourceIncludes []string
StoredFields []string
Version *int
VersionType string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ExistsRequest configures the Exists API request.
Do executes the request and returns response or error.
type ExistsSource func(index string, id string, o ...func(*ExistsSourceRequest)) (*Response, error)
ExistsSource returns information about whether a document source exists in an index.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html.
func (f ExistsSource) WithContext(v context.Context) func(*ExistsSourceRequest)
WithContext sets the request context.
func (f ExistsSource) WithDocumentType(v string) func(*ExistsSourceRequest)
WithDocumentType - the type of the document; deprecated and optional starting with 7.0.
func (f ExistsSource) WithErrorTrace() func(*ExistsSourceRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ExistsSource) WithFilterPath(v ...string) func(*ExistsSourceRequest)
WithFilterPath filters the properties of the response body.
func (f ExistsSource) WithHeader(h map[string]string) func(*ExistsSourceRequest)
WithHeader adds the headers to the HTTP request.
func (f ExistsSource) WithHuman() func(*ExistsSourceRequest)
WithHuman makes statistical values human-readable.
func (f ExistsSource) WithPreference(v string) func(*ExistsSourceRequest)
WithPreference - specify the node or shard the operation should be performed on (default: random).
func (f ExistsSource) WithPretty() func(*ExistsSourceRequest)
WithPretty makes the response body pretty-printed.
func (f ExistsSource) WithRealtime(v bool) func(*ExistsSourceRequest)
WithRealtime - specify whether to perform the operation in realtime or search mode.
func (f ExistsSource) WithRefresh(v bool) func(*ExistsSourceRequest)
WithRefresh - refresh the shard containing the document before performing the operation.
func (f ExistsSource) WithRouting(v string) func(*ExistsSourceRequest)
WithRouting - specific routing value.
func (f ExistsSource) WithSource(v ...string) func(*ExistsSourceRequest)
WithSource - true or false to return the _source field or not, or a list of fields to return.
func (f ExistsSource) WithSourceExcludes(v ...string) func(*ExistsSourceRequest)
WithSourceExcludes - a list of fields to exclude from the returned _source field.
func (f ExistsSource) WithSourceIncludes(v ...string) func(*ExistsSourceRequest)
WithSourceIncludes - a list of fields to extract and return from the _source field.
func (f ExistsSource) WithVersion(v int) func(*ExistsSourceRequest)
WithVersion - explicit version number for concurrency control.
func (f ExistsSource) WithVersionType(v string) func(*ExistsSourceRequest)
WithVersionType - specific version type.
type ExistsSourceRequest struct {
Index string
DocumentType string
DocumentID string
Preference string
Realtime *bool
Refresh *bool
Routing string
Source []string
SourceExcludes []string
SourceIncludes []string
Version *int
VersionType string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ExistsSourceRequest configures the Exists Source API request.
Do executes the request and returns response or error.
Explain returns information about why a specific matches (or doesn't match) a query.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html.
func (f Explain) WithAnalyzeWildcard(v bool) func(*ExplainRequest)
WithAnalyzeWildcard - specify whether wildcards and prefix queries in the query string query should be analyzed (default: false).
func (f Explain) WithAnalyzer(v string) func(*ExplainRequest)
WithAnalyzer - the analyzer for the query string query.
func (f Explain) WithBody(v io.Reader) func(*ExplainRequest)
WithBody - The query definition using the Query DSL.
func (f Explain) WithContext(v context.Context) func(*ExplainRequest)
WithContext sets the request context.
func (f Explain) WithDefaultOperator(v string) func(*ExplainRequest)
WithDefaultOperator - the default operator for query string query (and or or).
func (f Explain) WithDf(v string) func(*ExplainRequest)
WithDf - the default field for query string query (default: _all).
func (f Explain) WithDocumentType(v string) func(*ExplainRequest)
WithDocumentType - the type of the document.
func (f Explain) WithErrorTrace() func(*ExplainRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Explain) WithFilterPath(v ...string) func(*ExplainRequest)
WithFilterPath filters the properties of the response body.
func (f Explain) WithHeader(h map[string]string) func(*ExplainRequest)
WithHeader adds the headers to the HTTP request.
func (f Explain) WithHuman() func(*ExplainRequest)
WithHuman makes statistical values human-readable.
func (f Explain) WithLenient(v bool) func(*ExplainRequest)
WithLenient - specify whether format-based query failures (such as providing text to a numeric field) should be ignored.
func (f Explain) WithPreference(v string) func(*ExplainRequest)
WithPreference - specify the node or shard the operation should be performed on (default: random).
func (f Explain) WithPretty() func(*ExplainRequest)
WithPretty makes the response body pretty-printed.
func (f Explain) WithQuery(v string) func(*ExplainRequest)
WithQuery - query in the lucene query string syntax.
func (f Explain) WithRouting(v string) func(*ExplainRequest)
WithRouting - specific routing value.
func (f Explain) WithSource(v ...string) func(*ExplainRequest)
WithSource - true or false to return the _source field or not, or a list of fields to return.
func (f Explain) WithSourceExcludes(v ...string) func(*ExplainRequest)
WithSourceExcludes - a list of fields to exclude from the returned _source field.
func (f Explain) WithSourceIncludes(v ...string) func(*ExplainRequest)
WithSourceIncludes - a list of fields to extract and return from the _source field.
func (f Explain) WithStoredFields(v ...string) func(*ExplainRequest)
WithStoredFields - a list of stored fields to return in the response.
type ExplainRequest struct {
Index string
DocumentType string
DocumentID string
Body io.Reader
Analyzer string
AnalyzeWildcard *bool
DefaultOperator string
Df string
Lenient *bool
Preference string
Query string
Routing string
Source []string
SourceExcludes []string
SourceIncludes []string
StoredFields []string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ExplainRequest configures the Explain API request.
Do executes the request and returns response or error.
type FieldCaps func(o ...func(*FieldCapsRequest)) (*Response, error)
FieldCaps returns the information about the capabilities of fields among multiple indices.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html.
func (f FieldCaps) WithAllowNoIndices(v bool) func(*FieldCapsRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f FieldCaps) WithContext(v context.Context) func(*FieldCapsRequest)
WithContext sets the request context.
func (f FieldCaps) WithErrorTrace() func(*FieldCapsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f FieldCaps) WithExpandWildcards(v string) func(*FieldCapsRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f FieldCaps) WithFields(v ...string) func(*FieldCapsRequest)
WithFields - a list of field names.
func (f FieldCaps) WithFilterPath(v ...string) func(*FieldCapsRequest)
WithFilterPath filters the properties of the response body.
func (f FieldCaps) WithHeader(h map[string]string) func(*FieldCapsRequest)
WithHeader adds the headers to the HTTP request.
func (f FieldCaps) WithHuman() func(*FieldCapsRequest)
WithHuman makes statistical values human-readable.
func (f FieldCaps) WithIgnoreUnavailable(v bool) func(*FieldCapsRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f FieldCaps) WithIncludeUnmapped(v bool) func(*FieldCapsRequest)
WithIncludeUnmapped - indicates whether unmapped fields should be included in the response..
func (f FieldCaps) WithIndex(v ...string) func(*FieldCapsRequest)
WithIndex - a list of index names; use _all to perform the operation on all indices.
func (f FieldCaps) WithPretty() func(*FieldCapsRequest)
WithPretty makes the response body pretty-printed.
type FieldCapsRequest struct {
Index []string
AllowNoIndices *bool
ExpandWildcards string
Fields []string
*bool
IncludeUnmapped *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}FieldCapsRequest configures the Field Caps API request.
Do executes the request and returns response or error.
Get returns a document.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html.
func (f Get) WithContext(v context.Context) func(*GetRequest)
WithContext sets the request context.
func (f Get) WithDocumentType(v string) func(*GetRequest)
WithDocumentType - the type of the document (use `_all` to fetch the first document matching the ID across all types).
func (f Get) WithErrorTrace() func(*GetRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Get) WithFilterPath(v ...string) func(*GetRequest)
WithFilterPath filters the properties of the response body.
func (f Get) WithHeader(h map[string]string) func(*GetRequest)
WithHeader adds the headers to the HTTP request.
func (f Get) WithHuman() func(*GetRequest)
WithHuman makes statistical values human-readable.
func (f Get) WithPreference(v string) func(*GetRequest)
WithPreference - specify the node or shard the operation should be performed on (default: random).
func (f Get) WithPretty() func(*GetRequest)
WithPretty makes the response body pretty-printed.
func (f Get) WithRealtime(v bool) func(*GetRequest)
WithRealtime - specify whether to perform the operation in realtime or search mode.
func (f Get) WithRefresh(v bool) func(*GetRequest)
WithRefresh - refresh the shard containing the document before performing the operation.
func (f Get) WithRouting(v string) func(*GetRequest)
WithRouting - specific routing value.
func (f Get) WithSource(v ...string) func(*GetRequest)
WithSource - true or false to return the _source field or not, or a list of fields to return.
func (f Get) WithSourceExcludes(v ...string) func(*GetRequest)
WithSourceExcludes - a list of fields to exclude from the returned _source field.
func (f Get) WithSourceIncludes(v ...string) func(*GetRequest)
WithSourceIncludes - a list of fields to extract and return from the _source field.
func (f Get) WithStoredFields(v ...string) func(*GetRequest)
WithStoredFields - a list of stored fields to return in the response.
func (f Get) WithVersion(v int) func(*GetRequest)
WithVersion - explicit version number for concurrency control.
func (f Get) WithVersionType(v string) func(*GetRequest)
WithVersionType - specific version type.
type GetRequest struct {
Index string
DocumentType string
DocumentID string
Preference string
Realtime *bool
Refresh *bool
Routing string
Source []string
SourceExcludes []string
SourceIncludes []string
StoredFields []string
Version *int
VersionType string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}GetRequest configures the Get API request.
Do executes the request and returns response or error.
type GetScript func(id string, o ...func(*GetScriptRequest)) (*Response, error)
GetScript returns a script.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html.
func (f GetScript) WithContext(v context.Context) func(*GetScriptRequest)
WithContext sets the request context.
func (f GetScript) WithErrorTrace() func(*GetScriptRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f GetScript) WithFilterPath(v ...string) func(*GetScriptRequest)
WithFilterPath filters the properties of the response body.
func (f GetScript) WithHeader(h map[string]string) func(*GetScriptRequest)
WithHeader adds the headers to the HTTP request.
func (f GetScript) WithHuman() func(*GetScriptRequest)
WithHuman makes statistical values human-readable.
func (f GetScript) WithMasterTimeout(v time.Duration) func(*GetScriptRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f GetScript) WithPretty() func(*GetScriptRequest)
WithPretty makes the response body pretty-printed.
type GetScriptRequest struct {
ScriptID string
MasterTimeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}GetScriptRequest configures the Get Script API request.
Do executes the request and returns response or error.
GetSource returns the source of a document.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html.
func (f GetSource) WithContext(v context.Context) func(*GetSourceRequest)
WithContext sets the request context.
func (f GetSource) WithDocumentType(v string) func(*GetSourceRequest)
WithDocumentType - the type of the document; deprecated and optional starting with 7.0.
func (f GetSource) WithErrorTrace() func(*GetSourceRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f GetSource) WithFilterPath(v ...string) func(*GetSourceRequest)
WithFilterPath filters the properties of the response body.
func (f GetSource) WithHeader(h map[string]string) func(*GetSourceRequest)
WithHeader adds the headers to the HTTP request.
func (f GetSource) WithHuman() func(*GetSourceRequest)
WithHuman makes statistical values human-readable.
func (f GetSource) WithPreference(v string) func(*GetSourceRequest)
WithPreference - specify the node or shard the operation should be performed on (default: random).
func (f GetSource) WithPretty() func(*GetSourceRequest)
WithPretty makes the response body pretty-printed.
func (f GetSource) WithRealtime(v bool) func(*GetSourceRequest)
WithRealtime - specify whether to perform the operation in realtime or search mode.
func (f GetSource) WithRefresh(v bool) func(*GetSourceRequest)
WithRefresh - refresh the shard containing the document before performing the operation.
func (f GetSource) WithRouting(v string) func(*GetSourceRequest)
WithRouting - specific routing value.
func (f GetSource) WithSource(v ...string) func(*GetSourceRequest)
WithSource - true or false to return the _source field or not, or a list of fields to return.
func (f GetSource) WithSourceExcludes(v ...string) func(*GetSourceRequest)
WithSourceExcludes - a list of fields to exclude from the returned _source field.
func (f GetSource) WithSourceIncludes(v ...string) func(*GetSourceRequest)
WithSourceIncludes - a list of fields to extract and return from the _source field.
func (f GetSource) WithVersion(v int) func(*GetSourceRequest)
WithVersion - explicit version number for concurrency control.
func (f GetSource) WithVersionType(v string) func(*GetSourceRequest)
WithVersionType - specific version type.
type GetSourceRequest struct {
Index string
DocumentType string
DocumentID string
Preference string
Realtime *bool
Refresh *bool
Routing string
Source []string
SourceExcludes []string
SourceIncludes []string
Version *int
VersionType string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}GetSourceRequest configures the Get Source API request.
Do executes the request and returns response or error.
type GraphExplore func(o ...func(*GraphExploreRequest)) (*Response, error)
GraphExplore - https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html
func (f GraphExplore) WithBody(v io.Reader) func(*GraphExploreRequest)
WithBody - Graph Query DSL.
func (f GraphExplore) WithContext(v context.Context) func(*GraphExploreRequest)
WithContext sets the request context.
func (f GraphExplore) WithDocumentType(v ...string) func(*GraphExploreRequest)
WithDocumentType - a list of document types to search; leave empty to perform the operation on all types.
func (f GraphExplore) WithErrorTrace() func(*GraphExploreRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f GraphExplore) WithFilterPath(v ...string) func(*GraphExploreRequest)
WithFilterPath filters the properties of the response body.
func (f GraphExplore) WithHeader(h map[string]string) func(*GraphExploreRequest)
WithHeader adds the headers to the HTTP request.
func (f GraphExplore) WithHuman() func(*GraphExploreRequest)
WithHuman makes statistical values human-readable.
func (f GraphExplore) WithIndex(v ...string) func(*GraphExploreRequest)
WithIndex - a list of index names to search; use _all to perform the operation on all indices.
func (f GraphExplore) WithPretty() func(*GraphExploreRequest)
WithPretty makes the response body pretty-printed.
func (f GraphExplore) WithRouting(v string) func(*GraphExploreRequest)
WithRouting - specific routing value.
func (f GraphExplore) WithTimeout(v time.Duration) func(*GraphExploreRequest)
WithTimeout - explicit operation timeout.
type GraphExploreRequest struct {
Index []string
DocumentType []string
Body io.Reader
Routing string
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}GraphExploreRequest configures the Graph Explore API request.
Do executes the request and returns response or error.
type ILM struct {
DeleteLifecycle ILMDeleteLifecycle
ExplainLifecycle ILMExplainLifecycle
GetLifecycle ILMGetLifecycle
GetStatus ILMGetStatus
MoveToStep ILMMoveToStep
PutLifecycle ILMPutLifecycle
RemovePolicy ILMRemovePolicy
Retry ILMRetry
Start ILMStart
Stop ILMStop
}ILM contains the ILM APIs
type ILMDeleteLifecycle func(o ...func(*ILMDeleteLifecycleRequest)) (*Response, error)
ILMDeleteLifecycle - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html
func (f ILMDeleteLifecycle) WithContext(v context.Context) func(*ILMDeleteLifecycleRequest)
WithContext sets the request context.
func (f ILMDeleteLifecycle) WithErrorTrace() func(*ILMDeleteLifecycleRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ILMDeleteLifecycle) WithFilterPath(v ...string) func(*ILMDeleteLifecycleRequest)
WithFilterPath filters the properties of the response body.
func (f ILMDeleteLifecycle) WithHeader(h map[string]string) func(*ILMDeleteLifecycleRequest)
WithHeader adds the headers to the HTTP request.
func (f ILMDeleteLifecycle) WithHuman() func(*ILMDeleteLifecycleRequest)
WithHuman makes statistical values human-readable.
func (f ILMDeleteLifecycle) WithPolicy(v string) func(*ILMDeleteLifecycleRequest)
WithPolicy - the name of the index lifecycle policy.
func (f ILMDeleteLifecycle) WithPretty() func(*ILMDeleteLifecycleRequest)
WithPretty makes the response body pretty-printed.
type ILMDeleteLifecycleRequest struct {
Policy string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ILMDeleteLifecycleRequest configures the ILM Delete Lifecycle API request.
Do executes the request and returns response or error.
type ILMExplainLifecycle func(o ...func(*ILMExplainLifecycleRequest)) (*Response, error)
ILMExplainLifecycle - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html
func (f ILMExplainLifecycle) WithContext(v context.Context) func(*ILMExplainLifecycleRequest)
WithContext sets the request context.
func (f ILMExplainLifecycle) WithErrorTrace() func(*ILMExplainLifecycleRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ILMExplainLifecycle) WithFilterPath(v ...string) func(*ILMExplainLifecycleRequest)
WithFilterPath filters the properties of the response body.
func (f ILMExplainLifecycle) WithHeader(h map[string]string) func(*ILMExplainLifecycleRequest)
WithHeader adds the headers to the HTTP request.
func (f ILMExplainLifecycle) WithHuman() func(*ILMExplainLifecycleRequest)
WithHuman makes statistical values human-readable.
func (f ILMExplainLifecycle) WithIndex(v string) func(*ILMExplainLifecycleRequest)
WithIndex - the name of the index to explain.
func (f ILMExplainLifecycle) WithOnlyErrors(v bool) func(*ILMExplainLifecycleRequest)
WithOnlyErrors - filters the indices included in the response to ones in an ilm error state, implies only_managed.
func (f ILMExplainLifecycle) WithOnlyManaged(v bool) func(*ILMExplainLifecycleRequest)
WithOnlyManaged - filters the indices included in the response to ones managed by ilm.
func (f ILMExplainLifecycle) WithPretty() func(*ILMExplainLifecycleRequest)
WithPretty makes the response body pretty-printed.
type ILMExplainLifecycleRequest struct {
Index string
OnlyErrors *bool
OnlyManaged *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ILMExplainLifecycleRequest configures the ILM Explain Lifecycle API request.
func (r ILMExplainLifecycleRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type ILMGetLifecycle func(o ...func(*ILMGetLifecycleRequest)) (*Response, error)
ILMGetLifecycle - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html
func (f ILMGetLifecycle) WithContext(v context.Context) func(*ILMGetLifecycleRequest)
WithContext sets the request context.
func (f ILMGetLifecycle) WithErrorTrace() func(*ILMGetLifecycleRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ILMGetLifecycle) WithFilterPath(v ...string) func(*ILMGetLifecycleRequest)
WithFilterPath filters the properties of the response body.
func (f ILMGetLifecycle) WithHeader(h map[string]string) func(*ILMGetLifecycleRequest)
WithHeader adds the headers to the HTTP request.
func (f ILMGetLifecycle) WithHuman() func(*ILMGetLifecycleRequest)
WithHuman makes statistical values human-readable.
func (f ILMGetLifecycle) WithPolicy(v string) func(*ILMGetLifecycleRequest)
WithPolicy - the name of the index lifecycle policy.
func (f ILMGetLifecycle) WithPretty() func(*ILMGetLifecycleRequest)
WithPretty makes the response body pretty-printed.
type ILMGetLifecycleRequest struct {
Policy string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ILMGetLifecycleRequest configures the ILM Get Lifecycle API request.
Do executes the request and returns response or error.
type ILMGetStatus func(o ...func(*ILMGetStatusRequest)) (*Response, error)
ILMGetStatus - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html
func (f ILMGetStatus) WithContext(v context.Context) func(*ILMGetStatusRequest)
WithContext sets the request context.
func (f ILMGetStatus) WithErrorTrace() func(*ILMGetStatusRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ILMGetStatus) WithFilterPath(v ...string) func(*ILMGetStatusRequest)
WithFilterPath filters the properties of the response body.
func (f ILMGetStatus) WithHeader(h map[string]string) func(*ILMGetStatusRequest)
WithHeader adds the headers to the HTTP request.
func (f ILMGetStatus) WithHuman() func(*ILMGetStatusRequest)
WithHuman makes statistical values human-readable.
func (f ILMGetStatus) WithPretty() func(*ILMGetStatusRequest)
WithPretty makes the response body pretty-printed.
type ILMGetStatusRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ILMGetStatusRequest configures the ILM Get Status API request.
Do executes the request and returns response or error.
type ILMMoveToStep func(o ...func(*ILMMoveToStepRequest)) (*Response, error)
ILMMoveToStep - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html
func (f ILMMoveToStep) WithBody(v io.Reader) func(*ILMMoveToStepRequest)
WithBody - The new lifecycle step to move to.
func (f ILMMoveToStep) WithContext(v context.Context) func(*ILMMoveToStepRequest)
WithContext sets the request context.
func (f ILMMoveToStep) WithErrorTrace() func(*ILMMoveToStepRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ILMMoveToStep) WithFilterPath(v ...string) func(*ILMMoveToStepRequest)
WithFilterPath filters the properties of the response body.
func (f ILMMoveToStep) WithHeader(h map[string]string) func(*ILMMoveToStepRequest)
WithHeader adds the headers to the HTTP request.
func (f ILMMoveToStep) WithHuman() func(*ILMMoveToStepRequest)
WithHuman makes statistical values human-readable.
func (f ILMMoveToStep) WithIndex(v string) func(*ILMMoveToStepRequest)
WithIndex - the name of the index whose lifecycle step is to change.
func (f ILMMoveToStep) WithPretty() func(*ILMMoveToStepRequest)
WithPretty makes the response body pretty-printed.
type ILMMoveToStepRequest struct {
Index string
Body io.Reader
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ILMMoveToStepRequest configures the ILM Move To Step API request.
Do executes the request and returns response or error.
type ILMPutLifecycle func(o ...func(*ILMPutLifecycleRequest)) (*Response, error)
ILMPutLifecycle - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html
func (f ILMPutLifecycle) WithBody(v io.Reader) func(*ILMPutLifecycleRequest)
WithBody - The lifecycle policy definition to register.
func (f ILMPutLifecycle) WithContext(v context.Context) func(*ILMPutLifecycleRequest)
WithContext sets the request context.
func (f ILMPutLifecycle) WithErrorTrace() func(*ILMPutLifecycleRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ILMPutLifecycle) WithFilterPath(v ...string) func(*ILMPutLifecycleRequest)
WithFilterPath filters the properties of the response body.
func (f ILMPutLifecycle) WithHeader(h map[string]string) func(*ILMPutLifecycleRequest)
WithHeader adds the headers to the HTTP request.
func (f ILMPutLifecycle) WithHuman() func(*ILMPutLifecycleRequest)
WithHuman makes statistical values human-readable.
func (f ILMPutLifecycle) WithPolicy(v string) func(*ILMPutLifecycleRequest)
WithPolicy - the name of the index lifecycle policy.
func (f ILMPutLifecycle) WithPretty() func(*ILMPutLifecycleRequest)
WithPretty makes the response body pretty-printed.
type ILMPutLifecycleRequest struct {
Body io.Reader
Policy string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ILMPutLifecycleRequest configures the ILM Put Lifecycle API request.
Do executes the request and returns response or error.
type ILMRemovePolicy func(o ...func(*ILMRemovePolicyRequest)) (*Response, error)
ILMRemovePolicy - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html
func (f ILMRemovePolicy) WithContext(v context.Context) func(*ILMRemovePolicyRequest)
WithContext sets the request context.
func (f ILMRemovePolicy) WithErrorTrace() func(*ILMRemovePolicyRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ILMRemovePolicy) WithFilterPath(v ...string) func(*ILMRemovePolicyRequest)
WithFilterPath filters the properties of the response body.
func (f ILMRemovePolicy) WithHeader(h map[string]string) func(*ILMRemovePolicyRequest)
WithHeader adds the headers to the HTTP request.
func (f ILMRemovePolicy) WithHuman() func(*ILMRemovePolicyRequest)
WithHuman makes statistical values human-readable.
func (f ILMRemovePolicy) WithIndex(v string) func(*ILMRemovePolicyRequest)
WithIndex - the name of the index to remove policy on.
func (f ILMRemovePolicy) WithPretty() func(*ILMRemovePolicyRequest)
WithPretty makes the response body pretty-printed.
type ILMRemovePolicyRequest struct {
Index string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ILMRemovePolicyRequest configures the ILM Remove Policy API request.
Do executes the request and returns response or error.
type ILMRetry func(o ...func(*ILMRetryRequest)) (*Response, error)
ILMRetry - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html
func (f ILMRetry) WithContext(v context.Context) func(*ILMRetryRequest)
WithContext sets the request context.
func (f ILMRetry) WithErrorTrace() func(*ILMRetryRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ILMRetry) WithFilterPath(v ...string) func(*ILMRetryRequest)
WithFilterPath filters the properties of the response body.
func (f ILMRetry) WithHeader(h map[string]string) func(*ILMRetryRequest)
WithHeader adds the headers to the HTTP request.
func (f ILMRetry) WithHuman() func(*ILMRetryRequest)
WithHuman makes statistical values human-readable.
func (f ILMRetry) WithIndex(v string) func(*ILMRetryRequest)
WithIndex - the name of the indices (comma-separated) whose failed lifecycle step is to be retry.
func (f ILMRetry) WithPretty() func(*ILMRetryRequest)
WithPretty makes the response body pretty-printed.
type ILMRetryRequest struct {
Index string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ILMRetryRequest configures the ILM Retry API request.
Do executes the request and returns response or error.
type ILMStart func(o ...func(*ILMStartRequest)) (*Response, error)
ILMStart - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html
func (f ILMStart) WithContext(v context.Context) func(*ILMStartRequest)
WithContext sets the request context.
func (f ILMStart) WithErrorTrace() func(*ILMStartRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ILMStart) WithFilterPath(v ...string) func(*ILMStartRequest)
WithFilterPath filters the properties of the response body.
func (f ILMStart) WithHeader(h map[string]string) func(*ILMStartRequest)
WithHeader adds the headers to the HTTP request.
func (f ILMStart) WithHuman() func(*ILMStartRequest)
WithHuman makes statistical values human-readable.
func (f ILMStart) WithPretty() func(*ILMStartRequest)
WithPretty makes the response body pretty-printed.
type ILMStartRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ILMStartRequest configures the ILM Start API request.
Do executes the request and returns response or error.
type ILMStop func(o ...func(*ILMStopRequest)) (*Response, error)
ILMStop - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html
func (f ILMStop) WithContext(v context.Context) func(*ILMStopRequest)
WithContext sets the request context.
func (f ILMStop) WithErrorTrace() func(*ILMStopRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ILMStop) WithFilterPath(v ...string) func(*ILMStopRequest)
WithFilterPath filters the properties of the response body.
func (f ILMStop) WithHeader(h map[string]string) func(*ILMStopRequest)
WithHeader adds the headers to the HTTP request.
func (f ILMStop) WithHuman() func(*ILMStopRequest)
WithHuman makes statistical values human-readable.
func (f ILMStop) WithPretty() func(*ILMStopRequest)
WithPretty makes the response body pretty-printed.
type ILMStopRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ILMStopRequest configures the ILM Stop API request.
Do executes the request and returns response or error.
Index creates or updates a document in an index.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html.
func (f Index) WithContext(v context.Context) func(*IndexRequest)
WithContext sets the request context.
func (f Index) WithDocumentID(v string) func(*IndexRequest)
WithDocumentID - document ID.
func (f Index) WithDocumentType(v string) func(*IndexRequest)
WithDocumentType - the type of the document.
func (f Index) WithErrorTrace() func(*IndexRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Index) WithFilterPath(v ...string) func(*IndexRequest)
WithFilterPath filters the properties of the response body.
func (f Index) WithHeader(h map[string]string) func(*IndexRequest)
WithHeader adds the headers to the HTTP request.
func (f Index) WithHuman() func(*IndexRequest)
WithHuman makes statistical values human-readable.
func (f Index) WithIfPrimaryTerm(v int) func(*IndexRequest)
WithIfPrimaryTerm - only perform the index operation if the last operation that has changed the document has the specified primary term.
func (f Index) WithIfSeqNo(v int) func(*IndexRequest)
WithIfSeqNo - only perform the index operation if the last operation that has changed the document has the specified sequence number.
func (f Index) WithOpType(v string) func(*IndexRequest)
WithOpType - explicit operation type.
func (f Index) WithPipeline(v string) func(*IndexRequest)
WithPipeline - the pipeline ID to preprocess incoming documents with.
func (f Index) WithPretty() func(*IndexRequest)
WithPretty makes the response body pretty-printed.
func (f Index) WithRefresh(v string) func(*IndexRequest)
WithRefresh - if `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes..
func (f Index) WithRouting(v string) func(*IndexRequest)
WithRouting - specific routing value.
func (f Index) WithTimeout(v time.Duration) func(*IndexRequest)
WithTimeout - explicit operation timeout.
func (f Index) WithVersion(v int) func(*IndexRequest)
WithVersion - explicit version number for concurrency control.
func (f Index) WithVersionType(v string) func(*IndexRequest)
WithVersionType - specific version type.
func (f Index) WithWaitForActiveShards(v string) func(*IndexRequest)
WithWaitForActiveShards - sets the number of shard copies that must be active before proceeding with the index operation. defaults to 1, meaning the primary shard only. set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).
type IndexRequest struct {
Index string
DocumentType string
DocumentID string
Body io.Reader
IfPrimaryTerm *int
IfSeqNo *int
OpType string
Pipeline string
Refresh string
Routing string
Timeout time.Duration
Version *int
VersionType string
WaitForActiveShards string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndexRequest configures the Index API request.
Do executes the request and returns response or error.
type Indices struct {
Analyze IndicesAnalyze
ClearCache IndicesClearCache
Clone IndicesClone
Close IndicesClose
Create IndicesCreate
DeleteAlias IndicesDeleteAlias
Delete IndicesDelete
DeleteTemplate IndicesDeleteTemplate
ExistsAlias IndicesExistsAlias
ExistsDocumentType IndicesExistsDocumentType
Exists IndicesExists
ExistsTemplate IndicesExistsTemplate
Flush IndicesFlush
FlushSynced IndicesFlushSynced
Forcemerge IndicesForcemerge
Freeze IndicesFreeze
GetAlias IndicesGetAlias
GetFieldMapping IndicesGetFieldMapping
GetMapping IndicesGetMapping
Get IndicesGet
GetSettings IndicesGetSettings
GetTemplate IndicesGetTemplate
GetUpgrade IndicesGetUpgrade
Open IndicesOpen
PutAlias IndicesPutAlias
PutMapping IndicesPutMapping
PutSettings IndicesPutSettings
PutTemplate IndicesPutTemplate
Recovery IndicesRecovery
Refresh IndicesRefresh
ReloadSearchAnalyzers IndicesReloadSearchAnalyzers
Rollover IndicesRollover
Segments IndicesSegments
ShardStores IndicesShardStores
Shrink IndicesShrink
Split IndicesSplit
Stats IndicesStats
Unfreeze IndicesUnfreeze
UpdateAliases IndicesUpdateAliases
Upgrade IndicesUpgrade
ValidateQuery IndicesValidateQuery
}Indices contains the Indices APIs
type IndicesAnalyze func(o ...func(*IndicesAnalyzeRequest)) (*Response, error)
IndicesAnalyze performs the analysis process on a text and return the tokens breakdown of the text.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html.
func (f IndicesAnalyze) WithBody(v io.Reader) func(*IndicesAnalyzeRequest)
WithBody - Define analyzer/tokenizer parameters and the text on which the analysis should be performed.
func (f IndicesAnalyze) WithContext(v context.Context) func(*IndicesAnalyzeRequest)
WithContext sets the request context.
func (f IndicesAnalyze) WithErrorTrace() func(*IndicesAnalyzeRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesAnalyze) WithFilterPath(v ...string) func(*IndicesAnalyzeRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesAnalyze) WithHeader(h map[string]string) func(*IndicesAnalyzeRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesAnalyze) WithHuman() func(*IndicesAnalyzeRequest)
WithHuman makes statistical values human-readable.
func (f IndicesAnalyze) WithIndex(v string) func(*IndicesAnalyzeRequest)
WithIndex - the name of the index to scope the operation.
func (f IndicesAnalyze) WithPretty() func(*IndicesAnalyzeRequest)
WithPretty makes the response body pretty-printed.
type IndicesAnalyzeRequest struct {
Index string
Body io.Reader
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesAnalyzeRequest configures the Indices Analyze API request.
Do executes the request and returns response or error.
type IndicesClearCache func(o ...func(*IndicesClearCacheRequest)) (*Response, error)
IndicesClearCache clears all or specific caches for one or more indices.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html.
func (f IndicesClearCache) WithAllowNoIndices(v bool) func(*IndicesClearCacheRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesClearCache) WithContext(v context.Context) func(*IndicesClearCacheRequest)
WithContext sets the request context.
func (f IndicesClearCache) WithErrorTrace() func(*IndicesClearCacheRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesClearCache) WithExpandWildcards(v string) func(*IndicesClearCacheRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesClearCache) WithFielddata(v bool) func(*IndicesClearCacheRequest)
WithFielddata - clear field data.
func (f IndicesClearCache) WithFields(v ...string) func(*IndicesClearCacheRequest)
WithFields - a list of fields to clear when using the `fielddata` parameter (default: all).
func (f IndicesClearCache) WithFilterPath(v ...string) func(*IndicesClearCacheRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesClearCache) WithHeader(h map[string]string) func(*IndicesClearCacheRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesClearCache) WithHuman() func(*IndicesClearCacheRequest)
WithHuman makes statistical values human-readable.
func (f IndicesClearCache) WithIgnoreUnavailable(v bool) func(*IndicesClearCacheRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesClearCache) WithIndex(v ...string) func(*IndicesClearCacheRequest)
WithIndex - a list of index name to limit the operation.
func (f IndicesClearCache) WithPretty() func(*IndicesClearCacheRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesClearCache) WithQuery(v bool) func(*IndicesClearCacheRequest)
WithQuery - clear query caches.
func (f IndicesClearCache) WithRequest(v bool) func(*IndicesClearCacheRequest)
WithRequest - clear request cache.
type IndicesClearCacheRequest struct {
Index []string
AllowNoIndices *bool
ExpandWildcards string
Fielddata *bool
Fields []string
*bool
Query *bool
Request *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesClearCacheRequest configures the Indices Clear Cache API request.
Do executes the request and returns response or error.
type IndicesClone func(index string, target string, o ...func(*IndicesCloneRequest)) (*Response, error)
IndicesClone clones an existing index into a new index.
See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html.
func (f IndicesClone) WithBody(v io.Reader) func(*IndicesCloneRequest)
WithBody - The configuration for the target index (`settings` and `aliases`).
func (f IndicesClone) WithContext(v context.Context) func(*IndicesCloneRequest)
WithContext sets the request context.
func (f IndicesClone) WithErrorTrace() func(*IndicesCloneRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesClone) WithFilterPath(v ...string) func(*IndicesCloneRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesClone) WithHeader(h map[string]string) func(*IndicesCloneRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesClone) WithHuman() func(*IndicesCloneRequest)
WithHuman makes statistical values human-readable.
func (f IndicesClone) WithMasterTimeout(v time.Duration) func(*IndicesCloneRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesClone) WithPretty() func(*IndicesCloneRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesClone) WithTimeout(v time.Duration) func(*IndicesCloneRequest)
WithTimeout - explicit operation timeout.
func (f IndicesClone) WithWaitForActiveShards(v string) func(*IndicesCloneRequest)
WithWaitForActiveShards - set the number of active shards to wait for on the cloned index before the operation returns..
type IndicesCloneRequest struct {
Index string
Body io.Reader
Target string
MasterTimeout time.Duration
Timeout time.Duration
WaitForActiveShards string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesCloneRequest configures the Indices Clone API request.
Do executes the request and returns response or error.
type IndicesClose func(index []string, o ...func(*IndicesCloseRequest)) (*Response, error)
IndicesClose closes an index.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html.
func (f IndicesClose) WithAllowNoIndices(v bool) func(*IndicesCloseRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesClose) WithContext(v context.Context) func(*IndicesCloseRequest)
WithContext sets the request context.
func (f IndicesClose) WithErrorTrace() func(*IndicesCloseRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesClose) WithExpandWildcards(v string) func(*IndicesCloseRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesClose) WithFilterPath(v ...string) func(*IndicesCloseRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesClose) WithHeader(h map[string]string) func(*IndicesCloseRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesClose) WithHuman() func(*IndicesCloseRequest)
WithHuman makes statistical values human-readable.
func (f IndicesClose) WithIgnoreUnavailable(v bool) func(*IndicesCloseRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesClose) WithMasterTimeout(v time.Duration) func(*IndicesCloseRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesClose) WithPretty() func(*IndicesCloseRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesClose) WithTimeout(v time.Duration) func(*IndicesCloseRequest)
WithTimeout - explicit operation timeout.
func (f IndicesClose) WithWaitForActiveShards(v string) func(*IndicesCloseRequest)
WithWaitForActiveShards - sets the number of active shards to wait for before the operation returns..
type IndicesCloseRequest struct {
Index []string
AllowNoIndices *bool
ExpandWildcards string
*bool
MasterTimeout time.Duration
Timeout time.Duration
WaitForActiveShards string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesCloseRequest configures the Indices Close API request.
Do executes the request and returns response or error.
type IndicesCreate func(index string, o ...func(*IndicesCreateRequest)) (*Response, error)
IndicesCreate creates an index with optional settings and mappings.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html.
func (f IndicesCreate) WithBody(v io.Reader) func(*IndicesCreateRequest)
WithBody - The configuration for the index (`settings` and `mappings`).
func (f IndicesCreate) WithContext(v context.Context) func(*IndicesCreateRequest)
WithContext sets the request context.
func (f IndicesCreate) WithErrorTrace() func(*IndicesCreateRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesCreate) WithFilterPath(v ...string) func(*IndicesCreateRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesCreate) WithHeader(h map[string]string) func(*IndicesCreateRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesCreate) WithHuman() func(*IndicesCreateRequest)
WithHuman makes statistical values human-readable.
func (f IndicesCreate) WithIncludeTypeName(v bool) func(*IndicesCreateRequest)
WithIncludeTypeName - whether a type should be expected in the body of the mappings..
func (f IndicesCreate) WithMasterTimeout(v time.Duration) func(*IndicesCreateRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesCreate) WithPretty() func(*IndicesCreateRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesCreate) WithTimeout(v time.Duration) func(*IndicesCreateRequest)
WithTimeout - explicit operation timeout.
func (f IndicesCreate) WithWaitForActiveShards(v string) func(*IndicesCreateRequest)
WithWaitForActiveShards - set the number of active shards to wait for before the operation returns..
type IndicesCreateRequest struct {
Index string
Body io.Reader
IncludeTypeName *bool
MasterTimeout time.Duration
Timeout time.Duration
WaitForActiveShards string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesCreateRequest configures the Indices Create API request.
Do executes the request and returns response or error.
type IndicesDelete func(index []string, o ...func(*IndicesDeleteRequest)) (*Response, error)
IndicesDelete deletes an index.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html.
func (f IndicesDelete) WithAllowNoIndices(v bool) func(*IndicesDeleteRequest)
WithAllowNoIndices - ignore if a wildcard expression resolves to no concrete indices (default: false).
func (f IndicesDelete) WithContext(v context.Context) func(*IndicesDeleteRequest)
WithContext sets the request context.
func (f IndicesDelete) WithErrorTrace() func(*IndicesDeleteRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesDelete) WithExpandWildcards(v string) func(*IndicesDeleteRequest)
WithExpandWildcards - whether wildcard expressions should get expanded to open or closed indices (default: open).
func (f IndicesDelete) WithFilterPath(v ...string) func(*IndicesDeleteRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesDelete) WithHeader(h map[string]string) func(*IndicesDeleteRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesDelete) WithHuman() func(*IndicesDeleteRequest)
WithHuman makes statistical values human-readable.
func (f IndicesDelete) WithIgnoreUnavailable(v bool) func(*IndicesDeleteRequest)
WithIgnoreUnavailable - ignore unavailable indexes (default: false).
func (f IndicesDelete) WithMasterTimeout(v time.Duration) func(*IndicesDeleteRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesDelete) WithPretty() func(*IndicesDeleteRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesDelete) WithTimeout(v time.Duration) func(*IndicesDeleteRequest)
WithTimeout - explicit operation timeout.
type IndicesDeleteAlias func(index []string, name []string, o ...func(*IndicesDeleteAliasRequest)) (*Response, error)
IndicesDeleteAlias deletes an alias.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html.
func (f IndicesDeleteAlias) WithContext(v context.Context) func(*IndicesDeleteAliasRequest)
WithContext sets the request context.
func (f IndicesDeleteAlias) WithErrorTrace() func(*IndicesDeleteAliasRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesDeleteAlias) WithFilterPath(v ...string) func(*IndicesDeleteAliasRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesDeleteAlias) WithHeader(h map[string]string) func(*IndicesDeleteAliasRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesDeleteAlias) WithHuman() func(*IndicesDeleteAliasRequest)
WithHuman makes statistical values human-readable.
func (f IndicesDeleteAlias) WithMasterTimeout(v time.Duration) func(*IndicesDeleteAliasRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesDeleteAlias) WithPretty() func(*IndicesDeleteAliasRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesDeleteAlias) WithTimeout(v time.Duration) func(*IndicesDeleteAliasRequest)
WithTimeout - explicit timestamp for the document.
type IndicesDeleteAliasRequest struct {
Index []string
Name []string
MasterTimeout time.Duration
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesDeleteAliasRequest configures the Indices Delete Alias API request.
Do executes the request and returns response or error.
type IndicesDeleteRequest struct {
Index []string
AllowNoIndices *bool
ExpandWildcards string
*bool
MasterTimeout time.Duration
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesDeleteRequest configures the Indices Delete API request.
Do executes the request and returns response or error.
type IndicesDeleteTemplate func(name string, o ...func(*IndicesDeleteTemplateRequest)) (*Response, error)
IndicesDeleteTemplate deletes an index template.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html.
func (f IndicesDeleteTemplate) WithContext(v context.Context) func(*IndicesDeleteTemplateRequest)
WithContext sets the request context.
func (f IndicesDeleteTemplate) WithErrorTrace() func(*IndicesDeleteTemplateRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesDeleteTemplate) WithFilterPath(v ...string) func(*IndicesDeleteTemplateRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesDeleteTemplate) WithHeader(h map[string]string) func(*IndicesDeleteTemplateRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesDeleteTemplate) WithHuman() func(*IndicesDeleteTemplateRequest)
WithHuman makes statistical values human-readable.
func (f IndicesDeleteTemplate) WithMasterTimeout(v time.Duration) func(*IndicesDeleteTemplateRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesDeleteTemplate) WithPretty() func(*IndicesDeleteTemplateRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesDeleteTemplate) WithTimeout(v time.Duration) func(*IndicesDeleteTemplateRequest)
WithTimeout - explicit operation timeout.
type IndicesDeleteTemplateRequest struct {
Name string
MasterTimeout time.Duration
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesDeleteTemplateRequest configures the Indices Delete Template API request.
func (r IndicesDeleteTemplateRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type IndicesExists func(index []string, o ...func(*IndicesExistsRequest)) (*Response, error)
IndicesExists returns information about whether a particular index exists.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html.
func (f IndicesExists) WithAllowNoIndices(v bool) func(*IndicesExistsRequest)
WithAllowNoIndices - ignore if a wildcard expression resolves to no concrete indices (default: false).
func (f IndicesExists) WithContext(v context.Context) func(*IndicesExistsRequest)
WithContext sets the request context.
func (f IndicesExists) WithErrorTrace() func(*IndicesExistsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesExists) WithExpandWildcards(v string) func(*IndicesExistsRequest)
WithExpandWildcards - whether wildcard expressions should get expanded to open or closed indices (default: open).
func (f IndicesExists) WithFilterPath(v ...string) func(*IndicesExistsRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesExists) WithFlatSettings(v bool) func(*IndicesExistsRequest)
WithFlatSettings - return settings in flat format (default: false).
func (f IndicesExists) WithHeader(h map[string]string) func(*IndicesExistsRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesExists) WithHuman() func(*IndicesExistsRequest)
WithHuman makes statistical values human-readable.
func (f IndicesExists) WithIgnoreUnavailable(v bool) func(*IndicesExistsRequest)
WithIgnoreUnavailable - ignore unavailable indexes (default: false).
func (f IndicesExists) WithIncludeDefaults(v bool) func(*IndicesExistsRequest)
WithIncludeDefaults - whether to return all default setting for each of the indices..
func (f IndicesExists) WithLocal(v bool) func(*IndicesExistsRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f IndicesExists) WithPretty() func(*IndicesExistsRequest)
WithPretty makes the response body pretty-printed.
type IndicesExistsAlias func(name []string, o ...func(*IndicesExistsAliasRequest)) (*Response, error)
IndicesExistsAlias returns information about whether a particular alias exists.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html.
func (f IndicesExistsAlias) WithAllowNoIndices(v bool) func(*IndicesExistsAliasRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesExistsAlias) WithContext(v context.Context) func(*IndicesExistsAliasRequest)
WithContext sets the request context.
func (f IndicesExistsAlias) WithErrorTrace() func(*IndicesExistsAliasRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesExistsAlias) WithExpandWildcards(v string) func(*IndicesExistsAliasRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesExistsAlias) WithFilterPath(v ...string) func(*IndicesExistsAliasRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesExistsAlias) WithHeader(h map[string]string) func(*IndicesExistsAliasRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesExistsAlias) WithHuman() func(*IndicesExistsAliasRequest)
WithHuman makes statistical values human-readable.
func (f IndicesExistsAlias) WithIgnoreUnavailable(v bool) func(*IndicesExistsAliasRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesExistsAlias) WithIndex(v ...string) func(*IndicesExistsAliasRequest)
WithIndex - a list of index names to filter aliases.
func (f IndicesExistsAlias) WithLocal(v bool) func(*IndicesExistsAliasRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f IndicesExistsAlias) WithPretty() func(*IndicesExistsAliasRequest)
WithPretty makes the response body pretty-printed.
type IndicesExistsAliasRequest struct {
Index []string
Name []string
AllowNoIndices *bool
ExpandWildcards string
*bool
Local *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesExistsAliasRequest configures the Indices Exists Alias API request.
Do executes the request and returns response or error.
type IndicesExistsDocumentType func(index []string, o ...func(*IndicesExistsDocumentTypeRequest)) (*Response, error)
IndicesExistsDocumentType returns information about whether a particular document type exists. (DEPRECATED)
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html.
func (f IndicesExistsDocumentType) WithAllowNoIndices(v bool) func(*IndicesExistsDocumentTypeRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesExistsDocumentType) WithContext(v context.Context) func(*IndicesExistsDocumentTypeRequest)
WithContext sets the request context.
func (f IndicesExistsDocumentType) WithDocumentType(v ...string) func(*IndicesExistsDocumentTypeRequest)
WithDocumentType - a list of document types to check.
func (f IndicesExistsDocumentType) WithErrorTrace() func(*IndicesExistsDocumentTypeRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesExistsDocumentType) WithExpandWildcards(v string) func(*IndicesExistsDocumentTypeRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesExistsDocumentType) WithFilterPath(v ...string) func(*IndicesExistsDocumentTypeRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesExistsDocumentType) WithHeader(h map[string]string) func(*IndicesExistsDocumentTypeRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesExistsDocumentType) WithHuman() func(*IndicesExistsDocumentTypeRequest)
WithHuman makes statistical values human-readable.
func (f IndicesExistsDocumentType) WithIgnoreUnavailable(v bool) func(*IndicesExistsDocumentTypeRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesExistsDocumentType) WithLocal(v bool) func(*IndicesExistsDocumentTypeRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f IndicesExistsDocumentType) WithPretty() func(*IndicesExistsDocumentTypeRequest)
WithPretty makes the response body pretty-printed.
type IndicesExistsDocumentTypeRequest struct {
Index []string
DocumentType []string
AllowNoIndices *bool
ExpandWildcards string
*bool
Local *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesExistsDocumentTypeRequest configures the Indices Exists Document Type API request.
func (r IndicesExistsDocumentTypeRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type IndicesExistsRequest struct {
Index []string
AllowNoIndices *bool
ExpandWildcards string
FlatSettings *bool
*bool
IncludeDefaults *bool
Local *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesExistsRequest configures the Indices Exists API request.
Do executes the request and returns response or error.
type IndicesExistsTemplate func(name []string, o ...func(*IndicesExistsTemplateRequest)) (*Response, error)
IndicesExistsTemplate returns information about whether a particular index template exists.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html.
func (f IndicesExistsTemplate) WithContext(v context.Context) func(*IndicesExistsTemplateRequest)
WithContext sets the request context.
func (f IndicesExistsTemplate) WithErrorTrace() func(*IndicesExistsTemplateRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesExistsTemplate) WithFilterPath(v ...string) func(*IndicesExistsTemplateRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesExistsTemplate) WithFlatSettings(v bool) func(*IndicesExistsTemplateRequest)
WithFlatSettings - return settings in flat format (default: false).
func (f IndicesExistsTemplate) WithHeader(h map[string]string) func(*IndicesExistsTemplateRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesExistsTemplate) WithHuman() func(*IndicesExistsTemplateRequest)
WithHuman makes statistical values human-readable.
func (f IndicesExistsTemplate) WithLocal(v bool) func(*IndicesExistsTemplateRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f IndicesExistsTemplate) WithMasterTimeout(v time.Duration) func(*IndicesExistsTemplateRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f IndicesExistsTemplate) WithPretty() func(*IndicesExistsTemplateRequest)
WithPretty makes the response body pretty-printed.
type IndicesExistsTemplateRequest struct {
Name []string
FlatSettings *bool
Local *bool
MasterTimeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesExistsTemplateRequest configures the Indices Exists Template API request.
func (r IndicesExistsTemplateRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type IndicesFlush func(o ...func(*IndicesFlushRequest)) (*Response, error)
IndicesFlush performs the flush operation on one or more indices.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html.
func (f IndicesFlush) WithAllowNoIndices(v bool) func(*IndicesFlushRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesFlush) WithContext(v context.Context) func(*IndicesFlushRequest)
WithContext sets the request context.
func (f IndicesFlush) WithErrorTrace() func(*IndicesFlushRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesFlush) WithExpandWildcards(v string) func(*IndicesFlushRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesFlush) WithFilterPath(v ...string) func(*IndicesFlushRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesFlush) WithForce(v bool) func(*IndicesFlushRequest)
WithForce - whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. this is useful if transaction log ids should be incremented even if no uncommitted changes are present. (this setting can be considered as internal).
func (f IndicesFlush) WithHeader(h map[string]string) func(*IndicesFlushRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesFlush) WithHuman() func(*IndicesFlushRequest)
WithHuman makes statistical values human-readable.
func (f IndicesFlush) WithIgnoreUnavailable(v bool) func(*IndicesFlushRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesFlush) WithIndex(v ...string) func(*IndicesFlushRequest)
WithIndex - a list of index names; use _all for all indices.
func (f IndicesFlush) WithPretty() func(*IndicesFlushRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesFlush) WithWaitIfOngoing(v bool) func(*IndicesFlushRequest)
WithWaitIfOngoing - if set to true the flush operation will block until the flush can be executed if another flush operation is already executing. the default is true. if set to false the flush will be skipped iff if another flush operation is already running..
type IndicesFlushRequest struct {
Index []string
AllowNoIndices *bool
ExpandWildcards string
Force *bool
*bool
WaitIfOngoing *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesFlushRequest configures the Indices Flush API request.
Do executes the request and returns response or error.
type IndicesFlushSynced func(o ...func(*IndicesFlushSyncedRequest)) (*Response, error)
IndicesFlushSynced performs a synced flush operation on one or more indices.
See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html#synced-flush-api.
func (f IndicesFlushSynced) WithAllowNoIndices(v bool) func(*IndicesFlushSyncedRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesFlushSynced) WithContext(v context.Context) func(*IndicesFlushSyncedRequest)
WithContext sets the request context.
func (f IndicesFlushSynced) WithErrorTrace() func(*IndicesFlushSyncedRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesFlushSynced) WithExpandWildcards(v string) func(*IndicesFlushSyncedRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesFlushSynced) WithFilterPath(v ...string) func(*IndicesFlushSyncedRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesFlushSynced) WithHeader(h map[string]string) func(*IndicesFlushSyncedRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesFlushSynced) WithHuman() func(*IndicesFlushSyncedRequest)
WithHuman makes statistical values human-readable.
func (f IndicesFlushSynced) WithIgnoreUnavailable(v bool) func(*IndicesFlushSyncedRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesFlushSynced) WithIndex(v ...string) func(*IndicesFlushSyncedRequest)
WithIndex - a list of index names; use _all for all indices.
func (f IndicesFlushSynced) WithPretty() func(*IndicesFlushSyncedRequest)
WithPretty makes the response body pretty-printed.
type IndicesFlushSyncedRequest struct {
Index []string
AllowNoIndices *bool
ExpandWildcards string
*bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesFlushSyncedRequest configures the Indices Flush Synced API request.
Do executes the request and returns response or error.
type IndicesForcemerge func(o ...func(*IndicesForcemergeRequest)) (*Response, error)
IndicesForcemerge performs the force merge operation on one or more indices.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html.
func (f IndicesForcemerge) WithAllowNoIndices(v bool) func(*IndicesForcemergeRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesForcemerge) WithContext(v context.Context) func(*IndicesForcemergeRequest)
WithContext sets the request context.
func (f IndicesForcemerge) WithErrorTrace() func(*IndicesForcemergeRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesForcemerge) WithExpandWildcards(v string) func(*IndicesForcemergeRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesForcemerge) WithFilterPath(v ...string) func(*IndicesForcemergeRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesForcemerge) WithFlush(v bool) func(*IndicesForcemergeRequest)
WithFlush - specify whether the index should be flushed after performing the operation (default: true).
func (f IndicesForcemerge) WithHeader(h map[string]string) func(*IndicesForcemergeRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesForcemerge) WithHuman() func(*IndicesForcemergeRequest)
WithHuman makes statistical values human-readable.
func (f IndicesForcemerge) WithIgnoreUnavailable(v bool) func(*IndicesForcemergeRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesForcemerge) WithIndex(v ...string) func(*IndicesForcemergeRequest)
WithIndex - a list of index names; use _all to perform the operation on all indices.
func (f IndicesForcemerge) WithMaxNumSegments(v int) func(*IndicesForcemergeRequest)
WithMaxNumSegments - the number of segments the index should be merged into (default: dynamic).
func (f IndicesForcemerge) WithOnlyExpungeDeletes(v bool) func(*IndicesForcemergeRequest)
WithOnlyExpungeDeletes - specify whether the operation should only expunge deleted documents.
func (f IndicesForcemerge) WithPretty() func(*IndicesForcemergeRequest)
WithPretty makes the response body pretty-printed.
type IndicesForcemergeRequest struct {
Index []string
AllowNoIndices *bool
ExpandWildcards string
Flush *bool
*bool
MaxNumSegments *int
OnlyExpungeDeletes *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesForcemergeRequest configures the Indices Forcemerge API request.
Do executes the request and returns response or error.
type IndicesFreeze func(index string, o ...func(*IndicesFreezeRequest)) (*Response, error)
IndicesFreeze - https://www.elastic.co/guide/en/elasticsearch/reference/current/frozen.html
func (f IndicesFreeze) WithAllowNoIndices(v bool) func(*IndicesFreezeRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesFreeze) WithContext(v context.Context) func(*IndicesFreezeRequest)
WithContext sets the request context.
func (f IndicesFreeze) WithErrorTrace() func(*IndicesFreezeRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesFreeze) WithExpandWildcards(v string) func(*IndicesFreezeRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesFreeze) WithFilterPath(v ...string) func(*IndicesFreezeRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesFreeze) WithHeader(h map[string]string) func(*IndicesFreezeRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesFreeze) WithHuman() func(*IndicesFreezeRequest)
WithHuman makes statistical values human-readable.
func (f IndicesFreeze) WithIgnoreUnavailable(v bool) func(*IndicesFreezeRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesFreeze) WithMasterTimeout(v time.Duration) func(*IndicesFreezeRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesFreeze) WithPretty() func(*IndicesFreezeRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesFreeze) WithTimeout(v time.Duration) func(*IndicesFreezeRequest)
WithTimeout - explicit operation timeout.
func (f IndicesFreeze) WithWaitForActiveShards(v string) func(*IndicesFreezeRequest)
WithWaitForActiveShards - sets the number of active shards to wait for before the operation returns..
type IndicesFreezeRequest struct {
Index string
AllowNoIndices *bool
ExpandWildcards string
*bool
MasterTimeout time.Duration
Timeout time.Duration
WaitForActiveShards string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesFreezeRequest configures the Indices Freeze API request.
Do executes the request and returns response or error.
type IndicesGet func(index []string, o ...func(*IndicesGetRequest)) (*Response, error)
IndicesGet returns information about one or more indices.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html.
func (f IndicesGet) WithAllowNoIndices(v bool) func(*IndicesGetRequest)
WithAllowNoIndices - ignore if a wildcard expression resolves to no concrete indices (default: false).
func (f IndicesGet) WithContext(v context.Context) func(*IndicesGetRequest)
WithContext sets the request context.
func (f IndicesGet) WithErrorTrace() func(*IndicesGetRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesGet) WithExpandWildcards(v string) func(*IndicesGetRequest)
WithExpandWildcards - whether wildcard expressions should get expanded to open or closed indices (default: open).
func (f IndicesGet) WithFilterPath(v ...string) func(*IndicesGetRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesGet) WithFlatSettings(v bool) func(*IndicesGetRequest)
WithFlatSettings - return settings in flat format (default: false).
func (f IndicesGet) WithHeader(h map[string]string) func(*IndicesGetRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesGet) WithHuman() func(*IndicesGetRequest)
WithHuman makes statistical values human-readable.
func (f IndicesGet) WithIgnoreUnavailable(v bool) func(*IndicesGetRequest)
WithIgnoreUnavailable - ignore unavailable indexes (default: false).
func (f IndicesGet) WithIncludeDefaults(v bool) func(*IndicesGetRequest)
WithIncludeDefaults - whether to return all default setting for each of the indices..
func (f IndicesGet) WithIncludeTypeName(v bool) func(*IndicesGetRequest)
WithIncludeTypeName - whether to add the type name to the response (default: false).
func (f IndicesGet) WithLocal(v bool) func(*IndicesGetRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f IndicesGet) WithMasterTimeout(v time.Duration) func(*IndicesGetRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesGet) WithPretty() func(*IndicesGetRequest)
WithPretty makes the response body pretty-printed.
type IndicesGetAlias func(o ...func(*IndicesGetAliasRequest)) (*Response, error)
IndicesGetAlias returns an alias.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html.
func (f IndicesGetAlias) WithAllowNoIndices(v bool) func(*IndicesGetAliasRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesGetAlias) WithContext(v context.Context) func(*IndicesGetAliasRequest)
WithContext sets the request context.
func (f IndicesGetAlias) WithErrorTrace() func(*IndicesGetAliasRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesGetAlias) WithExpandWildcards(v string) func(*IndicesGetAliasRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesGetAlias) WithFilterPath(v ...string) func(*IndicesGetAliasRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesGetAlias) WithHeader(h map[string]string) func(*IndicesGetAliasRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesGetAlias) WithHuman() func(*IndicesGetAliasRequest)
WithHuman makes statistical values human-readable.
func (f IndicesGetAlias) WithIgnoreUnavailable(v bool) func(*IndicesGetAliasRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesGetAlias) WithIndex(v ...string) func(*IndicesGetAliasRequest)
WithIndex - a list of index names to filter aliases.
func (f IndicesGetAlias) WithLocal(v bool) func(*IndicesGetAliasRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f IndicesGetAlias) WithName(v ...string) func(*IndicesGetAliasRequest)
WithName - a list of alias names to return.
func (f IndicesGetAlias) WithPretty() func(*IndicesGetAliasRequest)
WithPretty makes the response body pretty-printed.
type IndicesGetAliasRequest struct {
Index []string
Name []string
AllowNoIndices *bool
ExpandWildcards string
*bool
Local *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesGetAliasRequest configures the Indices Get Alias API request.
Do executes the request and returns response or error.
type IndicesGetFieldMapping func(fields []string, o ...func(*IndicesGetFieldMappingRequest)) (*Response, error)
IndicesGetFieldMapping returns mapping for one or more fields.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html.
func (f IndicesGetFieldMapping) WithAllowNoIndices(v bool) func(*IndicesGetFieldMappingRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesGetFieldMapping) WithContext(v context.Context) func(*IndicesGetFieldMappingRequest)
WithContext sets the request context.
func (f IndicesGetFieldMapping) WithDocumentType(v ...string) func(*IndicesGetFieldMappingRequest)
WithDocumentType - a list of document types.
func (f IndicesGetFieldMapping) WithErrorTrace() func(*IndicesGetFieldMappingRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesGetFieldMapping) WithExpandWildcards(v string) func(*IndicesGetFieldMappingRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesGetFieldMapping) WithFilterPath(v ...string) func(*IndicesGetFieldMappingRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesGetFieldMapping) WithHeader(h map[string]string) func(*IndicesGetFieldMappingRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesGetFieldMapping) WithHuman() func(*IndicesGetFieldMappingRequest)
WithHuman makes statistical values human-readable.
func (f IndicesGetFieldMapping) WithIgnoreUnavailable(v bool) func(*IndicesGetFieldMappingRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesGetFieldMapping) WithIncludeDefaults(v bool) func(*IndicesGetFieldMappingRequest)
WithIncludeDefaults - whether the default mapping values should be returned as well.
func (f IndicesGetFieldMapping) WithIncludeTypeName(v bool) func(*IndicesGetFieldMappingRequest)
WithIncludeTypeName - whether a type should be returned in the body of the mappings..
func (f IndicesGetFieldMapping) WithIndex(v ...string) func(*IndicesGetFieldMappingRequest)
WithIndex - a list of index names.
func (f IndicesGetFieldMapping) WithLocal(v bool) func(*IndicesGetFieldMappingRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f IndicesGetFieldMapping) WithPretty() func(*IndicesGetFieldMappingRequest)
WithPretty makes the response body pretty-printed.
type IndicesGetFieldMappingRequest struct {
Index []string
DocumentType []string
Fields []string
AllowNoIndices *bool
ExpandWildcards string
*bool
IncludeDefaults *bool
IncludeTypeName *bool
Local *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesGetFieldMappingRequest configures the Indices Get Field Mapping API request.
func (r IndicesGetFieldMappingRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type IndicesGetMapping func(o ...func(*IndicesGetMappingRequest)) (*Response, error)
IndicesGetMapping returns mappings for one or more indices.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html.
func (f IndicesGetMapping) WithAllowNoIndices(v bool) func(*IndicesGetMappingRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesGetMapping) WithContext(v context.Context) func(*IndicesGetMappingRequest)
WithContext sets the request context.
func (f IndicesGetMapping) WithDocumentType(v ...string) func(*IndicesGetMappingRequest)
WithDocumentType - a list of document types.
func (f IndicesGetMapping) WithErrorTrace() func(*IndicesGetMappingRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesGetMapping) WithExpandWildcards(v string) func(*IndicesGetMappingRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesGetMapping) WithFilterPath(v ...string) func(*IndicesGetMappingRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesGetMapping) WithHeader(h map[string]string) func(*IndicesGetMappingRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesGetMapping) WithHuman() func(*IndicesGetMappingRequest)
WithHuman makes statistical values human-readable.
func (f IndicesGetMapping) WithIgnoreUnavailable(v bool) func(*IndicesGetMappingRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesGetMapping) WithIncludeTypeName(v bool) func(*IndicesGetMappingRequest)
WithIncludeTypeName - whether to add the type name to the response (default: false).
func (f IndicesGetMapping) WithIndex(v ...string) func(*IndicesGetMappingRequest)
WithIndex - a list of index names.
func (f IndicesGetMapping) WithLocal(v bool) func(*IndicesGetMappingRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f IndicesGetMapping) WithMasterTimeout(v time.Duration) func(*IndicesGetMappingRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesGetMapping) WithPretty() func(*IndicesGetMappingRequest)
WithPretty makes the response body pretty-printed.
type IndicesGetMappingRequest struct {
Index []string
DocumentType []string
AllowNoIndices *bool
ExpandWildcards string
*bool
IncludeTypeName *bool
Local *bool
MasterTimeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesGetMappingRequest configures the Indices Get Mapping API request.
Do executes the request and returns response or error.
type IndicesGetRequest struct {
Index []string
AllowNoIndices *bool
ExpandWildcards string
FlatSettings *bool
*bool
IncludeDefaults *bool
IncludeTypeName *bool
Local *bool
MasterTimeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesGetRequest configures the Indices Get API request.
Do executes the request and returns response or error.
type IndicesGetSettings func(o ...func(*IndicesGetSettingsRequest)) (*Response, error)
IndicesGetSettings returns settings for one or more indices.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html.
func (f IndicesGetSettings) WithAllowNoIndices(v bool) func(*IndicesGetSettingsRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesGetSettings) WithContext(v context.Context) func(*IndicesGetSettingsRequest)
WithContext sets the request context.
func (f IndicesGetSettings) WithErrorTrace() func(*IndicesGetSettingsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesGetSettings) WithExpandWildcards(v string) func(*IndicesGetSettingsRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesGetSettings) WithFilterPath(v ...string) func(*IndicesGetSettingsRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesGetSettings) WithFlatSettings(v bool) func(*IndicesGetSettingsRequest)
WithFlatSettings - return settings in flat format (default: false).
func (f IndicesGetSettings) WithHeader(h map[string]string) func(*IndicesGetSettingsRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesGetSettings) WithHuman() func(*IndicesGetSettingsRequest)
WithHuman makes statistical values human-readable.
func (f IndicesGetSettings) WithIgnoreUnavailable(v bool) func(*IndicesGetSettingsRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesGetSettings) WithIncludeDefaults(v bool) func(*IndicesGetSettingsRequest)
WithIncludeDefaults - whether to return all default setting for each of the indices..
func (f IndicesGetSettings) WithIndex(v ...string) func(*IndicesGetSettingsRequest)
WithIndex - a list of index names; use _all to perform the operation on all indices.
func (f IndicesGetSettings) WithLocal(v bool) func(*IndicesGetSettingsRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f IndicesGetSettings) WithMasterTimeout(v time.Duration) func(*IndicesGetSettingsRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesGetSettings) WithName(v ...string) func(*IndicesGetSettingsRequest)
WithName - the name of the settings that should be included.
func (f IndicesGetSettings) WithPretty() func(*IndicesGetSettingsRequest)
WithPretty makes the response body pretty-printed.
type IndicesGetSettingsRequest struct {
Index []string
Name []string
AllowNoIndices *bool
ExpandWildcards string
FlatSettings *bool
*bool
IncludeDefaults *bool
Local *bool
MasterTimeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesGetSettingsRequest configures the Indices Get Settings API request.
Do executes the request and returns response or error.
type IndicesGetTemplate func(o ...func(*IndicesGetTemplateRequest)) (*Response, error)
IndicesGetTemplate returns an index template.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html.
func (f IndicesGetTemplate) WithContext(v context.Context) func(*IndicesGetTemplateRequest)
WithContext sets the request context.
func (f IndicesGetTemplate) WithErrorTrace() func(*IndicesGetTemplateRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesGetTemplate) WithFilterPath(v ...string) func(*IndicesGetTemplateRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesGetTemplate) WithFlatSettings(v bool) func(*IndicesGetTemplateRequest)
WithFlatSettings - return settings in flat format (default: false).
func (f IndicesGetTemplate) WithHeader(h map[string]string) func(*IndicesGetTemplateRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesGetTemplate) WithHuman() func(*IndicesGetTemplateRequest)
WithHuman makes statistical values human-readable.
func (f IndicesGetTemplate) WithIncludeTypeName(v bool) func(*IndicesGetTemplateRequest)
WithIncludeTypeName - whether a type should be returned in the body of the mappings..
func (f IndicesGetTemplate) WithLocal(v bool) func(*IndicesGetTemplateRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f IndicesGetTemplate) WithMasterTimeout(v time.Duration) func(*IndicesGetTemplateRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f IndicesGetTemplate) WithName(v ...string) func(*IndicesGetTemplateRequest)
WithName - the comma separated names of the index templates.
func (f IndicesGetTemplate) WithPretty() func(*IndicesGetTemplateRequest)
WithPretty makes the response body pretty-printed.
type IndicesGetTemplateRequest struct {
Name []string
FlatSettings *bool
IncludeTypeName *bool
Local *bool
MasterTimeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesGetTemplateRequest configures the Indices Get Template API request.
Do executes the request and returns response or error.
type IndicesGetUpgrade func(o ...func(*IndicesGetUpgradeRequest)) (*Response, error)
IndicesGetUpgrade the _upgrade API is no longer useful and will be removed.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html.
func (f IndicesGetUpgrade) WithAllowNoIndices(v bool) func(*IndicesGetUpgradeRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesGetUpgrade) WithContext(v context.Context) func(*IndicesGetUpgradeRequest)
WithContext sets the request context.
func (f IndicesGetUpgrade) WithErrorTrace() func(*IndicesGetUpgradeRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesGetUpgrade) WithExpandWildcards(v string) func(*IndicesGetUpgradeRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesGetUpgrade) WithFilterPath(v ...string) func(*IndicesGetUpgradeRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesGetUpgrade) WithHeader(h map[string]string) func(*IndicesGetUpgradeRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesGetUpgrade) WithHuman() func(*IndicesGetUpgradeRequest)
WithHuman makes statistical values human-readable.
func (f IndicesGetUpgrade) WithIgnoreUnavailable(v bool) func(*IndicesGetUpgradeRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesGetUpgrade) WithIndex(v ...string) func(*IndicesGetUpgradeRequest)
WithIndex - a list of index names; use _all to perform the operation on all indices.
func (f IndicesGetUpgrade) WithPretty() func(*IndicesGetUpgradeRequest)
WithPretty makes the response body pretty-printed.
type IndicesGetUpgradeRequest struct {
Index []string
AllowNoIndices *bool
ExpandWildcards string
*bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesGetUpgradeRequest configures the Indices Get Upgrade API request.
Do executes the request and returns response or error.
type IndicesOpen func(index []string, o ...func(*IndicesOpenRequest)) (*Response, error)
IndicesOpen opens an index.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html.
func (f IndicesOpen) WithAllowNoIndices(v bool) func(*IndicesOpenRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesOpen) WithContext(v context.Context) func(*IndicesOpenRequest)
WithContext sets the request context.
func (f IndicesOpen) WithErrorTrace() func(*IndicesOpenRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesOpen) WithExpandWildcards(v string) func(*IndicesOpenRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesOpen) WithFilterPath(v ...string) func(*IndicesOpenRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesOpen) WithHeader(h map[string]string) func(*IndicesOpenRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesOpen) WithHuman() func(*IndicesOpenRequest)
WithHuman makes statistical values human-readable.
func (f IndicesOpen) WithIgnoreUnavailable(v bool) func(*IndicesOpenRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesOpen) WithMasterTimeout(v time.Duration) func(*IndicesOpenRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesOpen) WithPretty() func(*IndicesOpenRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesOpen) WithTimeout(v time.Duration) func(*IndicesOpenRequest)
WithTimeout - explicit operation timeout.
func (f IndicesOpen) WithWaitForActiveShards(v string) func(*IndicesOpenRequest)
WithWaitForActiveShards - sets the number of active shards to wait for before the operation returns..
type IndicesOpenRequest struct {
Index []string
AllowNoIndices *bool
ExpandWildcards string
*bool
MasterTimeout time.Duration
Timeout time.Duration
WaitForActiveShards string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesOpenRequest configures the Indices Open API request.
Do executes the request and returns response or error.
type IndicesPutAlias func(index []string, name string, o ...func(*IndicesPutAliasRequest)) (*Response, error)
IndicesPutAlias creates or updates an alias.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html.
func (f IndicesPutAlias) WithBody(v io.Reader) func(*IndicesPutAliasRequest)
WithBody - The settings for the alias, such as `routing` or `filter`.
func (f IndicesPutAlias) WithContext(v context.Context) func(*IndicesPutAliasRequest)
WithContext sets the request context.
func (f IndicesPutAlias) WithErrorTrace() func(*IndicesPutAliasRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesPutAlias) WithFilterPath(v ...string) func(*IndicesPutAliasRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesPutAlias) WithHeader(h map[string]string) func(*IndicesPutAliasRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesPutAlias) WithHuman() func(*IndicesPutAliasRequest)
WithHuman makes statistical values human-readable.
func (f IndicesPutAlias) WithMasterTimeout(v time.Duration) func(*IndicesPutAliasRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesPutAlias) WithPretty() func(*IndicesPutAliasRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesPutAlias) WithTimeout(v time.Duration) func(*IndicesPutAliasRequest)
WithTimeout - explicit timestamp for the document.
type IndicesPutAliasRequest struct {
Index []string
Body io.Reader
Name string
MasterTimeout time.Duration
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesPutAliasRequest configures the Indices Put Alias API request.
Do executes the request and returns response or error.
type IndicesPutMapping func(body io.Reader, o ...func(*IndicesPutMappingRequest)) (*Response, error)
IndicesPutMapping updates the index mappings.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html.
func (f IndicesPutMapping) WithAllowNoIndices(v bool) func(*IndicesPutMappingRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesPutMapping) WithContext(v context.Context) func(*IndicesPutMappingRequest)
WithContext sets the request context.
func (f IndicesPutMapping) WithDocumentType(v string) func(*IndicesPutMappingRequest)
WithDocumentType - the name of the document type.
func (f IndicesPutMapping) WithErrorTrace() func(*IndicesPutMappingRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesPutMapping) WithExpandWildcards(v string) func(*IndicesPutMappingRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesPutMapping) WithFilterPath(v ...string) func(*IndicesPutMappingRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesPutMapping) WithHeader(h map[string]string) func(*IndicesPutMappingRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesPutMapping) WithHuman() func(*IndicesPutMappingRequest)
WithHuman makes statistical values human-readable.
func (f IndicesPutMapping) WithIgnoreUnavailable(v bool) func(*IndicesPutMappingRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesPutMapping) WithIncludeTypeName(v bool) func(*IndicesPutMappingRequest)
WithIncludeTypeName - whether a type should be expected in the body of the mappings..
func (f IndicesPutMapping) WithIndex(v ...string) func(*IndicesPutMappingRequest)
WithIndex - a list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices..
func (f IndicesPutMapping) WithMasterTimeout(v time.Duration) func(*IndicesPutMappingRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesPutMapping) WithPretty() func(*IndicesPutMappingRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesPutMapping) WithTimeout(v time.Duration) func(*IndicesPutMappingRequest)
WithTimeout - explicit operation timeout.
type IndicesPutMappingRequest struct {
Index []string
DocumentType string
Body io.Reader
AllowNoIndices *bool
ExpandWildcards string
*bool
IncludeTypeName *bool
MasterTimeout time.Duration
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesPutMappingRequest configures the Indices Put Mapping API request.
Do executes the request and returns response or error.
type IndicesPutSettings func(body io.Reader, o ...func(*IndicesPutSettingsRequest)) (*Response, error)
IndicesPutSettings updates the index settings.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html.
func (f IndicesPutSettings) WithAllowNoIndices(v bool) func(*IndicesPutSettingsRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesPutSettings) WithContext(v context.Context) func(*IndicesPutSettingsRequest)
WithContext sets the request context.
func (f IndicesPutSettings) WithErrorTrace() func(*IndicesPutSettingsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesPutSettings) WithExpandWildcards(v string) func(*IndicesPutSettingsRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesPutSettings) WithFilterPath(v ...string) func(*IndicesPutSettingsRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesPutSettings) WithFlatSettings(v bool) func(*IndicesPutSettingsRequest)
WithFlatSettings - return settings in flat format (default: false).
func (f IndicesPutSettings) WithHeader(h map[string]string) func(*IndicesPutSettingsRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesPutSettings) WithHuman() func(*IndicesPutSettingsRequest)
WithHuman makes statistical values human-readable.
func (f IndicesPutSettings) WithIgnoreUnavailable(v bool) func(*IndicesPutSettingsRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesPutSettings) WithIndex(v ...string) func(*IndicesPutSettingsRequest)
WithIndex - a list of index names; use _all to perform the operation on all indices.
func (f IndicesPutSettings) WithMasterTimeout(v time.Duration) func(*IndicesPutSettingsRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesPutSettings) WithPreserveExisting(v bool) func(*IndicesPutSettingsRequest)
WithPreserveExisting - whether to update existing settings. if set to `true` existing settings on an index remain unchanged, the default is `false`.
func (f IndicesPutSettings) WithPretty() func(*IndicesPutSettingsRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesPutSettings) WithTimeout(v time.Duration) func(*IndicesPutSettingsRequest)
WithTimeout - explicit operation timeout.
type IndicesPutSettingsRequest struct {
Index []string
Body io.Reader
AllowNoIndices *bool
ExpandWildcards string
FlatSettings *bool
*bool
MasterTimeout time.Duration
PreserveExisting *bool
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesPutSettingsRequest configures the Indices Put Settings API request.
Do executes the request and returns response or error.
type IndicesPutTemplate func(name string, body io.Reader, o ...func(*IndicesPutTemplateRequest)) (*Response, error)
IndicesPutTemplate creates or updates an index template.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html.
func (f IndicesPutTemplate) WithContext(v context.Context) func(*IndicesPutTemplateRequest)
WithContext sets the request context.
func (f IndicesPutTemplate) WithCreate(v bool) func(*IndicesPutTemplateRequest)
WithCreate - whether the index template should only be added if new or can also replace an existing one.
func (f IndicesPutTemplate) WithErrorTrace() func(*IndicesPutTemplateRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesPutTemplate) WithFilterPath(v ...string) func(*IndicesPutTemplateRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesPutTemplate) WithFlatSettings(v bool) func(*IndicesPutTemplateRequest)
WithFlatSettings - return settings in flat format (default: false).
func (f IndicesPutTemplate) WithHeader(h map[string]string) func(*IndicesPutTemplateRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesPutTemplate) WithHuman() func(*IndicesPutTemplateRequest)
WithHuman makes statistical values human-readable.
func (f IndicesPutTemplate) WithIncludeTypeName(v bool) func(*IndicesPutTemplateRequest)
WithIncludeTypeName - whether a type should be returned in the body of the mappings..
func (f IndicesPutTemplate) WithMasterTimeout(v time.Duration) func(*IndicesPutTemplateRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesPutTemplate) WithOrder(v int) func(*IndicesPutTemplateRequest)
WithOrder - the order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers).
func (f IndicesPutTemplate) WithPretty() func(*IndicesPutTemplateRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesPutTemplate) WithTimeout(v time.Duration) func(*IndicesPutTemplateRequest)
WithTimeout - explicit operation timeout.
type IndicesPutTemplateRequest struct {
Body io.Reader
Name string
Create *bool
FlatSettings *bool
IncludeTypeName *bool
MasterTimeout time.Duration
Order *int
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesPutTemplateRequest configures the Indices Put Template API request.
Do executes the request and returns response or error.
type IndicesRecovery func(o ...func(*IndicesRecoveryRequest)) (*Response, error)
IndicesRecovery returns information about ongoing index shard recoveries.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html.
func (f IndicesRecovery) WithActiveOnly(v bool) func(*IndicesRecoveryRequest)
WithActiveOnly - display only those recoveries that are currently on-going.
func (f IndicesRecovery) WithContext(v context.Context) func(*IndicesRecoveryRequest)
WithContext sets the request context.
func (f IndicesRecovery) WithDetailed(v bool) func(*IndicesRecoveryRequest)
WithDetailed - whether to display detailed information about shard recovery.
func (f IndicesRecovery) WithErrorTrace() func(*IndicesRecoveryRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesRecovery) WithFilterPath(v ...string) func(*IndicesRecoveryRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesRecovery) WithHeader(h map[string]string) func(*IndicesRecoveryRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesRecovery) WithHuman() func(*IndicesRecoveryRequest)
WithHuman makes statistical values human-readable.
func (f IndicesRecovery) WithIndex(v ...string) func(*IndicesRecoveryRequest)
WithIndex - a list of index names; use _all to perform the operation on all indices.
func (f IndicesRecovery) WithPretty() func(*IndicesRecoveryRequest)
WithPretty makes the response body pretty-printed.
type IndicesRecoveryRequest struct {
Index []string
ActiveOnly *bool
Detailed *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesRecoveryRequest configures the Indices Recovery API request.
Do executes the request and returns response or error.
type IndicesRefresh func(o ...func(*IndicesRefreshRequest)) (*Response, error)
IndicesRefresh performs the refresh operation in one or more indices.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html.
func (f IndicesRefresh) WithAllowNoIndices(v bool) func(*IndicesRefreshRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesRefresh) WithContext(v context.Context) func(*IndicesRefreshRequest)
WithContext sets the request context.
func (f IndicesRefresh) WithErrorTrace() func(*IndicesRefreshRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesRefresh) WithExpandWildcards(v string) func(*IndicesRefreshRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesRefresh) WithFilterPath(v ...string) func(*IndicesRefreshRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesRefresh) WithHeader(h map[string]string) func(*IndicesRefreshRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesRefresh) WithHuman() func(*IndicesRefreshRequest)
WithHuman makes statistical values human-readable.
func (f IndicesRefresh) WithIgnoreUnavailable(v bool) func(*IndicesRefreshRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesRefresh) WithIndex(v ...string) func(*IndicesRefreshRequest)
WithIndex - a list of index names; use _all to perform the operation on all indices.
func (f IndicesRefresh) WithPretty() func(*IndicesRefreshRequest)
WithPretty makes the response body pretty-printed.
type IndicesRefreshRequest struct {
Index []string
AllowNoIndices *bool
ExpandWildcards string
*bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesRefreshRequest configures the Indices Refresh API request.
Do executes the request and returns response or error.
type IndicesReloadSearchAnalyzers func(o ...func(*IndicesReloadSearchAnalyzersRequest)) (*Response, error)
IndicesReloadSearchAnalyzers - https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-reload-analyzers.html
func (f IndicesReloadSearchAnalyzers) WithAllowNoIndices(v bool) func(*IndicesReloadSearchAnalyzersRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesReloadSearchAnalyzers) WithContext(v context.Context) func(*IndicesReloadSearchAnalyzersRequest)
WithContext sets the request context.
func (f IndicesReloadSearchAnalyzers) WithErrorTrace() func(*IndicesReloadSearchAnalyzersRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesReloadSearchAnalyzers) WithExpandWildcards(v string) func(*IndicesReloadSearchAnalyzersRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesReloadSearchAnalyzers) WithFilterPath(v ...string) func(*IndicesReloadSearchAnalyzersRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesReloadSearchAnalyzers) WithHeader(h map[string]string) func(*IndicesReloadSearchAnalyzersRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesReloadSearchAnalyzers) WithHuman() func(*IndicesReloadSearchAnalyzersRequest)
WithHuman makes statistical values human-readable.
func (f IndicesReloadSearchAnalyzers) WithIgnoreUnavailable(v bool) func(*IndicesReloadSearchAnalyzersRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesReloadSearchAnalyzers) WithIndex(v ...string) func(*IndicesReloadSearchAnalyzersRequest)
WithIndex - a list of index names to reload analyzers for.
func (f IndicesReloadSearchAnalyzers) WithPretty() func(*IndicesReloadSearchAnalyzersRequest)
WithPretty makes the response body pretty-printed.
type IndicesReloadSearchAnalyzersRequest struct {
Index []string
AllowNoIndices *bool
ExpandWildcards string
*bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesReloadSearchAnalyzersRequest configures the Indices Reload Search Analyzers API request.
func (r IndicesReloadSearchAnalyzersRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type IndicesRollover func(alias string, o ...func(*IndicesRolloverRequest)) (*Response, error)
IndicesRollover updates an alias to point to a new index when the existing index is considered to be too large or too old.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html.
func (f IndicesRollover) WithBody(v io.Reader) func(*IndicesRolloverRequest)
WithBody - The conditions that needs to be met for executing rollover.
func (f IndicesRollover) WithContext(v context.Context) func(*IndicesRolloverRequest)
WithContext sets the request context.
func (f IndicesRollover) WithDryRun(v bool) func(*IndicesRolloverRequest)
WithDryRun - if set to true the rollover action will only be validated but not actually performed even if a condition matches. the default is false.
func (f IndicesRollover) WithErrorTrace() func(*IndicesRolloverRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesRollover) WithFilterPath(v ...string) func(*IndicesRolloverRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesRollover) WithHeader(h map[string]string) func(*IndicesRolloverRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesRollover) WithHuman() func(*IndicesRolloverRequest)
WithHuman makes statistical values human-readable.
func (f IndicesRollover) WithIncludeTypeName(v bool) func(*IndicesRolloverRequest)
WithIncludeTypeName - whether a type should be included in the body of the mappings..
func (f IndicesRollover) WithMasterTimeout(v time.Duration) func(*IndicesRolloverRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesRollover) WithNewIndex(v string) func(*IndicesRolloverRequest)
WithNewIndex - the name of the rollover index.
func (f IndicesRollover) WithPretty() func(*IndicesRolloverRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesRollover) WithTimeout(v time.Duration) func(*IndicesRolloverRequest)
WithTimeout - explicit operation timeout.
func (f IndicesRollover) WithWaitForActiveShards(v string) func(*IndicesRolloverRequest)
WithWaitForActiveShards - set the number of active shards to wait for on the newly created rollover index before the operation returns..
type IndicesRolloverRequest struct {
Body io.Reader
Alias string
NewIndex string
DryRun *bool
IncludeTypeName *bool
MasterTimeout time.Duration
Timeout time.Duration
WaitForActiveShards string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesRolloverRequest configures the Indices Rollover API request.
Do executes the request and returns response or error.
type IndicesSegments func(o ...func(*IndicesSegmentsRequest)) (*Response, error)
IndicesSegments provides low-level information about segments in a Lucene index.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html.
func (f IndicesSegments) WithAllowNoIndices(v bool) func(*IndicesSegmentsRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesSegments) WithContext(v context.Context) func(*IndicesSegmentsRequest)
WithContext sets the request context.
func (f IndicesSegments) WithErrorTrace() func(*IndicesSegmentsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesSegments) WithExpandWildcards(v string) func(*IndicesSegmentsRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesSegments) WithFilterPath(v ...string) func(*IndicesSegmentsRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesSegments) WithHeader(h map[string]string) func(*IndicesSegmentsRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesSegments) WithHuman() func(*IndicesSegmentsRequest)
WithHuman makes statistical values human-readable.
func (f IndicesSegments) WithIgnoreUnavailable(v bool) func(*IndicesSegmentsRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesSegments) WithIndex(v ...string) func(*IndicesSegmentsRequest)
WithIndex - a list of index names; use _all to perform the operation on all indices.
func (f IndicesSegments) WithPretty() func(*IndicesSegmentsRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesSegments) WithVerbose(v bool) func(*IndicesSegmentsRequest)
WithVerbose - includes detailed memory usage by lucene..
type IndicesSegmentsRequest struct {
Index []string
AllowNoIndices *bool
ExpandWildcards string
*bool
Verbose *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesSegmentsRequest configures the Indices Segments API request.
Do executes the request and returns response or error.
type IndicesShardStores func(o ...func(*IndicesShardStoresRequest)) (*Response, error)
IndicesShardStores provides store information for shard copies of indices.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html.
func (f IndicesShardStores) WithAllowNoIndices(v bool) func(*IndicesShardStoresRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesShardStores) WithContext(v context.Context) func(*IndicesShardStoresRequest)
WithContext sets the request context.
func (f IndicesShardStores) WithErrorTrace() func(*IndicesShardStoresRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesShardStores) WithExpandWildcards(v string) func(*IndicesShardStoresRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesShardStores) WithFilterPath(v ...string) func(*IndicesShardStoresRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesShardStores) WithHeader(h map[string]string) func(*IndicesShardStoresRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesShardStores) WithHuman() func(*IndicesShardStoresRequest)
WithHuman makes statistical values human-readable.
func (f IndicesShardStores) WithIgnoreUnavailable(v bool) func(*IndicesShardStoresRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesShardStores) WithIndex(v ...string) func(*IndicesShardStoresRequest)
WithIndex - a list of index names; use _all to perform the operation on all indices.
func (f IndicesShardStores) WithPretty() func(*IndicesShardStoresRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesShardStores) WithStatus(v ...string) func(*IndicesShardStoresRequest)
WithStatus - a list of statuses used to filter on shards to get store information for.
type IndicesShardStoresRequest struct {
Index []string
AllowNoIndices *bool
ExpandWildcards string
*bool
Status []string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesShardStoresRequest configures the Indices Shard Stores API request.
Do executes the request and returns response or error.
type IndicesShrink func(index string, target string, o ...func(*IndicesShrinkRequest)) (*Response, error)
IndicesShrink allow to shrink an existing index into a new index with fewer primary shards.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-index.html.
func (f IndicesShrink) WithBody(v io.Reader) func(*IndicesShrinkRequest)
WithBody - The configuration for the target index (`settings` and `aliases`).
func (f IndicesShrink) WithContext(v context.Context) func(*IndicesShrinkRequest)
WithContext sets the request context.
func (f IndicesShrink) WithErrorTrace() func(*IndicesShrinkRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesShrink) WithFilterPath(v ...string) func(*IndicesShrinkRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesShrink) WithHeader(h map[string]string) func(*IndicesShrinkRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesShrink) WithHuman() func(*IndicesShrinkRequest)
WithHuman makes statistical values human-readable.
func (f IndicesShrink) WithMasterTimeout(v time.Duration) func(*IndicesShrinkRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesShrink) WithPretty() func(*IndicesShrinkRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesShrink) WithTimeout(v time.Duration) func(*IndicesShrinkRequest)
WithTimeout - explicit operation timeout.
func (f IndicesShrink) WithWaitForActiveShards(v string) func(*IndicesShrinkRequest)
WithWaitForActiveShards - set the number of active shards to wait for on the shrunken index before the operation returns..
type IndicesShrinkRequest struct {
Index string
Body io.Reader
Target string
MasterTimeout time.Duration
Timeout time.Duration
WaitForActiveShards string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesShrinkRequest configures the Indices Shrink API request.
Do executes the request and returns response or error.
type IndicesSplit func(index string, target string, o ...func(*IndicesSplitRequest)) (*Response, error)
IndicesSplit allows you to split an existing index into a new index with more primary shards.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html.
func (f IndicesSplit) WithBody(v io.Reader) func(*IndicesSplitRequest)
WithBody - The configuration for the target index (`settings` and `aliases`).
func (f IndicesSplit) WithContext(v context.Context) func(*IndicesSplitRequest)
WithContext sets the request context.
func (f IndicesSplit) WithErrorTrace() func(*IndicesSplitRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesSplit) WithFilterPath(v ...string) func(*IndicesSplitRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesSplit) WithHeader(h map[string]string) func(*IndicesSplitRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesSplit) WithHuman() func(*IndicesSplitRequest)
WithHuman makes statistical values human-readable.
func (f IndicesSplit) WithMasterTimeout(v time.Duration) func(*IndicesSplitRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesSplit) WithPretty() func(*IndicesSplitRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesSplit) WithTimeout(v time.Duration) func(*IndicesSplitRequest)
WithTimeout - explicit operation timeout.
func (f IndicesSplit) WithWaitForActiveShards(v string) func(*IndicesSplitRequest)
WithWaitForActiveShards - set the number of active shards to wait for on the shrunken index before the operation returns..
type IndicesSplitRequest struct {
Index string
Body io.Reader
Target string
MasterTimeout time.Duration
Timeout time.Duration
WaitForActiveShards string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesSplitRequest configures the Indices Split API request.
Do executes the request and returns response or error.
type IndicesStats func(o ...func(*IndicesStatsRequest)) (*Response, error)
IndicesStats provides statistics on operations happening in an index.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html.
func (f IndicesStats) WithCompletionFields(v ...string) func(*IndicesStatsRequest)
WithCompletionFields - a list of fields for `fielddata` and `suggest` index metric (supports wildcards).
func (f IndicesStats) WithContext(v context.Context) func(*IndicesStatsRequest)
WithContext sets the request context.
func (f IndicesStats) WithErrorTrace() func(*IndicesStatsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesStats) WithExpandWildcards(v string) func(*IndicesStatsRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesStats) WithFielddataFields(v ...string) func(*IndicesStatsRequest)
WithFielddataFields - a list of fields for `fielddata` index metric (supports wildcards).
func (f IndicesStats) WithFields(v ...string) func(*IndicesStatsRequest)
WithFields - a list of fields for `fielddata` and `completion` index metric (supports wildcards).
func (f IndicesStats) WithFilterPath(v ...string) func(*IndicesStatsRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesStats) WithForbidClosedIndices(v bool) func(*IndicesStatsRequest)
WithForbidClosedIndices - if set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices.
func (f IndicesStats) WithGroups(v ...string) func(*IndicesStatsRequest)
WithGroups - a list of search groups for `search` index metric.
func (f IndicesStats) WithHeader(h map[string]string) func(*IndicesStatsRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesStats) WithHuman() func(*IndicesStatsRequest)
WithHuman makes statistical values human-readable.
func (f IndicesStats) WithIncludeSegmentFileSizes(v bool) func(*IndicesStatsRequest)
WithIncludeSegmentFileSizes - whether to report the aggregated disk usage of each one of the lucene index files (only applies if segment stats are requested).
func (f IndicesStats) WithIncludeUnloadedSegments(v bool) func(*IndicesStatsRequest)
WithIncludeUnloadedSegments - if set to true segment stats will include stats for segments that are not currently loaded into memory.
func (f IndicesStats) WithIndex(v ...string) func(*IndicesStatsRequest)
WithIndex - a list of index names; use _all to perform the operation on all indices.
func (f IndicesStats) WithLevel(v string) func(*IndicesStatsRequest)
WithLevel - return stats aggregated at cluster, index or shard level.
func (f IndicesStats) WithMetric(v ...string) func(*IndicesStatsRequest)
WithMetric - limit the information returned the specific metrics..
func (f IndicesStats) WithPretty() func(*IndicesStatsRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesStats) WithTypes(v ...string) func(*IndicesStatsRequest)
WithTypes - a list of document types for the `indexing` index metric.
type IndicesStatsRequest struct {
Index []string
Metric []string
CompletionFields []string
ExpandWildcards string
FielddataFields []string
Fields []string
ForbidClosedIndices *bool
Groups []string
IncludeSegmentFileSizes *bool
IncludeUnloadedSegments *bool
Level string
Types []string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesStatsRequest configures the Indices Stats API request.
Do executes the request and returns response or error.
type IndicesUnfreeze func(index string, o ...func(*IndicesUnfreezeRequest)) (*Response, error)
IndicesUnfreeze - https://www.elastic.co/guide/en/elasticsearch/reference/current/frozen.html
func (f IndicesUnfreeze) WithAllowNoIndices(v bool) func(*IndicesUnfreezeRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesUnfreeze) WithContext(v context.Context) func(*IndicesUnfreezeRequest)
WithContext sets the request context.
func (f IndicesUnfreeze) WithErrorTrace() func(*IndicesUnfreezeRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesUnfreeze) WithExpandWildcards(v string) func(*IndicesUnfreezeRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesUnfreeze) WithFilterPath(v ...string) func(*IndicesUnfreezeRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesUnfreeze) WithHeader(h map[string]string) func(*IndicesUnfreezeRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesUnfreeze) WithHuman() func(*IndicesUnfreezeRequest)
WithHuman makes statistical values human-readable.
func (f IndicesUnfreeze) WithIgnoreUnavailable(v bool) func(*IndicesUnfreezeRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesUnfreeze) WithMasterTimeout(v time.Duration) func(*IndicesUnfreezeRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesUnfreeze) WithPretty() func(*IndicesUnfreezeRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesUnfreeze) WithTimeout(v time.Duration) func(*IndicesUnfreezeRequest)
WithTimeout - explicit operation timeout.
func (f IndicesUnfreeze) WithWaitForActiveShards(v string) func(*IndicesUnfreezeRequest)
WithWaitForActiveShards - sets the number of active shards to wait for before the operation returns..
type IndicesUnfreezeRequest struct {
Index string
AllowNoIndices *bool
ExpandWildcards string
*bool
MasterTimeout time.Duration
Timeout time.Duration
WaitForActiveShards string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesUnfreezeRequest configures the Indices Unfreeze API request.
Do executes the request and returns response or error.
type IndicesUpdateAliases func(body io.Reader, o ...func(*IndicesUpdateAliasesRequest)) (*Response, error)
IndicesUpdateAliases updates index aliases.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html.
func (f IndicesUpdateAliases) WithContext(v context.Context) func(*IndicesUpdateAliasesRequest)
WithContext sets the request context.
func (f IndicesUpdateAliases) WithErrorTrace() func(*IndicesUpdateAliasesRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesUpdateAliases) WithFilterPath(v ...string) func(*IndicesUpdateAliasesRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesUpdateAliases) WithHeader(h map[string]string) func(*IndicesUpdateAliasesRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesUpdateAliases) WithHuman() func(*IndicesUpdateAliasesRequest)
WithHuman makes statistical values human-readable.
func (f IndicesUpdateAliases) WithMasterTimeout(v time.Duration) func(*IndicesUpdateAliasesRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f IndicesUpdateAliases) WithPretty() func(*IndicesUpdateAliasesRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesUpdateAliases) WithTimeout(v time.Duration) func(*IndicesUpdateAliasesRequest)
WithTimeout - request timeout.
type IndicesUpdateAliasesRequest struct {
Body io.Reader
MasterTimeout time.Duration
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesUpdateAliasesRequest configures the Indices Update Aliases API request.
func (r IndicesUpdateAliasesRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type IndicesUpgrade func(o ...func(*IndicesUpgradeRequest)) (*Response, error)
IndicesUpgrade the _upgrade API is no longer useful and will be removed.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html.
func (f IndicesUpgrade) WithAllowNoIndices(v bool) func(*IndicesUpgradeRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesUpgrade) WithContext(v context.Context) func(*IndicesUpgradeRequest)
WithContext sets the request context.
func (f IndicesUpgrade) WithErrorTrace() func(*IndicesUpgradeRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesUpgrade) WithExpandWildcards(v string) func(*IndicesUpgradeRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesUpgrade) WithFilterPath(v ...string) func(*IndicesUpgradeRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesUpgrade) WithHeader(h map[string]string) func(*IndicesUpgradeRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesUpgrade) WithHuman() func(*IndicesUpgradeRequest)
WithHuman makes statistical values human-readable.
func (f IndicesUpgrade) WithIgnoreUnavailable(v bool) func(*IndicesUpgradeRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesUpgrade) WithIndex(v ...string) func(*IndicesUpgradeRequest)
WithIndex - a list of index names; use _all to perform the operation on all indices.
func (f IndicesUpgrade) WithOnlyAncientSegments(v bool) func(*IndicesUpgradeRequest)
WithOnlyAncientSegments - if true, only ancient (an older lucene major release) segments will be upgraded.
func (f IndicesUpgrade) WithPretty() func(*IndicesUpgradeRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesUpgrade) WithWaitForCompletion(v bool) func(*IndicesUpgradeRequest)
WithWaitForCompletion - specify whether the request should block until the all segments are upgraded (default: false).
type IndicesUpgradeRequest struct {
Index []string
AllowNoIndices *bool
ExpandWildcards string
*bool
OnlyAncientSegments *bool
WaitForCompletion *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesUpgradeRequest configures the Indices Upgrade API request.
Do executes the request and returns response or error.
type IndicesValidateQuery func(o ...func(*IndicesValidateQueryRequest)) (*Response, error)
IndicesValidateQuery allows a user to validate a potentially expensive query without executing it.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html.
func (f IndicesValidateQuery) WithAllShards(v bool) func(*IndicesValidateQueryRequest)
WithAllShards - execute validation on all shards instead of one random shard per index.
func (f IndicesValidateQuery) WithAllowNoIndices(v bool) func(*IndicesValidateQueryRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f IndicesValidateQuery) WithAnalyzeWildcard(v bool) func(*IndicesValidateQueryRequest)
WithAnalyzeWildcard - specify whether wildcard and prefix queries should be analyzed (default: false).
func (f IndicesValidateQuery) WithAnalyzer(v string) func(*IndicesValidateQueryRequest)
WithAnalyzer - the analyzer to use for the query string.
func (f IndicesValidateQuery) WithBody(v io.Reader) func(*IndicesValidateQueryRequest)
WithBody - The query definition specified with the Query DSL.
func (f IndicesValidateQuery) WithContext(v context.Context) func(*IndicesValidateQueryRequest)
WithContext sets the request context.
func (f IndicesValidateQuery) WithDefaultOperator(v string) func(*IndicesValidateQueryRequest)
WithDefaultOperator - the default operator for query string query (and or or).
func (f IndicesValidateQuery) WithDf(v string) func(*IndicesValidateQueryRequest)
WithDf - the field to use as default where no field prefix is given in the query string.
func (f IndicesValidateQuery) WithDocumentType(v ...string) func(*IndicesValidateQueryRequest)
WithDocumentType - a list of document types to restrict the operation; leave empty to perform the operation on all types.
func (f IndicesValidateQuery) WithErrorTrace() func(*IndicesValidateQueryRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IndicesValidateQuery) WithExpandWildcards(v string) func(*IndicesValidateQueryRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f IndicesValidateQuery) WithExplain(v bool) func(*IndicesValidateQueryRequest)
WithExplain - return detailed information about the error.
func (f IndicesValidateQuery) WithFilterPath(v ...string) func(*IndicesValidateQueryRequest)
WithFilterPath filters the properties of the response body.
func (f IndicesValidateQuery) WithHeader(h map[string]string) func(*IndicesValidateQueryRequest)
WithHeader adds the headers to the HTTP request.
func (f IndicesValidateQuery) WithHuman() func(*IndicesValidateQueryRequest)
WithHuman makes statistical values human-readable.
func (f IndicesValidateQuery) WithIgnoreUnavailable(v bool) func(*IndicesValidateQueryRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f IndicesValidateQuery) WithIndex(v ...string) func(*IndicesValidateQueryRequest)
WithIndex - a list of index names to restrict the operation; use _all to perform the operation on all indices.
func (f IndicesValidateQuery) WithLenient(v bool) func(*IndicesValidateQueryRequest)
WithLenient - specify whether format-based query failures (such as providing text to a numeric field) should be ignored.
func (f IndicesValidateQuery) WithPretty() func(*IndicesValidateQueryRequest)
WithPretty makes the response body pretty-printed.
func (f IndicesValidateQuery) WithQuery(v string) func(*IndicesValidateQueryRequest)
WithQuery - query in the lucene query string syntax.
func (f IndicesValidateQuery) WithRewrite(v bool) func(*IndicesValidateQueryRequest)
WithRewrite - provide a more detailed explanation showing the actual lucene query that will be executed..
type IndicesValidateQueryRequest struct {
Index []string
DocumentType []string
Body io.Reader
AllowNoIndices *bool
AllShards *bool
Analyzer string
AnalyzeWildcard *bool
DefaultOperator string
Df string
ExpandWildcards string
Explain *bool
*bool
Lenient *bool
Query string
Rewrite *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IndicesValidateQueryRequest configures the Indices Validate Query API request.
func (r IndicesValidateQueryRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type Info func(o ...func(*InfoRequest)) (*Response, error)
Info returns basic information about the cluster.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html.
func (f Info) WithContext(v context.Context) func(*InfoRequest)
WithContext sets the request context.
func (f Info) WithErrorTrace() func(*InfoRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Info) WithFilterPath(v ...string) func(*InfoRequest)
WithFilterPath filters the properties of the response body.
func (f Info) WithHeader(h map[string]string) func(*InfoRequest)
WithHeader adds the headers to the HTTP request.
func (f Info) WithHuman() func(*InfoRequest)
WithHuman makes statistical values human-readable.
type InfoRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}InfoRequest configures the Info API request.
Do executes the request and returns response or error.
type Ingest struct {
DeletePipeline IngestDeletePipeline
GetPipeline IngestGetPipeline
ProcessorGrok IngestProcessorGrok
PutPipeline IngestPutPipeline
Simulate IngestSimulate
}Ingest contains the Ingest APIs
type IngestDeletePipeline func(id string, o ...func(*IngestDeletePipelineRequest)) (*Response, error)
IngestDeletePipeline deletes a pipeline.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html.
func (f IngestDeletePipeline) WithContext(v context.Context) func(*IngestDeletePipelineRequest)
WithContext sets the request context.
func (f IngestDeletePipeline) WithErrorTrace() func(*IngestDeletePipelineRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IngestDeletePipeline) WithFilterPath(v ...string) func(*IngestDeletePipelineRequest)
WithFilterPath filters the properties of the response body.
func (f IngestDeletePipeline) WithHeader(h map[string]string) func(*IngestDeletePipelineRequest)
WithHeader adds the headers to the HTTP request.
func (f IngestDeletePipeline) WithHuman() func(*IngestDeletePipelineRequest)
WithHuman makes statistical values human-readable.
func (f IngestDeletePipeline) WithMasterTimeout(v time.Duration) func(*IngestDeletePipelineRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f IngestDeletePipeline) WithPretty() func(*IngestDeletePipelineRequest)
WithPretty makes the response body pretty-printed.
func (f IngestDeletePipeline) WithTimeout(v time.Duration) func(*IngestDeletePipelineRequest)
WithTimeout - explicit operation timeout.
type IngestDeletePipelineRequest struct {
PipelineID string
MasterTimeout time.Duration
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IngestDeletePipelineRequest configures the Ingest Delete Pipeline API request.
func (r IngestDeletePipelineRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type IngestGetPipeline func(o ...func(*IngestGetPipelineRequest)) (*Response, error)
IngestGetPipeline returns a pipeline.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html.
func (f IngestGetPipeline) WithContext(v context.Context) func(*IngestGetPipelineRequest)
WithContext sets the request context.
func (f IngestGetPipeline) WithErrorTrace() func(*IngestGetPipelineRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IngestGetPipeline) WithFilterPath(v ...string) func(*IngestGetPipelineRequest)
WithFilterPath filters the properties of the response body.
func (f IngestGetPipeline) WithHeader(h map[string]string) func(*IngestGetPipelineRequest)
WithHeader adds the headers to the HTTP request.
func (f IngestGetPipeline) WithHuman() func(*IngestGetPipelineRequest)
WithHuman makes statistical values human-readable.
func (f IngestGetPipeline) WithMasterTimeout(v time.Duration) func(*IngestGetPipelineRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f IngestGetPipeline) WithPipelineID(v string) func(*IngestGetPipelineRequest)
WithPipelineID - comma separated list of pipeline ids. wildcards supported.
func (f IngestGetPipeline) WithPretty() func(*IngestGetPipelineRequest)
WithPretty makes the response body pretty-printed.
type IngestGetPipelineRequest struct {
PipelineID string
MasterTimeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IngestGetPipelineRequest configures the Ingest Get Pipeline API request.
Do executes the request and returns response or error.
type IngestProcessorGrok func(o ...func(*IngestProcessorGrokRequest)) (*Response, error)
IngestProcessorGrok returns a list of the built-in patterns.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/grok-processor.html#grok-processor-rest-get.
func (f IngestProcessorGrok) WithContext(v context.Context) func(*IngestProcessorGrokRequest)
WithContext sets the request context.
func (f IngestProcessorGrok) WithErrorTrace() func(*IngestProcessorGrokRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IngestProcessorGrok) WithFilterPath(v ...string) func(*IngestProcessorGrokRequest)
WithFilterPath filters the properties of the response body.
func (f IngestProcessorGrok) WithHeader(h map[string]string) func(*IngestProcessorGrokRequest)
WithHeader adds the headers to the HTTP request.
func (f IngestProcessorGrok) WithHuman() func(*IngestProcessorGrokRequest)
WithHuman makes statistical values human-readable.
func (f IngestProcessorGrok) WithPretty() func(*IngestProcessorGrokRequest)
WithPretty makes the response body pretty-printed.
type IngestProcessorGrokRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IngestProcessorGrokRequest configures the Ingest Processor Grok API request.
func (r IngestProcessorGrokRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type IngestPutPipeline func(id string, body io.Reader, o ...func(*IngestPutPipelineRequest)) (*Response, error)
IngestPutPipeline creates or updates a pipeline.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/put-pipeline-api.html.
func (f IngestPutPipeline) WithContext(v context.Context) func(*IngestPutPipelineRequest)
WithContext sets the request context.
func (f IngestPutPipeline) WithErrorTrace() func(*IngestPutPipelineRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IngestPutPipeline) WithFilterPath(v ...string) func(*IngestPutPipelineRequest)
WithFilterPath filters the properties of the response body.
func (f IngestPutPipeline) WithHeader(h map[string]string) func(*IngestPutPipelineRequest)
WithHeader adds the headers to the HTTP request.
func (f IngestPutPipeline) WithHuman() func(*IngestPutPipelineRequest)
WithHuman makes statistical values human-readable.
func (f IngestPutPipeline) WithMasterTimeout(v time.Duration) func(*IngestPutPipelineRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f IngestPutPipeline) WithPretty() func(*IngestPutPipelineRequest)
WithPretty makes the response body pretty-printed.
func (f IngestPutPipeline) WithTimeout(v time.Duration) func(*IngestPutPipelineRequest)
WithTimeout - explicit operation timeout.
type IngestPutPipelineRequest struct {
PipelineID string
Body io.Reader
MasterTimeout time.Duration
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IngestPutPipelineRequest configures the Ingest Put Pipeline API request.
Do executes the request and returns response or error.
IngestSimulate allows to simulate a pipeline with example documents.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html.
func (f IngestSimulate) WithContext(v context.Context) func(*IngestSimulateRequest)
WithContext sets the request context.
func (f IngestSimulate) WithErrorTrace() func(*IngestSimulateRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f IngestSimulate) WithFilterPath(v ...string) func(*IngestSimulateRequest)
WithFilterPath filters the properties of the response body.
func (f IngestSimulate) WithHeader(h map[string]string) func(*IngestSimulateRequest)
WithHeader adds the headers to the HTTP request.
func (f IngestSimulate) WithHuman() func(*IngestSimulateRequest)
WithHuman makes statistical values human-readable.
func (f IngestSimulate) WithPipelineID(v string) func(*IngestSimulateRequest)
WithPipelineID - pipeline ID.
func (f IngestSimulate) WithPretty() func(*IngestSimulateRequest)
WithPretty makes the response body pretty-printed.
func (f IngestSimulate) WithVerbose(v bool) func(*IngestSimulateRequest)
WithVerbose - verbose mode. display data output for each processor in executed pipeline.
type IngestSimulateRequest struct {
PipelineID string
Body io.Reader
Verbose *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}IngestSimulateRequest configures the Ingest Simulate API request.
Do executes the request and returns response or error.
type License struct {
Delete LicenseDelete
GetBasicStatus LicenseGetBasicStatus
Get LicenseGet
GetTrialStatus LicenseGetTrialStatus
Post LicensePost
PostStartBasic LicensePostStartBasic
PostStartTrial LicensePostStartTrial
}License contains the License APIs
type LicenseDelete func(o ...func(*LicenseDeleteRequest)) (*Response, error)
LicenseDelete - https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html
func (f LicenseDelete) WithContext(v context.Context) func(*LicenseDeleteRequest)
WithContext sets the request context.
func (f LicenseDelete) WithErrorTrace() func(*LicenseDeleteRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f LicenseDelete) WithFilterPath(v ...string) func(*LicenseDeleteRequest)
WithFilterPath filters the properties of the response body.
func (f LicenseDelete) WithHeader(h map[string]string) func(*LicenseDeleteRequest)
WithHeader adds the headers to the HTTP request.
func (f LicenseDelete) WithHuman() func(*LicenseDeleteRequest)
WithHuman makes statistical values human-readable.
func (f LicenseDelete) WithPretty() func(*LicenseDeleteRequest)
WithPretty makes the response body pretty-printed.
type LicenseDeleteRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}LicenseDeleteRequest configures the License Delete API request.
Do executes the request and returns response or error.
type LicenseGet func(o ...func(*LicenseGetRequest)) (*Response, error)
LicenseGet - https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html
func (f LicenseGet) WithContext(v context.Context) func(*LicenseGetRequest)
WithContext sets the request context.
func (f LicenseGet) WithErrorTrace() func(*LicenseGetRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f LicenseGet) WithFilterPath(v ...string) func(*LicenseGetRequest)
WithFilterPath filters the properties of the response body.
func (f LicenseGet) WithHeader(h map[string]string) func(*LicenseGetRequest)
WithHeader adds the headers to the HTTP request.
func (f LicenseGet) WithHuman() func(*LicenseGetRequest)
WithHuman makes statistical values human-readable.
func (f LicenseGet) WithLocal(v bool) func(*LicenseGetRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f LicenseGet) WithPretty() func(*LicenseGetRequest)
WithPretty makes the response body pretty-printed.
type LicenseGetBasicStatus func(o ...func(*LicenseGetBasicStatusRequest)) (*Response, error)
LicenseGetBasicStatus - https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html
func (f LicenseGetBasicStatus) WithContext(v context.Context) func(*LicenseGetBasicStatusRequest)
WithContext sets the request context.
func (f LicenseGetBasicStatus) WithErrorTrace() func(*LicenseGetBasicStatusRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f LicenseGetBasicStatus) WithFilterPath(v ...string) func(*LicenseGetBasicStatusRequest)
WithFilterPath filters the properties of the response body.
func (f LicenseGetBasicStatus) WithHeader(h map[string]string) func(*LicenseGetBasicStatusRequest)
WithHeader adds the headers to the HTTP request.
func (f LicenseGetBasicStatus) WithHuman() func(*LicenseGetBasicStatusRequest)
WithHuman makes statistical values human-readable.
func (f LicenseGetBasicStatus) WithPretty() func(*LicenseGetBasicStatusRequest)
WithPretty makes the response body pretty-printed.
type LicenseGetBasicStatusRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}LicenseGetBasicStatusRequest configures the License Get Basic Status API request.
func (r LicenseGetBasicStatusRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type LicenseGetRequest struct {
Local *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}LicenseGetRequest configures the License Get API request.
Do executes the request and returns response or error.
type LicenseGetTrialStatus func(o ...func(*LicenseGetTrialStatusRequest)) (*Response, error)
LicenseGetTrialStatus - https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html
func (f LicenseGetTrialStatus) WithContext(v context.Context) func(*LicenseGetTrialStatusRequest)
WithContext sets the request context.
func (f LicenseGetTrialStatus) WithErrorTrace() func(*LicenseGetTrialStatusRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f LicenseGetTrialStatus) WithFilterPath(v ...string) func(*LicenseGetTrialStatusRequest)
WithFilterPath filters the properties of the response body.
func (f LicenseGetTrialStatus) WithHeader(h map[string]string) func(*LicenseGetTrialStatusRequest)
WithHeader adds the headers to the HTTP request.
func (f LicenseGetTrialStatus) WithHuman() func(*LicenseGetTrialStatusRequest)
WithHuman makes statistical values human-readable.
func (f LicenseGetTrialStatus) WithPretty() func(*LicenseGetTrialStatusRequest)
WithPretty makes the response body pretty-printed.
type LicenseGetTrialStatusRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}LicenseGetTrialStatusRequest configures the License Get Trial Status API request.
func (r LicenseGetTrialStatusRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type LicensePost func(o ...func(*LicensePostRequest)) (*Response, error)
LicensePost - https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html
func (f LicensePost) WithAcknowledge(v bool) func(*LicensePostRequest)
WithAcknowledge - whether the user has acknowledged acknowledge messages (default: false).
func (f LicensePost) WithBody(v io.Reader) func(*LicensePostRequest)
WithBody - licenses to be installed.
func (f LicensePost) WithContext(v context.Context) func(*LicensePostRequest)
WithContext sets the request context.
func (f LicensePost) WithErrorTrace() func(*LicensePostRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f LicensePost) WithFilterPath(v ...string) func(*LicensePostRequest)
WithFilterPath filters the properties of the response body.
func (f LicensePost) WithHeader(h map[string]string) func(*LicensePostRequest)
WithHeader adds the headers to the HTTP request.
func (f LicensePost) WithHuman() func(*LicensePostRequest)
WithHuman makes statistical values human-readable.
func (f LicensePost) WithPretty() func(*LicensePostRequest)
WithPretty makes the response body pretty-printed.
type LicensePostRequest struct {
Body io.Reader
Acknowledge *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}LicensePostRequest configures the License Post API request.
Do executes the request and returns response or error.
type LicensePostStartBasic func(o ...func(*LicensePostStartBasicRequest)) (*Response, error)
LicensePostStartBasic - https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html
func (f LicensePostStartBasic) WithAcknowledge(v bool) func(*LicensePostStartBasicRequest)
WithAcknowledge - whether the user has acknowledged acknowledge messages (default: false).
func (f LicensePostStartBasic) WithContext(v context.Context) func(*LicensePostStartBasicRequest)
WithContext sets the request context.
func (f LicensePostStartBasic) WithErrorTrace() func(*LicensePostStartBasicRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f LicensePostStartBasic) WithFilterPath(v ...string) func(*LicensePostStartBasicRequest)
WithFilterPath filters the properties of the response body.
func (f LicensePostStartBasic) WithHeader(h map[string]string) func(*LicensePostStartBasicRequest)
WithHeader adds the headers to the HTTP request.
func (f LicensePostStartBasic) WithHuman() func(*LicensePostStartBasicRequest)
WithHuman makes statistical values human-readable.
func (f LicensePostStartBasic) WithPretty() func(*LicensePostStartBasicRequest)
WithPretty makes the response body pretty-printed.
type LicensePostStartBasicRequest struct {
Acknowledge *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}LicensePostStartBasicRequest configures the License Post Start Basic API request.
func (r LicensePostStartBasicRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type LicensePostStartTrial func(o ...func(*LicensePostStartTrialRequest)) (*Response, error)
LicensePostStartTrial - https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html
func (f LicensePostStartTrial) WithAcknowledge(v bool) func(*LicensePostStartTrialRequest)
WithAcknowledge - whether the user has acknowledged acknowledge messages (default: false).
func (f LicensePostStartTrial) WithContext(v context.Context) func(*LicensePostStartTrialRequest)
WithContext sets the request context.
func (f LicensePostStartTrial) WithDocumentType(v string) func(*LicensePostStartTrialRequest)
WithDocumentType - the type of trial license to generate (default: "trial").
func (f LicensePostStartTrial) WithErrorTrace() func(*LicensePostStartTrialRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f LicensePostStartTrial) WithFilterPath(v ...string) func(*LicensePostStartTrialRequest)
WithFilterPath filters the properties of the response body.
func (f LicensePostStartTrial) WithHeader(h map[string]string) func(*LicensePostStartTrialRequest)
WithHeader adds the headers to the HTTP request.
func (f LicensePostStartTrial) WithHuman() func(*LicensePostStartTrialRequest)
WithHuman makes statistical values human-readable.
func (f LicensePostStartTrial) WithPretty() func(*LicensePostStartTrialRequest)
WithPretty makes the response body pretty-printed.
type LicensePostStartTrialRequest struct {
Acknowledge *bool
DocumentType string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}LicensePostStartTrialRequest configures the License Post Start Trial API request.
func (r LicensePostStartTrialRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type ML struct {
CloseJob MLCloseJob
DeleteCalendarEvent MLDeleteCalendarEvent
DeleteCalendarJob MLDeleteCalendarJob
DeleteCalendar MLDeleteCalendar
DeleteDataFrameAnalytics MLDeleteDataFrameAnalytics
DeleteDatafeed MLDeleteDatafeed
DeleteExpiredData MLDeleteExpiredData
DeleteFilter MLDeleteFilter
DeleteForecast MLDeleteForecast
DeleteJob MLDeleteJob
DeleteModelSnapshot MLDeleteModelSnapshot
EvaluateDataFrame MLEvaluateDataFrame
FindFileStructure MLFindFileStructure
FlushJob MLFlushJob
Forecast MLForecast
GetBuckets MLGetBuckets
GetCalendarEvents MLGetCalendarEvents
GetCalendars MLGetCalendars
GetCategories MLGetCategories
GetDataFrameAnalytics MLGetDataFrameAnalytics
GetDataFrameAnalyticsStats MLGetDataFrameAnalyticsStats
GetDatafeedStats MLGetDatafeedStats
GetDatafeeds MLGetDatafeeds
GetFilters MLGetFilters
GetInfluencers MLGetInfluencers
GetJobStats MLGetJobStats
GetJobs MLGetJobs
GetModelSnapshots MLGetModelSnapshots
GetOverallBuckets MLGetOverallBuckets
GetRecords MLGetRecords
Info MLInfo
OpenJob MLOpenJob
PostCalendarEvents MLPostCalendarEvents
PostData MLPostData
PreviewDatafeed MLPreviewDatafeed
PutCalendarJob MLPutCalendarJob
PutCalendar MLPutCalendar
PutDataFrameAnalytics MLPutDataFrameAnalytics
PutDatafeed MLPutDatafeed
PutFilter MLPutFilter
PutJob MLPutJob
RevertModelSnapshot MLRevertModelSnapshot
SetUpgradeMode MLSetUpgradeMode
StartDataFrameAnalytics MLStartDataFrameAnalytics
StartDatafeed MLStartDatafeed
StopDataFrameAnalytics MLStopDataFrameAnalytics
StopDatafeed MLStopDatafeed
UpdateDatafeed MLUpdateDatafeed
UpdateFilter MLUpdateFilter
UpdateJob MLUpdateJob
UpdateModelSnapshot MLUpdateModelSnapshot
ValidateDetector MLValidateDetector
Validate MLValidate
}ML contains the ML APIs
type MLCloseJob func(job_id string, o ...func(*MLCloseJobRequest)) (*Response, error)
MLCloseJob - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html
func (f MLCloseJob) WithAllowNoJobs(v bool) func(*MLCloseJobRequest)
WithAllowNoJobs - whether to ignore if a wildcard expression matches no jobs. (this includes `_all` string or when no jobs have been specified).
func (f MLCloseJob) WithBody(v io.Reader) func(*MLCloseJobRequest)
WithBody - The URL params optionally sent in the body.
func (f MLCloseJob) WithContext(v context.Context) func(*MLCloseJobRequest)
WithContext sets the request context.
func (f MLCloseJob) WithErrorTrace() func(*MLCloseJobRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLCloseJob) WithFilterPath(v ...string) func(*MLCloseJobRequest)
WithFilterPath filters the properties of the response body.
func (f MLCloseJob) WithForce(v bool) func(*MLCloseJobRequest)
WithForce - true if the job should be forcefully closed.
func (f MLCloseJob) WithHeader(h map[string]string) func(*MLCloseJobRequest)
WithHeader adds the headers to the HTTP request.
func (f MLCloseJob) WithHuman() func(*MLCloseJobRequest)
WithHuman makes statistical values human-readable.
func (f MLCloseJob) WithPretty() func(*MLCloseJobRequest)
WithPretty makes the response body pretty-printed.
func (f MLCloseJob) WithTimeout(v time.Duration) func(*MLCloseJobRequest)
WithTimeout - controls the time to wait until a job has closed. default to 30 minutes.
type MLCloseJobRequest struct {
Body io.Reader
JobID string
AllowNoJobs *bool
Force *bool
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLCloseJobRequest configures the ML Close Job API request.
Do executes the request and returns response or error.
type MLDeleteCalendar func(calendar_id string, o ...func(*MLDeleteCalendarRequest)) (*Response, error)
MLDeleteCalendar -
func (f MLDeleteCalendar) WithContext(v context.Context) func(*MLDeleteCalendarRequest)
WithContext sets the request context.
func (f MLDeleteCalendar) WithErrorTrace() func(*MLDeleteCalendarRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLDeleteCalendar) WithFilterPath(v ...string) func(*MLDeleteCalendarRequest)
WithFilterPath filters the properties of the response body.
func (f MLDeleteCalendar) WithHeader(h map[string]string) func(*MLDeleteCalendarRequest)
WithHeader adds the headers to the HTTP request.
func (f MLDeleteCalendar) WithHuman() func(*MLDeleteCalendarRequest)
WithHuman makes statistical values human-readable.
func (f MLDeleteCalendar) WithPretty() func(*MLDeleteCalendarRequest)
WithPretty makes the response body pretty-printed.
type MLDeleteCalendarEvent func(calendar_id string, event_id string, o ...func(*MLDeleteCalendarEventRequest)) (*Response, error)
MLDeleteCalendarEvent -
func (f MLDeleteCalendarEvent) WithContext(v context.Context) func(*MLDeleteCalendarEventRequest)
WithContext sets the request context.
func (f MLDeleteCalendarEvent) WithErrorTrace() func(*MLDeleteCalendarEventRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLDeleteCalendarEvent) WithFilterPath(v ...string) func(*MLDeleteCalendarEventRequest)
WithFilterPath filters the properties of the response body.
func (f MLDeleteCalendarEvent) WithHeader(h map[string]string) func(*MLDeleteCalendarEventRequest)
WithHeader adds the headers to the HTTP request.
func (f MLDeleteCalendarEvent) WithHuman() func(*MLDeleteCalendarEventRequest)
WithHuman makes statistical values human-readable.
func (f MLDeleteCalendarEvent) WithPretty() func(*MLDeleteCalendarEventRequest)
WithPretty makes the response body pretty-printed.
type MLDeleteCalendarEventRequest struct {
CalendarID string
EventID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLDeleteCalendarEventRequest configures the ML Delete Calendar Event API request.
func (r MLDeleteCalendarEventRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type MLDeleteCalendarJob func(calendar_id string, job_id string, o ...func(*MLDeleteCalendarJobRequest)) (*Response, error)
MLDeleteCalendarJob -
func (f MLDeleteCalendarJob) WithContext(v context.Context) func(*MLDeleteCalendarJobRequest)
WithContext sets the request context.
func (f MLDeleteCalendarJob) WithErrorTrace() func(*MLDeleteCalendarJobRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLDeleteCalendarJob) WithFilterPath(v ...string) func(*MLDeleteCalendarJobRequest)
WithFilterPath filters the properties of the response body.
func (f MLDeleteCalendarJob) WithHeader(h map[string]string) func(*MLDeleteCalendarJobRequest)
WithHeader adds the headers to the HTTP request.
func (f MLDeleteCalendarJob) WithHuman() func(*MLDeleteCalendarJobRequest)
WithHuman makes statistical values human-readable.
func (f MLDeleteCalendarJob) WithPretty() func(*MLDeleteCalendarJobRequest)
WithPretty makes the response body pretty-printed.
type MLDeleteCalendarJobRequest struct {
CalendarID string
JobID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLDeleteCalendarJobRequest configures the ML Delete Calendar Job API request.
func (r MLDeleteCalendarJobRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type MLDeleteCalendarRequest struct {
CalendarID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLDeleteCalendarRequest configures the ML Delete Calendar API request.
Do executes the request and returns response or error.
type MLDeleteDataFrameAnalytics func(id string, o ...func(*MLDeleteDataFrameAnalyticsRequest)) (*Response, error)
MLDeleteDataFrameAnalytics - http://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html
func (f MLDeleteDataFrameAnalytics) WithContext(v context.Context) func(*MLDeleteDataFrameAnalyticsRequest)
WithContext sets the request context.
func (f MLDeleteDataFrameAnalytics) WithErrorTrace() func(*MLDeleteDataFrameAnalyticsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLDeleteDataFrameAnalytics) WithFilterPath(v ...string) func(*MLDeleteDataFrameAnalyticsRequest)
WithFilterPath filters the properties of the response body.
func (f MLDeleteDataFrameAnalytics) WithHeader(h map[string]string) func(*MLDeleteDataFrameAnalyticsRequest)
WithHeader adds the headers to the HTTP request.
func (f MLDeleteDataFrameAnalytics) WithHuman() func(*MLDeleteDataFrameAnalyticsRequest)
WithHuman makes statistical values human-readable.
func (f MLDeleteDataFrameAnalytics) WithPretty() func(*MLDeleteDataFrameAnalyticsRequest)
WithPretty makes the response body pretty-printed.
type MLDeleteDataFrameAnalyticsRequest struct {
ID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLDeleteDataFrameAnalyticsRequest configures the ML Delete Data Frame Analytics API request.
func (r MLDeleteDataFrameAnalyticsRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type MLDeleteDatafeed func(datafeed_id string, o ...func(*MLDeleteDatafeedRequest)) (*Response, error)
MLDeleteDatafeed - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html
func (f MLDeleteDatafeed) WithContext(v context.Context) func(*MLDeleteDatafeedRequest)
WithContext sets the request context.
func (f MLDeleteDatafeed) WithErrorTrace() func(*MLDeleteDatafeedRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLDeleteDatafeed) WithFilterPath(v ...string) func(*MLDeleteDatafeedRequest)
WithFilterPath filters the properties of the response body.
func (f MLDeleteDatafeed) WithForce(v bool) func(*MLDeleteDatafeedRequest)
WithForce - true if the datafeed should be forcefully deleted.
func (f MLDeleteDatafeed) WithHeader(h map[string]string) func(*MLDeleteDatafeedRequest)
WithHeader adds the headers to the HTTP request.
func (f MLDeleteDatafeed) WithHuman() func(*MLDeleteDatafeedRequest)
WithHuman makes statistical values human-readable.
func (f MLDeleteDatafeed) WithPretty() func(*MLDeleteDatafeedRequest)
WithPretty makes the response body pretty-printed.
type MLDeleteDatafeedRequest struct {
DatafeedID string
Force *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLDeleteDatafeedRequest configures the ML Delete Datafeed API request.
Do executes the request and returns response or error.
type MLDeleteExpiredData func(o ...func(*MLDeleteExpiredDataRequest)) (*Response, error)
MLDeleteExpiredData -
func (f MLDeleteExpiredData) WithContext(v context.Context) func(*MLDeleteExpiredDataRequest)
WithContext sets the request context.
func (f MLDeleteExpiredData) WithErrorTrace() func(*MLDeleteExpiredDataRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLDeleteExpiredData) WithFilterPath(v ...string) func(*MLDeleteExpiredDataRequest)
WithFilterPath filters the properties of the response body.
func (f MLDeleteExpiredData) WithHeader(h map[string]string) func(*MLDeleteExpiredDataRequest)
WithHeader adds the headers to the HTTP request.
func (f MLDeleteExpiredData) WithHuman() func(*MLDeleteExpiredDataRequest)
WithHuman makes statistical values human-readable.
func (f MLDeleteExpiredData) WithPretty() func(*MLDeleteExpiredDataRequest)
WithPretty makes the response body pretty-printed.
type MLDeleteExpiredDataRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLDeleteExpiredDataRequest configures the ML Delete Expired Data API request.
func (r MLDeleteExpiredDataRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type MLDeleteFilter func(filter_id string, o ...func(*MLDeleteFilterRequest)) (*Response, error)
MLDeleteFilter -
func (f MLDeleteFilter) WithContext(v context.Context) func(*MLDeleteFilterRequest)
WithContext sets the request context.
func (f MLDeleteFilter) WithErrorTrace() func(*MLDeleteFilterRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLDeleteFilter) WithFilterPath(v ...string) func(*MLDeleteFilterRequest)
WithFilterPath filters the properties of the response body.
func (f MLDeleteFilter) WithHeader(h map[string]string) func(*MLDeleteFilterRequest)
WithHeader adds the headers to the HTTP request.
func (f MLDeleteFilter) WithHuman() func(*MLDeleteFilterRequest)
WithHuman makes statistical values human-readable.
func (f MLDeleteFilter) WithPretty() func(*MLDeleteFilterRequest)
WithPretty makes the response body pretty-printed.
type MLDeleteFilterRequest struct {
FilterID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLDeleteFilterRequest configures the ML Delete Filter API request.
Do executes the request and returns response or error.
type MLDeleteForecast func(job_id string, o ...func(*MLDeleteForecastRequest)) (*Response, error)
MLDeleteForecast - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html
func (f MLDeleteForecast) WithAllowNoForecasts(v bool) func(*MLDeleteForecastRequest)
WithAllowNoForecasts - whether to ignore if `_all` matches no forecasts.
func (f MLDeleteForecast) WithContext(v context.Context) func(*MLDeleteForecastRequest)
WithContext sets the request context.
func (f MLDeleteForecast) WithErrorTrace() func(*MLDeleteForecastRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLDeleteForecast) WithFilterPath(v ...string) func(*MLDeleteForecastRequest)
WithFilterPath filters the properties of the response body.
func (f MLDeleteForecast) WithForecastID(v string) func(*MLDeleteForecastRequest)
WithForecastID - the ID of the forecast to delete, can be comma delimited list. leaving blank implies `_all`.
func (f MLDeleteForecast) WithHeader(h map[string]string) func(*MLDeleteForecastRequest)
WithHeader adds the headers to the HTTP request.
func (f MLDeleteForecast) WithHuman() func(*MLDeleteForecastRequest)
WithHuman makes statistical values human-readable.
func (f MLDeleteForecast) WithPretty() func(*MLDeleteForecastRequest)
WithPretty makes the response body pretty-printed.
func (f MLDeleteForecast) WithTimeout(v time.Duration) func(*MLDeleteForecastRequest)
WithTimeout - controls the time to wait until the forecast(s) are deleted. default to 30 seconds.
type MLDeleteForecastRequest struct {
ForecastID string
JobID string
AllowNoForecasts *bool
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLDeleteForecastRequest configures the ML Delete Forecast API request.
Do executes the request and returns response or error.
type MLDeleteJob func(job_id string, o ...func(*MLDeleteJobRequest)) (*Response, error)
MLDeleteJob - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html
func (f MLDeleteJob) WithContext(v context.Context) func(*MLDeleteJobRequest)
WithContext sets the request context.
func (f MLDeleteJob) WithErrorTrace() func(*MLDeleteJobRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLDeleteJob) WithFilterPath(v ...string) func(*MLDeleteJobRequest)
WithFilterPath filters the properties of the response body.
func (f MLDeleteJob) WithForce(v bool) func(*MLDeleteJobRequest)
WithForce - true if the job should be forcefully deleted.
func (f MLDeleteJob) WithHeader(h map[string]string) func(*MLDeleteJobRequest)
WithHeader adds the headers to the HTTP request.
func (f MLDeleteJob) WithHuman() func(*MLDeleteJobRequest)
WithHuman makes statistical values human-readable.
func (f MLDeleteJob) WithPretty() func(*MLDeleteJobRequest)
WithPretty makes the response body pretty-printed.
func (f MLDeleteJob) WithWaitForCompletion(v bool) func(*MLDeleteJobRequest)
WithWaitForCompletion - should this request wait until the operation has completed before returning.
type MLDeleteJobRequest struct {
JobID string
Force *bool
WaitForCompletion *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLDeleteJobRequest configures the ML Delete Job API request.
Do executes the request and returns response or error.
type MLDeleteModelSnapshot func(snapshot_id string, job_id string, o ...func(*MLDeleteModelSnapshotRequest)) (*Response, error)
MLDeleteModelSnapshot - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html
func (f MLDeleteModelSnapshot) WithContext(v context.Context) func(*MLDeleteModelSnapshotRequest)
WithContext sets the request context.
func (f MLDeleteModelSnapshot) WithErrorTrace() func(*MLDeleteModelSnapshotRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLDeleteModelSnapshot) WithFilterPath(v ...string) func(*MLDeleteModelSnapshotRequest)
WithFilterPath filters the properties of the response body.
func (f MLDeleteModelSnapshot) WithHeader(h map[string]string) func(*MLDeleteModelSnapshotRequest)
WithHeader adds the headers to the HTTP request.
func (f MLDeleteModelSnapshot) WithHuman() func(*MLDeleteModelSnapshotRequest)
WithHuman makes statistical values human-readable.
func (f MLDeleteModelSnapshot) WithPretty() func(*MLDeleteModelSnapshotRequest)
WithPretty makes the response body pretty-printed.
type MLDeleteModelSnapshotRequest struct {
JobID string
SnapshotID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLDeleteModelSnapshotRequest configures the ML Delete Model Snapshot API request.
func (r MLDeleteModelSnapshotRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type MLEvaluateDataFrame func(body io.Reader, o ...func(*MLEvaluateDataFrameRequest)) (*Response, error)
MLEvaluateDataFrame - http://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html
func (f MLEvaluateDataFrame) WithContext(v context.Context) func(*MLEvaluateDataFrameRequest)
WithContext sets the request context.
func (f MLEvaluateDataFrame) WithErrorTrace() func(*MLEvaluateDataFrameRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLEvaluateDataFrame) WithFilterPath(v ...string) func(*MLEvaluateDataFrameRequest)
WithFilterPath filters the properties of the response body.
func (f MLEvaluateDataFrame) WithHeader(h map[string]string) func(*MLEvaluateDataFrameRequest)
WithHeader adds the headers to the HTTP request.
func (f MLEvaluateDataFrame) WithHuman() func(*MLEvaluateDataFrameRequest)
WithHuman makes statistical values human-readable.
func (f MLEvaluateDataFrame) WithPretty() func(*MLEvaluateDataFrameRequest)
WithPretty makes the response body pretty-printed.
type MLEvaluateDataFrameRequest struct {
Body io.Reader
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLEvaluateDataFrameRequest configures the ML Evaluate Data Frame API request.
func (r MLEvaluateDataFrameRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type MLFindFileStructure func(body io.Reader, o ...func(*MLFindFileStructureRequest)) (*Response, error)
MLFindFileStructure - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-find-file-structure.html
func (f MLFindFileStructure) WithCharset(v string) func(*MLFindFileStructureRequest)
WithCharset - optional parameter to specify the character set of the file.
func (f MLFindFileStructure) WithColumnNames(v ...string) func(*MLFindFileStructureRequest)
WithColumnNames - optional parameter containing a comma separated list of the column names for a delimited file.
func (f MLFindFileStructure) WithContext(v context.Context) func(*MLFindFileStructureRequest)
WithContext sets the request context.
func (f MLFindFileStructure) WithDelimiter(v string) func(*MLFindFileStructureRequest)
WithDelimiter - optional parameter to specify the delimiter character for a delimited file - must be a single character.
func (f MLFindFileStructure) WithErrorTrace() func(*MLFindFileStructureRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLFindFileStructure) WithExplain(v bool) func(*MLFindFileStructureRequest)
WithExplain - whether to include a commentary on how the structure was derived.
func (f MLFindFileStructure) WithFilterPath(v ...string) func(*MLFindFileStructureRequest)
WithFilterPath filters the properties of the response body.
func (f MLFindFileStructure) WithFormat(v string) func(*MLFindFileStructureRequest)
WithFormat - optional parameter to specify the high level file format.
func (f MLFindFileStructure) WithGrokPattern(v string) func(*MLFindFileStructureRequest)
WithGrokPattern - optional parameter to specify the grok pattern that should be used to extract fields from messages in a semi-structured text file.
func (f MLFindFileStructure) WithHasHeaderRow(v bool) func(*MLFindFileStructureRequest)
WithHasHeaderRow - optional parameter to specify whether a delimited file includes the column names in its first row.
func (f MLFindFileStructure) WithHeader(h map[string]string) func(*MLFindFileStructureRequest)
WithHeader adds the headers to the HTTP request.
func (f MLFindFileStructure) WithHuman() func(*MLFindFileStructureRequest)
WithHuman makes statistical values human-readable.
func (f MLFindFileStructure) WithLineMergeSizeLimit(v int) func(*MLFindFileStructureRequest)
WithLineMergeSizeLimit - maximum number of characters permitted in a single message when lines are merged to create messages..
func (f MLFindFileStructure) WithLinesToSample(v int) func(*MLFindFileStructureRequest)
WithLinesToSample - how many lines of the file should be included in the analysis.
func (f MLFindFileStructure) WithPretty() func(*MLFindFileStructureRequest)
WithPretty makes the response body pretty-printed.
func (f MLFindFileStructure) WithQuote(v string) func(*MLFindFileStructureRequest)
WithQuote - optional parameter to specify the quote character for a delimited file - must be a single character.
func (f MLFindFileStructure) WithShouldTrimFields(v bool) func(*MLFindFileStructureRequest)
WithShouldTrimFields - optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them.
func (f MLFindFileStructure) WithTimeout(v time.Duration) func(*MLFindFileStructureRequest)
WithTimeout - timeout after which the analysis will be aborted.
func (f MLFindFileStructure) WithTimestampField(v string) func(*MLFindFileStructureRequest)
WithTimestampField - optional parameter to specify the timestamp field in the file.
func (f MLFindFileStructure) WithTimestampFormat(v string) func(*MLFindFileStructureRequest)
WithTimestampFormat - optional parameter to specify the timestamp format in the file - may be either a joda or java time format.
type MLFindFileStructureRequest struct {
Body io.Reader
Charset string
ColumnNames []string
Delimiter string
Explain *bool
Format string
GrokPattern string
HasHeaderRow *bool
LineMergeSizeLimit *int
LinesToSample *int
Quote string
ShouldTrimFields *bool
Timeout time.Duration
TimestampField string
TimestampFormat string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLFindFileStructureRequest configures the ML Find File Structure API request.
func (r MLFindFileStructureRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type MLFlushJob func(job_id string, o ...func(*MLFlushJobRequest)) (*Response, error)
MLFlushJob - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html
func (f MLFlushJob) WithAdvanceTime(v string) func(*MLFlushJobRequest)
WithAdvanceTime - advances time to the given value generating results and updating the model for the advanced interval.
func (f MLFlushJob) WithBody(v io.Reader) func(*MLFlushJobRequest)
WithBody - Flush parameters.
func (f MLFlushJob) WithCalcInterim(v bool) func(*MLFlushJobRequest)
WithCalcInterim - calculates interim results for the most recent bucket or all buckets within the latency period.
func (f MLFlushJob) WithContext(v context.Context) func(*MLFlushJobRequest)
WithContext sets the request context.
func (f MLFlushJob) WithEnd(v string) func(*MLFlushJobRequest)
WithEnd - when used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results.
func (f MLFlushJob) WithErrorTrace() func(*MLFlushJobRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLFlushJob) WithFilterPath(v ...string) func(*MLFlushJobRequest)
WithFilterPath filters the properties of the response body.
func (f MLFlushJob) WithHeader(h map[string]string) func(*MLFlushJobRequest)
WithHeader adds the headers to the HTTP request.
func (f MLFlushJob) WithHuman() func(*MLFlushJobRequest)
WithHuman makes statistical values human-readable.
func (f MLFlushJob) WithPretty() func(*MLFlushJobRequest)
WithPretty makes the response body pretty-printed.
func (f MLFlushJob) WithSkipTime(v string) func(*MLFlushJobRequest)
WithSkipTime - skips time to the given value without generating results or updating the model for the skipped interval.
func (f MLFlushJob) WithStart(v string) func(*MLFlushJobRequest)
WithStart - when used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results.
type MLFlushJobRequest struct {
Body io.Reader
JobID string
AdvanceTime string
CalcInterim *bool
End string
SkipTime string
Start string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLFlushJobRequest configures the ML Flush Job API request.
Do executes the request and returns response or error.
type MLForecast func(job_id string, o ...func(*MLForecastRequest)) (*Response, error)
MLForecast -
func (f MLForecast) WithContext(v context.Context) func(*MLForecastRequest)
WithContext sets the request context.
func (f MLForecast) WithDuration(v time.Duration) func(*MLForecastRequest)
WithDuration - the duration of the forecast.
func (f MLForecast) WithErrorTrace() func(*MLForecastRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLForecast) WithExpiresIn(v time.Duration) func(*MLForecastRequest)
WithExpiresIn - the time interval after which the forecast expires. expired forecasts will be deleted at the first opportunity..
func (f MLForecast) WithFilterPath(v ...string) func(*MLForecastRequest)
WithFilterPath filters the properties of the response body.
func (f MLForecast) WithHeader(h map[string]string) func(*MLForecastRequest)
WithHeader adds the headers to the HTTP request.
func (f MLForecast) WithHuman() func(*MLForecastRequest)
WithHuman makes statistical values human-readable.
func (f MLForecast) WithPretty() func(*MLForecastRequest)
WithPretty makes the response body pretty-printed.
type MLForecastRequest struct {
JobID string
Duration time.Duration
ExpiresIn time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLForecastRequest configures the ML Forecast API request.
Do executes the request and returns response or error.
type MLGetBuckets func(job_id string, o ...func(*MLGetBucketsRequest)) (*Response, error)
MLGetBuckets - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html
func (f MLGetBuckets) WithAnomalyScore(v interface{}) func(*MLGetBucketsRequest)
WithAnomalyScore - filter for the most anomalous buckets.
func (f MLGetBuckets) WithBody(v io.Reader) func(*MLGetBucketsRequest)
WithBody - Bucket selection details if not provided in URI.
func (f MLGetBuckets) WithContext(v context.Context) func(*MLGetBucketsRequest)
WithContext sets the request context.
func (f MLGetBuckets) WithDesc(v bool) func(*MLGetBucketsRequest)
WithDesc - set the sort direction.
func (f MLGetBuckets) WithEnd(v string) func(*MLGetBucketsRequest)
WithEnd - end time filter for buckets.
func (f MLGetBuckets) WithErrorTrace() func(*MLGetBucketsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLGetBuckets) WithExcludeInterim(v bool) func(*MLGetBucketsRequest)
WithExcludeInterim - exclude interim results.
func (f MLGetBuckets) WithExpand(v bool) func(*MLGetBucketsRequest)
WithExpand - include anomaly records.
func (f MLGetBuckets) WithFilterPath(v ...string) func(*MLGetBucketsRequest)
WithFilterPath filters the properties of the response body.
func (f MLGetBuckets) WithFrom(v int) func(*MLGetBucketsRequest)
WithFrom - skips a number of buckets.
func (f MLGetBuckets) WithHeader(h map[string]string) func(*MLGetBucketsRequest)
WithHeader adds the headers to the HTTP request.
func (f MLGetBuckets) WithHuman() func(*MLGetBucketsRequest)
WithHuman makes statistical values human-readable.
func (f MLGetBuckets) WithPretty() func(*MLGetBucketsRequest)
WithPretty makes the response body pretty-printed.
func (f MLGetBuckets) WithSize(v int) func(*MLGetBucketsRequest)
WithSize - specifies a max number of buckets to get.
func (f MLGetBuckets) WithSort(v string) func(*MLGetBucketsRequest)
WithSort - sort buckets by a particular field.
func (f MLGetBuckets) WithStart(v string) func(*MLGetBucketsRequest)
WithStart - start time filter for buckets.
func (f MLGetBuckets) WithTimestamp(v string) func(*MLGetBucketsRequest)
WithTimestamp - the timestamp of the desired single bucket result.
type MLGetBucketsRequest struct {
Body io.Reader
JobID string
Timestamp string
AnomalyScore interface{}
Desc *bool
End string
ExcludeInterim *bool
Expand *bool
From *int
Size *int
Sort string
Start string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLGetBucketsRequest configures the ML Get Buckets API request.
Do executes the request and returns response or error.
type MLGetCalendarEvents func(calendar_id string, o ...func(*MLGetCalendarEventsRequest)) (*Response, error)
MLGetCalendarEvents -
func (f MLGetCalendarEvents) WithContext(v context.Context) func(*MLGetCalendarEventsRequest)
WithContext sets the request context.
func (f MLGetCalendarEvents) WithEnd(v interface{}) func(*MLGetCalendarEventsRequest)
WithEnd - get events before this time.
func (f MLGetCalendarEvents) WithErrorTrace() func(*MLGetCalendarEventsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLGetCalendarEvents) WithFilterPath(v ...string) func(*MLGetCalendarEventsRequest)
WithFilterPath filters the properties of the response body.
func (f MLGetCalendarEvents) WithFrom(v int) func(*MLGetCalendarEventsRequest)
WithFrom - skips a number of events.
func (f MLGetCalendarEvents) WithHeader(h map[string]string) func(*MLGetCalendarEventsRequest)
WithHeader adds the headers to the HTTP request.
func (f MLGetCalendarEvents) WithHuman() func(*MLGetCalendarEventsRequest)
WithHuman makes statistical values human-readable.
func (f MLGetCalendarEvents) WithJobID(v string) func(*MLGetCalendarEventsRequest)
WithJobID - get events for the job. when this option is used calendar_id must be '_all'.
func (f MLGetCalendarEvents) WithPretty() func(*MLGetCalendarEventsRequest)
WithPretty makes the response body pretty-printed.
func (f MLGetCalendarEvents) WithSize(v int) func(*MLGetCalendarEventsRequest)
WithSize - specifies a max number of events to get.
func (f MLGetCalendarEvents) WithStart(v string) func(*MLGetCalendarEventsRequest)
WithStart - get events after this time.
type MLGetCalendarEventsRequest struct {
CalendarID string
End interface{}
From *int
JobID string
Size *int
Start string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLGetCalendarEventsRequest configures the ML Get Calendar Events API request.
func (r MLGetCalendarEventsRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type MLGetCalendars func(o ...func(*MLGetCalendarsRequest)) (*Response, error)
MLGetCalendars -
func (f MLGetCalendars) WithBody(v io.Reader) func(*MLGetCalendarsRequest)
WithBody - The from and size parameters optionally sent in the body.
func (f MLGetCalendars) WithCalendarID(v string) func(*MLGetCalendarsRequest)
WithCalendarID - the ID of the calendar to fetch.
func (f MLGetCalendars) WithContext(v context.Context) func(*MLGetCalendarsRequest)
WithContext sets the request context.
func (f MLGetCalendars) WithErrorTrace() func(*MLGetCalendarsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLGetCalendars) WithFilterPath(v ...string) func(*MLGetCalendarsRequest)
WithFilterPath filters the properties of the response body.
func (f MLGetCalendars) WithFrom(v int) func(*MLGetCalendarsRequest)
WithFrom - skips a number of calendars.
func (f MLGetCalendars) WithHeader(h map[string]string) func(*MLGetCalendarsRequest)
WithHeader adds the headers to the HTTP request.
func (f MLGetCalendars) WithHuman() func(*MLGetCalendarsRequest)
WithHuman makes statistical values human-readable.
func (f MLGetCalendars) WithPretty() func(*MLGetCalendarsRequest)
WithPretty makes the response body pretty-printed.
func (f MLGetCalendars) WithSize(v int) func(*MLGetCalendarsRequest)
WithSize - specifies a max number of calendars to get.
type MLGetCalendarsRequest struct {
Body io.Reader
CalendarID string
From *int
Size *int
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLGetCalendarsRequest configures the ML Get Calendars API request.
Do executes the request and returns response or error.
type MLGetCategories func(job_id string, o ...func(*MLGetCategoriesRequest)) (*Response, error)
MLGetCategories - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html
func (f MLGetCategories) WithBody(v io.Reader) func(*MLGetCategoriesRequest)
WithBody - Category selection details if not provided in URI.
func (f MLGetCategories) WithCategoryID(v int) func(*MLGetCategoriesRequest)
WithCategoryID - the identifier of the category definition of interest.
func (f MLGetCategories) WithContext(v context.Context) func(*MLGetCategoriesRequest)
WithContext sets the request context.
func (f MLGetCategories) WithErrorTrace() func(*MLGetCategoriesRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLGetCategories) WithFilterPath(v ...string) func(*MLGetCategoriesRequest)
WithFilterPath filters the properties of the response body.
func (f MLGetCategories) WithFrom(v int) func(*MLGetCategoriesRequest)
WithFrom - skips a number of categories.
func (f MLGetCategories) WithHeader(h map[string]string) func(*MLGetCategoriesRequest)
WithHeader adds the headers to the HTTP request.
func (f MLGetCategories) WithHuman() func(*MLGetCategoriesRequest)
WithHuman makes statistical values human-readable.
func (f MLGetCategories) WithPretty() func(*MLGetCategoriesRequest)
WithPretty makes the response body pretty-printed.
func (f MLGetCategories) WithSize(v int) func(*MLGetCategoriesRequest)
WithSize - specifies a max number of categories to get.
type MLGetCategoriesRequest struct {
Body io.Reader
CategoryID *int
JobID string
From *int
Size *int
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLGetCategoriesRequest configures the ML Get Categories API request.
Do executes the request and returns response or error.
type MLGetDataFrameAnalytics func(o ...func(*MLGetDataFrameAnalyticsRequest)) (*Response, error)
MLGetDataFrameAnalytics - http://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html
func (f MLGetDataFrameAnalytics) WithAllowNoMatch(v bool) func(*MLGetDataFrameAnalyticsRequest)
WithAllowNoMatch - whether to ignore if a wildcard expression matches no data frame analytics. (this includes `_all` string or when no data frame analytics have been specified).
func (f MLGetDataFrameAnalytics) WithContext(v context.Context) func(*MLGetDataFrameAnalyticsRequest)
WithContext sets the request context.
func (f MLGetDataFrameAnalytics) WithErrorTrace() func(*MLGetDataFrameAnalyticsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLGetDataFrameAnalytics) WithFilterPath(v ...string) func(*MLGetDataFrameAnalyticsRequest)
WithFilterPath filters the properties of the response body.
func (f MLGetDataFrameAnalytics) WithFrom(v int) func(*MLGetDataFrameAnalyticsRequest)
WithFrom - skips a number of analytics.
func (f MLGetDataFrameAnalytics) WithHeader(h map[string]string) func(*MLGetDataFrameAnalyticsRequest)
WithHeader adds the headers to the HTTP request.
func (f MLGetDataFrameAnalytics) WithHuman() func(*MLGetDataFrameAnalyticsRequest)
WithHuman makes statistical values human-readable.
func (f MLGetDataFrameAnalytics) WithID(v string) func(*MLGetDataFrameAnalyticsRequest)
WithID - the ID of the data frame analytics to fetch.
func (f MLGetDataFrameAnalytics) WithPretty() func(*MLGetDataFrameAnalyticsRequest)
WithPretty makes the response body pretty-printed.
func (f MLGetDataFrameAnalytics) WithSize(v int) func(*MLGetDataFrameAnalyticsRequest)
WithSize - specifies a max number of analytics to get.
type MLGetDataFrameAnalyticsRequest struct {
ID string
AllowNoMatch *bool
From *int
Size *int
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLGetDataFrameAnalyticsRequest configures the ML Get Data Frame Analytics API request.
func (r MLGetDataFrameAnalyticsRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type MLGetDataFrameAnalyticsStats func(o ...func(*MLGetDataFrameAnalyticsStatsRequest)) (*Response, error)
MLGetDataFrameAnalyticsStats - http://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html
func (f MLGetDataFrameAnalyticsStats) WithAllowNoMatch(v bool) func(*MLGetDataFrameAnalyticsStatsRequest)
WithAllowNoMatch - whether to ignore if a wildcard expression matches no data frame analytics. (this includes `_all` string or when no data frame analytics have been specified).
func (f MLGetDataFrameAnalyticsStats) WithContext(v context.Context) func(*MLGetDataFrameAnalyticsStatsRequest)
WithContext sets the request context.
func (f MLGetDataFrameAnalyticsStats) WithErrorTrace() func(*MLGetDataFrameAnalyticsStatsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLGetDataFrameAnalyticsStats) WithFilterPath(v ...string) func(*MLGetDataFrameAnalyticsStatsRequest)
WithFilterPath filters the properties of the response body.
func (f MLGetDataFrameAnalyticsStats) WithFrom(v int) func(*MLGetDataFrameAnalyticsStatsRequest)
WithFrom - skips a number of analytics.
func (f MLGetDataFrameAnalyticsStats) WithHeader(h map[string]string) func(*MLGetDataFrameAnalyticsStatsRequest)
WithHeader adds the headers to the HTTP request.
func (f MLGetDataFrameAnalyticsStats) WithHuman() func(*MLGetDataFrameAnalyticsStatsRequest)
WithHuman makes statistical values human-readable.
func (f MLGetDataFrameAnalyticsStats) WithID(v string) func(*MLGetDataFrameAnalyticsStatsRequest)
WithID - the ID of the data frame analytics stats to fetch.
func (f MLGetDataFrameAnalyticsStats) WithPretty() func(*MLGetDataFrameAnalyticsStatsRequest)
WithPretty makes the response body pretty-printed.
func (f MLGetDataFrameAnalyticsStats) WithSize(v int) func(*MLGetDataFrameAnalyticsStatsRequest)
WithSize - specifies a max number of analytics to get.
type MLGetDataFrameAnalyticsStatsRequest struct {
ID string
AllowNoMatch *bool
From *int
Size *int
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLGetDataFrameAnalyticsStatsRequest configures the ML Get Data Frame Analytics Stats API request.
func (r MLGetDataFrameAnalyticsStatsRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type MLGetDatafeedStats func(o ...func(*MLGetDatafeedStatsRequest)) (*Response, error)
MLGetDatafeedStats - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html
func (f MLGetDatafeedStats) WithAllowNoDatafeeds(v bool) func(*MLGetDatafeedStatsRequest)
WithAllowNoDatafeeds - whether to ignore if a wildcard expression matches no datafeeds. (this includes `_all` string or when no datafeeds have been specified).
func (f MLGetDatafeedStats) WithContext(v context.Context) func(*MLGetDatafeedStatsRequest)
WithContext sets the request context.
func (f MLGetDatafeedStats) WithDatafeedID(v string) func(*MLGetDatafeedStatsRequest)
WithDatafeedID - the ID of the datafeeds stats to fetch.
func (f MLGetDatafeedStats) WithErrorTrace() func(*MLGetDatafeedStatsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLGetDatafeedStats) WithFilterPath(v ...string) func(*MLGetDatafeedStatsRequest)
WithFilterPath filters the properties of the response body.
func (f MLGetDatafeedStats) WithHeader(h map[string]string) func(*MLGetDatafeedStatsRequest)
WithHeader adds the headers to the HTTP request.
func (f MLGetDatafeedStats) WithHuman() func(*MLGetDatafeedStatsRequest)
WithHuman makes statistical values human-readable.
func (f MLGetDatafeedStats) WithPretty() func(*MLGetDatafeedStatsRequest)
WithPretty makes the response body pretty-printed.
type MLGetDatafeedStatsRequest struct {
DatafeedID string
AllowNoDatafeeds *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLGetDatafeedStatsRequest configures the ML Get Datafeed Stats API request.
Do executes the request and returns response or error.
type MLGetDatafeeds func(o ...func(*MLGetDatafeedsRequest)) (*Response, error)
MLGetDatafeeds - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html
func (f MLGetDatafeeds) WithAllowNoDatafeeds(v bool) func(*MLGetDatafeedsRequest)
WithAllowNoDatafeeds - whether to ignore if a wildcard expression matches no datafeeds. (this includes `_all` string or when no datafeeds have been specified).
func (f MLGetDatafeeds) WithContext(v context.Context) func(*MLGetDatafeedsRequest)
WithContext sets the request context.
func (f MLGetDatafeeds) WithDatafeedID(v string) func(*MLGetDatafeedsRequest)
WithDatafeedID - the ID of the datafeeds to fetch.
func (f MLGetDatafeeds) WithErrorTrace() func(*MLGetDatafeedsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLGetDatafeeds) WithFilterPath(v ...string) func(*MLGetDatafeedsRequest)
WithFilterPath filters the properties of the response body.
func (f MLGetDatafeeds) WithHeader(h map[string]string) func(*MLGetDatafeedsRequest)
WithHeader adds the headers to the HTTP request.
func (f MLGetDatafeeds) WithHuman() func(*MLGetDatafeedsRequest)
WithHuman makes statistical values human-readable.
func (f MLGetDatafeeds) WithPretty() func(*MLGetDatafeedsRequest)
WithPretty makes the response body pretty-printed.
type MLGetDatafeedsRequest struct {
DatafeedID string
AllowNoDatafeeds *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLGetDatafeedsRequest configures the ML Get Datafeeds API request.
Do executes the request and returns response or error.
type MLGetFilters func(o ...func(*MLGetFiltersRequest)) (*Response, error)
MLGetFilters -
func (f MLGetFilters) WithContext(v context.Context) func(*MLGetFiltersRequest)
WithContext sets the request context.
func (f MLGetFilters) WithErrorTrace() func(*MLGetFiltersRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLGetFilters) WithFilterID(v string) func(*MLGetFiltersRequest)
WithFilterID - the ID of the filter to fetch.
func (f MLGetFilters) WithFilterPath(v ...string) func(*MLGetFiltersRequest)
WithFilterPath filters the properties of the response body.
func (f MLGetFilters) WithFrom(v int) func(*MLGetFiltersRequest)
WithFrom - skips a number of filters.
func (f MLGetFilters) WithHeader(h map[string]string) func(*MLGetFiltersRequest)
WithHeader adds the headers to the HTTP request.
func (f MLGetFilters) WithHuman() func(*MLGetFiltersRequest)
WithHuman makes statistical values human-readable.
func (f MLGetFilters) WithPretty() func(*MLGetFiltersRequest)
WithPretty makes the response body pretty-printed.
func (f MLGetFilters) WithSize(v int) func(*MLGetFiltersRequest)
WithSize - specifies a max number of filters to get.
type MLGetFiltersRequest struct {
FilterID string
From *int
Size *int
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLGetFiltersRequest configures the ML Get Filters API request.
Do executes the request and returns response or error.
type MLGetInfluencers func(job_id string, o ...func(*MLGetInfluencersRequest)) (*Response, error)
MLGetInfluencers - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html
func (f MLGetInfluencers) WithBody(v io.Reader) func(*MLGetInfluencersRequest)
WithBody - Influencer selection criteria.
func (f MLGetInfluencers) WithContext(v context.Context) func(*MLGetInfluencersRequest)
WithContext sets the request context.
func (f MLGetInfluencers) WithDesc(v bool) func(*MLGetInfluencersRequest)
WithDesc - whether the results should be sorted in decending order.
func (f MLGetInfluencers) WithEnd(v string) func(*MLGetInfluencersRequest)
WithEnd - end timestamp for the requested influencers.
func (f MLGetInfluencers) WithErrorTrace() func(*MLGetInfluencersRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLGetInfluencers) WithExcludeInterim(v bool) func(*MLGetInfluencersRequest)
WithExcludeInterim - exclude interim results.
func (f MLGetInfluencers) WithFilterPath(v ...string) func(*MLGetInfluencersRequest)
WithFilterPath filters the properties of the response body.
func (f MLGetInfluencers) WithFrom(v int) func(*MLGetInfluencersRequest)
WithFrom - skips a number of influencers.
func (f MLGetInfluencers) WithHeader(h map[string]string) func(*MLGetInfluencersRequest)
WithHeader adds the headers to the HTTP request.
func (f MLGetInfluencers) WithHuman() func(*MLGetInfluencersRequest)
WithHuman makes statistical values human-readable.
func (f MLGetInfluencers) WithInfluencerScore(v interface{}) func(*MLGetInfluencersRequest)
WithInfluencerScore - influencer score threshold for the requested influencers.
func (f MLGetInfluencers) WithPretty() func(*MLGetInfluencersRequest)
WithPretty makes the response body pretty-printed.
func (f MLGetInfluencers) WithSize(v int) func(*MLGetInfluencersRequest)
WithSize - specifies a max number of influencers to get.
func (f MLGetInfluencers) WithSort(v string) func(*MLGetInfluencersRequest)
WithSort - sort field for the requested influencers.
func (f MLGetInfluencers) WithStart(v string) func(*MLGetInfluencersRequest)
WithStart - start timestamp for the requested influencers.
type MLGetInfluencersRequest struct {
Body io.Reader
JobID string
Desc *bool
End string
ExcludeInterim *bool
From *int
InfluencerScore interface{}
Size *int
Sort string
Start string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLGetInfluencersRequest configures the ML Get Influencers API request.
Do executes the request and returns response or error.
type MLGetJobStats func(o ...func(*MLGetJobStatsRequest)) (*Response, error)
MLGetJobStats - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html
func (f MLGetJobStats) WithAllowNoJobs(v bool) func(*MLGetJobStatsRequest)
WithAllowNoJobs - whether to ignore if a wildcard expression matches no jobs. (this includes `_all` string or when no jobs have been specified).
func (f MLGetJobStats) WithContext(v context.Context) func(*MLGetJobStatsRequest)
WithContext sets the request context.
func (f MLGetJobStats) WithErrorTrace() func(*MLGetJobStatsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLGetJobStats) WithFilterPath(v ...string) func(*MLGetJobStatsRequest)
WithFilterPath filters the properties of the response body.
func (f MLGetJobStats) WithHeader(h map[string]string) func(*MLGetJobStatsRequest)
WithHeader adds the headers to the HTTP request.
func (f MLGetJobStats) WithHuman() func(*MLGetJobStatsRequest)
WithHuman makes statistical values human-readable.
func (f MLGetJobStats) WithJobID(v string) func(*MLGetJobStatsRequest)
WithJobID - the ID of the jobs stats to fetch.
func (f MLGetJobStats) WithPretty() func(*MLGetJobStatsRequest)
WithPretty makes the response body pretty-printed.
type MLGetJobStatsRequest struct {
JobID string
AllowNoJobs *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLGetJobStatsRequest configures the ML Get Job Stats API request.
Do executes the request and returns response or error.
type MLGetJobs func(o ...func(*MLGetJobsRequest)) (*Response, error)
MLGetJobs - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html
func (f MLGetJobs) WithAllowNoJobs(v bool) func(*MLGetJobsRequest)
WithAllowNoJobs - whether to ignore if a wildcard expression matches no jobs. (this includes `_all` string or when no jobs have been specified).
func (f MLGetJobs) WithContext(v context.Context) func(*MLGetJobsRequest)
WithContext sets the request context.
func (f MLGetJobs) WithErrorTrace() func(*MLGetJobsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLGetJobs) WithFilterPath(v ...string) func(*MLGetJobsRequest)
WithFilterPath filters the properties of the response body.
func (f MLGetJobs) WithHeader(h map[string]string) func(*MLGetJobsRequest)
WithHeader adds the headers to the HTTP request.
func (f MLGetJobs) WithHuman() func(*MLGetJobsRequest)
WithHuman makes statistical values human-readable.
func (f MLGetJobs) WithJobID(v string) func(*MLGetJobsRequest)
WithJobID - the ID of the jobs to fetch.
func (f MLGetJobs) WithPretty() func(*MLGetJobsRequest)
WithPretty makes the response body pretty-printed.
type MLGetJobsRequest struct {
JobID string
AllowNoJobs *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLGetJobsRequest configures the ML Get Jobs API request.
Do executes the request and returns response or error.
type MLGetModelSnapshots func(job_id string, o ...func(*MLGetModelSnapshotsRequest)) (*Response, error)
MLGetModelSnapshots - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html
func (f MLGetModelSnapshots) WithBody(v io.Reader) func(*MLGetModelSnapshotsRequest)
WithBody - Model snapshot selection criteria.
func (f MLGetModelSnapshots) WithContext(v context.Context) func(*MLGetModelSnapshotsRequest)
WithContext sets the request context.
func (f MLGetModelSnapshots) WithDesc(v bool) func(*MLGetModelSnapshotsRequest)
WithDesc - true if the results should be sorted in descending order.
func (f MLGetModelSnapshots) WithEnd(v interface{}) func(*MLGetModelSnapshotsRequest)
WithEnd - the filter 'end' query parameter.
func (f MLGetModelSnapshots) WithErrorTrace() func(*MLGetModelSnapshotsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLGetModelSnapshots) WithFilterPath(v ...string) func(*MLGetModelSnapshotsRequest)
WithFilterPath filters the properties of the response body.
func (f MLGetModelSnapshots) WithFrom(v int) func(*MLGetModelSnapshotsRequest)
WithFrom - skips a number of documents.
func (f MLGetModelSnapshots) WithHeader(h map[string]string) func(*MLGetModelSnapshotsRequest)
WithHeader adds the headers to the HTTP request.
func (f MLGetModelSnapshots) WithHuman() func(*MLGetModelSnapshotsRequest)
WithHuman makes statistical values human-readable.
func (f MLGetModelSnapshots) WithPretty() func(*MLGetModelSnapshotsRequest)
WithPretty makes the response body pretty-printed.
func (f MLGetModelSnapshots) WithSize(v int) func(*MLGetModelSnapshotsRequest)
WithSize - the default number of documents returned in queries as a string..
func (f MLGetModelSnapshots) WithSnapshotID(v string) func(*MLGetModelSnapshotsRequest)
WithSnapshotID - the ID of the snapshot to fetch.
func (f MLGetModelSnapshots) WithSort(v string) func(*MLGetModelSnapshotsRequest)
WithSort - name of the field to sort on.
func (f MLGetModelSnapshots) WithStart(v interface{}) func(*MLGetModelSnapshotsRequest)
WithStart - the filter 'start' query parameter.
type MLGetModelSnapshotsRequest struct {
Body io.Reader
JobID string
SnapshotID string
Desc *bool
End interface{}
From *int
Size *int
Sort string
Start interface{}
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLGetModelSnapshotsRequest configures the ML Get Model Snapshots API request.
func (r MLGetModelSnapshotsRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type MLGetOverallBuckets func(job_id string, o ...func(*MLGetOverallBucketsRequest)) (*Response, error)
MLGetOverallBuckets - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html
func (f MLGetOverallBuckets) WithAllowNoJobs(v bool) func(*MLGetOverallBucketsRequest)
WithAllowNoJobs - whether to ignore if a wildcard expression matches no jobs. (this includes `_all` string or when no jobs have been specified).
func (f MLGetOverallBuckets) WithBody(v io.Reader) func(*MLGetOverallBucketsRequest)
WithBody - Overall bucket selection details if not provided in URI.
func (f MLGetOverallBuckets) WithBucketSpan(v string) func(*MLGetOverallBucketsRequest)
WithBucketSpan - the span of the overall buckets. defaults to the longest job bucket_span.
func (f MLGetOverallBuckets) WithContext(v context.Context) func(*MLGetOverallBucketsRequest)
WithContext sets the request context.
func (f MLGetOverallBuckets) WithEnd(v string) func(*MLGetOverallBucketsRequest)
WithEnd - returns overall buckets with timestamps earlier than this time.
func (f MLGetOverallBuckets) WithErrorTrace() func(*MLGetOverallBucketsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLGetOverallBuckets) WithExcludeInterim(v bool) func(*MLGetOverallBucketsRequest)
WithExcludeInterim - if true overall buckets that include interim buckets will be excluded.
func (f MLGetOverallBuckets) WithFilterPath(v ...string) func(*MLGetOverallBucketsRequest)
WithFilterPath filters the properties of the response body.
func (f MLGetOverallBuckets) WithHeader(h map[string]string) func(*MLGetOverallBucketsRequest)
WithHeader adds the headers to the HTTP request.
func (f MLGetOverallBuckets) WithHuman() func(*MLGetOverallBucketsRequest)
WithHuman makes statistical values human-readable.
func (f MLGetOverallBuckets) WithOverallScore(v interface{}) func(*MLGetOverallBucketsRequest)
WithOverallScore - returns overall buckets with overall scores higher than this value.
func (f MLGetOverallBuckets) WithPretty() func(*MLGetOverallBucketsRequest)
WithPretty makes the response body pretty-printed.
func (f MLGetOverallBuckets) WithStart(v string) func(*MLGetOverallBucketsRequest)
WithStart - returns overall buckets with timestamps after this time.
func (f MLGetOverallBuckets) WithTopN(v int) func(*MLGetOverallBucketsRequest)
WithTopN - the number of top job bucket scores to be used in the overall_score calculation.
type MLGetOverallBucketsRequest struct {
Body io.Reader
JobID string
AllowNoJobs *bool
BucketSpan string
End string
ExcludeInterim *bool
OverallScore interface{}
Start string
TopN *int
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLGetOverallBucketsRequest configures the ML Get Overall Buckets API request.
func (r MLGetOverallBucketsRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type MLGetRecords func(job_id string, o ...func(*MLGetRecordsRequest)) (*Response, error)
MLGetRecords - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html
func (f MLGetRecords) WithBody(v io.Reader) func(*MLGetRecordsRequest)
WithBody - Record selection criteria.
func (f MLGetRecords) WithContext(v context.Context) func(*MLGetRecordsRequest)
WithContext sets the request context.
func (f MLGetRecords) WithDesc(v bool) func(*MLGetRecordsRequest)
WithDesc - set the sort direction.
func (f MLGetRecords) WithEnd(v string) func(*MLGetRecordsRequest)
WithEnd - end time filter for records.
func (f MLGetRecords) WithErrorTrace() func(*MLGetRecordsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLGetRecords) WithExcludeInterim(v bool) func(*MLGetRecordsRequest)
WithExcludeInterim - exclude interim results.
func (f MLGetRecords) WithFilterPath(v ...string) func(*MLGetRecordsRequest)
WithFilterPath filters the properties of the response body.
func (f MLGetRecords) WithFrom(v int) func(*MLGetRecordsRequest)
WithFrom - skips a number of records.
func (f MLGetRecords) WithHeader(h map[string]string) func(*MLGetRecordsRequest)
WithHeader adds the headers to the HTTP request.
func (f MLGetRecords) WithHuman() func(*MLGetRecordsRequest)
WithHuman makes statistical values human-readable.
func (f MLGetRecords) WithPretty() func(*MLGetRecordsRequest)
WithPretty makes the response body pretty-printed.
func (f MLGetRecords) WithRecordScore(v interface{}) func(*MLGetRecordsRequest)
WithRecordScore - .
func (f MLGetRecords) WithSize(v int) func(*MLGetRecordsRequest)
WithSize - specifies a max number of records to get.
func (f MLGetRecords) WithSort(v string) func(*MLGetRecordsRequest)
WithSort - sort records by a particular field.
func (f MLGetRecords) WithStart(v string) func(*MLGetRecordsRequest)
WithStart - start time filter for records.
type MLGetRecordsRequest struct {
Body io.Reader
JobID string
Desc *bool
End string
ExcludeInterim *bool
From *int
RecordScore interface{}
Size *int
Sort string
Start string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLGetRecordsRequest configures the ML Get Records API request.
Do executes the request and returns response or error.
type MLInfo func(o ...func(*MLInfoRequest)) (*Response, error)
MLInfo -
func (f MLInfo) WithContext(v context.Context) func(*MLInfoRequest)
WithContext sets the request context.
func (f MLInfo) WithErrorTrace() func(*MLInfoRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLInfo) WithFilterPath(v ...string) func(*MLInfoRequest)
WithFilterPath filters the properties of the response body.
func (f MLInfo) WithHeader(h map[string]string) func(*MLInfoRequest)
WithHeader adds the headers to the HTTP request.
func (f MLInfo) WithHuman() func(*MLInfoRequest)
WithHuman makes statistical values human-readable.
func (f MLInfo) WithPretty() func(*MLInfoRequest)
WithPretty makes the response body pretty-printed.
type MLInfoRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLInfoRequest configures the ML Info API request.
Do executes the request and returns response or error.
type MLOpenJob func(job_id string, o ...func(*MLOpenJobRequest)) (*Response, error)
MLOpenJob - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html
func (f MLOpenJob) WithContext(v context.Context) func(*MLOpenJobRequest)
WithContext sets the request context.
func (f MLOpenJob) WithErrorTrace() func(*MLOpenJobRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLOpenJob) WithFilterPath(v ...string) func(*MLOpenJobRequest)
WithFilterPath filters the properties of the response body.
func (f MLOpenJob) WithHeader(h map[string]string) func(*MLOpenJobRequest)
WithHeader adds the headers to the HTTP request.
func (f MLOpenJob) WithHuman() func(*MLOpenJobRequest)
WithHuman makes statistical values human-readable.
func (f MLOpenJob) WithIgnoreDowntime(v bool) func(*MLOpenJobRequest)
WithIgnoreDowntime - controls if gaps in data are treated as anomalous or as a maintenance window after a job re-start.
func (f MLOpenJob) WithPretty() func(*MLOpenJobRequest)
WithPretty makes the response body pretty-printed.
func (f MLOpenJob) WithTimeout(v time.Duration) func(*MLOpenJobRequest)
WithTimeout - controls the time to wait until a job has opened. default to 30 minutes.
type MLOpenJobRequest struct {
IgnoreDowntime *bool
JobID string
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLOpenJobRequest configures the ML Open Job API request.
Do executes the request and returns response or error.
type MLPostCalendarEvents func(calendar_id string, body io.Reader, o ...func(*MLPostCalendarEventsRequest)) (*Response, error)
MLPostCalendarEvents -
func (f MLPostCalendarEvents) WithContext(v context.Context) func(*MLPostCalendarEventsRequest)
WithContext sets the request context.
func (f MLPostCalendarEvents) WithErrorTrace() func(*MLPostCalendarEventsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLPostCalendarEvents) WithFilterPath(v ...string) func(*MLPostCalendarEventsRequest)
WithFilterPath filters the properties of the response body.
func (f MLPostCalendarEvents) WithHeader(h map[string]string) func(*MLPostCalendarEventsRequest)
WithHeader adds the headers to the HTTP request.
func (f MLPostCalendarEvents) WithHuman() func(*MLPostCalendarEventsRequest)
WithHuman makes statistical values human-readable.
func (f MLPostCalendarEvents) WithPretty() func(*MLPostCalendarEventsRequest)
WithPretty makes the response body pretty-printed.
type MLPostCalendarEventsRequest struct {
Body io.Reader
CalendarID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLPostCalendarEventsRequest configures the ML Post Calendar Events API request.
func (r MLPostCalendarEventsRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type MLPostData func(job_id string, body io.Reader, o ...func(*MLPostDataRequest)) (*Response, error)
MLPostData - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html
func (f MLPostData) WithContext(v context.Context) func(*MLPostDataRequest)
WithContext sets the request context.
func (f MLPostData) WithErrorTrace() func(*MLPostDataRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLPostData) WithFilterPath(v ...string) func(*MLPostDataRequest)
WithFilterPath filters the properties of the response body.
func (f MLPostData) WithHeader(h map[string]string) func(*MLPostDataRequest)
WithHeader adds the headers to the HTTP request.
func (f MLPostData) WithHuman() func(*MLPostDataRequest)
WithHuman makes statistical values human-readable.
func (f MLPostData) WithPretty() func(*MLPostDataRequest)
WithPretty makes the response body pretty-printed.
func (f MLPostData) WithResetEnd(v string) func(*MLPostDataRequest)
WithResetEnd - optional parameter to specify the end of the bucket resetting range.
func (f MLPostData) WithResetStart(v string) func(*MLPostDataRequest)
WithResetStart - optional parameter to specify the start of the bucket resetting range.
type MLPostDataRequest struct {
Body io.Reader
JobID string
ResetEnd string
ResetStart string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLPostDataRequest configures the ML Post Data API request.
Do executes the request and returns response or error.
type MLPreviewDatafeed func(datafeed_id string, o ...func(*MLPreviewDatafeedRequest)) (*Response, error)
MLPreviewDatafeed - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html
func (f MLPreviewDatafeed) WithContext(v context.Context) func(*MLPreviewDatafeedRequest)
WithContext sets the request context.
func (f MLPreviewDatafeed) WithErrorTrace() func(*MLPreviewDatafeedRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLPreviewDatafeed) WithFilterPath(v ...string) func(*MLPreviewDatafeedRequest)
WithFilterPath filters the properties of the response body.
func (f MLPreviewDatafeed) WithHeader(h map[string]string) func(*MLPreviewDatafeedRequest)
WithHeader adds the headers to the HTTP request.
func (f MLPreviewDatafeed) WithHuman() func(*MLPreviewDatafeedRequest)
WithHuman makes statistical values human-readable.
func (f MLPreviewDatafeed) WithPretty() func(*MLPreviewDatafeedRequest)
WithPretty makes the response body pretty-printed.
type MLPreviewDatafeedRequest struct {
DatafeedID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLPreviewDatafeedRequest configures the ML Preview Datafeed API request.
Do executes the request and returns response or error.
type MLPutCalendar func(calendar_id string, o ...func(*MLPutCalendarRequest)) (*Response, error)
MLPutCalendar -
func (f MLPutCalendar) WithBody(v io.Reader) func(*MLPutCalendarRequest)
WithBody - The calendar details.
func (f MLPutCalendar) WithContext(v context.Context) func(*MLPutCalendarRequest)
WithContext sets the request context.
func (f MLPutCalendar) WithErrorTrace() func(*MLPutCalendarRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLPutCalendar) WithFilterPath(v ...string) func(*MLPutCalendarRequest)
WithFilterPath filters the properties of the response body.
func (f MLPutCalendar) WithHeader(h map[string]string) func(*MLPutCalendarRequest)
WithHeader adds the headers to the HTTP request.
func (f MLPutCalendar) WithHuman() func(*MLPutCalendarRequest)
WithHuman makes statistical values human-readable.
func (f MLPutCalendar) WithPretty() func(*MLPutCalendarRequest)
WithPretty makes the response body pretty-printed.
type MLPutCalendarJob func(calendar_id string, job_id string, o ...func(*MLPutCalendarJobRequest)) (*Response, error)
MLPutCalendarJob -
func (f MLPutCalendarJob) WithContext(v context.Context) func(*MLPutCalendarJobRequest)
WithContext sets the request context.
func (f MLPutCalendarJob) WithErrorTrace() func(*MLPutCalendarJobRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLPutCalendarJob) WithFilterPath(v ...string) func(*MLPutCalendarJobRequest)
WithFilterPath filters the properties of the response body.
func (f MLPutCalendarJob) WithHeader(h map[string]string) func(*MLPutCalendarJobRequest)
WithHeader adds the headers to the HTTP request.
func (f MLPutCalendarJob) WithHuman() func(*MLPutCalendarJobRequest)
WithHuman makes statistical values human-readable.
func (f MLPutCalendarJob) WithPretty() func(*MLPutCalendarJobRequest)
WithPretty makes the response body pretty-printed.
type MLPutCalendarJobRequest struct {
CalendarID string
JobID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLPutCalendarJobRequest configures the ML Put Calendar Job API request.
Do executes the request and returns response or error.
type MLPutCalendarRequest struct {
Body io.Reader
CalendarID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLPutCalendarRequest configures the ML Put Calendar API request.
Do executes the request and returns response or error.
type MLPutDataFrameAnalytics func(id string, body io.Reader, o ...func(*MLPutDataFrameAnalyticsRequest)) (*Response, error)
MLPutDataFrameAnalytics - http://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html
func (f MLPutDataFrameAnalytics) WithContext(v context.Context) func(*MLPutDataFrameAnalyticsRequest)
WithContext sets the request context.
func (f MLPutDataFrameAnalytics) WithErrorTrace() func(*MLPutDataFrameAnalyticsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLPutDataFrameAnalytics) WithFilterPath(v ...string) func(*MLPutDataFrameAnalyticsRequest)
WithFilterPath filters the properties of the response body.
func (f MLPutDataFrameAnalytics) WithHeader(h map[string]string) func(*MLPutDataFrameAnalyticsRequest)
WithHeader adds the headers to the HTTP request.
func (f MLPutDataFrameAnalytics) WithHuman() func(*MLPutDataFrameAnalyticsRequest)
WithHuman makes statistical values human-readable.
func (f MLPutDataFrameAnalytics) WithPretty() func(*MLPutDataFrameAnalyticsRequest)
WithPretty makes the response body pretty-printed.
type MLPutDataFrameAnalyticsRequest struct {
ID string
Body io.Reader
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLPutDataFrameAnalyticsRequest configures the ML Put Data Frame Analytics API request.
func (r MLPutDataFrameAnalyticsRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type MLPutDatafeed func(body io.Reader, datafeed_id string, o ...func(*MLPutDatafeedRequest)) (*Response, error)
MLPutDatafeed - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html
func (f MLPutDatafeed) WithContext(v context.Context) func(*MLPutDatafeedRequest)
WithContext sets the request context.
func (f MLPutDatafeed) WithErrorTrace() func(*MLPutDatafeedRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLPutDatafeed) WithFilterPath(v ...string) func(*MLPutDatafeedRequest)
WithFilterPath filters the properties of the response body.
func (f MLPutDatafeed) WithHeader(h map[string]string) func(*MLPutDatafeedRequest)
WithHeader adds the headers to the HTTP request.
func (f MLPutDatafeed) WithHuman() func(*MLPutDatafeedRequest)
WithHuman makes statistical values human-readable.
func (f MLPutDatafeed) WithPretty() func(*MLPutDatafeedRequest)
WithPretty makes the response body pretty-printed.
type MLPutDatafeedRequest struct {
Body io.Reader
DatafeedID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLPutDatafeedRequest configures the ML Put Datafeed API request.
Do executes the request and returns response or error.
type MLPutFilter func(body io.Reader, filter_id string, o ...func(*MLPutFilterRequest)) (*Response, error)
MLPutFilter -
func (f MLPutFilter) WithContext(v context.Context) func(*MLPutFilterRequest)
WithContext sets the request context.
func (f MLPutFilter) WithErrorTrace() func(*MLPutFilterRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLPutFilter) WithFilterPath(v ...string) func(*MLPutFilterRequest)
WithFilterPath filters the properties of the response body.
func (f MLPutFilter) WithHeader(h map[string]string) func(*MLPutFilterRequest)
WithHeader adds the headers to the HTTP request.
func (f MLPutFilter) WithHuman() func(*MLPutFilterRequest)
WithHuman makes statistical values human-readable.
func (f MLPutFilter) WithPretty() func(*MLPutFilterRequest)
WithPretty makes the response body pretty-printed.
type MLPutFilterRequest struct {
Body io.Reader
FilterID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLPutFilterRequest configures the ML Put Filter API request.
Do executes the request and returns response or error.
MLPutJob - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html
func (f MLPutJob) WithContext(v context.Context) func(*MLPutJobRequest)
WithContext sets the request context.
func (f MLPutJob) WithErrorTrace() func(*MLPutJobRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLPutJob) WithFilterPath(v ...string) func(*MLPutJobRequest)
WithFilterPath filters the properties of the response body.
func (f MLPutJob) WithHeader(h map[string]string) func(*MLPutJobRequest)
WithHeader adds the headers to the HTTP request.
func (f MLPutJob) WithHuman() func(*MLPutJobRequest)
WithHuman makes statistical values human-readable.
func (f MLPutJob) WithPretty() func(*MLPutJobRequest)
WithPretty makes the response body pretty-printed.
type MLPutJobRequest struct {
Body io.Reader
JobID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLPutJobRequest configures the ML Put Job API request.
Do executes the request and returns response or error.
type MLRevertModelSnapshot func(snapshot_id string, job_id string, o ...func(*MLRevertModelSnapshotRequest)) (*Response, error)
MLRevertModelSnapshot - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html
func (f MLRevertModelSnapshot) WithBody(v io.Reader) func(*MLRevertModelSnapshotRequest)
WithBody - Reversion options.
func (f MLRevertModelSnapshot) WithContext(v context.Context) func(*MLRevertModelSnapshotRequest)
WithContext sets the request context.
func (f MLRevertModelSnapshot) WithDeleteInterveningResults(v bool) func(*MLRevertModelSnapshotRequest)
WithDeleteInterveningResults - should we reset the results back to the time of the snapshot?.
func (f MLRevertModelSnapshot) WithErrorTrace() func(*MLRevertModelSnapshotRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLRevertModelSnapshot) WithFilterPath(v ...string) func(*MLRevertModelSnapshotRequest)
WithFilterPath filters the properties of the response body.
func (f MLRevertModelSnapshot) WithHeader(h map[string]string) func(*MLRevertModelSnapshotRequest)
WithHeader adds the headers to the HTTP request.
func (f MLRevertModelSnapshot) WithHuman() func(*MLRevertModelSnapshotRequest)
WithHuman makes statistical values human-readable.
func (f MLRevertModelSnapshot) WithPretty() func(*MLRevertModelSnapshotRequest)
WithPretty makes the response body pretty-printed.
type MLRevertModelSnapshotRequest struct {
Body io.Reader
JobID string
SnapshotID string
DeleteInterveningResults *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLRevertModelSnapshotRequest configures the ML Revert Model Snapshot API request.
func (r MLRevertModelSnapshotRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type MLSetUpgradeMode func(o ...func(*MLSetUpgradeModeRequest)) (*Response, error)
MLSetUpgradeMode - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html
func (f MLSetUpgradeMode) WithContext(v context.Context) func(*MLSetUpgradeModeRequest)
WithContext sets the request context.
func (f MLSetUpgradeMode) WithEnabled(v bool) func(*MLSetUpgradeModeRequest)
WithEnabled - whether to enable upgrade_mode ml setting or not. defaults to false..
func (f MLSetUpgradeMode) WithErrorTrace() func(*MLSetUpgradeModeRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLSetUpgradeMode) WithFilterPath(v ...string) func(*MLSetUpgradeModeRequest)
WithFilterPath filters the properties of the response body.
func (f MLSetUpgradeMode) WithHeader(h map[string]string) func(*MLSetUpgradeModeRequest)
WithHeader adds the headers to the HTTP request.
func (f MLSetUpgradeMode) WithHuman() func(*MLSetUpgradeModeRequest)
WithHuman makes statistical values human-readable.
func (f MLSetUpgradeMode) WithPretty() func(*MLSetUpgradeModeRequest)
WithPretty makes the response body pretty-printed.
func (f MLSetUpgradeMode) WithTimeout(v time.Duration) func(*MLSetUpgradeModeRequest)
WithTimeout - controls the time to wait before action times out. defaults to 30 seconds.
type MLSetUpgradeModeRequest struct {
Enabled *bool
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLSetUpgradeModeRequest configures the ML Set Upgrade Mode API request.
Do executes the request and returns response or error.
type MLStartDataFrameAnalytics func(id string, o ...func(*MLStartDataFrameAnalyticsRequest)) (*Response, error)
MLStartDataFrameAnalytics - http://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html
func (f MLStartDataFrameAnalytics) WithBody(v io.Reader) func(*MLStartDataFrameAnalyticsRequest)
WithBody - The start data frame analytics parameters.
func (f MLStartDataFrameAnalytics) WithContext(v context.Context) func(*MLStartDataFrameAnalyticsRequest)
WithContext sets the request context.
func (f MLStartDataFrameAnalytics) WithErrorTrace() func(*MLStartDataFrameAnalyticsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLStartDataFrameAnalytics) WithFilterPath(v ...string) func(*MLStartDataFrameAnalyticsRequest)
WithFilterPath filters the properties of the response body.
func (f MLStartDataFrameAnalytics) WithHeader(h map[string]string) func(*MLStartDataFrameAnalyticsRequest)
WithHeader adds the headers to the HTTP request.
func (f MLStartDataFrameAnalytics) WithHuman() func(*MLStartDataFrameAnalyticsRequest)
WithHuman makes statistical values human-readable.
func (f MLStartDataFrameAnalytics) WithPretty() func(*MLStartDataFrameAnalyticsRequest)
WithPretty makes the response body pretty-printed.
func (f MLStartDataFrameAnalytics) WithTimeout(v time.Duration) func(*MLStartDataFrameAnalyticsRequest)
WithTimeout - controls the time to wait until the task has started. defaults to 20 seconds.
type MLStartDataFrameAnalyticsRequest struct {
ID string
Body io.Reader
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLStartDataFrameAnalyticsRequest configures the ML Start Data Frame Analytics API request.
func (r MLStartDataFrameAnalyticsRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type MLStartDatafeed func(datafeed_id string, o ...func(*MLStartDatafeedRequest)) (*Response, error)
MLStartDatafeed - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html
func (f MLStartDatafeed) WithBody(v io.Reader) func(*MLStartDatafeedRequest)
WithBody - The start datafeed parameters.
func (f MLStartDatafeed) WithContext(v context.Context) func(*MLStartDatafeedRequest)
WithContext sets the request context.
func (f MLStartDatafeed) WithEnd(v string) func(*MLStartDatafeedRequest)
WithEnd - the end time when the datafeed should stop. when not set, the datafeed continues in real time.
func (f MLStartDatafeed) WithErrorTrace() func(*MLStartDatafeedRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLStartDatafeed) WithFilterPath(v ...string) func(*MLStartDatafeedRequest)
WithFilterPath filters the properties of the response body.
func (f MLStartDatafeed) WithHeader(h map[string]string) func(*MLStartDatafeedRequest)
WithHeader adds the headers to the HTTP request.
func (f MLStartDatafeed) WithHuman() func(*MLStartDatafeedRequest)
WithHuman makes statistical values human-readable.
func (f MLStartDatafeed) WithPretty() func(*MLStartDatafeedRequest)
WithPretty makes the response body pretty-printed.
func (f MLStartDatafeed) WithStart(v string) func(*MLStartDatafeedRequest)
WithStart - the start time from where the datafeed should begin.
func (f MLStartDatafeed) WithTimeout(v time.Duration) func(*MLStartDatafeedRequest)
WithTimeout - controls the time to wait until a datafeed has started. default to 20 seconds.
type MLStartDatafeedRequest struct {
Body io.Reader
DatafeedID string
End string
Start string
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLStartDatafeedRequest configures the ML Start Datafeed API request.
Do executes the request and returns response or error.
type MLStopDataFrameAnalytics func(id string, o ...func(*MLStopDataFrameAnalyticsRequest)) (*Response, error)
MLStopDataFrameAnalytics - http://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html
func (f MLStopDataFrameAnalytics) WithAllowNoMatch(v bool) func(*MLStopDataFrameAnalyticsRequest)
WithAllowNoMatch - whether to ignore if a wildcard expression matches no data frame analytics. (this includes `_all` string or when no data frame analytics have been specified).
func (f MLStopDataFrameAnalytics) WithBody(v io.Reader) func(*MLStopDataFrameAnalyticsRequest)
WithBody - The stop data frame analytics parameters.
func (f MLStopDataFrameAnalytics) WithContext(v context.Context) func(*MLStopDataFrameAnalyticsRequest)
WithContext sets the request context.
func (f MLStopDataFrameAnalytics) WithErrorTrace() func(*MLStopDataFrameAnalyticsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLStopDataFrameAnalytics) WithFilterPath(v ...string) func(*MLStopDataFrameAnalyticsRequest)
WithFilterPath filters the properties of the response body.
func (f MLStopDataFrameAnalytics) WithForce(v bool) func(*MLStopDataFrameAnalyticsRequest)
WithForce - true if the data frame analytics should be forcefully stopped.
func (f MLStopDataFrameAnalytics) WithHeader(h map[string]string) func(*MLStopDataFrameAnalyticsRequest)
WithHeader adds the headers to the HTTP request.
func (f MLStopDataFrameAnalytics) WithHuman() func(*MLStopDataFrameAnalyticsRequest)
WithHuman makes statistical values human-readable.
func (f MLStopDataFrameAnalytics) WithPretty() func(*MLStopDataFrameAnalyticsRequest)
WithPretty makes the response body pretty-printed.
func (f MLStopDataFrameAnalytics) WithTimeout(v time.Duration) func(*MLStopDataFrameAnalyticsRequest)
WithTimeout - controls the time to wait until the task has stopped. defaults to 20 seconds.
type MLStopDataFrameAnalyticsRequest struct {
ID string
Body io.Reader
AllowNoMatch *bool
Force *bool
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLStopDataFrameAnalyticsRequest configures the ML Stop Data Frame Analytics API request.
func (r MLStopDataFrameAnalyticsRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type MLStopDatafeed func(datafeed_id string, o ...func(*MLStopDatafeedRequest)) (*Response, error)
MLStopDatafeed - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html
func (f MLStopDatafeed) WithAllowNoDatafeeds(v bool) func(*MLStopDatafeedRequest)
WithAllowNoDatafeeds - whether to ignore if a wildcard expression matches no datafeeds. (this includes `_all` string or when no datafeeds have been specified).
func (f MLStopDatafeed) WithContext(v context.Context) func(*MLStopDatafeedRequest)
WithContext sets the request context.
func (f MLStopDatafeed) WithErrorTrace() func(*MLStopDatafeedRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLStopDatafeed) WithFilterPath(v ...string) func(*MLStopDatafeedRequest)
WithFilterPath filters the properties of the response body.
func (f MLStopDatafeed) WithForce(v bool) func(*MLStopDatafeedRequest)
WithForce - true if the datafeed should be forcefully stopped..
func (f MLStopDatafeed) WithHeader(h map[string]string) func(*MLStopDatafeedRequest)
WithHeader adds the headers to the HTTP request.
func (f MLStopDatafeed) WithHuman() func(*MLStopDatafeedRequest)
WithHuman makes statistical values human-readable.
func (f MLStopDatafeed) WithPretty() func(*MLStopDatafeedRequest)
WithPretty makes the response body pretty-printed.
func (f MLStopDatafeed) WithTimeout(v time.Duration) func(*MLStopDatafeedRequest)
WithTimeout - controls the time to wait until a datafeed has stopped. default to 20 seconds.
type MLStopDatafeedRequest struct {
DatafeedID string
AllowNoDatafeeds *bool
Force *bool
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLStopDatafeedRequest configures the ML Stop Datafeed API request.
Do executes the request and returns response or error.
type MLUpdateDatafeed func(body io.Reader, datafeed_id string, o ...func(*MLUpdateDatafeedRequest)) (*Response, error)
MLUpdateDatafeed - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html
func (f MLUpdateDatafeed) WithContext(v context.Context) func(*MLUpdateDatafeedRequest)
WithContext sets the request context.
func (f MLUpdateDatafeed) WithErrorTrace() func(*MLUpdateDatafeedRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLUpdateDatafeed) WithFilterPath(v ...string) func(*MLUpdateDatafeedRequest)
WithFilterPath filters the properties of the response body.
func (f MLUpdateDatafeed) WithHeader(h map[string]string) func(*MLUpdateDatafeedRequest)
WithHeader adds the headers to the HTTP request.
func (f MLUpdateDatafeed) WithHuman() func(*MLUpdateDatafeedRequest)
WithHuman makes statistical values human-readable.
func (f MLUpdateDatafeed) WithPretty() func(*MLUpdateDatafeedRequest)
WithPretty makes the response body pretty-printed.
type MLUpdateDatafeedRequest struct {
Body io.Reader
DatafeedID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLUpdateDatafeedRequest configures the ML Update Datafeed API request.
Do executes the request and returns response or error.
type MLUpdateFilter func(body io.Reader, filter_id string, o ...func(*MLUpdateFilterRequest)) (*Response, error)
MLUpdateFilter -
func (f MLUpdateFilter) WithContext(v context.Context) func(*MLUpdateFilterRequest)
WithContext sets the request context.
func (f MLUpdateFilter) WithErrorTrace() func(*MLUpdateFilterRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLUpdateFilter) WithFilterPath(v ...string) func(*MLUpdateFilterRequest)
WithFilterPath filters the properties of the response body.
func (f MLUpdateFilter) WithHeader(h map[string]string) func(*MLUpdateFilterRequest)
WithHeader adds the headers to the HTTP request.
func (f MLUpdateFilter) WithHuman() func(*MLUpdateFilterRequest)
WithHuman makes statistical values human-readable.
func (f MLUpdateFilter) WithPretty() func(*MLUpdateFilterRequest)
WithPretty makes the response body pretty-printed.
type MLUpdateFilterRequest struct {
Body io.Reader
FilterID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLUpdateFilterRequest configures the ML Update Filter API request.
Do executes the request and returns response or error.
type MLUpdateJob func(job_id string, body io.Reader, o ...func(*MLUpdateJobRequest)) (*Response, error)
MLUpdateJob - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html
func (f MLUpdateJob) WithContext(v context.Context) func(*MLUpdateJobRequest)
WithContext sets the request context.
func (f MLUpdateJob) WithErrorTrace() func(*MLUpdateJobRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLUpdateJob) WithFilterPath(v ...string) func(*MLUpdateJobRequest)
WithFilterPath filters the properties of the response body.
func (f MLUpdateJob) WithHeader(h map[string]string) func(*MLUpdateJobRequest)
WithHeader adds the headers to the HTTP request.
func (f MLUpdateJob) WithHuman() func(*MLUpdateJobRequest)
WithHuman makes statistical values human-readable.
func (f MLUpdateJob) WithPretty() func(*MLUpdateJobRequest)
WithPretty makes the response body pretty-printed.
type MLUpdateJobRequest struct {
Body io.Reader
JobID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLUpdateJobRequest configures the ML Update Job API request.
Do executes the request and returns response or error.
type MLUpdateModelSnapshot func(snapshot_id string, job_id string, body io.Reader, o ...func(*MLUpdateModelSnapshotRequest)) (*Response, error)
MLUpdateModelSnapshot - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html
func (f MLUpdateModelSnapshot) WithContext(v context.Context) func(*MLUpdateModelSnapshotRequest)
WithContext sets the request context.
func (f MLUpdateModelSnapshot) WithErrorTrace() func(*MLUpdateModelSnapshotRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLUpdateModelSnapshot) WithFilterPath(v ...string) func(*MLUpdateModelSnapshotRequest)
WithFilterPath filters the properties of the response body.
func (f MLUpdateModelSnapshot) WithHeader(h map[string]string) func(*MLUpdateModelSnapshotRequest)
WithHeader adds the headers to the HTTP request.
func (f MLUpdateModelSnapshot) WithHuman() func(*MLUpdateModelSnapshotRequest)
WithHuman makes statistical values human-readable.
func (f MLUpdateModelSnapshot) WithPretty() func(*MLUpdateModelSnapshotRequest)
WithPretty makes the response body pretty-printed.
type MLUpdateModelSnapshotRequest struct {
Body io.Reader
JobID string
SnapshotID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLUpdateModelSnapshotRequest configures the ML Update Model Snapshot API request.
func (r MLUpdateModelSnapshotRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
MLValidate -
func (f MLValidate) WithContext(v context.Context) func(*MLValidateRequest)
WithContext sets the request context.
func (f MLValidate) WithErrorTrace() func(*MLValidateRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLValidate) WithFilterPath(v ...string) func(*MLValidateRequest)
WithFilterPath filters the properties of the response body.
func (f MLValidate) WithHeader(h map[string]string) func(*MLValidateRequest)
WithHeader adds the headers to the HTTP request.
func (f MLValidate) WithHuman() func(*MLValidateRequest)
WithHuman makes statistical values human-readable.
func (f MLValidate) WithPretty() func(*MLValidateRequest)
WithPretty makes the response body pretty-printed.
type MLValidateDetector func(body io.Reader, o ...func(*MLValidateDetectorRequest)) (*Response, error)
MLValidateDetector -
func (f MLValidateDetector) WithContext(v context.Context) func(*MLValidateDetectorRequest)
WithContext sets the request context.
func (f MLValidateDetector) WithErrorTrace() func(*MLValidateDetectorRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MLValidateDetector) WithFilterPath(v ...string) func(*MLValidateDetectorRequest)
WithFilterPath filters the properties of the response body.
func (f MLValidateDetector) WithHeader(h map[string]string) func(*MLValidateDetectorRequest)
WithHeader adds the headers to the HTTP request.
func (f MLValidateDetector) WithHuman() func(*MLValidateDetectorRequest)
WithHuman makes statistical values human-readable.
func (f MLValidateDetector) WithPretty() func(*MLValidateDetectorRequest)
WithPretty makes the response body pretty-printed.
type MLValidateDetectorRequest struct {
Body io.Reader
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLValidateDetectorRequest configures the ML Validate Detector API request.
Do executes the request and returns response or error.
type MLValidateRequest struct {
Body io.Reader
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MLValidateRequest configures the ML Validate API request.
Do executes the request and returns response or error.
Mget allows to get multiple documents in one request.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html.
func (f Mget) WithContext(v context.Context) func(*MgetRequest)
WithContext sets the request context.
func (f Mget) WithDocumentType(v string) func(*MgetRequest)
WithDocumentType - the type of the document.
func (f Mget) WithErrorTrace() func(*MgetRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Mget) WithFilterPath(v ...string) func(*MgetRequest)
WithFilterPath filters the properties of the response body.
func (f Mget) WithHeader(h map[string]string) func(*MgetRequest)
WithHeader adds the headers to the HTTP request.
func (f Mget) WithHuman() func(*MgetRequest)
WithHuman makes statistical values human-readable.
func (f Mget) WithIndex(v string) func(*MgetRequest)
WithIndex - the name of the index.
func (f Mget) WithPreference(v string) func(*MgetRequest)
WithPreference - specify the node or shard the operation should be performed on (default: random).
func (f Mget) WithPretty() func(*MgetRequest)
WithPretty makes the response body pretty-printed.
func (f Mget) WithRealtime(v bool) func(*MgetRequest)
WithRealtime - specify whether to perform the operation in realtime or search mode.
func (f Mget) WithRefresh(v bool) func(*MgetRequest)
WithRefresh - refresh the shard containing the document before performing the operation.
func (f Mget) WithRouting(v string) func(*MgetRequest)
WithRouting - specific routing value.
func (f Mget) WithSource(v ...string) func(*MgetRequest)
WithSource - true or false to return the _source field or not, or a list of fields to return.
func (f Mget) WithSourceExcludes(v ...string) func(*MgetRequest)
WithSourceExcludes - a list of fields to exclude from the returned _source field.
func (f Mget) WithSourceIncludes(v ...string) func(*MgetRequest)
WithSourceIncludes - a list of fields to extract and return from the _source field.
func (f Mget) WithStoredFields(v ...string) func(*MgetRequest)
WithStoredFields - a list of stored fields to return in the response.
type MgetRequest struct {
Index string
DocumentType string
Body io.Reader
Preference string
Realtime *bool
Refresh *bool
Routing string
Source []string
SourceExcludes []string
SourceIncludes []string
StoredFields []string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MgetRequest configures the Mget API request.
Do executes the request and returns response or error.
type Migration struct {
Deprecations MigrationDeprecations
}Migration contains the Migration APIs
type MigrationDeprecations func(o ...func(*MigrationDeprecationsRequest)) (*Response, error)
MigrationDeprecations - http://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html
func (f MigrationDeprecations) WithContext(v context.Context) func(*MigrationDeprecationsRequest)
WithContext sets the request context.
func (f MigrationDeprecations) WithErrorTrace() func(*MigrationDeprecationsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MigrationDeprecations) WithFilterPath(v ...string) func(*MigrationDeprecationsRequest)
WithFilterPath filters the properties of the response body.
func (f MigrationDeprecations) WithHeader(h map[string]string) func(*MigrationDeprecationsRequest)
WithHeader adds the headers to the HTTP request.
func (f MigrationDeprecations) WithHuman() func(*MigrationDeprecationsRequest)
WithHuman makes statistical values human-readable.
func (f MigrationDeprecations) WithIndex(v string) func(*MigrationDeprecationsRequest)
WithIndex - index pattern.
func (f MigrationDeprecations) WithPretty() func(*MigrationDeprecationsRequest)
WithPretty makes the response body pretty-printed.
type MigrationDeprecationsRequest struct {
Index string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MigrationDeprecationsRequest configures the Migration Deprecations API request.
func (r MigrationDeprecationsRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type Monitoring struct {
Bulk MonitoringBulk
}Monitoring contains the Monitoring APIs
MonitoringBulk - https://www.elastic.co/guide/en/elasticsearch/reference/master/es-monitoring.html
func (f MonitoringBulk) WithContext(v context.Context) func(*MonitoringBulkRequest)
WithContext sets the request context.
func (f MonitoringBulk) WithDocumentType(v string) func(*MonitoringBulkRequest)
WithDocumentType - default document type for items which don't provide one.
func (f MonitoringBulk) WithErrorTrace() func(*MonitoringBulkRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MonitoringBulk) WithFilterPath(v ...string) func(*MonitoringBulkRequest)
WithFilterPath filters the properties of the response body.
func (f MonitoringBulk) WithHeader(h map[string]string) func(*MonitoringBulkRequest)
WithHeader adds the headers to the HTTP request.
func (f MonitoringBulk) WithHuman() func(*MonitoringBulkRequest)
WithHuman makes statistical values human-readable.
func (f MonitoringBulk) WithInterval(v string) func(*MonitoringBulkRequest)
WithInterval - collection interval (e.g., '10s' or '10000ms') of the payload.
func (f MonitoringBulk) WithPretty() func(*MonitoringBulkRequest)
WithPretty makes the response body pretty-printed.
func (f MonitoringBulk) WithSystemAPIVersion(v string) func(*MonitoringBulkRequest)
WithSystemAPIVersion - api version of the monitored system.
func (f MonitoringBulk) WithSystemID(v string) func(*MonitoringBulkRequest)
WithSystemID - identifier of the monitored system.
type MonitoringBulkRequest struct {
DocumentType string
Body io.Reader
Interval string
SystemAPIVersion string
SystemID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MonitoringBulkRequest configures the Monitoring Bulk API request.
Do executes the request and returns response or error.
Msearch allows to execute several search operations in one request.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html.
func (f Msearch) WithCcsMinimizeRoundtrips(v bool) func(*MsearchRequest)
WithCcsMinimizeRoundtrips - indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.
func (f Msearch) WithContext(v context.Context) func(*MsearchRequest)
WithContext sets the request context.
func (f Msearch) WithErrorTrace() func(*MsearchRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Msearch) WithFilterPath(v ...string) func(*MsearchRequest)
WithFilterPath filters the properties of the response body.
func (f Msearch) WithHeader(h map[string]string) func(*MsearchRequest)
WithHeader adds the headers to the HTTP request.
func (f Msearch) WithHuman() func(*MsearchRequest)
WithHuman makes statistical values human-readable.
func (f Msearch) WithIndex(v ...string) func(*MsearchRequest)
WithIndex - a list of index names to use as default.
func (f Msearch) WithMaxConcurrentSearches(v int) func(*MsearchRequest)
WithMaxConcurrentSearches - controls the maximum number of concurrent searches the multi search api will execute.
func (f Msearch) WithMaxConcurrentShardRequests(v int) func(*MsearchRequest)
WithMaxConcurrentShardRequests - the number of concurrent shard requests each sub search executes concurrently per node. this value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.
func (f Msearch) WithPreFilterShardSize(v int) func(*MsearchRequest)
WithPreFilterShardSize - a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. this filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint..
func (f Msearch) WithPretty() func(*MsearchRequest)
WithPretty makes the response body pretty-printed.
func (f Msearch) WithRestTotalHitsAsInt(v bool) func(*MsearchRequest)
WithRestTotalHitsAsInt - indicates whether hits.total should be rendered as an integer or an object in the rest search response.
func (f Msearch) WithSearchType(v string) func(*MsearchRequest)
WithSearchType - search operation type.
func (f Msearch) WithTypedKeys(v bool) func(*MsearchRequest)
WithTypedKeys - specify whether aggregation and suggester names should be prefixed by their respective types in the response.
type MsearchRequest struct {
Index []string
Body io.Reader
CcsMinimizeRoundtrips *bool
MaxConcurrentSearches *int
MaxConcurrentShardRequests *int
PreFilterShardSize *int
RestTotalHitsAsInt *bool
SearchType string
TypedKeys *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MsearchRequest configures the Msearch API request.
Do executes the request and returns response or error.
MsearchTemplate allows to execute several search template operations in one request.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html.
func (f MsearchTemplate) WithCcsMinimizeRoundtrips(v bool) func(*MsearchTemplateRequest)
WithCcsMinimizeRoundtrips - indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.
func (f MsearchTemplate) WithContext(v context.Context) func(*MsearchTemplateRequest)
WithContext sets the request context.
func (f MsearchTemplate) WithErrorTrace() func(*MsearchTemplateRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f MsearchTemplate) WithFilterPath(v ...string) func(*MsearchTemplateRequest)
WithFilterPath filters the properties of the response body.
func (f MsearchTemplate) WithHeader(h map[string]string) func(*MsearchTemplateRequest)
WithHeader adds the headers to the HTTP request.
func (f MsearchTemplate) WithHuman() func(*MsearchTemplateRequest)
WithHuman makes statistical values human-readable.
func (f MsearchTemplate) WithIndex(v ...string) func(*MsearchTemplateRequest)
WithIndex - a list of index names to use as default.
func (f MsearchTemplate) WithMaxConcurrentSearches(v int) func(*MsearchTemplateRequest)
WithMaxConcurrentSearches - controls the maximum number of concurrent searches the multi search api will execute.
func (f MsearchTemplate) WithPretty() func(*MsearchTemplateRequest)
WithPretty makes the response body pretty-printed.
func (f MsearchTemplate) WithRestTotalHitsAsInt(v bool) func(*MsearchTemplateRequest)
WithRestTotalHitsAsInt - indicates whether hits.total should be rendered as an integer or an object in the rest search response.
func (f MsearchTemplate) WithSearchType(v string) func(*MsearchTemplateRequest)
WithSearchType - search operation type.
func (f MsearchTemplate) WithTypedKeys(v bool) func(*MsearchTemplateRequest)
WithTypedKeys - specify whether aggregation and suggester names should be prefixed by their respective types in the response.
type MsearchTemplateRequest struct {
Index []string
Body io.Reader
CcsMinimizeRoundtrips *bool
MaxConcurrentSearches *int
RestTotalHitsAsInt *bool
SearchType string
TypedKeys *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MsearchTemplateRequest configures the Msearch Template API request.
Do executes the request and returns response or error.
type Mtermvectors func(o ...func(*MtermvectorsRequest)) (*Response, error)
Mtermvectors returns multiple termvectors in one request.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html.
func (f Mtermvectors) WithBody(v io.Reader) func(*MtermvectorsRequest)
WithBody - Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation..
func (f Mtermvectors) WithContext(v context.Context) func(*MtermvectorsRequest)
WithContext sets the request context.
func (f Mtermvectors) WithErrorTrace() func(*MtermvectorsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Mtermvectors) WithFieldStatistics(v bool) func(*MtermvectorsRequest)
WithFieldStatistics - specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. applies to all returned documents unless otherwise specified in body "params" or "docs"..
func (f Mtermvectors) WithFields(v ...string) func(*MtermvectorsRequest)
WithFields - a list of fields to return. applies to all returned documents unless otherwise specified in body "params" or "docs"..
func (f Mtermvectors) WithFilterPath(v ...string) func(*MtermvectorsRequest)
WithFilterPath filters the properties of the response body.
func (f Mtermvectors) WithHeader(h map[string]string) func(*MtermvectorsRequest)
WithHeader adds the headers to the HTTP request.
func (f Mtermvectors) WithHuman() func(*MtermvectorsRequest)
WithHuman makes statistical values human-readable.
func (f Mtermvectors) WithIds(v ...string) func(*MtermvectorsRequest)
WithIds - a list of documents ids. you must define ids as parameter or set "ids" or "docs" in the request body.
func (f Mtermvectors) WithIndex(v string) func(*MtermvectorsRequest)
WithIndex - the index in which the document resides..
func (f Mtermvectors) WithOffsets(v bool) func(*MtermvectorsRequest)
WithOffsets - specifies if term offsets should be returned. applies to all returned documents unless otherwise specified in body "params" or "docs"..
func (f Mtermvectors) WithPayloads(v bool) func(*MtermvectorsRequest)
WithPayloads - specifies if term payloads should be returned. applies to all returned documents unless otherwise specified in body "params" or "docs"..
func (f Mtermvectors) WithPositions(v bool) func(*MtermvectorsRequest)
WithPositions - specifies if term positions should be returned. applies to all returned documents unless otherwise specified in body "params" or "docs"..
func (f Mtermvectors) WithPreference(v string) func(*MtermvectorsRequest)
WithPreference - specify the node or shard the operation should be performed on (default: random) .applies to all returned documents unless otherwise specified in body "params" or "docs"..
func (f Mtermvectors) WithPretty() func(*MtermvectorsRequest)
WithPretty makes the response body pretty-printed.
func (f Mtermvectors) WithRealtime(v bool) func(*MtermvectorsRequest)
WithRealtime - specifies if requests are real-time as opposed to near-real-time (default: true)..
func (f Mtermvectors) WithRouting(v string) func(*MtermvectorsRequest)
WithRouting - specific routing value. applies to all returned documents unless otherwise specified in body "params" or "docs"..
func (f Mtermvectors) WithTermStatistics(v bool) func(*MtermvectorsRequest)
WithTermStatistics - specifies if total term frequency and document frequency should be returned. applies to all returned documents unless otherwise specified in body "params" or "docs"..
func (f Mtermvectors) WithVersion(v int) func(*MtermvectorsRequest)
WithVersion - explicit version number for concurrency control.
func (f Mtermvectors) WithVersionType(v string) func(*MtermvectorsRequest)
WithVersionType - specific version type.
type MtermvectorsRequest struct {
Index string
Body io.Reader
Fields []string
FieldStatistics *bool
Ids []string
Offsets *bool
Payloads *bool
Positions *bool
Preference string
Realtime *bool
Routing string
TermStatistics *bool
Version *int
VersionType string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}MtermvectorsRequest configures the Mtermvectors API request.
Do executes the request and returns response or error.
type Nodes struct {
HotThreads NodesHotThreads
Info NodesInfo
ReloadSecureSettings NodesReloadSecureSettings
Stats NodesStats
Usage NodesUsage
}Nodes contains the Nodes APIs
type NodesHotThreads func(o ...func(*NodesHotThreadsRequest)) (*Response, error)
NodesHotThreads returns information about hot threads on each node in the cluster.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html.
func (f NodesHotThreads) WithContext(v context.Context) func(*NodesHotThreadsRequest)
WithContext sets the request context.
func (f NodesHotThreads) WithDocumentType(v string) func(*NodesHotThreadsRequest)
WithDocumentType - the type to sample (default: cpu).
func (f NodesHotThreads) WithErrorTrace() func(*NodesHotThreadsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f NodesHotThreads) WithFilterPath(v ...string) func(*NodesHotThreadsRequest)
WithFilterPath filters the properties of the response body.
func (f NodesHotThreads) WithHeader(h map[string]string) func(*NodesHotThreadsRequest)
WithHeader adds the headers to the HTTP request.
func (f NodesHotThreads) WithHuman() func(*NodesHotThreadsRequest)
WithHuman makes statistical values human-readable.
func (f NodesHotThreads) WithIgnoreIdleThreads(v bool) func(*NodesHotThreadsRequest)
WithIgnoreIdleThreads - don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true).
func (f NodesHotThreads) WithInterval(v time.Duration) func(*NodesHotThreadsRequest)
WithInterval - the interval for the second sampling of threads.
func (f NodesHotThreads) WithNodeID(v ...string) func(*NodesHotThreadsRequest)
WithNodeID - a list of node ids or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
func (f NodesHotThreads) WithPretty() func(*NodesHotThreadsRequest)
WithPretty makes the response body pretty-printed.
func (f NodesHotThreads) WithSnapshots(v int) func(*NodesHotThreadsRequest)
WithSnapshots - number of samples of thread stacktrace (default: 10).
func (f NodesHotThreads) WithThreads(v int) func(*NodesHotThreadsRequest)
WithThreads - specify the number of threads to provide information for (default: 3).
func (f NodesHotThreads) WithTimeout(v time.Duration) func(*NodesHotThreadsRequest)
WithTimeout - explicit operation timeout.
type NodesHotThreadsRequest struct {
NodeID []string
IgnoreIdleThreads *bool
Interval time.Duration
Snapshots *int
Threads *int
Timeout time.Duration
DocumentType string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}NodesHotThreadsRequest configures the Nodes Hot Threads API request.
Do executes the request and returns response or error.
type NodesInfo func(o ...func(*NodesInfoRequest)) (*Response, error)
NodesInfo returns information about nodes in the cluster.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html.
func (f NodesInfo) WithContext(v context.Context) func(*NodesInfoRequest)
WithContext sets the request context.
func (f NodesInfo) WithErrorTrace() func(*NodesInfoRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f NodesInfo) WithFilterPath(v ...string) func(*NodesInfoRequest)
WithFilterPath filters the properties of the response body.
func (f NodesInfo) WithFlatSettings(v bool) func(*NodesInfoRequest)
WithFlatSettings - return settings in flat format (default: false).
func (f NodesInfo) WithHeader(h map[string]string) func(*NodesInfoRequest)
WithHeader adds the headers to the HTTP request.
func (f NodesInfo) WithHuman() func(*NodesInfoRequest)
WithHuman makes statistical values human-readable.
func (f NodesInfo) WithMetric(v ...string) func(*NodesInfoRequest)
WithMetric - a list of metrics you wish returned. leave empty to return all..
func (f NodesInfo) WithNodeID(v ...string) func(*NodesInfoRequest)
WithNodeID - a list of node ids or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
func (f NodesInfo) WithPretty() func(*NodesInfoRequest)
WithPretty makes the response body pretty-printed.
func (f NodesInfo) WithTimeout(v time.Duration) func(*NodesInfoRequest)
WithTimeout - explicit operation timeout.
type NodesInfoRequest struct {
Metric []string
NodeID []string
FlatSettings *bool
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}NodesInfoRequest configures the Nodes Info API request.
Do executes the request and returns response or error.
type NodesReloadSecureSettings func(o ...func(*NodesReloadSecureSettingsRequest)) (*Response, error)
NodesReloadSecureSettings reloads secure settings.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings.
func (f NodesReloadSecureSettings) WithContext(v context.Context) func(*NodesReloadSecureSettingsRequest)
WithContext sets the request context.
func (f NodesReloadSecureSettings) WithErrorTrace() func(*NodesReloadSecureSettingsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f NodesReloadSecureSettings) WithFilterPath(v ...string) func(*NodesReloadSecureSettingsRequest)
WithFilterPath filters the properties of the response body.
func (f NodesReloadSecureSettings) WithHeader(h map[string]string) func(*NodesReloadSecureSettingsRequest)
WithHeader adds the headers to the HTTP request.
func (f NodesReloadSecureSettings) WithHuman() func(*NodesReloadSecureSettingsRequest)
WithHuman makes statistical values human-readable.
func (f NodesReloadSecureSettings) WithNodeID(v ...string) func(*NodesReloadSecureSettingsRequest)
WithNodeID - a list of node ids to span the reload/reinit call. should stay empty because reloading usually involves all cluster nodes..
func (f NodesReloadSecureSettings) WithPretty() func(*NodesReloadSecureSettingsRequest)
WithPretty makes the response body pretty-printed.
func (f NodesReloadSecureSettings) WithTimeout(v time.Duration) func(*NodesReloadSecureSettingsRequest)
WithTimeout - explicit operation timeout.
type NodesReloadSecureSettingsRequest struct {
NodeID []string
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}NodesReloadSecureSettingsRequest configures the Nodes Reload Secure Settings API request.
func (r NodesReloadSecureSettingsRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type NodesStats func(o ...func(*NodesStatsRequest)) (*Response, error)
NodesStats returns statistical information about nodes in the cluster.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html.
func (f NodesStats) WithCompletionFields(v ...string) func(*NodesStatsRequest)
WithCompletionFields - a list of fields for `fielddata` and `suggest` index metric (supports wildcards).
func (f NodesStats) WithContext(v context.Context) func(*NodesStatsRequest)
WithContext sets the request context.
func (f NodesStats) WithErrorTrace() func(*NodesStatsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f NodesStats) WithFielddataFields(v ...string) func(*NodesStatsRequest)
WithFielddataFields - a list of fields for `fielddata` index metric (supports wildcards).
func (f NodesStats) WithFields(v ...string) func(*NodesStatsRequest)
WithFields - a list of fields for `fielddata` and `completion` index metric (supports wildcards).
func (f NodesStats) WithFilterPath(v ...string) func(*NodesStatsRequest)
WithFilterPath filters the properties of the response body.
func (f NodesStats) WithGroups(v bool) func(*NodesStatsRequest)
WithGroups - a list of search groups for `search` index metric.
func (f NodesStats) WithHeader(h map[string]string) func(*NodesStatsRequest)
WithHeader adds the headers to the HTTP request.
func (f NodesStats) WithHuman() func(*NodesStatsRequest)
WithHuman makes statistical values human-readable.
func (f NodesStats) WithIncludeSegmentFileSizes(v bool) func(*NodesStatsRequest)
WithIncludeSegmentFileSizes - whether to report the aggregated disk usage of each one of the lucene index files (only applies if segment stats are requested).
func (f NodesStats) WithIndexMetric(v ...string) func(*NodesStatsRequest)
WithIndexMetric - limit the information returned for `indices` metric to the specific index metrics. isn't used if `indices` (or `all`) metric isn't specified..
func (f NodesStats) WithLevel(v string) func(*NodesStatsRequest)
WithLevel - return indices stats aggregated at index, node or shard level.
func (f NodesStats) WithMetric(v ...string) func(*NodesStatsRequest)
WithMetric - limit the information returned to the specified metrics.
func (f NodesStats) WithNodeID(v ...string) func(*NodesStatsRequest)
WithNodeID - a list of node ids or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
func (f NodesStats) WithPretty() func(*NodesStatsRequest)
WithPretty makes the response body pretty-printed.
func (f NodesStats) WithTimeout(v time.Duration) func(*NodesStatsRequest)
WithTimeout - explicit operation timeout.
func (f NodesStats) WithTypes(v ...string) func(*NodesStatsRequest)
WithTypes - a list of document types for the `indexing` index metric.
type NodesStatsRequest struct {
IndexMetric []string
Metric []string
NodeID []string
CompletionFields []string
FielddataFields []string
Fields []string
Groups *bool
IncludeSegmentFileSizes *bool
Level string
Timeout time.Duration
Types []string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}NodesStatsRequest configures the Nodes Stats API request.
Do executes the request and returns response or error.
type NodesUsage func(o ...func(*NodesUsageRequest)) (*Response, error)
NodesUsage returns low-level information about REST actions usage on nodes.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-usage.html.
func (f NodesUsage) WithContext(v context.Context) func(*NodesUsageRequest)
WithContext sets the request context.
func (f NodesUsage) WithErrorTrace() func(*NodesUsageRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f NodesUsage) WithFilterPath(v ...string) func(*NodesUsageRequest)
WithFilterPath filters the properties of the response body.
func (f NodesUsage) WithHeader(h map[string]string) func(*NodesUsageRequest)
WithHeader adds the headers to the HTTP request.
func (f NodesUsage) WithHuman() func(*NodesUsageRequest)
WithHuman makes statistical values human-readable.
func (f NodesUsage) WithMetric(v ...string) func(*NodesUsageRequest)
WithMetric - limit the information returned to the specified metrics.
func (f NodesUsage) WithNodeID(v ...string) func(*NodesUsageRequest)
WithNodeID - a list of node ids or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
func (f NodesUsage) WithPretty() func(*NodesUsageRequest)
WithPretty makes the response body pretty-printed.
func (f NodesUsage) WithTimeout(v time.Duration) func(*NodesUsageRequest)
WithTimeout - explicit operation timeout.
type NodesUsageRequest struct {
Metric []string
NodeID []string
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}NodesUsageRequest configures the Nodes Usage API request.
Do executes the request and returns response or error.
type Ping func(o ...func(*PingRequest)) (*Response, error)
Ping returns whether the cluster is running.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html.
func (f Ping) WithContext(v context.Context) func(*PingRequest)
WithContext sets the request context.
func (f Ping) WithErrorTrace() func(*PingRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Ping) WithFilterPath(v ...string) func(*PingRequest)
WithFilterPath filters the properties of the response body.
func (f Ping) WithHeader(h map[string]string) func(*PingRequest)
WithHeader adds the headers to the HTTP request.
func (f Ping) WithHuman() func(*PingRequest)
WithHuman makes statistical values human-readable.
func (f Ping) WithPretty() func(*PingRequest)
WithPretty makes the response body pretty-printed.
type PingRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}PingRequest configures the Ping API request.
Do executes the request and returns response or error.
PutScript creates or updates a script.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html.
func (f PutScript) WithContext(v context.Context) func(*PutScriptRequest)
WithContext sets the request context.
func (f PutScript) WithErrorTrace() func(*PutScriptRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f PutScript) WithFilterPath(v ...string) func(*PutScriptRequest)
WithFilterPath filters the properties of the response body.
func (f PutScript) WithHeader(h map[string]string) func(*PutScriptRequest)
WithHeader adds the headers to the HTTP request.
func (f PutScript) WithHuman() func(*PutScriptRequest)
WithHuman makes statistical values human-readable.
func (f PutScript) WithMasterTimeout(v time.Duration) func(*PutScriptRequest)
WithMasterTimeout - specify timeout for connection to master.
func (f PutScript) WithPretty() func(*PutScriptRequest)
WithPretty makes the response body pretty-printed.
func (f PutScript) WithScriptContext(v string) func(*PutScriptRequest)
WithScriptContext - script context.
func (f PutScript) WithTimeout(v time.Duration) func(*PutScriptRequest)
WithTimeout - explicit operation timeout.
type PutScriptRequest struct {
ScriptID string
Body io.Reader
ScriptContext string
MasterTimeout time.Duration
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}PutScriptRequest configures the Put Script API request.
Do executes the request and returns response or error.
RankEval allows to evaluate the quality of ranked search results over a set of typical search queries
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html.
func (f RankEval) WithAllowNoIndices(v bool) func(*RankEvalRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f RankEval) WithContext(v context.Context) func(*RankEvalRequest)
WithContext sets the request context.
func (f RankEval) WithErrorTrace() func(*RankEvalRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f RankEval) WithExpandWildcards(v string) func(*RankEvalRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f RankEval) WithFilterPath(v ...string) func(*RankEvalRequest)
WithFilterPath filters the properties of the response body.
func (f RankEval) WithHeader(h map[string]string) func(*RankEvalRequest)
WithHeader adds the headers to the HTTP request.
func (f RankEval) WithHuman() func(*RankEvalRequest)
WithHuman makes statistical values human-readable.
func (f RankEval) WithIgnoreUnavailable(v bool) func(*RankEvalRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f RankEval) WithIndex(v ...string) func(*RankEvalRequest)
WithIndex - a list of index names to search; use _all to perform the operation on all indices.
func (f RankEval) WithPretty() func(*RankEvalRequest)
WithPretty makes the response body pretty-printed.
type RankEvalRequest struct {
Index []string
Body io.Reader
AllowNoIndices *bool
ExpandWildcards string
*bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}RankEvalRequest configures the Rank Eval API request.
Do executes the request and returns response or error.
Reindex allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html.
func (f Reindex) WithContext(v context.Context) func(*ReindexRequest)
WithContext sets the request context.
func (f Reindex) WithErrorTrace() func(*ReindexRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Reindex) WithFilterPath(v ...string) func(*ReindexRequest)
WithFilterPath filters the properties of the response body.
func (f Reindex) WithHeader(h map[string]string) func(*ReindexRequest)
WithHeader adds the headers to the HTTP request.
func (f Reindex) WithHuman() func(*ReindexRequest)
WithHuman makes statistical values human-readable.
func (f Reindex) WithMaxDocs(v int) func(*ReindexRequest)
WithMaxDocs - maximum number of documents to process (default: all documents).
func (f Reindex) WithPretty() func(*ReindexRequest)
WithPretty makes the response body pretty-printed.
func (f Reindex) WithRefresh(v bool) func(*ReindexRequest)
WithRefresh - should the effected indexes be refreshed?.
func (f Reindex) WithRequestsPerSecond(v int) func(*ReindexRequest)
WithRequestsPerSecond - the throttle to set on this request in sub-requests per second. -1 means no throttle..
func (f Reindex) WithScroll(v time.Duration) func(*ReindexRequest)
WithScroll - control how long to keep the search context alive.
func (f Reindex) WithSlices(v int) func(*ReindexRequest)
WithSlices - the number of slices this task should be divided into. defaults to 1 meaning the task isn't sliced into subtasks..
func (f Reindex) WithTimeout(v time.Duration) func(*ReindexRequest)
WithTimeout - time each individual bulk request should wait for shards that are unavailable..
func (f Reindex) WithWaitForActiveShards(v string) func(*ReindexRequest)
WithWaitForActiveShards - sets the number of shard copies that must be active before proceeding with the reindex operation. defaults to 1, meaning the primary shard only. set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).
func (f Reindex) WithWaitForCompletion(v bool) func(*ReindexRequest)
WithWaitForCompletion - should the request should block until the reindex is complete..
type ReindexRequest struct {
Body io.Reader
MaxDocs *int
Refresh *bool
RequestsPerSecond *int
Scroll time.Duration
Slices *int
Timeout time.Duration
WaitForActiveShards string
WaitForCompletion *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ReindexRequest configures the Reindex API request.
Do executes the request and returns response or error.
type ReindexRethrottle func(task_id string, requests_per_second *int, o ...func(*ReindexRethrottleRequest)) (*Response, error)
ReindexRethrottle changes the number of requests per second for a particular Reindex operation.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html.
func (f ReindexRethrottle) WithContext(v context.Context) func(*ReindexRethrottleRequest)
WithContext sets the request context.
func (f ReindexRethrottle) WithErrorTrace() func(*ReindexRethrottleRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ReindexRethrottle) WithFilterPath(v ...string) func(*ReindexRethrottleRequest)
WithFilterPath filters the properties of the response body.
func (f ReindexRethrottle) WithHeader(h map[string]string) func(*ReindexRethrottleRequest)
WithHeader adds the headers to the HTTP request.
func (f ReindexRethrottle) WithHuman() func(*ReindexRethrottleRequest)
WithHuman makes statistical values human-readable.
func (f ReindexRethrottle) WithPretty() func(*ReindexRethrottleRequest)
WithPretty makes the response body pretty-printed.
func (f ReindexRethrottle) WithRequestsPerSecond(v int) func(*ReindexRethrottleRequest)
WithRequestsPerSecond - the throttle to set on this request in floating sub-requests per second. -1 means set no throttle..
type ReindexRethrottleRequest struct {
TaskID string
RequestsPerSecond *int
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ReindexRethrottleRequest configures the Reindex Rethrottle API request.
Do executes the request and returns response or error.
type Remote struct {
}Remote contains the Remote APIs
type RenderSearchTemplate func(o ...func(*RenderSearchTemplateRequest)) (*Response, error)
RenderSearchTemplate allows to use the Mustache language to pre-render a search definition.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html#_validating_templates.
func (f RenderSearchTemplate) WithBody(v io.Reader) func(*RenderSearchTemplateRequest)
WithBody - The search definition template and its params.
func (f RenderSearchTemplate) WithContext(v context.Context) func(*RenderSearchTemplateRequest)
WithContext sets the request context.
func (f RenderSearchTemplate) WithErrorTrace() func(*RenderSearchTemplateRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f RenderSearchTemplate) WithFilterPath(v ...string) func(*RenderSearchTemplateRequest)
WithFilterPath filters the properties of the response body.
func (f RenderSearchTemplate) WithHeader(h map[string]string) func(*RenderSearchTemplateRequest)
WithHeader adds the headers to the HTTP request.
func (f RenderSearchTemplate) WithHuman() func(*RenderSearchTemplateRequest)
WithHuman makes statistical values human-readable.
func (f RenderSearchTemplate) WithPretty() func(*RenderSearchTemplateRequest)
WithPretty makes the response body pretty-printed.
func (f RenderSearchTemplate) WithTemplateID(v string) func(*RenderSearchTemplateRequest)
WithTemplateID - the ID of the stored search template.
type RenderSearchTemplateRequest struct {
TemplateID string
Body io.Reader
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}RenderSearchTemplateRequest configures the Render Search Template API request.
func (r RenderSearchTemplateRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
Request defines the API request.
Response represents the API response.
IsError returns true when the response status indicates failure.
Code:
es, _ := elasticsearch.NewDefaultClient() res, err := es.Info() // Handle connection errors // if err != nil { log.Fatalf("ERROR: %v", err) } defer res.Body.Close() // Handle error response (4xx, 5xx) // if res.IsError() { log.Fatalf("ERROR: %s", res.Status()) } // Handle successful response (2xx) // log.Println(res)
Status returns the response status as a string.
Code:
es, _ := elasticsearch.NewDefaultClient()
res, _ := es.Info()
log.Println(res.Status())
// 200 OK
String returns the response as a string.
The intended usage is for testing or debugging only.
Code:
es, _ := elasticsearch.NewDefaultClient()
res, _ := es.Info()
log.Println(res.String())
// [200 OK] {
// "name" : "es1",
// "cluster_name" : "go-elasticsearch",
// ...
// }
type Rollup struct {
DeleteJob RollupDeleteJob
GetJobs RollupGetJobs
GetCaps RollupGetRollupCaps
GetIndexCaps RollupGetRollupIndexCaps
PutJob RollupPutJob
Search RollupRollupSearch
StartJob RollupStartJob
StopJob RollupStopJob
}Rollup contains the Rollup APIs
type RollupDeleteJob func(id string, o ...func(*RollupDeleteJobRequest)) (*Response, error)
RollupDeleteJob -
func (f RollupDeleteJob) WithContext(v context.Context) func(*RollupDeleteJobRequest)
WithContext sets the request context.
func (f RollupDeleteJob) WithErrorTrace() func(*RollupDeleteJobRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f RollupDeleteJob) WithFilterPath(v ...string) func(*RollupDeleteJobRequest)
WithFilterPath filters the properties of the response body.
func (f RollupDeleteJob) WithHeader(h map[string]string) func(*RollupDeleteJobRequest)
WithHeader adds the headers to the HTTP request.
func (f RollupDeleteJob) WithHuman() func(*RollupDeleteJobRequest)
WithHuman makes statistical values human-readable.
func (f RollupDeleteJob) WithPretty() func(*RollupDeleteJobRequest)
WithPretty makes the response body pretty-printed.
type RollupDeleteJobRequest struct {
JobID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}RollupDeleteJobRequest configures the Rollup Delete Job API request.
Do executes the request and returns response or error.
type RollupGetJobs func(o ...func(*RollupGetJobsRequest)) (*Response, error)
RollupGetJobs -
func (f RollupGetJobs) WithContext(v context.Context) func(*RollupGetJobsRequest)
WithContext sets the request context.
func (f RollupGetJobs) WithErrorTrace() func(*RollupGetJobsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f RollupGetJobs) WithFilterPath(v ...string) func(*RollupGetJobsRequest)
WithFilterPath filters the properties of the response body.
func (f RollupGetJobs) WithHeader(h map[string]string) func(*RollupGetJobsRequest)
WithHeader adds the headers to the HTTP request.
func (f RollupGetJobs) WithHuman() func(*RollupGetJobsRequest)
WithHuman makes statistical values human-readable.
func (f RollupGetJobs) WithJobID(v string) func(*RollupGetJobsRequest)
WithJobID - the ID of the job(s) to fetch. accepts glob patterns, or left blank for all jobs.
func (f RollupGetJobs) WithPretty() func(*RollupGetJobsRequest)
WithPretty makes the response body pretty-printed.
type RollupGetJobsRequest struct {
JobID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}RollupGetJobsRequest configures the Rollup Get Jobs API request.
Do executes the request and returns response or error.
type RollupGetRollupCaps func(o ...func(*RollupGetRollupCapsRequest)) (*Response, error)
RollupGetRollupCaps -
func (f RollupGetRollupCaps) WithContext(v context.Context) func(*RollupGetRollupCapsRequest)
WithContext sets the request context.
func (f RollupGetRollupCaps) WithErrorTrace() func(*RollupGetRollupCapsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f RollupGetRollupCaps) WithFilterPath(v ...string) func(*RollupGetRollupCapsRequest)
WithFilterPath filters the properties of the response body.
func (f RollupGetRollupCaps) WithHeader(h map[string]string) func(*RollupGetRollupCapsRequest)
WithHeader adds the headers to the HTTP request.
func (f RollupGetRollupCaps) WithHuman() func(*RollupGetRollupCapsRequest)
WithHuman makes statistical values human-readable.
func (f RollupGetRollupCaps) WithIndex(v string) func(*RollupGetRollupCapsRequest)
WithIndex - the ID of the index to check rollup capabilities on, or left blank for all jobs.
func (f RollupGetRollupCaps) WithPretty() func(*RollupGetRollupCapsRequest)
WithPretty makes the response body pretty-printed.
type RollupGetRollupCapsRequest struct {
Index string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}RollupGetRollupCapsRequest configures the Rollup Get Rollup Caps API request.
func (r RollupGetRollupCapsRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type RollupGetRollupIndexCaps func(index string, o ...func(*RollupGetRollupIndexCapsRequest)) (*Response, error)
RollupGetRollupIndexCaps -
func (f RollupGetRollupIndexCaps) WithContext(v context.Context) func(*RollupGetRollupIndexCapsRequest)
WithContext sets the request context.
func (f RollupGetRollupIndexCaps) WithErrorTrace() func(*RollupGetRollupIndexCapsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f RollupGetRollupIndexCaps) WithFilterPath(v ...string) func(*RollupGetRollupIndexCapsRequest)
WithFilterPath filters the properties of the response body.
func (f RollupGetRollupIndexCaps) WithHeader(h map[string]string) func(*RollupGetRollupIndexCapsRequest)
WithHeader adds the headers to the HTTP request.
func (f RollupGetRollupIndexCaps) WithHuman() func(*RollupGetRollupIndexCapsRequest)
WithHuman makes statistical values human-readable.
func (f RollupGetRollupIndexCaps) WithPretty() func(*RollupGetRollupIndexCapsRequest)
WithPretty makes the response body pretty-printed.
type RollupGetRollupIndexCapsRequest struct {
Index string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}RollupGetRollupIndexCapsRequest configures the Rollup Get Rollup Index Caps API request.
func (r RollupGetRollupIndexCapsRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type RollupPutJob func(id string, body io.Reader, o ...func(*RollupPutJobRequest)) (*Response, error)
RollupPutJob -
func (f RollupPutJob) WithContext(v context.Context) func(*RollupPutJobRequest)
WithContext sets the request context.
func (f RollupPutJob) WithErrorTrace() func(*RollupPutJobRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f RollupPutJob) WithFilterPath(v ...string) func(*RollupPutJobRequest)
WithFilterPath filters the properties of the response body.
func (f RollupPutJob) WithHeader(h map[string]string) func(*RollupPutJobRequest)
WithHeader adds the headers to the HTTP request.
func (f RollupPutJob) WithHuman() func(*RollupPutJobRequest)
WithHuman makes statistical values human-readable.
func (f RollupPutJob) WithPretty() func(*RollupPutJobRequest)
WithPretty makes the response body pretty-printed.
type RollupPutJobRequest struct {
JobID string
Body io.Reader
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}RollupPutJobRequest configures the Rollup Put Job API request.
Do executes the request and returns response or error.
type RollupRollupSearch func(index []string, body io.Reader, o ...func(*RollupRollupSearchRequest)) (*Response, error)
RollupRollupSearch -
func (f RollupRollupSearch) WithContext(v context.Context) func(*RollupRollupSearchRequest)
WithContext sets the request context.
func (f RollupRollupSearch) WithDocumentType(v string) func(*RollupRollupSearchRequest)
WithDocumentType - the doc type inside the index.
func (f RollupRollupSearch) WithErrorTrace() func(*RollupRollupSearchRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f RollupRollupSearch) WithFilterPath(v ...string) func(*RollupRollupSearchRequest)
WithFilterPath filters the properties of the response body.
func (f RollupRollupSearch) WithHeader(h map[string]string) func(*RollupRollupSearchRequest)
WithHeader adds the headers to the HTTP request.
func (f RollupRollupSearch) WithHuman() func(*RollupRollupSearchRequest)
WithHuman makes statistical values human-readable.
func (f RollupRollupSearch) WithPretty() func(*RollupRollupSearchRequest)
WithPretty makes the response body pretty-printed.
func (f RollupRollupSearch) WithRestTotalHitsAsInt(v bool) func(*RollupRollupSearchRequest)
WithRestTotalHitsAsInt - indicates whether hits.total should be rendered as an integer or an object in the rest search response.
func (f RollupRollupSearch) WithTypedKeys(v bool) func(*RollupRollupSearchRequest)
WithTypedKeys - specify whether aggregation and suggester names should be prefixed by their respective types in the response.
type RollupRollupSearchRequest struct {
Index []string
DocumentType string
Body io.Reader
RestTotalHitsAsInt *bool
TypedKeys *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}RollupRollupSearchRequest configures the Rollup Rollup Search API request.
Do executes the request and returns response or error.
type RollupStartJob func(id string, o ...func(*RollupStartJobRequest)) (*Response, error)
RollupStartJob -
func (f RollupStartJob) WithContext(v context.Context) func(*RollupStartJobRequest)
WithContext sets the request context.
func (f RollupStartJob) WithErrorTrace() func(*RollupStartJobRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f RollupStartJob) WithFilterPath(v ...string) func(*RollupStartJobRequest)
WithFilterPath filters the properties of the response body.
func (f RollupStartJob) WithHeader(h map[string]string) func(*RollupStartJobRequest)
WithHeader adds the headers to the HTTP request.
func (f RollupStartJob) WithHuman() func(*RollupStartJobRequest)
WithHuman makes statistical values human-readable.
func (f RollupStartJob) WithPretty() func(*RollupStartJobRequest)
WithPretty makes the response body pretty-printed.
type RollupStartJobRequest struct {
JobID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}RollupStartJobRequest configures the Rollup Start Job API request.
Do executes the request and returns response or error.
type RollupStopJob func(id string, o ...func(*RollupStopJobRequest)) (*Response, error)
RollupStopJob -
func (f RollupStopJob) WithContext(v context.Context) func(*RollupStopJobRequest)
WithContext sets the request context.
func (f RollupStopJob) WithErrorTrace() func(*RollupStopJobRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f RollupStopJob) WithFilterPath(v ...string) func(*RollupStopJobRequest)
WithFilterPath filters the properties of the response body.
func (f RollupStopJob) WithHeader(h map[string]string) func(*RollupStopJobRequest)
WithHeader adds the headers to the HTTP request.
func (f RollupStopJob) WithHuman() func(*RollupStopJobRequest)
WithHuman makes statistical values human-readable.
func (f RollupStopJob) WithPretty() func(*RollupStopJobRequest)
WithPretty makes the response body pretty-printed.
func (f RollupStopJob) WithTimeout(v time.Duration) func(*RollupStopJobRequest)
WithTimeout - block for (at maximum) the specified duration while waiting for the job to stop. defaults to 30s..
func (f RollupStopJob) WithWaitForCompletion(v bool) func(*RollupStopJobRequest)
WithWaitForCompletion - true if the api should block until the job has fully stopped, false if should be executed async. defaults to false..
type RollupStopJobRequest struct {
JobID string
Timeout time.Duration
WaitForCompletion *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}RollupStopJobRequest configures the Rollup Stop Job API request.
Do executes the request and returns response or error.
type SQL struct {
ClearCursor SQLClearCursor
Query SQLQuery
Translate SQLTranslate
}SQL contains the SQL APIs
SQLClearCursor - Clear SQL cursor
func (f SQLClearCursor) WithContext(v context.Context) func(*SQLClearCursorRequest)
WithContext sets the request context.
func (f SQLClearCursor) WithErrorTrace() func(*SQLClearCursorRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SQLClearCursor) WithFilterPath(v ...string) func(*SQLClearCursorRequest)
WithFilterPath filters the properties of the response body.
func (f SQLClearCursor) WithHeader(h map[string]string) func(*SQLClearCursorRequest)
WithHeader adds the headers to the HTTP request.
func (f SQLClearCursor) WithHuman() func(*SQLClearCursorRequest)
WithHuman makes statistical values human-readable.
func (f SQLClearCursor) WithPretty() func(*SQLClearCursorRequest)
WithPretty makes the response body pretty-printed.
type SQLClearCursorRequest struct {
Body io.Reader
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SQLClearCursorRequest configures the SQL Clear Cursor API request.
Do executes the request and returns response or error.
SQLQuery - Execute SQL
func (f SQLQuery) WithContext(v context.Context) func(*SQLQueryRequest)
WithContext sets the request context.
func (f SQLQuery) WithErrorTrace() func(*SQLQueryRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SQLQuery) WithFilterPath(v ...string) func(*SQLQueryRequest)
WithFilterPath filters the properties of the response body.
func (f SQLQuery) WithFormat(v string) func(*SQLQueryRequest)
WithFormat - a short version of the accept header, e.g. json, yaml.
func (f SQLQuery) WithHeader(h map[string]string) func(*SQLQueryRequest)
WithHeader adds the headers to the HTTP request.
func (f SQLQuery) WithHuman() func(*SQLQueryRequest)
WithHuman makes statistical values human-readable.
func (f SQLQuery) WithPretty() func(*SQLQueryRequest)
WithPretty makes the response body pretty-printed.
type SQLQueryRequest struct {
Body io.Reader
Format string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SQLQueryRequest configures the SQL Query API request.
Do executes the request and returns response or error.
SQLTranslate - Translate SQL into Elasticsearch queries
func (f SQLTranslate) WithContext(v context.Context) func(*SQLTranslateRequest)
WithContext sets the request context.
func (f SQLTranslate) WithErrorTrace() func(*SQLTranslateRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SQLTranslate) WithFilterPath(v ...string) func(*SQLTranslateRequest)
WithFilterPath filters the properties of the response body.
func (f SQLTranslate) WithHeader(h map[string]string) func(*SQLTranslateRequest)
WithHeader adds the headers to the HTTP request.
func (f SQLTranslate) WithHuman() func(*SQLTranslateRequest)
WithHuman makes statistical values human-readable.
func (f SQLTranslate) WithPretty() func(*SQLTranslateRequest)
WithPretty makes the response body pretty-printed.
type SQLTranslateRequest struct {
Body io.Reader
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SQLTranslateRequest configures the SQL Translate API request.
Do executes the request and returns response or error.
type SSL struct {
Certificates SSLCertificates
}SSL contains the SSL APIs
type SSLCertificates func(o ...func(*SSLCertificatesRequest)) (*Response, error)
SSLCertificates - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html
func (f SSLCertificates) WithContext(v context.Context) func(*SSLCertificatesRequest)
WithContext sets the request context.
func (f SSLCertificates) WithErrorTrace() func(*SSLCertificatesRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SSLCertificates) WithFilterPath(v ...string) func(*SSLCertificatesRequest)
WithFilterPath filters the properties of the response body.
func (f SSLCertificates) WithHeader(h map[string]string) func(*SSLCertificatesRequest)
WithHeader adds the headers to the HTTP request.
func (f SSLCertificates) WithHuman() func(*SSLCertificatesRequest)
WithHuman makes statistical values human-readable.
func (f SSLCertificates) WithPretty() func(*SSLCertificatesRequest)
WithPretty makes the response body pretty-printed.
type SSLCertificatesRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SSLCertificatesRequest configures the SSL Certificates API request.
Do executes the request and returns response or error.
type ScriptsPainlessContext func(o ...func(*ScriptsPainlessContextRequest)) (*Response, error)
ScriptsPainlessContext allows to query context information.
func (f ScriptsPainlessContext) WithContext(v context.Context) func(*ScriptsPainlessContextRequest)
WithContext sets the request context.
func (f ScriptsPainlessContext) WithErrorTrace() func(*ScriptsPainlessContextRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ScriptsPainlessContext) WithFilterPath(v ...string) func(*ScriptsPainlessContextRequest)
WithFilterPath filters the properties of the response body.
func (f ScriptsPainlessContext) WithHuman() func(*ScriptsPainlessContextRequest)
WithHuman makes statistical values human-readable.
func (f ScriptsPainlessContext) WithPretty() func(*ScriptsPainlessContextRequest)
WithPretty makes the response body pretty-printed.
func (f ScriptsPainlessContext) WithScriptContext(v string) func(*ScriptsPainlessContextRequest)
WithScriptContext - select a specific context to retrieve api information about.
type ScriptsPainlessContextRequest struct {
ScriptContext string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
// contains filtered or unexported fields
}ScriptsPainlessContextRequest configures the Scripts Painless Context API request.
func (r ScriptsPainlessContextRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type ScriptsPainlessExecute func(o ...func(*ScriptsPainlessExecuteRequest)) (*Response, error)
ScriptsPainlessExecute allows an arbitrary script to be executed and a result to be returned
See full documentation at https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html.
func (f ScriptsPainlessExecute) WithBody(v io.Reader) func(*ScriptsPainlessExecuteRequest)
WithBody - The script to execute.
func (f ScriptsPainlessExecute) WithContext(v context.Context) func(*ScriptsPainlessExecuteRequest)
WithContext sets the request context.
func (f ScriptsPainlessExecute) WithErrorTrace() func(*ScriptsPainlessExecuteRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f ScriptsPainlessExecute) WithFilterPath(v ...string) func(*ScriptsPainlessExecuteRequest)
WithFilterPath filters the properties of the response body.
func (f ScriptsPainlessExecute) WithHeader(h map[string]string) func(*ScriptsPainlessExecuteRequest)
WithHeader adds the headers to the HTTP request.
func (f ScriptsPainlessExecute) WithHuman() func(*ScriptsPainlessExecuteRequest)
WithHuman makes statistical values human-readable.
func (f ScriptsPainlessExecute) WithPretty() func(*ScriptsPainlessExecuteRequest)
WithPretty makes the response body pretty-printed.
type ScriptsPainlessExecuteRequest struct {
Body io.Reader
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ScriptsPainlessExecuteRequest configures the Scripts Painless Execute API request.
func (r ScriptsPainlessExecuteRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type Scroll func(o ...func(*ScrollRequest)) (*Response, error)
Scroll allows to retrieve a large numbers of results from a single search request.
See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll.
func (f Scroll) WithBody(v io.Reader) func(*ScrollRequest)
WithBody - The scroll ID if not passed by URL or query parameter..
func (f Scroll) WithContext(v context.Context) func(*ScrollRequest)
WithContext sets the request context.
func (f Scroll) WithErrorTrace() func(*ScrollRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Scroll) WithFilterPath(v ...string) func(*ScrollRequest)
WithFilterPath filters the properties of the response body.
func (f Scroll) WithHeader(h map[string]string) func(*ScrollRequest)
WithHeader adds the headers to the HTTP request.
func (f Scroll) WithHuman() func(*ScrollRequest)
WithHuman makes statistical values human-readable.
func (f Scroll) WithPretty() func(*ScrollRequest)
WithPretty makes the response body pretty-printed.
func (f Scroll) WithRestTotalHitsAsInt(v bool) func(*ScrollRequest)
WithRestTotalHitsAsInt - indicates whether hits.total should be rendered as an integer or an object in the rest search response.
func (f Scroll) WithScroll(v time.Duration) func(*ScrollRequest)
WithScroll - specify how long a consistent view of the index should be maintained for scrolled search.
func (f Scroll) WithScrollID(v string) func(*ScrollRequest)
WithScrollID - the scroll ID.
type ScrollRequest struct {
Body io.Reader
ScrollID string
RestTotalHitsAsInt *bool
Scroll time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}ScrollRequest configures the Scroll API request.
Do executes the request and returns response or error.
type Search func(o ...func(*SearchRequest)) (*Response, error)
Search returns results matching a query.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html.
func (f Search) WithAllowNoIndices(v bool) func(*SearchRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f Search) WithAllowPartialSearchResults(v bool) func(*SearchRequest)
WithAllowPartialSearchResults - indicate if an error should be returned if there is a partial search failure or timeout.
func (f Search) WithAnalyzeWildcard(v bool) func(*SearchRequest)
WithAnalyzeWildcard - specify whether wildcard and prefix queries should be analyzed (default: false).
func (f Search) WithAnalyzer(v string) func(*SearchRequest)
WithAnalyzer - the analyzer to use for the query string.
func (f Search) WithBatchedReduceSize(v int) func(*SearchRequest)
WithBatchedReduceSize - the number of shard results that should be reduced at once on the coordinating node. this value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large..
func (f Search) WithBody(v io.Reader) func(*SearchRequest)
WithBody - The search definition using the Query DSL.
func (f Search) WithCcsMinimizeRoundtrips(v bool) func(*SearchRequest)
WithCcsMinimizeRoundtrips - indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.
func (f Search) WithContext(v context.Context) func(*SearchRequest)
WithContext sets the request context.
func (f Search) WithDefaultOperator(v string) func(*SearchRequest)
WithDefaultOperator - the default operator for query string query (and or or).
func (f Search) WithDf(v string) func(*SearchRequest)
WithDf - the field to use as default where no field prefix is given in the query string.
func (f Search) WithDocvalueFields(v ...string) func(*SearchRequest)
WithDocvalueFields - a list of fields to return as the docvalue representation of a field for each hit.
func (f Search) WithErrorTrace() func(*SearchRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Search) WithExpandWildcards(v string) func(*SearchRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f Search) WithExplain(v bool) func(*SearchRequest)
WithExplain - specify whether to return detailed information about score computation as part of a hit.
func (f Search) WithFilterPath(v ...string) func(*SearchRequest)
WithFilterPath filters the properties of the response body.
func (f Search) WithFrom(v int) func(*SearchRequest)
WithFrom - starting offset (default: 0).
func (f Search) WithHeader(h map[string]string) func(*SearchRequest)
WithHeader adds the headers to the HTTP request.
func (f Search) WithHuman() func(*SearchRequest)
WithHuman makes statistical values human-readable.
func (f Search) WithIgnoreThrottled(v bool) func(*SearchRequest)
WithIgnoreThrottled - whether specified concrete, expanded or aliased indices should be ignored when throttled.
func (f Search) WithIgnoreUnavailable(v bool) func(*SearchRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f Search) WithIndex(v ...string) func(*SearchRequest)
WithIndex - a list of index names to search; use _all to perform the operation on all indices.
func (f Search) WithLenient(v bool) func(*SearchRequest)
WithLenient - specify whether format-based query failures (such as providing text to a numeric field) should be ignored.
func (f Search) WithMaxConcurrentShardRequests(v int) func(*SearchRequest)
WithMaxConcurrentShardRequests - the number of concurrent shard requests per node this search executes concurrently. this value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.
func (f Search) WithPreFilterShardSize(v int) func(*SearchRequest)
WithPreFilterShardSize - a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. this filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint..
func (f Search) WithPreference(v string) func(*SearchRequest)
WithPreference - specify the node or shard the operation should be performed on (default: random).
func (f Search) WithPretty() func(*SearchRequest)
WithPretty makes the response body pretty-printed.
func (f Search) WithQuery(v string) func(*SearchRequest)
WithQuery - query in the lucene query string syntax.
func (f Search) WithRequestCache(v bool) func(*SearchRequest)
WithRequestCache - specify if request cache should be used for this request or not, defaults to index level setting.
func (f Search) WithRestTotalHitsAsInt(v bool) func(*SearchRequest)
WithRestTotalHitsAsInt - indicates whether hits.total should be rendered as an integer or an object in the rest search response.
func (f Search) WithRouting(v ...string) func(*SearchRequest)
WithRouting - a list of specific routing values.
func (f Search) WithScroll(v time.Duration) func(*SearchRequest)
WithScroll - specify how long a consistent view of the index should be maintained for scrolled search.
func (f Search) WithSearchType(v string) func(*SearchRequest)
WithSearchType - search operation type.
func (f Search) WithSeqNoPrimaryTerm(v bool) func(*SearchRequest)
WithSeqNoPrimaryTerm - specify whether to return sequence number and primary term of the last modification of each hit.
func (f Search) WithSize(v int) func(*SearchRequest)
WithSize - number of hits to return (default: 10).
func (f Search) WithSort(v ...string) func(*SearchRequest)
WithSort - a list of <field>:<direction> pairs.
func (f Search) WithSource(v ...string) func(*SearchRequest)
WithSource - true or false to return the _source field or not, or a list of fields to return.
func (f Search) WithSourceExcludes(v ...string) func(*SearchRequest)
WithSourceExcludes - a list of fields to exclude from the returned _source field.
func (f Search) WithSourceIncludes(v ...string) func(*SearchRequest)
WithSourceIncludes - a list of fields to extract and return from the _source field.
func (f Search) WithStats(v ...string) func(*SearchRequest)
WithStats - specific 'tag' of the request for logging and statistical purposes.
func (f Search) WithStoredFields(v ...string) func(*SearchRequest)
WithStoredFields - a list of stored fields to return as part of a hit.
func (f Search) WithSuggestField(v string) func(*SearchRequest)
WithSuggestField - specify which field to use for suggestions.
func (f Search) WithSuggestMode(v string) func(*SearchRequest)
WithSuggestMode - specify suggest mode.
func (f Search) WithSuggestSize(v int) func(*SearchRequest)
WithSuggestSize - how many suggestions to return in response.
func (f Search) WithSuggestText(v string) func(*SearchRequest)
WithSuggestText - the source text for which the suggestions should be returned.
func (f Search) WithTerminateAfter(v int) func(*SearchRequest)
WithTerminateAfter - the maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early..
func (f Search) WithTimeout(v time.Duration) func(*SearchRequest)
WithTimeout - explicit operation timeout.
func (f Search) WithTrackScores(v bool) func(*SearchRequest)
WithTrackScores - whether to calculate and return scores even if they are not used for sorting.
func (f Search) WithTrackTotalHits(v interface{}) func(*SearchRequest)
WithTrackTotalHits - indicate if the number of documents that match the query should be tracked.
func (f Search) WithTypedKeys(v bool) func(*SearchRequest)
WithTypedKeys - specify whether aggregation and suggester names should be prefixed by their respective types in the response.
func (f Search) WithVersion(v bool) func(*SearchRequest)
WithVersion - specify whether to return document version as part of a hit.
type SearchRequest struct {
Index []string
Body io.Reader
AllowNoIndices *bool
AllowPartialSearchResults *bool
Analyzer string
AnalyzeWildcard *bool
BatchedReduceSize *int
CcsMinimizeRoundtrips *bool
DefaultOperator string
Df string
DocvalueFields []string
ExpandWildcards string
Explain *bool
From *int
IgnoreThrottled *bool
*bool
Lenient *bool
MaxConcurrentShardRequests *int
Preference string
PreFilterShardSize *int
Query string
RequestCache *bool
RestTotalHitsAsInt *bool
Routing []string
Scroll time.Duration
SearchType string
SeqNoPrimaryTerm *bool
Size *int
Sort []string
Source []string
SourceExcludes []string
SourceIncludes []string
Stats []string
StoredFields []string
SuggestField string
SuggestMode string
SuggestSize *int
SuggestText string
TerminateAfter *int
Timeout time.Duration
TrackScores *bool
TrackTotalHits interface{}
TypedKeys *bool
Version *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SearchRequest configures the Search API request.
Do executes the request and returns response or error.
type SearchShards func(o ...func(*SearchShardsRequest)) (*Response, error)
SearchShards returns information about the indices and shards that a search request would be executed against.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html.
func (f SearchShards) WithAllowNoIndices(v bool) func(*SearchShardsRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f SearchShards) WithContext(v context.Context) func(*SearchShardsRequest)
WithContext sets the request context.
func (f SearchShards) WithErrorTrace() func(*SearchShardsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SearchShards) WithExpandWildcards(v string) func(*SearchShardsRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f SearchShards) WithFilterPath(v ...string) func(*SearchShardsRequest)
WithFilterPath filters the properties of the response body.
func (f SearchShards) WithHeader(h map[string]string) func(*SearchShardsRequest)
WithHeader adds the headers to the HTTP request.
func (f SearchShards) WithHuman() func(*SearchShardsRequest)
WithHuman makes statistical values human-readable.
func (f SearchShards) WithIgnoreUnavailable(v bool) func(*SearchShardsRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f SearchShards) WithIndex(v ...string) func(*SearchShardsRequest)
WithIndex - a list of index names to search; use _all to perform the operation on all indices.
func (f SearchShards) WithLocal(v bool) func(*SearchShardsRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f SearchShards) WithPreference(v string) func(*SearchShardsRequest)
WithPreference - specify the node or shard the operation should be performed on (default: random).
func (f SearchShards) WithPretty() func(*SearchShardsRequest)
WithPretty makes the response body pretty-printed.
func (f SearchShards) WithRouting(v string) func(*SearchShardsRequest)
WithRouting - specific routing value.
type SearchShardsRequest struct {
Index []string
AllowNoIndices *bool
ExpandWildcards string
*bool
Local *bool
Preference string
Routing string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SearchShardsRequest configures the Search Shards API request.
Do executes the request and returns response or error.
SearchTemplate allows to use the Mustache language to pre-render a search definition.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html.
func (f SearchTemplate) WithAllowNoIndices(v bool) func(*SearchTemplateRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f SearchTemplate) WithCcsMinimizeRoundtrips(v bool) func(*SearchTemplateRequest)
WithCcsMinimizeRoundtrips - indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.
func (f SearchTemplate) WithContext(v context.Context) func(*SearchTemplateRequest)
WithContext sets the request context.
func (f SearchTemplate) WithErrorTrace() func(*SearchTemplateRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SearchTemplate) WithExpandWildcards(v string) func(*SearchTemplateRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f SearchTemplate) WithExplain(v bool) func(*SearchTemplateRequest)
WithExplain - specify whether to return detailed information about score computation as part of a hit.
func (f SearchTemplate) WithFilterPath(v ...string) func(*SearchTemplateRequest)
WithFilterPath filters the properties of the response body.
func (f SearchTemplate) WithHeader(h map[string]string) func(*SearchTemplateRequest)
WithHeader adds the headers to the HTTP request.
func (f SearchTemplate) WithHuman() func(*SearchTemplateRequest)
WithHuman makes statistical values human-readable.
func (f SearchTemplate) WithIgnoreThrottled(v bool) func(*SearchTemplateRequest)
WithIgnoreThrottled - whether specified concrete, expanded or aliased indices should be ignored when throttled.
func (f SearchTemplate) WithIgnoreUnavailable(v bool) func(*SearchTemplateRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f SearchTemplate) WithIndex(v ...string) func(*SearchTemplateRequest)
WithIndex - a list of index names to search; use _all to perform the operation on all indices.
func (f SearchTemplate) WithPreference(v string) func(*SearchTemplateRequest)
WithPreference - specify the node or shard the operation should be performed on (default: random).
func (f SearchTemplate) WithPretty() func(*SearchTemplateRequest)
WithPretty makes the response body pretty-printed.
func (f SearchTemplate) WithProfile(v bool) func(*SearchTemplateRequest)
WithProfile - specify whether to profile the query execution.
func (f SearchTemplate) WithRestTotalHitsAsInt(v bool) func(*SearchTemplateRequest)
WithRestTotalHitsAsInt - indicates whether hits.total should be rendered as an integer or an object in the rest search response.
func (f SearchTemplate) WithRouting(v ...string) func(*SearchTemplateRequest)
WithRouting - a list of specific routing values.
func (f SearchTemplate) WithScroll(v time.Duration) func(*SearchTemplateRequest)
WithScroll - specify how long a consistent view of the index should be maintained for scrolled search.
func (f SearchTemplate) WithSearchType(v string) func(*SearchTemplateRequest)
WithSearchType - search operation type.
func (f SearchTemplate) WithTypedKeys(v bool) func(*SearchTemplateRequest)
WithTypedKeys - specify whether aggregation and suggester names should be prefixed by their respective types in the response.
type SearchTemplateRequest struct {
Index []string
Body io.Reader
AllowNoIndices *bool
CcsMinimizeRoundtrips *bool
ExpandWildcards string
Explain *bool
IgnoreThrottled *bool
*bool
Preference string
Profile *bool
RestTotalHitsAsInt *bool
Routing []string
Scroll time.Duration
SearchType string
TypedKeys *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SearchTemplateRequest configures the Search Template API request.
Do executes the request and returns response or error.
type Security struct {
Authenticate SecurityAuthenticate
ChangePassword SecurityChangePassword
ClearCachedRealms SecurityClearCachedRealms
ClearCachedRoles SecurityClearCachedRoles
CreateAPIKey SecurityCreateAPIKey
DeletePrivileges SecurityDeletePrivileges
DeleteRoleMapping SecurityDeleteRoleMapping
DeleteRole SecurityDeleteRole
DeleteUser SecurityDeleteUser
DisableUser SecurityDisableUser
EnableUser SecurityEnableUser
GetAPIKey SecurityGetAPIKey
GetBuiltinPrivileges SecurityGetBuiltinPrivileges
GetPrivileges SecurityGetPrivileges
GetRoleMapping SecurityGetRoleMapping
GetRole SecurityGetRole
GetToken SecurityGetToken
GetUserPrivileges SecurityGetUserPrivileges
GetUser SecurityGetUser
HasPrivileges SecurityHasPrivileges
InvalidateAPIKey SecurityInvalidateAPIKey
InvalidateToken SecurityInvalidateToken
PutPrivileges SecurityPutPrivileges
PutRoleMapping SecurityPutRoleMapping
PutRole SecurityPutRole
PutUser SecurityPutUser
}Security contains the Security APIs
type SecurityAuthenticate func(o ...func(*SecurityAuthenticateRequest)) (*Response, error)
SecurityAuthenticate - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html
func (f SecurityAuthenticate) WithContext(v context.Context) func(*SecurityAuthenticateRequest)
WithContext sets the request context.
func (f SecurityAuthenticate) WithErrorTrace() func(*SecurityAuthenticateRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityAuthenticate) WithFilterPath(v ...string) func(*SecurityAuthenticateRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityAuthenticate) WithHeader(h map[string]string) func(*SecurityAuthenticateRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityAuthenticate) WithHuman() func(*SecurityAuthenticateRequest)
WithHuman makes statistical values human-readable.
func (f SecurityAuthenticate) WithPretty() func(*SecurityAuthenticateRequest)
WithPretty makes the response body pretty-printed.
type SecurityAuthenticateRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityAuthenticateRequest configures the Security Authenticate API request.
func (r SecurityAuthenticateRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SecurityChangePassword func(body io.Reader, o ...func(*SecurityChangePasswordRequest)) (*Response, error)
SecurityChangePassword - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html
func (f SecurityChangePassword) WithContext(v context.Context) func(*SecurityChangePasswordRequest)
WithContext sets the request context.
func (f SecurityChangePassword) WithErrorTrace() func(*SecurityChangePasswordRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityChangePassword) WithFilterPath(v ...string) func(*SecurityChangePasswordRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityChangePassword) WithHeader(h map[string]string) func(*SecurityChangePasswordRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityChangePassword) WithHuman() func(*SecurityChangePasswordRequest)
WithHuman makes statistical values human-readable.
func (f SecurityChangePassword) WithPretty() func(*SecurityChangePasswordRequest)
WithPretty makes the response body pretty-printed.
func (f SecurityChangePassword) WithRefresh(v string) func(*SecurityChangePasswordRequest)
WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..
func (f SecurityChangePassword) WithUsername(v string) func(*SecurityChangePasswordRequest)
WithUsername - the username of the user to change the password for.
type SecurityChangePasswordRequest struct {
Body io.Reader
Username string
Refresh string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityChangePasswordRequest configures the Security Change Password API request.
func (r SecurityChangePasswordRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SecurityClearCachedRealms func(realms []string, o ...func(*SecurityClearCachedRealmsRequest)) (*Response, error)
SecurityClearCachedRealms - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html
func (f SecurityClearCachedRealms) WithContext(v context.Context) func(*SecurityClearCachedRealmsRequest)
WithContext sets the request context.
func (f SecurityClearCachedRealms) WithErrorTrace() func(*SecurityClearCachedRealmsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityClearCachedRealms) WithFilterPath(v ...string) func(*SecurityClearCachedRealmsRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityClearCachedRealms) WithHeader(h map[string]string) func(*SecurityClearCachedRealmsRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityClearCachedRealms) WithHuman() func(*SecurityClearCachedRealmsRequest)
WithHuman makes statistical values human-readable.
func (f SecurityClearCachedRealms) WithPretty() func(*SecurityClearCachedRealmsRequest)
WithPretty makes the response body pretty-printed.
func (f SecurityClearCachedRealms) WithUsernames(v ...string) func(*SecurityClearCachedRealmsRequest)
WithUsernames - comma-separated list of usernames to clear from the cache.
type SecurityClearCachedRealmsRequest struct {
Realms []string
Usernames []string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityClearCachedRealmsRequest configures the Security Clear Cached Realms API request.
func (r SecurityClearCachedRealmsRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SecurityClearCachedRoles func(name []string, o ...func(*SecurityClearCachedRolesRequest)) (*Response, error)
SecurityClearCachedRoles - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html
func (f SecurityClearCachedRoles) WithContext(v context.Context) func(*SecurityClearCachedRolesRequest)
WithContext sets the request context.
func (f SecurityClearCachedRoles) WithErrorTrace() func(*SecurityClearCachedRolesRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityClearCachedRoles) WithFilterPath(v ...string) func(*SecurityClearCachedRolesRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityClearCachedRoles) WithHeader(h map[string]string) func(*SecurityClearCachedRolesRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityClearCachedRoles) WithHuman() func(*SecurityClearCachedRolesRequest)
WithHuman makes statistical values human-readable.
func (f SecurityClearCachedRoles) WithPretty() func(*SecurityClearCachedRolesRequest)
WithPretty makes the response body pretty-printed.
type SecurityClearCachedRolesRequest struct {
Name []string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityClearCachedRolesRequest configures the Security Clear Cached Roles API request.
func (r SecurityClearCachedRolesRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SecurityCreateAPIKey func(body io.Reader, o ...func(*SecurityCreateAPIKeyRequest)) (*Response, error)
SecurityCreateAPIKey - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html
func (f SecurityCreateAPIKey) WithContext(v context.Context) func(*SecurityCreateAPIKeyRequest)
WithContext sets the request context.
func (f SecurityCreateAPIKey) WithErrorTrace() func(*SecurityCreateAPIKeyRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityCreateAPIKey) WithFilterPath(v ...string) func(*SecurityCreateAPIKeyRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityCreateAPIKey) WithHeader(h map[string]string) func(*SecurityCreateAPIKeyRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityCreateAPIKey) WithHuman() func(*SecurityCreateAPIKeyRequest)
WithHuman makes statistical values human-readable.
func (f SecurityCreateAPIKey) WithPretty() func(*SecurityCreateAPIKeyRequest)
WithPretty makes the response body pretty-printed.
func (f SecurityCreateAPIKey) WithRefresh(v string) func(*SecurityCreateAPIKeyRequest)
WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..
type SecurityCreateAPIKeyRequest struct {
Body io.Reader
Refresh string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityCreateAPIKeyRequest configures the Security CreateAPI Key API request.
func (r SecurityCreateAPIKeyRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SecurityDeletePrivileges func(name string, application string, o ...func(*SecurityDeletePrivilegesRequest)) (*Response, error)
SecurityDeletePrivileges - TODO
func (f SecurityDeletePrivileges) WithContext(v context.Context) func(*SecurityDeletePrivilegesRequest)
WithContext sets the request context.
func (f SecurityDeletePrivileges) WithErrorTrace() func(*SecurityDeletePrivilegesRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityDeletePrivileges) WithFilterPath(v ...string) func(*SecurityDeletePrivilegesRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityDeletePrivileges) WithHeader(h map[string]string) func(*SecurityDeletePrivilegesRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityDeletePrivileges) WithHuman() func(*SecurityDeletePrivilegesRequest)
WithHuman makes statistical values human-readable.
func (f SecurityDeletePrivileges) WithPretty() func(*SecurityDeletePrivilegesRequest)
WithPretty makes the response body pretty-printed.
func (f SecurityDeletePrivileges) WithRefresh(v string) func(*SecurityDeletePrivilegesRequest)
WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..
type SecurityDeletePrivilegesRequest struct {
Application string
Name string
Refresh string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityDeletePrivilegesRequest configures the Security Delete Privileges API request.
func (r SecurityDeletePrivilegesRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SecurityDeleteRole func(name string, o ...func(*SecurityDeleteRoleRequest)) (*Response, error)
SecurityDeleteRole - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html
func (f SecurityDeleteRole) WithContext(v context.Context) func(*SecurityDeleteRoleRequest)
WithContext sets the request context.
func (f SecurityDeleteRole) WithErrorTrace() func(*SecurityDeleteRoleRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityDeleteRole) WithFilterPath(v ...string) func(*SecurityDeleteRoleRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityDeleteRole) WithHeader(h map[string]string) func(*SecurityDeleteRoleRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityDeleteRole) WithHuman() func(*SecurityDeleteRoleRequest)
WithHuman makes statistical values human-readable.
func (f SecurityDeleteRole) WithPretty() func(*SecurityDeleteRoleRequest)
WithPretty makes the response body pretty-printed.
func (f SecurityDeleteRole) WithRefresh(v string) func(*SecurityDeleteRoleRequest)
WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..
type SecurityDeleteRoleMapping func(name string, o ...func(*SecurityDeleteRoleMappingRequest)) (*Response, error)
SecurityDeleteRoleMapping - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html
func (f SecurityDeleteRoleMapping) WithContext(v context.Context) func(*SecurityDeleteRoleMappingRequest)
WithContext sets the request context.
func (f SecurityDeleteRoleMapping) WithErrorTrace() func(*SecurityDeleteRoleMappingRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityDeleteRoleMapping) WithFilterPath(v ...string) func(*SecurityDeleteRoleMappingRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityDeleteRoleMapping) WithHeader(h map[string]string) func(*SecurityDeleteRoleMappingRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityDeleteRoleMapping) WithHuman() func(*SecurityDeleteRoleMappingRequest)
WithHuman makes statistical values human-readable.
func (f SecurityDeleteRoleMapping) WithPretty() func(*SecurityDeleteRoleMappingRequest)
WithPretty makes the response body pretty-printed.
func (f SecurityDeleteRoleMapping) WithRefresh(v string) func(*SecurityDeleteRoleMappingRequest)
WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..
type SecurityDeleteRoleMappingRequest struct {
Name string
Refresh string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityDeleteRoleMappingRequest configures the Security Delete Role Mapping API request.
func (r SecurityDeleteRoleMappingRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SecurityDeleteRoleRequest struct {
Name string
Refresh string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityDeleteRoleRequest configures the Security Delete Role API request.
Do executes the request and returns response or error.
type SecurityDeleteUser func(username string, o ...func(*SecurityDeleteUserRequest)) (*Response, error)
SecurityDeleteUser - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html
func (f SecurityDeleteUser) WithContext(v context.Context) func(*SecurityDeleteUserRequest)
WithContext sets the request context.
func (f SecurityDeleteUser) WithErrorTrace() func(*SecurityDeleteUserRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityDeleteUser) WithFilterPath(v ...string) func(*SecurityDeleteUserRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityDeleteUser) WithHeader(h map[string]string) func(*SecurityDeleteUserRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityDeleteUser) WithHuman() func(*SecurityDeleteUserRequest)
WithHuman makes statistical values human-readable.
func (f SecurityDeleteUser) WithPretty() func(*SecurityDeleteUserRequest)
WithPretty makes the response body pretty-printed.
func (f SecurityDeleteUser) WithRefresh(v string) func(*SecurityDeleteUserRequest)
WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..
type SecurityDeleteUserRequest struct {
Username string
Refresh string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityDeleteUserRequest configures the Security Delete User API request.
Do executes the request and returns response or error.
type SecurityDisableUser func(username string, o ...func(*SecurityDisableUserRequest)) (*Response, error)
SecurityDisableUser - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html
func (f SecurityDisableUser) WithContext(v context.Context) func(*SecurityDisableUserRequest)
WithContext sets the request context.
func (f SecurityDisableUser) WithErrorTrace() func(*SecurityDisableUserRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityDisableUser) WithFilterPath(v ...string) func(*SecurityDisableUserRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityDisableUser) WithHeader(h map[string]string) func(*SecurityDisableUserRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityDisableUser) WithHuman() func(*SecurityDisableUserRequest)
WithHuman makes statistical values human-readable.
func (f SecurityDisableUser) WithPretty() func(*SecurityDisableUserRequest)
WithPretty makes the response body pretty-printed.
func (f SecurityDisableUser) WithRefresh(v string) func(*SecurityDisableUserRequest)
WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..
type SecurityDisableUserRequest struct {
Username string
Refresh string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityDisableUserRequest configures the Security Disable User API request.
func (r SecurityDisableUserRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SecurityEnableUser func(username string, o ...func(*SecurityEnableUserRequest)) (*Response, error)
SecurityEnableUser - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html
func (f SecurityEnableUser) WithContext(v context.Context) func(*SecurityEnableUserRequest)
WithContext sets the request context.
func (f SecurityEnableUser) WithErrorTrace() func(*SecurityEnableUserRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityEnableUser) WithFilterPath(v ...string) func(*SecurityEnableUserRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityEnableUser) WithHeader(h map[string]string) func(*SecurityEnableUserRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityEnableUser) WithHuman() func(*SecurityEnableUserRequest)
WithHuman makes statistical values human-readable.
func (f SecurityEnableUser) WithPretty() func(*SecurityEnableUserRequest)
WithPretty makes the response body pretty-printed.
func (f SecurityEnableUser) WithRefresh(v string) func(*SecurityEnableUserRequest)
WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..
type SecurityEnableUserRequest struct {
Username string
Refresh string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityEnableUserRequest configures the Security Enable User API request.
Do executes the request and returns response or error.
type SecurityGetAPIKey func(o ...func(*SecurityGetAPIKeyRequest)) (*Response, error)
SecurityGetAPIKey - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html
func (f SecurityGetAPIKey) WithContext(v context.Context) func(*SecurityGetAPIKeyRequest)
WithContext sets the request context.
func (f SecurityGetAPIKey) WithErrorTrace() func(*SecurityGetAPIKeyRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityGetAPIKey) WithFilterPath(v ...string) func(*SecurityGetAPIKeyRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityGetAPIKey) WithHeader(h map[string]string) func(*SecurityGetAPIKeyRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityGetAPIKey) WithHuman() func(*SecurityGetAPIKeyRequest)
WithHuman makes statistical values human-readable.
func (f SecurityGetAPIKey) WithID(v string) func(*SecurityGetAPIKeyRequest)
WithID - api key ID of the api key to be retrieved.
func (f SecurityGetAPIKey) WithName(v string) func(*SecurityGetAPIKeyRequest)
WithName - api key name of the api key to be retrieved.
func (f SecurityGetAPIKey) WithPretty() func(*SecurityGetAPIKeyRequest)
WithPretty makes the response body pretty-printed.
func (f SecurityGetAPIKey) WithRealmName(v string) func(*SecurityGetAPIKeyRequest)
WithRealmName - realm name of the user who created this api key to be retrieved.
func (f SecurityGetAPIKey) WithUsername(v string) func(*SecurityGetAPIKeyRequest)
WithUsername - user name of the user who created this api key to be retrieved.
type SecurityGetAPIKeyRequest struct {
ID string
Name string
RealmName string
Username string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityGetAPIKeyRequest configures the Security GetAPI Key API request.
Do executes the request and returns response or error.
type SecurityGetBuiltinPrivileges func(o ...func(*SecurityGetBuiltinPrivilegesRequest)) (*Response, error)
SecurityGetBuiltinPrivileges - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html
func (f SecurityGetBuiltinPrivileges) WithContext(v context.Context) func(*SecurityGetBuiltinPrivilegesRequest)
WithContext sets the request context.
func (f SecurityGetBuiltinPrivileges) WithErrorTrace() func(*SecurityGetBuiltinPrivilegesRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityGetBuiltinPrivileges) WithFilterPath(v ...string) func(*SecurityGetBuiltinPrivilegesRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityGetBuiltinPrivileges) WithHeader(h map[string]string) func(*SecurityGetBuiltinPrivilegesRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityGetBuiltinPrivileges) WithHuman() func(*SecurityGetBuiltinPrivilegesRequest)
WithHuman makes statistical values human-readable.
func (f SecurityGetBuiltinPrivileges) WithPretty() func(*SecurityGetBuiltinPrivilegesRequest)
WithPretty makes the response body pretty-printed.
type SecurityGetBuiltinPrivilegesRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityGetBuiltinPrivilegesRequest configures the Security Get Builtin Privileges API request.
func (r SecurityGetBuiltinPrivilegesRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SecurityGetPrivileges func(o ...func(*SecurityGetPrivilegesRequest)) (*Response, error)
SecurityGetPrivileges - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html
func (f SecurityGetPrivileges) WithApplication(v string) func(*SecurityGetPrivilegesRequest)
WithApplication - application name.
func (f SecurityGetPrivileges) WithContext(v context.Context) func(*SecurityGetPrivilegesRequest)
WithContext sets the request context.
func (f SecurityGetPrivileges) WithErrorTrace() func(*SecurityGetPrivilegesRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityGetPrivileges) WithFilterPath(v ...string) func(*SecurityGetPrivilegesRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityGetPrivileges) WithHeader(h map[string]string) func(*SecurityGetPrivilegesRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityGetPrivileges) WithHuman() func(*SecurityGetPrivilegesRequest)
WithHuman makes statistical values human-readable.
func (f SecurityGetPrivileges) WithName(v string) func(*SecurityGetPrivilegesRequest)
WithName - privilege name.
func (f SecurityGetPrivileges) WithPretty() func(*SecurityGetPrivilegesRequest)
WithPretty makes the response body pretty-printed.
type SecurityGetPrivilegesRequest struct {
Application string
Name string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityGetPrivilegesRequest configures the Security Get Privileges API request.
func (r SecurityGetPrivilegesRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SecurityGetRole func(o ...func(*SecurityGetRoleRequest)) (*Response, error)
SecurityGetRole - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html
func (f SecurityGetRole) WithContext(v context.Context) func(*SecurityGetRoleRequest)
WithContext sets the request context.
func (f SecurityGetRole) WithErrorTrace() func(*SecurityGetRoleRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityGetRole) WithFilterPath(v ...string) func(*SecurityGetRoleRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityGetRole) WithHeader(h map[string]string) func(*SecurityGetRoleRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityGetRole) WithHuman() func(*SecurityGetRoleRequest)
WithHuman makes statistical values human-readable.
func (f SecurityGetRole) WithName(v string) func(*SecurityGetRoleRequest)
WithName - role name.
func (f SecurityGetRole) WithPretty() func(*SecurityGetRoleRequest)
WithPretty makes the response body pretty-printed.
type SecurityGetRoleMapping func(o ...func(*SecurityGetRoleMappingRequest)) (*Response, error)
SecurityGetRoleMapping - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html
func (f SecurityGetRoleMapping) WithContext(v context.Context) func(*SecurityGetRoleMappingRequest)
WithContext sets the request context.
func (f SecurityGetRoleMapping) WithErrorTrace() func(*SecurityGetRoleMappingRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityGetRoleMapping) WithFilterPath(v ...string) func(*SecurityGetRoleMappingRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityGetRoleMapping) WithHeader(h map[string]string) func(*SecurityGetRoleMappingRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityGetRoleMapping) WithHuman() func(*SecurityGetRoleMappingRequest)
WithHuman makes statistical values human-readable.
func (f SecurityGetRoleMapping) WithName(v string) func(*SecurityGetRoleMappingRequest)
WithName - role-mapping name.
func (f SecurityGetRoleMapping) WithPretty() func(*SecurityGetRoleMappingRequest)
WithPretty makes the response body pretty-printed.
type SecurityGetRoleMappingRequest struct {
Name string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityGetRoleMappingRequest configures the Security Get Role Mapping API request.
func (r SecurityGetRoleMappingRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SecurityGetRoleRequest struct {
Name string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityGetRoleRequest configures the Security Get Role API request.
Do executes the request and returns response or error.
SecurityGetToken - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html
func (f SecurityGetToken) WithContext(v context.Context) func(*SecurityGetTokenRequest)
WithContext sets the request context.
func (f SecurityGetToken) WithErrorTrace() func(*SecurityGetTokenRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityGetToken) WithFilterPath(v ...string) func(*SecurityGetTokenRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityGetToken) WithHeader(h map[string]string) func(*SecurityGetTokenRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityGetToken) WithHuman() func(*SecurityGetTokenRequest)
WithHuman makes statistical values human-readable.
func (f SecurityGetToken) WithPretty() func(*SecurityGetTokenRequest)
WithPretty makes the response body pretty-printed.
type SecurityGetTokenRequest struct {
Body io.Reader
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityGetTokenRequest configures the Security Get Token API request.
Do executes the request and returns response or error.
type SecurityGetUser func(o ...func(*SecurityGetUserRequest)) (*Response, error)
SecurityGetUser - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html
func (f SecurityGetUser) WithContext(v context.Context) func(*SecurityGetUserRequest)
WithContext sets the request context.
func (f SecurityGetUser) WithErrorTrace() func(*SecurityGetUserRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityGetUser) WithFilterPath(v ...string) func(*SecurityGetUserRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityGetUser) WithHeader(h map[string]string) func(*SecurityGetUserRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityGetUser) WithHuman() func(*SecurityGetUserRequest)
WithHuman makes statistical values human-readable.
func (f SecurityGetUser) WithPretty() func(*SecurityGetUserRequest)
WithPretty makes the response body pretty-printed.
func (f SecurityGetUser) WithUsername(v ...string) func(*SecurityGetUserRequest)
WithUsername - a list of usernames.
type SecurityGetUserPrivileges func(o ...func(*SecurityGetUserPrivilegesRequest)) (*Response, error)
SecurityGetUserPrivileges - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html
func (f SecurityGetUserPrivileges) WithContext(v context.Context) func(*SecurityGetUserPrivilegesRequest)
WithContext sets the request context.
func (f SecurityGetUserPrivileges) WithErrorTrace() func(*SecurityGetUserPrivilegesRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityGetUserPrivileges) WithFilterPath(v ...string) func(*SecurityGetUserPrivilegesRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityGetUserPrivileges) WithHeader(h map[string]string) func(*SecurityGetUserPrivilegesRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityGetUserPrivileges) WithHuman() func(*SecurityGetUserPrivilegesRequest)
WithHuman makes statistical values human-readable.
func (f SecurityGetUserPrivileges) WithPretty() func(*SecurityGetUserPrivilegesRequest)
WithPretty makes the response body pretty-printed.
type SecurityGetUserPrivilegesRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityGetUserPrivilegesRequest configures the Security Get User Privileges API request.
func (r SecurityGetUserPrivilegesRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SecurityGetUserRequest struct {
Username []string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityGetUserRequest configures the Security Get User API request.
Do executes the request and returns response or error.
type SecurityHasPrivileges func(body io.Reader, o ...func(*SecurityHasPrivilegesRequest)) (*Response, error)
SecurityHasPrivileges - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html
func (f SecurityHasPrivileges) WithContext(v context.Context) func(*SecurityHasPrivilegesRequest)
WithContext sets the request context.
func (f SecurityHasPrivileges) WithErrorTrace() func(*SecurityHasPrivilegesRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityHasPrivileges) WithFilterPath(v ...string) func(*SecurityHasPrivilegesRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityHasPrivileges) WithHeader(h map[string]string) func(*SecurityHasPrivilegesRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityHasPrivileges) WithHuman() func(*SecurityHasPrivilegesRequest)
WithHuman makes statistical values human-readable.
func (f SecurityHasPrivileges) WithPretty() func(*SecurityHasPrivilegesRequest)
WithPretty makes the response body pretty-printed.
func (f SecurityHasPrivileges) WithUser(v string) func(*SecurityHasPrivilegesRequest)
WithUser - username.
type SecurityHasPrivilegesRequest struct {
Body io.Reader
User string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityHasPrivilegesRequest configures the Security Has Privileges API request.
func (r SecurityHasPrivilegesRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SecurityInvalidateAPIKey func(body io.Reader, o ...func(*SecurityInvalidateAPIKeyRequest)) (*Response, error)
SecurityInvalidateAPIKey - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html
func (f SecurityInvalidateAPIKey) WithContext(v context.Context) func(*SecurityInvalidateAPIKeyRequest)
WithContext sets the request context.
func (f SecurityInvalidateAPIKey) WithErrorTrace() func(*SecurityInvalidateAPIKeyRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityInvalidateAPIKey) WithFilterPath(v ...string) func(*SecurityInvalidateAPIKeyRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityInvalidateAPIKey) WithHeader(h map[string]string) func(*SecurityInvalidateAPIKeyRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityInvalidateAPIKey) WithHuman() func(*SecurityInvalidateAPIKeyRequest)
WithHuman makes statistical values human-readable.
func (f SecurityInvalidateAPIKey) WithPretty() func(*SecurityInvalidateAPIKeyRequest)
WithPretty makes the response body pretty-printed.
type SecurityInvalidateAPIKeyRequest struct {
Body io.Reader
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityInvalidateAPIKeyRequest configures the Security InvalidateAPI Key API request.
func (r SecurityInvalidateAPIKeyRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SecurityInvalidateToken func(body io.Reader, o ...func(*SecurityInvalidateTokenRequest)) (*Response, error)
SecurityInvalidateToken - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html
func (f SecurityInvalidateToken) WithContext(v context.Context) func(*SecurityInvalidateTokenRequest)
WithContext sets the request context.
func (f SecurityInvalidateToken) WithErrorTrace() func(*SecurityInvalidateTokenRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityInvalidateToken) WithFilterPath(v ...string) func(*SecurityInvalidateTokenRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityInvalidateToken) WithHeader(h map[string]string) func(*SecurityInvalidateTokenRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityInvalidateToken) WithHuman() func(*SecurityInvalidateTokenRequest)
WithHuman makes statistical values human-readable.
func (f SecurityInvalidateToken) WithPretty() func(*SecurityInvalidateTokenRequest)
WithPretty makes the response body pretty-printed.
type SecurityInvalidateTokenRequest struct {
Body io.Reader
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityInvalidateTokenRequest configures the Security Invalidate Token API request.
func (r SecurityInvalidateTokenRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SecurityPutPrivileges func(body io.Reader, o ...func(*SecurityPutPrivilegesRequest)) (*Response, error)
SecurityPutPrivileges - TODO
func (f SecurityPutPrivileges) WithContext(v context.Context) func(*SecurityPutPrivilegesRequest)
WithContext sets the request context.
func (f SecurityPutPrivileges) WithErrorTrace() func(*SecurityPutPrivilegesRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityPutPrivileges) WithFilterPath(v ...string) func(*SecurityPutPrivilegesRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityPutPrivileges) WithHeader(h map[string]string) func(*SecurityPutPrivilegesRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityPutPrivileges) WithHuman() func(*SecurityPutPrivilegesRequest)
WithHuman makes statistical values human-readable.
func (f SecurityPutPrivileges) WithPretty() func(*SecurityPutPrivilegesRequest)
WithPretty makes the response body pretty-printed.
func (f SecurityPutPrivileges) WithRefresh(v string) func(*SecurityPutPrivilegesRequest)
WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..
type SecurityPutPrivilegesRequest struct {
Body io.Reader
Refresh string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityPutPrivilegesRequest configures the Security Put Privileges API request.
func (r SecurityPutPrivilegesRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SecurityPutRole func(name string, body io.Reader, o ...func(*SecurityPutRoleRequest)) (*Response, error)
SecurityPutRole - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html
func (f SecurityPutRole) WithContext(v context.Context) func(*SecurityPutRoleRequest)
WithContext sets the request context.
func (f SecurityPutRole) WithErrorTrace() func(*SecurityPutRoleRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityPutRole) WithFilterPath(v ...string) func(*SecurityPutRoleRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityPutRole) WithHeader(h map[string]string) func(*SecurityPutRoleRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityPutRole) WithHuman() func(*SecurityPutRoleRequest)
WithHuman makes statistical values human-readable.
func (f SecurityPutRole) WithPretty() func(*SecurityPutRoleRequest)
WithPretty makes the response body pretty-printed.
func (f SecurityPutRole) WithRefresh(v string) func(*SecurityPutRoleRequest)
WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..
type SecurityPutRoleMapping func(name string, body io.Reader, o ...func(*SecurityPutRoleMappingRequest)) (*Response, error)
SecurityPutRoleMapping - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html
func (f SecurityPutRoleMapping) WithContext(v context.Context) func(*SecurityPutRoleMappingRequest)
WithContext sets the request context.
func (f SecurityPutRoleMapping) WithErrorTrace() func(*SecurityPutRoleMappingRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityPutRoleMapping) WithFilterPath(v ...string) func(*SecurityPutRoleMappingRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityPutRoleMapping) WithHeader(h map[string]string) func(*SecurityPutRoleMappingRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityPutRoleMapping) WithHuman() func(*SecurityPutRoleMappingRequest)
WithHuman makes statistical values human-readable.
func (f SecurityPutRoleMapping) WithPretty() func(*SecurityPutRoleMappingRequest)
WithPretty makes the response body pretty-printed.
func (f SecurityPutRoleMapping) WithRefresh(v string) func(*SecurityPutRoleMappingRequest)
WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..
type SecurityPutRoleMappingRequest struct {
Body io.Reader
Name string
Refresh string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityPutRoleMappingRequest configures the Security Put Role Mapping API request.
func (r SecurityPutRoleMappingRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SecurityPutRoleRequest struct {
Body io.Reader
Name string
Refresh string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityPutRoleRequest configures the Security Put Role API request.
Do executes the request and returns response or error.
type SecurityPutUser func(username string, body io.Reader, o ...func(*SecurityPutUserRequest)) (*Response, error)
SecurityPutUser - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html
func (f SecurityPutUser) WithContext(v context.Context) func(*SecurityPutUserRequest)
WithContext sets the request context.
func (f SecurityPutUser) WithErrorTrace() func(*SecurityPutUserRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SecurityPutUser) WithFilterPath(v ...string) func(*SecurityPutUserRequest)
WithFilterPath filters the properties of the response body.
func (f SecurityPutUser) WithHeader(h map[string]string) func(*SecurityPutUserRequest)
WithHeader adds the headers to the HTTP request.
func (f SecurityPutUser) WithHuman() func(*SecurityPutUserRequest)
WithHuman makes statistical values human-readable.
func (f SecurityPutUser) WithPretty() func(*SecurityPutUserRequest)
WithPretty makes the response body pretty-printed.
func (f SecurityPutUser) WithRefresh(v string) func(*SecurityPutUserRequest)
WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..
type SecurityPutUserRequest struct {
Body io.Reader
Username string
Refresh string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SecurityPutUserRequest configures the Security Put User API request.
Do executes the request and returns response or error.
type SlmDeleteLifecycle func(o ...func(*SlmDeleteLifecycleRequest)) (*Response, error)
SlmDeleteLifecycle - https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api.html
func (f SlmDeleteLifecycle) WithContext(v context.Context) func(*SlmDeleteLifecycleRequest)
WithContext sets the request context.
func (f SlmDeleteLifecycle) WithErrorTrace() func(*SlmDeleteLifecycleRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SlmDeleteLifecycle) WithFilterPath(v ...string) func(*SlmDeleteLifecycleRequest)
WithFilterPath filters the properties of the response body.
func (f SlmDeleteLifecycle) WithHeader(h map[string]string) func(*SlmDeleteLifecycleRequest)
WithHeader adds the headers to the HTTP request.
func (f SlmDeleteLifecycle) WithHuman() func(*SlmDeleteLifecycleRequest)
WithHuman makes statistical values human-readable.
func (f SlmDeleteLifecycle) WithPolicy(v string) func(*SlmDeleteLifecycleRequest)
WithPolicy - the ID of the snapshot lifecycle policy to remove.
func (f SlmDeleteLifecycle) WithPretty() func(*SlmDeleteLifecycleRequest)
WithPretty makes the response body pretty-printed.
type SlmDeleteLifecycleRequest struct {
Policy string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SlmDeleteLifecycleRequest configures the Slm Delete Lifecycle API request.
Do executes the request and returns response or error.
type SlmExecuteLifecycle func(o ...func(*SlmExecuteLifecycleRequest)) (*Response, error)
SlmExecuteLifecycle - https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api.html
func (f SlmExecuteLifecycle) WithContext(v context.Context) func(*SlmExecuteLifecycleRequest)
WithContext sets the request context.
func (f SlmExecuteLifecycle) WithErrorTrace() func(*SlmExecuteLifecycleRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SlmExecuteLifecycle) WithFilterPath(v ...string) func(*SlmExecuteLifecycleRequest)
WithFilterPath filters the properties of the response body.
func (f SlmExecuteLifecycle) WithHeader(h map[string]string) func(*SlmExecuteLifecycleRequest)
WithHeader adds the headers to the HTTP request.
func (f SlmExecuteLifecycle) WithHuman() func(*SlmExecuteLifecycleRequest)
WithHuman makes statistical values human-readable.
func (f SlmExecuteLifecycle) WithPolicyID(v string) func(*SlmExecuteLifecycleRequest)
WithPolicyID - the ID of the snapshot lifecycle policy to be executed.
func (f SlmExecuteLifecycle) WithPretty() func(*SlmExecuteLifecycleRequest)
WithPretty makes the response body pretty-printed.
type SlmExecuteLifecycleRequest struct {
PolicyID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SlmExecuteLifecycleRequest configures the Slm Execute Lifecycle API request.
func (r SlmExecuteLifecycleRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SlmGetLifecycle func(o ...func(*SlmGetLifecycleRequest)) (*Response, error)
SlmGetLifecycle - https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api.html
func (f SlmGetLifecycle) WithContext(v context.Context) func(*SlmGetLifecycleRequest)
WithContext sets the request context.
func (f SlmGetLifecycle) WithErrorTrace() func(*SlmGetLifecycleRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SlmGetLifecycle) WithFilterPath(v ...string) func(*SlmGetLifecycleRequest)
WithFilterPath filters the properties of the response body.
func (f SlmGetLifecycle) WithHeader(h map[string]string) func(*SlmGetLifecycleRequest)
WithHeader adds the headers to the HTTP request.
func (f SlmGetLifecycle) WithHuman() func(*SlmGetLifecycleRequest)
WithHuman makes statistical values human-readable.
func (f SlmGetLifecycle) WithPolicyID(v string) func(*SlmGetLifecycleRequest)
WithPolicyID - comma-separated list of snapshot lifecycle policies to retrieve.
func (f SlmGetLifecycle) WithPretty() func(*SlmGetLifecycleRequest)
WithPretty makes the response body pretty-printed.
type SlmGetLifecycleRequest struct {
PolicyID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SlmGetLifecycleRequest configures the Slm Get Lifecycle API request.
Do executes the request and returns response or error.
type SlmPutLifecycle func(o ...func(*SlmPutLifecycleRequest)) (*Response, error)
SlmPutLifecycle - https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api.html
func (f SlmPutLifecycle) WithBody(v io.Reader) func(*SlmPutLifecycleRequest)
WithBody - The snapshot lifecycle policy definition to register.
func (f SlmPutLifecycle) WithContext(v context.Context) func(*SlmPutLifecycleRequest)
WithContext sets the request context.
func (f SlmPutLifecycle) WithErrorTrace() func(*SlmPutLifecycleRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SlmPutLifecycle) WithFilterPath(v ...string) func(*SlmPutLifecycleRequest)
WithFilterPath filters the properties of the response body.
func (f SlmPutLifecycle) WithHeader(h map[string]string) func(*SlmPutLifecycleRequest)
WithHeader adds the headers to the HTTP request.
func (f SlmPutLifecycle) WithHuman() func(*SlmPutLifecycleRequest)
WithHuman makes statistical values human-readable.
func (f SlmPutLifecycle) WithPolicyID(v string) func(*SlmPutLifecycleRequest)
WithPolicyID - the ID of the snapshot lifecycle policy.
func (f SlmPutLifecycle) WithPretty() func(*SlmPutLifecycleRequest)
WithPretty makes the response body pretty-printed.
type SlmPutLifecycleRequest struct {
Body io.Reader
PolicyID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SlmPutLifecycleRequest configures the Slm Put Lifecycle API request.
Do executes the request and returns response or error.
type Snapshot struct {
CreateRepository SnapshotCreateRepository
Create SnapshotCreate
DeleteRepository SnapshotDeleteRepository
Delete SnapshotDelete
GetRepository SnapshotGetRepository
Get SnapshotGet
Restore SnapshotRestore
Status SnapshotStatus
VerifyRepository SnapshotVerifyRepository
}Snapshot contains the Snapshot APIs
type SnapshotCreate func(repository string, snapshot string, o ...func(*SnapshotCreateRequest)) (*Response, error)
SnapshotCreate creates a snapshot in a repository.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.
func (f SnapshotCreate) WithBody(v io.Reader) func(*SnapshotCreateRequest)
WithBody - The snapshot definition.
func (f SnapshotCreate) WithContext(v context.Context) func(*SnapshotCreateRequest)
WithContext sets the request context.
func (f SnapshotCreate) WithErrorTrace() func(*SnapshotCreateRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SnapshotCreate) WithFilterPath(v ...string) func(*SnapshotCreateRequest)
WithFilterPath filters the properties of the response body.
func (f SnapshotCreate) WithHeader(h map[string]string) func(*SnapshotCreateRequest)
WithHeader adds the headers to the HTTP request.
func (f SnapshotCreate) WithHuman() func(*SnapshotCreateRequest)
WithHuman makes statistical values human-readable.
func (f SnapshotCreate) WithMasterTimeout(v time.Duration) func(*SnapshotCreateRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f SnapshotCreate) WithPretty() func(*SnapshotCreateRequest)
WithPretty makes the response body pretty-printed.
func (f SnapshotCreate) WithWaitForCompletion(v bool) func(*SnapshotCreateRequest)
WithWaitForCompletion - should this request wait until the operation has completed before returning.
type SnapshotCreateRepository func(repository string, body io.Reader, o ...func(*SnapshotCreateRepositoryRequest)) (*Response, error)
SnapshotCreateRepository creates a repository.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.
func (f SnapshotCreateRepository) WithContext(v context.Context) func(*SnapshotCreateRepositoryRequest)
WithContext sets the request context.
func (f SnapshotCreateRepository) WithErrorTrace() func(*SnapshotCreateRepositoryRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SnapshotCreateRepository) WithFilterPath(v ...string) func(*SnapshotCreateRepositoryRequest)
WithFilterPath filters the properties of the response body.
func (f SnapshotCreateRepository) WithHeader(h map[string]string) func(*SnapshotCreateRepositoryRequest)
WithHeader adds the headers to the HTTP request.
func (f SnapshotCreateRepository) WithHuman() func(*SnapshotCreateRepositoryRequest)
WithHuman makes statistical values human-readable.
func (f SnapshotCreateRepository) WithMasterTimeout(v time.Duration) func(*SnapshotCreateRepositoryRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f SnapshotCreateRepository) WithPretty() func(*SnapshotCreateRepositoryRequest)
WithPretty makes the response body pretty-printed.
func (f SnapshotCreateRepository) WithTimeout(v time.Duration) func(*SnapshotCreateRepositoryRequest)
WithTimeout - explicit operation timeout.
func (f SnapshotCreateRepository) WithVerify(v bool) func(*SnapshotCreateRepositoryRequest)
WithVerify - whether to verify the repository after creation.
type SnapshotCreateRepositoryRequest struct {
Body io.Reader
Repository string
MasterTimeout time.Duration
Timeout time.Duration
Verify *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SnapshotCreateRepositoryRequest configures the Snapshot Create Repository API request.
func (r SnapshotCreateRepositoryRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SnapshotCreateRequest struct {
Body io.Reader
Repository string
Snapshot string
MasterTimeout time.Duration
WaitForCompletion *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SnapshotCreateRequest configures the Snapshot Create API request.
Do executes the request and returns response or error.
type SnapshotDelete func(repository string, snapshot string, o ...func(*SnapshotDeleteRequest)) (*Response, error)
SnapshotDelete deletes a snapshot.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.
func (f SnapshotDelete) WithContext(v context.Context) func(*SnapshotDeleteRequest)
WithContext sets the request context.
func (f SnapshotDelete) WithErrorTrace() func(*SnapshotDeleteRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SnapshotDelete) WithFilterPath(v ...string) func(*SnapshotDeleteRequest)
WithFilterPath filters the properties of the response body.
func (f SnapshotDelete) WithHeader(h map[string]string) func(*SnapshotDeleteRequest)
WithHeader adds the headers to the HTTP request.
func (f SnapshotDelete) WithHuman() func(*SnapshotDeleteRequest)
WithHuman makes statistical values human-readable.
func (f SnapshotDelete) WithMasterTimeout(v time.Duration) func(*SnapshotDeleteRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f SnapshotDelete) WithPretty() func(*SnapshotDeleteRequest)
WithPretty makes the response body pretty-printed.
type SnapshotDeleteRepository func(repository []string, o ...func(*SnapshotDeleteRepositoryRequest)) (*Response, error)
SnapshotDeleteRepository deletes a repository.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.
func (f SnapshotDeleteRepository) WithContext(v context.Context) func(*SnapshotDeleteRepositoryRequest)
WithContext sets the request context.
func (f SnapshotDeleteRepository) WithErrorTrace() func(*SnapshotDeleteRepositoryRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SnapshotDeleteRepository) WithFilterPath(v ...string) func(*SnapshotDeleteRepositoryRequest)
WithFilterPath filters the properties of the response body.
func (f SnapshotDeleteRepository) WithHeader(h map[string]string) func(*SnapshotDeleteRepositoryRequest)
WithHeader adds the headers to the HTTP request.
func (f SnapshotDeleteRepository) WithHuman() func(*SnapshotDeleteRepositoryRequest)
WithHuman makes statistical values human-readable.
func (f SnapshotDeleteRepository) WithMasterTimeout(v time.Duration) func(*SnapshotDeleteRepositoryRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f SnapshotDeleteRepository) WithPretty() func(*SnapshotDeleteRepositoryRequest)
WithPretty makes the response body pretty-printed.
func (f SnapshotDeleteRepository) WithTimeout(v time.Duration) func(*SnapshotDeleteRepositoryRequest)
WithTimeout - explicit operation timeout.
type SnapshotDeleteRepositoryRequest struct {
Repository []string
MasterTimeout time.Duration
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SnapshotDeleteRepositoryRequest configures the Snapshot Delete Repository API request.
func (r SnapshotDeleteRepositoryRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SnapshotDeleteRequest struct {
Repository string
Snapshot string
MasterTimeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SnapshotDeleteRequest configures the Snapshot Delete API request.
Do executes the request and returns response or error.
type SnapshotGet func(repository string, snapshot []string, o ...func(*SnapshotGetRequest)) (*Response, error)
SnapshotGet returns information about a snapshot.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.
func (f SnapshotGet) WithContext(v context.Context) func(*SnapshotGetRequest)
WithContext sets the request context.
func (f SnapshotGet) WithErrorTrace() func(*SnapshotGetRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SnapshotGet) WithFilterPath(v ...string) func(*SnapshotGetRequest)
WithFilterPath filters the properties of the response body.
func (f SnapshotGet) WithHeader(h map[string]string) func(*SnapshotGetRequest)
WithHeader adds the headers to the HTTP request.
func (f SnapshotGet) WithHuman() func(*SnapshotGetRequest)
WithHuman makes statistical values human-readable.
func (f SnapshotGet) WithIgnoreUnavailable(v bool) func(*SnapshotGetRequest)
WithIgnoreUnavailable - whether to ignore unavailable snapshots, defaults to false which means a snapshotmissingexception is thrown.
func (f SnapshotGet) WithMasterTimeout(v time.Duration) func(*SnapshotGetRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f SnapshotGet) WithPretty() func(*SnapshotGetRequest)
WithPretty makes the response body pretty-printed.
func (f SnapshotGet) WithVerbose(v bool) func(*SnapshotGetRequest)
WithVerbose - whether to show verbose snapshot info or only show the basic info found in the repository index blob.
type SnapshotGetRepository func(o ...func(*SnapshotGetRepositoryRequest)) (*Response, error)
SnapshotGetRepository returns information about a repository.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.
func (f SnapshotGetRepository) WithContext(v context.Context) func(*SnapshotGetRepositoryRequest)
WithContext sets the request context.
func (f SnapshotGetRepository) WithErrorTrace() func(*SnapshotGetRepositoryRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SnapshotGetRepository) WithFilterPath(v ...string) func(*SnapshotGetRepositoryRequest)
WithFilterPath filters the properties of the response body.
func (f SnapshotGetRepository) WithHeader(h map[string]string) func(*SnapshotGetRepositoryRequest)
WithHeader adds the headers to the HTTP request.
func (f SnapshotGetRepository) WithHuman() func(*SnapshotGetRepositoryRequest)
WithHuman makes statistical values human-readable.
func (f SnapshotGetRepository) WithLocal(v bool) func(*SnapshotGetRepositoryRequest)
WithLocal - return local information, do not retrieve the state from master node (default: false).
func (f SnapshotGetRepository) WithMasterTimeout(v time.Duration) func(*SnapshotGetRepositoryRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f SnapshotGetRepository) WithPretty() func(*SnapshotGetRepositoryRequest)
WithPretty makes the response body pretty-printed.
func (f SnapshotGetRepository) WithRepository(v ...string) func(*SnapshotGetRepositoryRequest)
WithRepository - a list of repository names.
type SnapshotGetRepositoryRequest struct {
Repository []string
Local *bool
MasterTimeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SnapshotGetRepositoryRequest configures the Snapshot Get Repository API request.
func (r SnapshotGetRepositoryRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type SnapshotGetRequest struct {
Repository string
Snapshot []string
*bool
MasterTimeout time.Duration
Verbose *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SnapshotGetRequest configures the Snapshot Get API request.
Do executes the request and returns response or error.
type SnapshotRestore func(repository string, snapshot string, o ...func(*SnapshotRestoreRequest)) (*Response, error)
SnapshotRestore restores a snapshot.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.
func (f SnapshotRestore) WithBody(v io.Reader) func(*SnapshotRestoreRequest)
WithBody - Details of what to restore.
func (f SnapshotRestore) WithContext(v context.Context) func(*SnapshotRestoreRequest)
WithContext sets the request context.
func (f SnapshotRestore) WithErrorTrace() func(*SnapshotRestoreRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SnapshotRestore) WithFilterPath(v ...string) func(*SnapshotRestoreRequest)
WithFilterPath filters the properties of the response body.
func (f SnapshotRestore) WithHeader(h map[string]string) func(*SnapshotRestoreRequest)
WithHeader adds the headers to the HTTP request.
func (f SnapshotRestore) WithHuman() func(*SnapshotRestoreRequest)
WithHuman makes statistical values human-readable.
func (f SnapshotRestore) WithMasterTimeout(v time.Duration) func(*SnapshotRestoreRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f SnapshotRestore) WithPretty() func(*SnapshotRestoreRequest)
WithPretty makes the response body pretty-printed.
func (f SnapshotRestore) WithWaitForCompletion(v bool) func(*SnapshotRestoreRequest)
WithWaitForCompletion - should this request wait until the operation has completed before returning.
type SnapshotRestoreRequest struct {
Body io.Reader
Repository string
Snapshot string
MasterTimeout time.Duration
WaitForCompletion *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SnapshotRestoreRequest configures the Snapshot Restore API request.
Do executes the request and returns response or error.
type SnapshotStatus func(o ...func(*SnapshotStatusRequest)) (*Response, error)
SnapshotStatus returns information about the status of a snapshot.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.
func (f SnapshotStatus) WithContext(v context.Context) func(*SnapshotStatusRequest)
WithContext sets the request context.
func (f SnapshotStatus) WithErrorTrace() func(*SnapshotStatusRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SnapshotStatus) WithFilterPath(v ...string) func(*SnapshotStatusRequest)
WithFilterPath filters the properties of the response body.
func (f SnapshotStatus) WithHeader(h map[string]string) func(*SnapshotStatusRequest)
WithHeader adds the headers to the HTTP request.
func (f SnapshotStatus) WithHuman() func(*SnapshotStatusRequest)
WithHuman makes statistical values human-readable.
func (f SnapshotStatus) WithIgnoreUnavailable(v bool) func(*SnapshotStatusRequest)
WithIgnoreUnavailable - whether to ignore unavailable snapshots, defaults to false which means a snapshotmissingexception is thrown.
func (f SnapshotStatus) WithMasterTimeout(v time.Duration) func(*SnapshotStatusRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f SnapshotStatus) WithPretty() func(*SnapshotStatusRequest)
WithPretty makes the response body pretty-printed.
func (f SnapshotStatus) WithRepository(v string) func(*SnapshotStatusRequest)
WithRepository - a repository name.
func (f SnapshotStatus) WithSnapshot(v ...string) func(*SnapshotStatusRequest)
WithSnapshot - a list of snapshot names.
type SnapshotStatusRequest struct {
Repository string
Snapshot []string
*bool
MasterTimeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SnapshotStatusRequest configures the Snapshot Status API request.
Do executes the request and returns response or error.
type SnapshotVerifyRepository func(repository string, o ...func(*SnapshotVerifyRepositoryRequest)) (*Response, error)
SnapshotVerifyRepository verifies a repository.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.
func (f SnapshotVerifyRepository) WithContext(v context.Context) func(*SnapshotVerifyRepositoryRequest)
WithContext sets the request context.
func (f SnapshotVerifyRepository) WithErrorTrace() func(*SnapshotVerifyRepositoryRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f SnapshotVerifyRepository) WithFilterPath(v ...string) func(*SnapshotVerifyRepositoryRequest)
WithFilterPath filters the properties of the response body.
func (f SnapshotVerifyRepository) WithHeader(h map[string]string) func(*SnapshotVerifyRepositoryRequest)
WithHeader adds the headers to the HTTP request.
func (f SnapshotVerifyRepository) WithHuman() func(*SnapshotVerifyRepositoryRequest)
WithHuman makes statistical values human-readable.
func (f SnapshotVerifyRepository) WithMasterTimeout(v time.Duration) func(*SnapshotVerifyRepositoryRequest)
WithMasterTimeout - explicit operation timeout for connection to master node.
func (f SnapshotVerifyRepository) WithPretty() func(*SnapshotVerifyRepositoryRequest)
WithPretty makes the response body pretty-printed.
func (f SnapshotVerifyRepository) WithTimeout(v time.Duration) func(*SnapshotVerifyRepositoryRequest)
WithTimeout - explicit operation timeout.
type SnapshotVerifyRepositoryRequest struct {
Repository string
MasterTimeout time.Duration
Timeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}SnapshotVerifyRepositoryRequest configures the Snapshot Verify Repository API request.
func (r SnapshotVerifyRepositoryRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type Tasks struct {
Cancel TasksCancel
Get TasksGet
List TasksList
}Tasks contains the Tasks APIs
type TasksCancel func(o ...func(*TasksCancelRequest)) (*Response, error)
TasksCancel cancels a task, if it can be cancelled through an API.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html.
func (f TasksCancel) WithActions(v ...string) func(*TasksCancelRequest)
WithActions - a list of actions that should be cancelled. leave empty to cancel all..
func (f TasksCancel) WithContext(v context.Context) func(*TasksCancelRequest)
WithContext sets the request context.
func (f TasksCancel) WithErrorTrace() func(*TasksCancelRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f TasksCancel) WithFilterPath(v ...string) func(*TasksCancelRequest)
WithFilterPath filters the properties of the response body.
func (f TasksCancel) WithHeader(h map[string]string) func(*TasksCancelRequest)
WithHeader adds the headers to the HTTP request.
func (f TasksCancel) WithHuman() func(*TasksCancelRequest)
WithHuman makes statistical values human-readable.
func (f TasksCancel) WithNodes(v ...string) func(*TasksCancelRequest)
WithNodes - a list of node ids or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
func (f TasksCancel) WithParentTaskID(v string) func(*TasksCancelRequest)
WithParentTaskID - cancel tasks with specified parent task ID (node_id:task_number). set to -1 to cancel all..
func (f TasksCancel) WithPretty() func(*TasksCancelRequest)
WithPretty makes the response body pretty-printed.
func (f TasksCancel) WithTaskID(v string) func(*TasksCancelRequest)
WithTaskID - cancel the task with specified task ID (node_id:task_number).
type TasksCancelRequest struct {
TaskID string
Actions []string
Nodes []string
ParentTaskID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}TasksCancelRequest configures the Tasks Cancel API request.
Do executes the request and returns response or error.
type TasksGet func(task_id string, o ...func(*TasksGetRequest)) (*Response, error)
TasksGet returns information about a task.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html.
func (f TasksGet) WithContext(v context.Context) func(*TasksGetRequest)
WithContext sets the request context.
func (f TasksGet) WithErrorTrace() func(*TasksGetRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f TasksGet) WithFilterPath(v ...string) func(*TasksGetRequest)
WithFilterPath filters the properties of the response body.
func (f TasksGet) WithHeader(h map[string]string) func(*TasksGetRequest)
WithHeader adds the headers to the HTTP request.
func (f TasksGet) WithHuman() func(*TasksGetRequest)
WithHuman makes statistical values human-readable.
func (f TasksGet) WithPretty() func(*TasksGetRequest)
WithPretty makes the response body pretty-printed.
func (f TasksGet) WithTimeout(v time.Duration) func(*TasksGetRequest)
WithTimeout - explicit operation timeout.
func (f TasksGet) WithWaitForCompletion(v bool) func(*TasksGetRequest)
WithWaitForCompletion - wait for the matching tasks to complete (default: false).
type TasksGetRequest struct {
TaskID string
Timeout time.Duration
WaitForCompletion *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}TasksGetRequest configures the Tasks Get API request.
Do executes the request and returns response or error.
type TasksList func(o ...func(*TasksListRequest)) (*Response, error)
TasksList returns a list of tasks.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html.
func (f TasksList) WithActions(v ...string) func(*TasksListRequest)
WithActions - a list of actions that should be returned. leave empty to return all..
func (f TasksList) WithContext(v context.Context) func(*TasksListRequest)
WithContext sets the request context.
func (f TasksList) WithDetailed(v bool) func(*TasksListRequest)
WithDetailed - return detailed task information (default: false).
func (f TasksList) WithErrorTrace() func(*TasksListRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f TasksList) WithFilterPath(v ...string) func(*TasksListRequest)
WithFilterPath filters the properties of the response body.
func (f TasksList) WithGroupBy(v string) func(*TasksListRequest)
WithGroupBy - group tasks by nodes or parent/child relationships.
func (f TasksList) WithHeader(h map[string]string) func(*TasksListRequest)
WithHeader adds the headers to the HTTP request.
func (f TasksList) WithHuman() func(*TasksListRequest)
WithHuman makes statistical values human-readable.
func (f TasksList) WithNodes(v ...string) func(*TasksListRequest)
WithNodes - a list of node ids or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
func (f TasksList) WithParentTaskID(v string) func(*TasksListRequest)
WithParentTaskID - return tasks with specified parent task ID (node_id:task_number). set to -1 to return all..
func (f TasksList) WithPretty() func(*TasksListRequest)
WithPretty makes the response body pretty-printed.
func (f TasksList) WithTimeout(v time.Duration) func(*TasksListRequest)
WithTimeout - explicit operation timeout.
func (f TasksList) WithWaitForCompletion(v bool) func(*TasksListRequest)
WithWaitForCompletion - wait for the matching tasks to complete (default: false).
type TasksListRequest struct {
Actions []string
Detailed *bool
GroupBy string
Nodes []string
ParentTaskID string
Timeout time.Duration
WaitForCompletion *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}TasksListRequest configures the Tasks List API request.
Do executes the request and returns response or error.
type Termvectors func(index string, o ...func(*TermvectorsRequest)) (*Response, error)
Termvectors returns information and statistics about terms in the fields of a particular document.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html.
func (f Termvectors) WithBody(v io.Reader) func(*TermvectorsRequest)
WithBody - Define parameters and or supply a document to get termvectors for. See documentation..
func (f Termvectors) WithContext(v context.Context) func(*TermvectorsRequest)
WithContext sets the request context.
func (f Termvectors) WithDocumentID(v string) func(*TermvectorsRequest)
WithDocumentID - the ID of the document, when not specified a doc param should be supplied..
func (f Termvectors) WithErrorTrace() func(*TermvectorsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Termvectors) WithFieldStatistics(v bool) func(*TermvectorsRequest)
WithFieldStatistics - specifies if document count, sum of document frequencies and sum of total term frequencies should be returned..
func (f Termvectors) WithFields(v ...string) func(*TermvectorsRequest)
WithFields - a list of fields to return..
func (f Termvectors) WithFilterPath(v ...string) func(*TermvectorsRequest)
WithFilterPath filters the properties of the response body.
func (f Termvectors) WithHeader(h map[string]string) func(*TermvectorsRequest)
WithHeader adds the headers to the HTTP request.
func (f Termvectors) WithHuman() func(*TermvectorsRequest)
WithHuman makes statistical values human-readable.
func (f Termvectors) WithOffsets(v bool) func(*TermvectorsRequest)
WithOffsets - specifies if term offsets should be returned..
func (f Termvectors) WithPayloads(v bool) func(*TermvectorsRequest)
WithPayloads - specifies if term payloads should be returned..
func (f Termvectors) WithPositions(v bool) func(*TermvectorsRequest)
WithPositions - specifies if term positions should be returned..
func (f Termvectors) WithPreference(v string) func(*TermvectorsRequest)
WithPreference - specify the node or shard the operation should be performed on (default: random)..
func (f Termvectors) WithPretty() func(*TermvectorsRequest)
WithPretty makes the response body pretty-printed.
func (f Termvectors) WithRealtime(v bool) func(*TermvectorsRequest)
WithRealtime - specifies if request is real-time as opposed to near-real-time (default: true)..
func (f Termvectors) WithRouting(v string) func(*TermvectorsRequest)
WithRouting - specific routing value..
func (f Termvectors) WithTermStatistics(v bool) func(*TermvectorsRequest)
WithTermStatistics - specifies if total term frequency and document frequency should be returned..
func (f Termvectors) WithVersion(v int) func(*TermvectorsRequest)
WithVersion - explicit version number for concurrency control.
func (f Termvectors) WithVersionType(v string) func(*TermvectorsRequest)
WithVersionType - specific version type.
type TermvectorsRequest struct {
Index string
DocumentID string
Body io.Reader
Fields []string
FieldStatistics *bool
Offsets *bool
Payloads *bool
Positions *bool
Preference string
Realtime *bool
Routing string
TermStatistics *bool
Version *int
VersionType string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}TermvectorsRequest configures the Termvectors API request.
Do executes the request and returns response or error.
Transport defines the interface for an API client.
type Update func(index string, id string, body io.Reader, o ...func(*UpdateRequest)) (*Response, error)
Update updates a document with a script or partial document.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html.
func (f Update) WithContext(v context.Context) func(*UpdateRequest)
WithContext sets the request context.
func (f Update) WithDocumentType(v string) func(*UpdateRequest)
WithDocumentType - the type of the document.
func (f Update) WithErrorTrace() func(*UpdateRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f Update) WithFilterPath(v ...string) func(*UpdateRequest)
WithFilterPath filters the properties of the response body.
func (f Update) WithHeader(h map[string]string) func(*UpdateRequest)
WithHeader adds the headers to the HTTP request.
func (f Update) WithHuman() func(*UpdateRequest)
WithHuman makes statistical values human-readable.
func (f Update) WithIfPrimaryTerm(v int) func(*UpdateRequest)
WithIfPrimaryTerm - only perform the update operation if the last operation that has changed the document has the specified primary term.
func (f Update) WithIfSeqNo(v int) func(*UpdateRequest)
WithIfSeqNo - only perform the update operation if the last operation that has changed the document has the specified sequence number.
func (f Update) WithLang(v string) func(*UpdateRequest)
WithLang - the script language (default: painless).
func (f Update) WithPretty() func(*UpdateRequest)
WithPretty makes the response body pretty-printed.
func (f Update) WithRefresh(v string) func(*UpdateRequest)
WithRefresh - if `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes..
func (f Update) WithRetryOnConflict(v int) func(*UpdateRequest)
WithRetryOnConflict - specify how many times should the operation be retried when a conflict occurs (default: 0).
func (f Update) WithRouting(v string) func(*UpdateRequest)
WithRouting - specific routing value.
func (f Update) WithSource(v ...string) func(*UpdateRequest)
WithSource - true or false to return the _source field or not, or a list of fields to return.
func (f Update) WithSourceExcludes(v ...string) func(*UpdateRequest)
WithSourceExcludes - a list of fields to exclude from the returned _source field.
func (f Update) WithSourceIncludes(v ...string) func(*UpdateRequest)
WithSourceIncludes - a list of fields to extract and return from the _source field.
func (f Update) WithTimeout(v time.Duration) func(*UpdateRequest)
WithTimeout - explicit operation timeout.
func (f Update) WithWaitForActiveShards(v string) func(*UpdateRequest)
WithWaitForActiveShards - sets the number of shard copies that must be active before proceeding with the update operation. defaults to 1, meaning the primary shard only. set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).
type UpdateByQuery func(index []string, o ...func(*UpdateByQueryRequest)) (*Response, error)
UpdateByQuery performs an update on every document in the index without changing the source, for example to pick up a mapping change.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html.
func (f UpdateByQuery) WithAllowNoIndices(v bool) func(*UpdateByQueryRequest)
WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
func (f UpdateByQuery) WithAnalyzeWildcard(v bool) func(*UpdateByQueryRequest)
WithAnalyzeWildcard - specify whether wildcard and prefix queries should be analyzed (default: false).
func (f UpdateByQuery) WithAnalyzer(v string) func(*UpdateByQueryRequest)
WithAnalyzer - the analyzer to use for the query string.
func (f UpdateByQuery) WithBody(v io.Reader) func(*UpdateByQueryRequest)
WithBody - The search definition using the Query DSL.
func (f UpdateByQuery) WithConflicts(v string) func(*UpdateByQueryRequest)
WithConflicts - what to do when the update by query hits version conflicts?.
func (f UpdateByQuery) WithContext(v context.Context) func(*UpdateByQueryRequest)
WithContext sets the request context.
func (f UpdateByQuery) WithDefaultOperator(v string) func(*UpdateByQueryRequest)
WithDefaultOperator - the default operator for query string query (and or or).
func (f UpdateByQuery) WithDf(v string) func(*UpdateByQueryRequest)
WithDf - the field to use as default where no field prefix is given in the query string.
func (f UpdateByQuery) WithErrorTrace() func(*UpdateByQueryRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f UpdateByQuery) WithExpandWildcards(v string) func(*UpdateByQueryRequest)
WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
func (f UpdateByQuery) WithFilterPath(v ...string) func(*UpdateByQueryRequest)
WithFilterPath filters the properties of the response body.
func (f UpdateByQuery) WithFrom(v int) func(*UpdateByQueryRequest)
WithFrom - starting offset (default: 0).
func (f UpdateByQuery) WithHeader(h map[string]string) func(*UpdateByQueryRequest)
WithHeader adds the headers to the HTTP request.
func (f UpdateByQuery) WithHuman() func(*UpdateByQueryRequest)
WithHuman makes statistical values human-readable.
func (f UpdateByQuery) WithIgnoreUnavailable(v bool) func(*UpdateByQueryRequest)
WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
func (f UpdateByQuery) WithLenient(v bool) func(*UpdateByQueryRequest)
WithLenient - specify whether format-based query failures (such as providing text to a numeric field) should be ignored.
func (f UpdateByQuery) WithMaxDocs(v int) func(*UpdateByQueryRequest)
WithMaxDocs - maximum number of documents to process (default: all documents).
func (f UpdateByQuery) WithPipeline(v string) func(*UpdateByQueryRequest)
WithPipeline - ingest pipeline to set on index requests made by this action. (default: none).
func (f UpdateByQuery) WithPreference(v string) func(*UpdateByQueryRequest)
WithPreference - specify the node or shard the operation should be performed on (default: random).
func (f UpdateByQuery) WithPretty() func(*UpdateByQueryRequest)
WithPretty makes the response body pretty-printed.
func (f UpdateByQuery) WithQuery(v string) func(*UpdateByQueryRequest)
WithQuery - query in the lucene query string syntax.
func (f UpdateByQuery) WithRefresh(v bool) func(*UpdateByQueryRequest)
WithRefresh - should the effected indexes be refreshed?.
func (f UpdateByQuery) WithRequestCache(v bool) func(*UpdateByQueryRequest)
WithRequestCache - specify if request cache should be used for this request or not, defaults to index level setting.
func (f UpdateByQuery) WithRequestsPerSecond(v int) func(*UpdateByQueryRequest)
WithRequestsPerSecond - the throttle to set on this request in sub-requests per second. -1 means no throttle..
func (f UpdateByQuery) WithRouting(v ...string) func(*UpdateByQueryRequest)
WithRouting - a list of specific routing values.
func (f UpdateByQuery) WithScroll(v time.Duration) func(*UpdateByQueryRequest)
WithScroll - specify how long a consistent view of the index should be maintained for scrolled search.
func (f UpdateByQuery) WithScrollSize(v int) func(*UpdateByQueryRequest)
WithScrollSize - size on the scroll request powering the update by query.
func (f UpdateByQuery) WithSearchTimeout(v time.Duration) func(*UpdateByQueryRequest)
WithSearchTimeout - explicit timeout for each search request. defaults to no timeout..
func (f UpdateByQuery) WithSearchType(v string) func(*UpdateByQueryRequest)
WithSearchType - search operation type.
func (f UpdateByQuery) WithSlices(v int) func(*UpdateByQueryRequest)
WithSlices - the number of slices this task should be divided into. defaults to 1 meaning the task isn't sliced into subtasks..
func (f UpdateByQuery) WithSort(v ...string) func(*UpdateByQueryRequest)
WithSort - a list of <field>:<direction> pairs.
func (f UpdateByQuery) WithSource(v ...string) func(*UpdateByQueryRequest)
WithSource - true or false to return the _source field or not, or a list of fields to return.
func (f UpdateByQuery) WithSourceExcludes(v ...string) func(*UpdateByQueryRequest)
WithSourceExcludes - a list of fields to exclude from the returned _source field.
func (f UpdateByQuery) WithSourceIncludes(v ...string) func(*UpdateByQueryRequest)
WithSourceIncludes - a list of fields to extract and return from the _source field.
func (f UpdateByQuery) WithStats(v ...string) func(*UpdateByQueryRequest)
WithStats - specific 'tag' of the request for logging and statistical purposes.
func (f UpdateByQuery) WithTerminateAfter(v int) func(*UpdateByQueryRequest)
WithTerminateAfter - the maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early..
func (f UpdateByQuery) WithTimeout(v time.Duration) func(*UpdateByQueryRequest)
WithTimeout - time each individual bulk request should wait for shards that are unavailable..
func (f UpdateByQuery) WithVersion(v bool) func(*UpdateByQueryRequest)
WithVersion - specify whether to return document version as part of a hit.
func (f UpdateByQuery) WithVersionType(v bool) func(*UpdateByQueryRequest)
WithVersionType - should the document increment the version number (internal) on hit or not (reindex).
func (f UpdateByQuery) WithWaitForActiveShards(v string) func(*UpdateByQueryRequest)
WithWaitForActiveShards - sets the number of shard copies that must be active before proceeding with the update by query operation. defaults to 1, meaning the primary shard only. set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).
func (f UpdateByQuery) WithWaitForCompletion(v bool) func(*UpdateByQueryRequest)
WithWaitForCompletion - should the request should block until the update by query operation is complete..
type UpdateByQueryRequest struct {
Index []string
Body io.Reader
AllowNoIndices *bool
Analyzer string
AnalyzeWildcard *bool
Conflicts string
DefaultOperator string
Df string
ExpandWildcards string
From *int
*bool
Lenient *bool
MaxDocs *int
Pipeline string
Preference string
Query string
Refresh *bool
RequestCache *bool
RequestsPerSecond *int
Routing []string
Scroll time.Duration
ScrollSize *int
SearchTimeout time.Duration
SearchType string
Slices *int
Sort []string
Source []string
SourceExcludes []string
SourceIncludes []string
Stats []string
TerminateAfter *int
Timeout time.Duration
Version *bool
VersionType *bool
WaitForActiveShards string
WaitForCompletion *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}UpdateByQueryRequest configures the Update By Query API request.
Do executes the request and returns response or error.
type UpdateByQueryRethrottle func(task_id string, requests_per_second *int, o ...func(*UpdateByQueryRethrottleRequest)) (*Response, error)
UpdateByQueryRethrottle changes the number of requests per second for a particular Update By Query operation.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html.
func (f UpdateByQueryRethrottle) WithContext(v context.Context) func(*UpdateByQueryRethrottleRequest)
WithContext sets the request context.
func (f UpdateByQueryRethrottle) WithErrorTrace() func(*UpdateByQueryRethrottleRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f UpdateByQueryRethrottle) WithFilterPath(v ...string) func(*UpdateByQueryRethrottleRequest)
WithFilterPath filters the properties of the response body.
func (f UpdateByQueryRethrottle) WithHeader(h map[string]string) func(*UpdateByQueryRethrottleRequest)
WithHeader adds the headers to the HTTP request.
func (f UpdateByQueryRethrottle) WithHuman() func(*UpdateByQueryRethrottleRequest)
WithHuman makes statistical values human-readable.
func (f UpdateByQueryRethrottle) WithPretty() func(*UpdateByQueryRethrottleRequest)
WithPretty makes the response body pretty-printed.
func (f UpdateByQueryRethrottle) WithRequestsPerSecond(v int) func(*UpdateByQueryRethrottleRequest)
WithRequestsPerSecond - the throttle to set on this request in floating sub-requests per second. -1 means set no throttle..
type UpdateByQueryRethrottleRequest struct {
TaskID string
RequestsPerSecond *int
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}UpdateByQueryRethrottleRequest configures the Update By Query Rethrottle API request.
func (r UpdateByQueryRethrottleRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type UpdateRequest struct {
Index string
DocumentType string
DocumentID string
Body io.Reader
IfPrimaryTerm *int
IfSeqNo *int
Lang string
Refresh string
RetryOnConflict *int
Routing string
Source []string
SourceExcludes []string
SourceIncludes []string
Timeout time.Duration
WaitForActiveShards string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}UpdateRequest configures the Update API request.
Do executes the request and returns response or error.
type Watcher struct {
AckWatch WatcherAckWatch
ActivateWatch WatcherActivateWatch
DeactivateWatch WatcherDeactivateWatch
DeleteWatch WatcherDeleteWatch
ExecuteWatch WatcherExecuteWatch
GetWatch WatcherGetWatch
PutWatch WatcherPutWatch
Start WatcherStart
Stats WatcherStats
Stop WatcherStop
}Watcher contains the Watcher APIs
type WatcherAckWatch func(watch_id string, o ...func(*WatcherAckWatchRequest)) (*Response, error)
WatcherAckWatch - http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html
func (f WatcherAckWatch) WithActionID(v ...string) func(*WatcherAckWatchRequest)
WithActionID - a list of the action ids to be acked.
func (f WatcherAckWatch) WithContext(v context.Context) func(*WatcherAckWatchRequest)
WithContext sets the request context.
func (f WatcherAckWatch) WithErrorTrace() func(*WatcherAckWatchRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f WatcherAckWatch) WithFilterPath(v ...string) func(*WatcherAckWatchRequest)
WithFilterPath filters the properties of the response body.
func (f WatcherAckWatch) WithHeader(h map[string]string) func(*WatcherAckWatchRequest)
WithHeader adds the headers to the HTTP request.
func (f WatcherAckWatch) WithHuman() func(*WatcherAckWatchRequest)
WithHuman makes statistical values human-readable.
func (f WatcherAckWatch) WithPretty() func(*WatcherAckWatchRequest)
WithPretty makes the response body pretty-printed.
type WatcherAckWatchRequest struct {
ActionID []string
WatchID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}WatcherAckWatchRequest configures the Watcher Ack Watch API request.
Do executes the request and returns response or error.
type WatcherActivateWatch func(watch_id string, o ...func(*WatcherActivateWatchRequest)) (*Response, error)
WatcherActivateWatch - https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html
func (f WatcherActivateWatch) WithContext(v context.Context) func(*WatcherActivateWatchRequest)
WithContext sets the request context.
func (f WatcherActivateWatch) WithErrorTrace() func(*WatcherActivateWatchRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f WatcherActivateWatch) WithFilterPath(v ...string) func(*WatcherActivateWatchRequest)
WithFilterPath filters the properties of the response body.
func (f WatcherActivateWatch) WithHeader(h map[string]string) func(*WatcherActivateWatchRequest)
WithHeader adds the headers to the HTTP request.
func (f WatcherActivateWatch) WithHuman() func(*WatcherActivateWatchRequest)
WithHuman makes statistical values human-readable.
func (f WatcherActivateWatch) WithPretty() func(*WatcherActivateWatchRequest)
WithPretty makes the response body pretty-printed.
type WatcherActivateWatchRequest struct {
WatchID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}WatcherActivateWatchRequest configures the Watcher Activate Watch API request.
func (r WatcherActivateWatchRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type WatcherDeactivateWatch func(watch_id string, o ...func(*WatcherDeactivateWatchRequest)) (*Response, error)
WatcherDeactivateWatch - https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html
func (f WatcherDeactivateWatch) WithContext(v context.Context) func(*WatcherDeactivateWatchRequest)
WithContext sets the request context.
func (f WatcherDeactivateWatch) WithErrorTrace() func(*WatcherDeactivateWatchRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f WatcherDeactivateWatch) WithFilterPath(v ...string) func(*WatcherDeactivateWatchRequest)
WithFilterPath filters the properties of the response body.
func (f WatcherDeactivateWatch) WithHeader(h map[string]string) func(*WatcherDeactivateWatchRequest)
WithHeader adds the headers to the HTTP request.
func (f WatcherDeactivateWatch) WithHuman() func(*WatcherDeactivateWatchRequest)
WithHuman makes statistical values human-readable.
func (f WatcherDeactivateWatch) WithPretty() func(*WatcherDeactivateWatchRequest)
WithPretty makes the response body pretty-printed.
type WatcherDeactivateWatchRequest struct {
WatchID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}WatcherDeactivateWatchRequest configures the Watcher Deactivate Watch API request.
func (r WatcherDeactivateWatchRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type WatcherDeleteWatch func(id string, o ...func(*WatcherDeleteWatchRequest)) (*Response, error)
WatcherDeleteWatch - http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html
func (f WatcherDeleteWatch) WithContext(v context.Context) func(*WatcherDeleteWatchRequest)
WithContext sets the request context.
func (f WatcherDeleteWatch) WithErrorTrace() func(*WatcherDeleteWatchRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f WatcherDeleteWatch) WithFilterPath(v ...string) func(*WatcherDeleteWatchRequest)
WithFilterPath filters the properties of the response body.
func (f WatcherDeleteWatch) WithHeader(h map[string]string) func(*WatcherDeleteWatchRequest)
WithHeader adds the headers to the HTTP request.
func (f WatcherDeleteWatch) WithHuman() func(*WatcherDeleteWatchRequest)
WithHuman makes statistical values human-readable.
func (f WatcherDeleteWatch) WithPretty() func(*WatcherDeleteWatchRequest)
WithPretty makes the response body pretty-printed.
type WatcherDeleteWatchRequest struct {
WatchID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}WatcherDeleteWatchRequest configures the Watcher Delete Watch API request.
Do executes the request and returns response or error.
type WatcherExecuteWatch func(o ...func(*WatcherExecuteWatchRequest)) (*Response, error)
WatcherExecuteWatch - http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html
func (f WatcherExecuteWatch) WithBody(v io.Reader) func(*WatcherExecuteWatchRequest)
WithBody - Execution control.
func (f WatcherExecuteWatch) WithContext(v context.Context) func(*WatcherExecuteWatchRequest)
WithContext sets the request context.
func (f WatcherExecuteWatch) WithDebug(v bool) func(*WatcherExecuteWatchRequest)
WithDebug - indicates whether the watch should execute in debug mode.
func (f WatcherExecuteWatch) WithErrorTrace() func(*WatcherExecuteWatchRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f WatcherExecuteWatch) WithFilterPath(v ...string) func(*WatcherExecuteWatchRequest)
WithFilterPath filters the properties of the response body.
func (f WatcherExecuteWatch) WithHeader(h map[string]string) func(*WatcherExecuteWatchRequest)
WithHeader adds the headers to the HTTP request.
func (f WatcherExecuteWatch) WithHuman() func(*WatcherExecuteWatchRequest)
WithHuman makes statistical values human-readable.
func (f WatcherExecuteWatch) WithPretty() func(*WatcherExecuteWatchRequest)
WithPretty makes the response body pretty-printed.
func (f WatcherExecuteWatch) WithWatchID(v string) func(*WatcherExecuteWatchRequest)
WithWatchID - watch ID.
type WatcherExecuteWatchRequest struct {
WatchID string
Body io.Reader
Debug *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}WatcherExecuteWatchRequest configures the Watcher Execute Watch API request.
func (r WatcherExecuteWatchRequest) Do(ctx context.Context, transport Transport) (*Response, error)
Do executes the request and returns response or error.
type WatcherGetWatch func(id string, o ...func(*WatcherGetWatchRequest)) (*Response, error)
WatcherGetWatch - http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html
func (f WatcherGetWatch) WithContext(v context.Context) func(*WatcherGetWatchRequest)
WithContext sets the request context.
func (f WatcherGetWatch) WithErrorTrace() func(*WatcherGetWatchRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f WatcherGetWatch) WithFilterPath(v ...string) func(*WatcherGetWatchRequest)
WithFilterPath filters the properties of the response body.
func (f WatcherGetWatch) WithHeader(h map[string]string) func(*WatcherGetWatchRequest)
WithHeader adds the headers to the HTTP request.
func (f WatcherGetWatch) WithHuman() func(*WatcherGetWatchRequest)
WithHuman makes statistical values human-readable.
func (f WatcherGetWatch) WithPretty() func(*WatcherGetWatchRequest)
WithPretty makes the response body pretty-printed.
type WatcherGetWatchRequest struct {
WatchID string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}WatcherGetWatchRequest configures the Watcher Get Watch API request.
Do executes the request and returns response or error.
type WatcherPutWatch func(id string, o ...func(*WatcherPutWatchRequest)) (*Response, error)
WatcherPutWatch - http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html
func (f WatcherPutWatch) WithActive(v bool) func(*WatcherPutWatchRequest)
WithActive - specify whether the watch is in/active by default.
func (f WatcherPutWatch) WithBody(v io.Reader) func(*WatcherPutWatchRequest)
WithBody - The watch.
func (f WatcherPutWatch) WithContext(v context.Context) func(*WatcherPutWatchRequest)
WithContext sets the request context.
func (f WatcherPutWatch) WithErrorTrace() func(*WatcherPutWatchRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f WatcherPutWatch) WithFilterPath(v ...string) func(*WatcherPutWatchRequest)
WithFilterPath filters the properties of the response body.
func (f WatcherPutWatch) WithHeader(h map[string]string) func(*WatcherPutWatchRequest)
WithHeader adds the headers to the HTTP request.
func (f WatcherPutWatch) WithHuman() func(*WatcherPutWatchRequest)
WithHuman makes statistical values human-readable.
func (f WatcherPutWatch) WithIfPrimaryTerm(v int) func(*WatcherPutWatchRequest)
WithIfPrimaryTerm - only update the watch if the last operation that has changed the watch has the specified primary term.
func (f WatcherPutWatch) WithIfSeqNo(v int) func(*WatcherPutWatchRequest)
WithIfSeqNo - only update the watch if the last operation that has changed the watch has the specified sequence number.
func (f WatcherPutWatch) WithPretty() func(*WatcherPutWatchRequest)
WithPretty makes the response body pretty-printed.
func (f WatcherPutWatch) WithVersion(v int) func(*WatcherPutWatchRequest)
WithVersion - explicit version number for concurrency control.
type WatcherPutWatchRequest struct {
WatchID string
Body io.Reader
Active *bool
IfPrimaryTerm *int
IfSeqNo *int
Version *int
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}WatcherPutWatchRequest configures the Watcher Put Watch API request.
Do executes the request and returns response or error.
type WatcherStart func(o ...func(*WatcherStartRequest)) (*Response, error)
WatcherStart - http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html
func (f WatcherStart) WithContext(v context.Context) func(*WatcherStartRequest)
WithContext sets the request context.
func (f WatcherStart) WithErrorTrace() func(*WatcherStartRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f WatcherStart) WithFilterPath(v ...string) func(*WatcherStartRequest)
WithFilterPath filters the properties of the response body.
func (f WatcherStart) WithHeader(h map[string]string) func(*WatcherStartRequest)
WithHeader adds the headers to the HTTP request.
func (f WatcherStart) WithHuman() func(*WatcherStartRequest)
WithHuman makes statistical values human-readable.
func (f WatcherStart) WithPretty() func(*WatcherStartRequest)
WithPretty makes the response body pretty-printed.
type WatcherStartRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}WatcherStartRequest configures the Watcher Start API request.
Do executes the request and returns response or error.
type WatcherStats func(o ...func(*WatcherStatsRequest)) (*Response, error)
WatcherStats - http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html
func (f WatcherStats) WithContext(v context.Context) func(*WatcherStatsRequest)
WithContext sets the request context.
func (f WatcherStats) WithEmitStacktraces(v bool) func(*WatcherStatsRequest)
WithEmitStacktraces - emits stack traces of currently running watches.
func (f WatcherStats) WithErrorTrace() func(*WatcherStatsRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f WatcherStats) WithFilterPath(v ...string) func(*WatcherStatsRequest)
WithFilterPath filters the properties of the response body.
func (f WatcherStats) WithHeader(h map[string]string) func(*WatcherStatsRequest)
WithHeader adds the headers to the HTTP request.
func (f WatcherStats) WithHuman() func(*WatcherStatsRequest)
WithHuman makes statistical values human-readable.
func (f WatcherStats) WithMetric(v ...string) func(*WatcherStatsRequest)
WithMetric - controls what additional stat metrics should be include in the response.
func (f WatcherStats) WithPretty() func(*WatcherStatsRequest)
WithPretty makes the response body pretty-printed.
type WatcherStatsRequest struct {
Metric []string
EmitStacktraces *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}WatcherStatsRequest configures the Watcher Stats API request.
Do executes the request and returns response or error.
type WatcherStop func(o ...func(*WatcherStopRequest)) (*Response, error)
WatcherStop - http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html
func (f WatcherStop) WithContext(v context.Context) func(*WatcherStopRequest)
WithContext sets the request context.
func (f WatcherStop) WithErrorTrace() func(*WatcherStopRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f WatcherStop) WithFilterPath(v ...string) func(*WatcherStopRequest)
WithFilterPath filters the properties of the response body.
func (f WatcherStop) WithHeader(h map[string]string) func(*WatcherStopRequest)
WithHeader adds the headers to the HTTP request.
func (f WatcherStop) WithHuman() func(*WatcherStopRequest)
WithHuman makes statistical values human-readable.
func (f WatcherStop) WithPretty() func(*WatcherStopRequest)
WithPretty makes the response body pretty-printed.
type WatcherStopRequest struct {
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}WatcherStopRequest configures the Watcher Stop API request.
Do executes the request and returns response or error.
type XPack struct {
Info XPackInfo
Usage XPackUsage
}XPack contains the XPack APIs
type XPackInfo func(o ...func(*XPackInfoRequest)) (*Response, error)
XPackInfo - https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html
func (f XPackInfo) WithCategories(v ...string) func(*XPackInfoRequest)
WithCategories - comma-separated list of info categories. can be any of: build, license, features.
func (f XPackInfo) WithContext(v context.Context) func(*XPackInfoRequest)
WithContext sets the request context.
func (f XPackInfo) WithErrorTrace() func(*XPackInfoRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f XPackInfo) WithFilterPath(v ...string) func(*XPackInfoRequest)
WithFilterPath filters the properties of the response body.
func (f XPackInfo) WithHeader(h map[string]string) func(*XPackInfoRequest)
WithHeader adds the headers to the HTTP request.
func (f XPackInfo) WithHuman() func(*XPackInfoRequest)
WithHuman makes statistical values human-readable.
func (f XPackInfo) WithPretty() func(*XPackInfoRequest)
WithPretty makes the response body pretty-printed.
type XPackInfoRequest struct {
Categories []string
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}XPackInfoRequest configures the X Pack Info API request.
Do executes the request and returns response or error.
type XPackUsage func(o ...func(*XPackUsageRequest)) (*Response, error)
XPackUsage - Retrieve information about xpack features usage
func (f XPackUsage) WithContext(v context.Context) func(*XPackUsageRequest)
WithContext sets the request context.
func (f XPackUsage) WithErrorTrace() func(*XPackUsageRequest)
WithErrorTrace includes the stack trace for errors in the response body.
func (f XPackUsage) WithFilterPath(v ...string) func(*XPackUsageRequest)
WithFilterPath filters the properties of the response body.
func (f XPackUsage) WithHeader(h map[string]string) func(*XPackUsageRequest)
WithHeader adds the headers to the HTTP request.
func (f XPackUsage) WithHuman() func(*XPackUsageRequest)
WithHuman makes statistical values human-readable.
func (f XPackUsage) WithMasterTimeout(v time.Duration) func(*XPackUsageRequest)
WithMasterTimeout - specify timeout for watch write operation.
func (f XPackUsage) WithPretty() func(*XPackUsageRequest)
WithPretty makes the response body pretty-printed.
type XPackUsageRequest struct {
MasterTimeout time.Duration
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
// contains filtered or unexported fields
}XPackUsageRequest configures the X Pack Usage API request.
Do executes the request and returns response or error.
Package esapi imports 11 packages (graph). Updated about a month ago. Refresh now. Tools for package owners.