esapi

package
v6.8.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 9, 2020 License: Apache-2.0 Imports: 10 Imported by: 98

Documentation ¶

Overview ¶

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/v6/esapi Index
go doc github.com/elastic/go-elasticsearch/v6/esapi IndexRequest

Response ¶

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.

Additional Information ¶

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/gensource.

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 available at internal/cmd/generate/commands/gentests.

Index ¶

Examples ¶

Constants ¶

View Source 
const Version = version.Client

Version returns the package version as a string.

Variables ¶

This section is empty.

Functions ¶

func BoolPtr ¶ 

func BoolPtr(v bool) *bool

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.

func IntPtr ¶ 

func IntPtr(v int) *int

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.

Types ¶

type API ¶ 

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
	DeleteByQuery           DeleteByQuery
	DeleteByQueryRethrottle DeleteByQueryRethrottle
	Delete                  Delete
	DeleteScript            DeleteScript
	Exists                  Exists
	ExistsSource            ExistsSource
	Explain                 Explain
	FieldCaps               FieldCaps
	Get                     Get
	GetScript               GetScript
	GetSource               GetSource
	Index                   Index
	Info                    Info
	Mget                    Mget
	Msearch                 Msearch
	MsearchTemplate         MsearchTemplate
	Mtermvectors            Mtermvectors
	Ping                    Ping
	PutScript               PutScript
	RankEval                RankEval
	Reindex                 Reindex
	ReindexRethrottle       ReindexRethrottle
	RenderSearchTemplate    RenderSearchTemplate
	ScriptsPainlessExecute  ScriptsPainlessExecute
	Scroll                  Scroll
	Search                  Search
	SearchShards            SearchShards
	SearchTemplate          SearchTemplate
	Termvectors             Termvectors
	UpdateByQuery           UpdateByQuery
	UpdateByQueryRethrottle UpdateByQueryRethrottle
	Update                  Update
}

API contains the Elasticsearch APIs

func New ¶ 

func New(t Transport) *API

New creates new API

type Bulk ¶ 

type Bulk func(body io.Reader, o ...func(*BulkRequest)) (*Response, error)

Bulk allows to perform multiple index/update/delete operations in a single request.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html.

func (Bulk) WithContext ¶ 

func (f Bulk) WithContext(v context.Context) func(*BulkRequest)

WithContext sets the request context.

func (Bulk) WithDocumentType ¶ 

func (f Bulk) WithDocumentType(v string) func(*BulkRequest)

WithDocumentType - default document type for items which don't provide one.

func (Bulk) WithErrorTrace ¶ 

func (f Bulk) WithErrorTrace() func(*BulkRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Bulk) WithFields ¶ 

func (f Bulk) WithFields(v ...string) func(*BulkRequest)

WithFields - default comma-separated list of fields to return in the response for updates, can be overridden on each sub-request.

func (Bulk) WithFilterPath ¶ 

func (f Bulk) WithFilterPath(v ...string) func(*BulkRequest)

WithFilterPath filters the properties of the response body.

func (Bulk) WithHeader ¶ added in v6.8.2 

func (f Bulk) WithHeader(h map[string]string) func(*BulkRequest)

WithHeader adds the headers to the HTTP request.

func (Bulk) WithHuman ¶ 

func (f Bulk) WithHuman() func(*BulkRequest)

WithHuman makes statistical values human-readable.

func (Bulk) WithIndex ¶ 

func (f Bulk) WithIndex(v string) func(*BulkRequest)

WithIndex - default index for items which don't provide one.

func (Bulk) WithOpaqueID ¶ added in v6.8.5 

func (f Bulk) WithOpaqueID(s string) func(*BulkRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Bulk) WithPipeline ¶ 

func (f Bulk) WithPipeline(v string) func(*BulkRequest)

WithPipeline - the pipeline ID to preprocess incoming documents with.

func (Bulk) WithPretty ¶ 

func (f Bulk) WithPretty() func(*BulkRequest)

WithPretty makes the response body pretty-printed.

func (Bulk) WithRefresh ¶ 

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 (Bulk) WithRouting ¶ 

func (f Bulk) WithRouting(v string) func(*BulkRequest)

WithRouting - specific routing value.

func (Bulk) WithSource ¶ 

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 (Bulk) WithSourceExcludes ¶ 

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 (Bulk) WithSourceIncludes ¶ 

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 (Bulk) WithTimeout ¶ 

func (f Bulk) WithTimeout(v time.Duration) func(*BulkRequest)

WithTimeout - explicit operation timeout.

func (Bulk) WithWaitForActiveShards ¶ 

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 ¶ 

type BulkRequest struct {
	Index        string
	DocumentType string

	Body io.Reader

	Fields              []string
	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.

func (BulkRequest) Do ¶ 

func (r BulkRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CCR ¶ added in v6.8.2 

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 ¶ added in v6.8.2 

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 (CCRDeleteAutoFollowPattern) WithContext ¶ added in v6.8.2 

func (f CCRDeleteAutoFollowPattern) WithContext(v context.Context) func(*CCRDeleteAutoFollowPatternRequest)

WithContext sets the request context.

func (CCRDeleteAutoFollowPattern) WithErrorTrace ¶ added in v6.8.2 

func (f CCRDeleteAutoFollowPattern) WithErrorTrace() func(*CCRDeleteAutoFollowPatternRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CCRDeleteAutoFollowPattern) WithFilterPath ¶ added in v6.8.2 

func (f CCRDeleteAutoFollowPattern) WithFilterPath(v ...string) func(*CCRDeleteAutoFollowPatternRequest)

WithFilterPath filters the properties of the response body.

func (CCRDeleteAutoFollowPattern) WithHeader ¶ added in v6.8.2 

func (f CCRDeleteAutoFollowPattern) WithHeader(h map[string]string) func(*CCRDeleteAutoFollowPatternRequest)

WithHeader adds the headers to the HTTP request.

func (CCRDeleteAutoFollowPattern) WithHuman ¶ added in v6.8.2 

func (f CCRDeleteAutoFollowPattern) WithHuman() func(*CCRDeleteAutoFollowPatternRequest)

WithHuman makes statistical values human-readable.

func (CCRDeleteAutoFollowPattern) WithOpaqueID ¶ added in v6.8.5 

func (f CCRDeleteAutoFollowPattern) WithOpaqueID(s string) func(*CCRDeleteAutoFollowPatternRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CCRDeleteAutoFollowPattern) WithPretty ¶ added in v6.8.2 

func (f CCRDeleteAutoFollowPattern) WithPretty() func(*CCRDeleteAutoFollowPatternRequest)

WithPretty makes the response body pretty-printed.

type CCRDeleteAutoFollowPatternRequest ¶ added in v6.8.2 

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 (CCRDeleteAutoFollowPatternRequest) Do ¶ added in v6.8.2 

func (r CCRDeleteAutoFollowPatternRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CCRFollow ¶ added in v6.8.2 

type CCRFollow func(index string, body io.Reader, o ...func(*CCRFollowRequest)) (*Response, error)

CCRFollow - https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html

func (CCRFollow) WithContext ¶ added in v6.8.2 

func (f CCRFollow) WithContext(v context.Context) func(*CCRFollowRequest)

WithContext sets the request context.

func (CCRFollow) WithErrorTrace ¶ added in v6.8.2 

func (f CCRFollow) WithErrorTrace() func(*CCRFollowRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CCRFollow) WithFilterPath ¶ added in v6.8.2 

func (f CCRFollow) WithFilterPath(v ...string) func(*CCRFollowRequest)

WithFilterPath filters the properties of the response body.

func (CCRFollow) WithHeader ¶ added in v6.8.2 

func (f CCRFollow) WithHeader(h map[string]string) func(*CCRFollowRequest)

WithHeader adds the headers to the HTTP request.

func (CCRFollow) WithHuman ¶ added in v6.8.2 

func (f CCRFollow) WithHuman() func(*CCRFollowRequest)

WithHuman makes statistical values human-readable.

func (CCRFollow) WithOpaqueID ¶ added in v6.8.5 

func (f CCRFollow) WithOpaqueID(s string) func(*CCRFollowRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CCRFollow) WithPretty ¶ added in v6.8.2 

func (f CCRFollow) WithPretty() func(*CCRFollowRequest)

WithPretty makes the response body pretty-printed.

func (CCRFollow) WithWaitForActiveShards ¶ added in v6.8.2 

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 ¶ added in v6.8.2 

type CCRFollowInfo func(o ...func(*CCRFollowInfoRequest)) (*Response, error)

CCRFollowInfo - https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html

func (CCRFollowInfo) WithContext ¶ added in v6.8.2 

func (f CCRFollowInfo) WithContext(v context.Context) func(*CCRFollowInfoRequest)

WithContext sets the request context.

func (CCRFollowInfo) WithErrorTrace ¶ added in v6.8.2 

func (f CCRFollowInfo) WithErrorTrace() func(*CCRFollowInfoRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CCRFollowInfo) WithFilterPath ¶ added in v6.8.2 

func (f CCRFollowInfo) WithFilterPath(v ...string) func(*CCRFollowInfoRequest)

WithFilterPath filters the properties of the response body.

func (CCRFollowInfo) WithHeader ¶ added in v6.8.2 

func (f CCRFollowInfo) WithHeader(h map[string]string) func(*CCRFollowInfoRequest)

WithHeader adds the headers to the HTTP request.

func (CCRFollowInfo) WithHuman ¶ added in v6.8.2 

func (f CCRFollowInfo) WithHuman() func(*CCRFollowInfoRequest)

WithHuman makes statistical values human-readable.

func (CCRFollowInfo) WithIndex ¶ added in v6.8.2 

func (f CCRFollowInfo) WithIndex(v ...string) func(*CCRFollowInfoRequest)

WithIndex - a list of index patterns; use `_all` to perform the operation on all indices.

func (CCRFollowInfo) WithOpaqueID ¶ added in v6.8.5 

func (f CCRFollowInfo) WithOpaqueID(s string) func(*CCRFollowInfoRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CCRFollowInfo) WithPretty ¶ added in v6.8.2 

func (f CCRFollowInfo) WithPretty() func(*CCRFollowInfoRequest)

WithPretty makes the response body pretty-printed.

type CCRFollowInfoRequest ¶ added in v6.8.2 

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.

func (CCRFollowInfoRequest) Do ¶ added in v6.8.2 

func (r CCRFollowInfoRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CCRFollowRequest ¶ added in v6.8.2 

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.

func (CCRFollowRequest) Do ¶ added in v6.8.2 

func (r CCRFollowRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CCRFollowStats ¶ added in v6.8.2 

type CCRFollowStats func(o ...func(*CCRFollowStatsRequest)) (*Response, error)

CCRFollowStats - https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html

func (CCRFollowStats) WithContext ¶ added in v6.8.2 

func (f CCRFollowStats) WithContext(v context.Context) func(*CCRFollowStatsRequest)

WithContext sets the request context.

func (CCRFollowStats) WithErrorTrace ¶ added in v6.8.2 

func (f CCRFollowStats) WithErrorTrace() func(*CCRFollowStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CCRFollowStats) WithFilterPath ¶ added in v6.8.2 

func (f CCRFollowStats) WithFilterPath(v ...string) func(*CCRFollowStatsRequest)

WithFilterPath filters the properties of the response body.

func (CCRFollowStats) WithHeader ¶ added in v6.8.2 

func (f CCRFollowStats) WithHeader(h map[string]string) func(*CCRFollowStatsRequest)

WithHeader adds the headers to the HTTP request.

func (CCRFollowStats) WithHuman ¶ added in v6.8.2 

func (f CCRFollowStats) WithHuman() func(*CCRFollowStatsRequest)

WithHuman makes statistical values human-readable.

func (CCRFollowStats) WithIndex ¶ added in v6.8.2 

func (f CCRFollowStats) WithIndex(v ...string) func(*CCRFollowStatsRequest)

WithIndex - a list of index patterns; use `_all` to perform the operation on all indices.

func (CCRFollowStats) WithOpaqueID ¶ added in v6.8.5 

func (f CCRFollowStats) WithOpaqueID(s string) func(*CCRFollowStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CCRFollowStats) WithPretty ¶ added in v6.8.2 

func (f CCRFollowStats) WithPretty() func(*CCRFollowStatsRequest)

WithPretty makes the response body pretty-printed.

type CCRFollowStatsRequest ¶ added in v6.8.2 

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.

func (CCRFollowStatsRequest) Do ¶ added in v6.8.2 

func (r CCRFollowStatsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CCRForgetFollower ¶ added in v6.8.2 

type CCRForgetFollower func(index string, body io.Reader, o ...func(*CCRForgetFollowerRequest)) (*Response, error)

CCRForgetFollower - http://www.elastic.co/guide/en/elasticsearch/reference/current

func (CCRForgetFollower) WithContext ¶ added in v6.8.2 

func (f CCRForgetFollower) WithContext(v context.Context) func(*CCRForgetFollowerRequest)

WithContext sets the request context.

func (CCRForgetFollower) WithErrorTrace ¶ added in v6.8.2 

func (f CCRForgetFollower) WithErrorTrace() func(*CCRForgetFollowerRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CCRForgetFollower) WithFilterPath ¶ added in v6.8.2 

func (f CCRForgetFollower) WithFilterPath(v ...string) func(*CCRForgetFollowerRequest)

WithFilterPath filters the properties of the response body.

func (CCRForgetFollower) WithHeader ¶ added in v6.8.2 

func (f CCRForgetFollower) WithHeader(h map[string]string) func(*CCRForgetFollowerRequest)

WithHeader adds the headers to the HTTP request.

func (CCRForgetFollower) WithHuman ¶ added in v6.8.2 

func (f CCRForgetFollower) WithHuman() func(*CCRForgetFollowerRequest)

WithHuman makes statistical values human-readable.

func (CCRForgetFollower) WithOpaqueID ¶ added in v6.8.5 

func (f CCRForgetFollower) WithOpaqueID(s string) func(*CCRForgetFollowerRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CCRForgetFollower) WithPretty ¶ added in v6.8.2 

func (f CCRForgetFollower) WithPretty() func(*CCRForgetFollowerRequest)

WithPretty makes the response body pretty-printed.

type CCRForgetFollowerRequest ¶ added in v6.8.2 

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.

func (CCRForgetFollowerRequest) Do ¶ added in v6.8.2 

func (r CCRForgetFollowerRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CCRGetAutoFollowPattern ¶ added in v6.8.2 

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 (CCRGetAutoFollowPattern) WithContext ¶ added in v6.8.2 

func (f CCRGetAutoFollowPattern) WithContext(v context.Context) func(*CCRGetAutoFollowPatternRequest)

WithContext sets the request context.

func (CCRGetAutoFollowPattern) WithErrorTrace ¶ added in v6.8.2 

func (f CCRGetAutoFollowPattern) WithErrorTrace() func(*CCRGetAutoFollowPatternRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CCRGetAutoFollowPattern) WithFilterPath ¶ added in v6.8.2 

func (f CCRGetAutoFollowPattern) WithFilterPath(v ...string) func(*CCRGetAutoFollowPatternRequest)

WithFilterPath filters the properties of the response body.

func (CCRGetAutoFollowPattern) WithHeader ¶ added in v6.8.2 

func (f CCRGetAutoFollowPattern) WithHeader(h map[string]string) func(*CCRGetAutoFollowPatternRequest)

WithHeader adds the headers to the HTTP request.

func (CCRGetAutoFollowPattern) WithHuman ¶ added in v6.8.2 

func (f CCRGetAutoFollowPattern) WithHuman() func(*CCRGetAutoFollowPatternRequest)

WithHuman makes statistical values human-readable.

func (CCRGetAutoFollowPattern) WithName ¶ added in v6.8.2 

func (f CCRGetAutoFollowPattern) WithName(v string) func(*CCRGetAutoFollowPatternRequest)

WithName - the name of the auto follow pattern..

func (CCRGetAutoFollowPattern) WithOpaqueID ¶ added in v6.8.5 

func (f CCRGetAutoFollowPattern) WithOpaqueID(s string) func(*CCRGetAutoFollowPatternRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CCRGetAutoFollowPattern) WithPretty ¶ added in v6.8.2 

func (f CCRGetAutoFollowPattern) WithPretty() func(*CCRGetAutoFollowPatternRequest)

WithPretty makes the response body pretty-printed.

type CCRGetAutoFollowPatternRequest ¶ added in v6.8.2 

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 (CCRGetAutoFollowPatternRequest) Do ¶ added in v6.8.2 

func (r CCRGetAutoFollowPatternRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CCRPauseFollow ¶ added in v6.8.2 

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 (CCRPauseFollow) WithContext ¶ added in v6.8.2 

func (f CCRPauseFollow) WithContext(v context.Context) func(*CCRPauseFollowRequest)

WithContext sets the request context.

func (CCRPauseFollow) WithErrorTrace ¶ added in v6.8.2 

func (f CCRPauseFollow) WithErrorTrace() func(*CCRPauseFollowRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CCRPauseFollow) WithFilterPath ¶ added in v6.8.2 

func (f CCRPauseFollow) WithFilterPath(v ...string) func(*CCRPauseFollowRequest)

WithFilterPath filters the properties of the response body.

func (CCRPauseFollow) WithHeader ¶ added in v6.8.2 

func (f CCRPauseFollow) WithHeader(h map[string]string) func(*CCRPauseFollowRequest)

WithHeader adds the headers to the HTTP request.

func (CCRPauseFollow) WithHuman ¶ added in v6.8.2 

func (f CCRPauseFollow) WithHuman() func(*CCRPauseFollowRequest)

WithHuman makes statistical values human-readable.

func (CCRPauseFollow) WithOpaqueID ¶ added in v6.8.5 

func (f CCRPauseFollow) WithOpaqueID(s string) func(*CCRPauseFollowRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CCRPauseFollow) WithPretty ¶ added in v6.8.2 

func (f CCRPauseFollow) WithPretty() func(*CCRPauseFollowRequest)

WithPretty makes the response body pretty-printed.

type CCRPauseFollowRequest ¶ added in v6.8.2 

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.

func (CCRPauseFollowRequest) Do ¶ added in v6.8.2 

func (r CCRPauseFollowRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CCRPutAutoFollowPattern ¶ added in v6.8.2 

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 (CCRPutAutoFollowPattern) WithContext ¶ added in v6.8.2 

func (f CCRPutAutoFollowPattern) WithContext(v context.Context) func(*CCRPutAutoFollowPatternRequest)

WithContext sets the request context.

func (CCRPutAutoFollowPattern) WithErrorTrace ¶ added in v6.8.2 

func (f CCRPutAutoFollowPattern) WithErrorTrace() func(*CCRPutAutoFollowPatternRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CCRPutAutoFollowPattern) WithFilterPath ¶ added in v6.8.2 

func (f CCRPutAutoFollowPattern) WithFilterPath(v ...string) func(*CCRPutAutoFollowPatternRequest)

WithFilterPath filters the properties of the response body.

func (CCRPutAutoFollowPattern) WithHeader ¶ added in v6.8.2 

func (f CCRPutAutoFollowPattern) WithHeader(h map[string]string) func(*CCRPutAutoFollowPatternRequest)

WithHeader adds the headers to the HTTP request.

func (CCRPutAutoFollowPattern) WithHuman ¶ added in v6.8.2 

func (f CCRPutAutoFollowPattern) WithHuman() func(*CCRPutAutoFollowPatternRequest)

WithHuman makes statistical values human-readable.

func (CCRPutAutoFollowPattern) WithOpaqueID ¶ added in v6.8.5 

func (f CCRPutAutoFollowPattern) WithOpaqueID(s string) func(*CCRPutAutoFollowPatternRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CCRPutAutoFollowPattern) WithPretty ¶ added in v6.8.2 

func (f CCRPutAutoFollowPattern) WithPretty() func(*CCRPutAutoFollowPatternRequest)

WithPretty makes the response body pretty-printed.

type CCRPutAutoFollowPatternRequest ¶ added in v6.8.2 

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 (CCRPutAutoFollowPatternRequest) Do ¶ added in v6.8.2 

func (r CCRPutAutoFollowPatternRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CCRResumeFollow ¶ added in v6.8.2 

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 (CCRResumeFollow) WithBody ¶ added in v6.8.2 

func (f CCRResumeFollow) WithBody(v io.Reader) func(*CCRResumeFollowRequest)

WithBody - The name of the leader index and other optional ccr related parameters.

func (CCRResumeFollow) WithContext ¶ added in v6.8.2 

func (f CCRResumeFollow) WithContext(v context.Context) func(*CCRResumeFollowRequest)

WithContext sets the request context.

func (CCRResumeFollow) WithErrorTrace ¶ added in v6.8.2 

func (f CCRResumeFollow) WithErrorTrace() func(*CCRResumeFollowRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CCRResumeFollow) WithFilterPath ¶ added in v6.8.2 

func (f CCRResumeFollow) WithFilterPath(v ...string) func(*CCRResumeFollowRequest)

WithFilterPath filters the properties of the response body.

func (CCRResumeFollow) WithHeader ¶ added in v6.8.2 

func (f CCRResumeFollow) WithHeader(h map[string]string) func(*CCRResumeFollowRequest)

WithHeader adds the headers to the HTTP request.

func (CCRResumeFollow) WithHuman ¶ added in v6.8.2 

func (f CCRResumeFollow) WithHuman() func(*CCRResumeFollowRequest)

WithHuman makes statistical values human-readable.

func (CCRResumeFollow) WithOpaqueID ¶ added in v6.8.5 

func (f CCRResumeFollow) WithOpaqueID(s string) func(*CCRResumeFollowRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CCRResumeFollow) WithPretty ¶ added in v6.8.2 

func (f CCRResumeFollow) WithPretty() func(*CCRResumeFollowRequest)

WithPretty makes the response body pretty-printed.

type CCRResumeFollowRequest ¶ added in v6.8.2 

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.

func (CCRResumeFollowRequest) Do ¶ added in v6.8.2 

func (r CCRResumeFollowRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CCRStats ¶ added in v6.8.2 

type CCRStats func(o ...func(*CCRStatsRequest)) (*Response, error)

CCRStats - https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html

func (CCRStats) WithContext ¶ added in v6.8.2 

func (f CCRStats) WithContext(v context.Context) func(*CCRStatsRequest)

WithContext sets the request context.

func (CCRStats) WithErrorTrace ¶ added in v6.8.2 

func (f CCRStats) WithErrorTrace() func(*CCRStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CCRStats) WithFilterPath ¶ added in v6.8.2 

func (f CCRStats) WithFilterPath(v ...string) func(*CCRStatsRequest)

WithFilterPath filters the properties of the response body.

func (CCRStats) WithHeader ¶ added in v6.8.2 

func (f CCRStats) WithHeader(h map[string]string) func(*CCRStatsRequest)

WithHeader adds the headers to the HTTP request.

func (CCRStats) WithHuman ¶ added in v6.8.2 

func (f CCRStats) WithHuman() func(*CCRStatsRequest)

WithHuman makes statistical values human-readable.

func (CCRStats) WithOpaqueID ¶ added in v6.8.5 

func (f CCRStats) WithOpaqueID(s string) func(*CCRStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CCRStats) WithPretty ¶ added in v6.8.2 

func (f CCRStats) WithPretty() func(*CCRStatsRequest)

WithPretty makes the response body pretty-printed.

type CCRStatsRequest ¶ added in v6.8.2 

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.

func (CCRStatsRequest) Do ¶ added in v6.8.2 

func (r CCRStatsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CCRUnfollow ¶ added in v6.8.2 

type CCRUnfollow func(index string, o ...func(*CCRUnfollowRequest)) (*Response, error)

CCRUnfollow - http://www.elastic.co/guide/en/elasticsearch/reference/current

func (CCRUnfollow) WithContext ¶ added in v6.8.2 

func (f CCRUnfollow) WithContext(v context.Context) func(*CCRUnfollowRequest)

WithContext sets the request context.

func (CCRUnfollow) WithErrorTrace ¶ added in v6.8.2 

func (f CCRUnfollow) WithErrorTrace() func(*CCRUnfollowRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CCRUnfollow) WithFilterPath ¶ added in v6.8.2 

func (f CCRUnfollow) WithFilterPath(v ...string) func(*CCRUnfollowRequest)

WithFilterPath filters the properties of the response body.

func (CCRUnfollow) WithHeader ¶ added in v6.8.2 

func (f CCRUnfollow) WithHeader(h map[string]string) func(*CCRUnfollowRequest)

WithHeader adds the headers to the HTTP request.

func (CCRUnfollow) WithHuman ¶ added in v6.8.2 

func (f CCRUnfollow) WithHuman() func(*CCRUnfollowRequest)

WithHuman makes statistical values human-readable.

func (CCRUnfollow) WithOpaqueID ¶ added in v6.8.5 

func (f CCRUnfollow) WithOpaqueID(s string) func(*CCRUnfollowRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CCRUnfollow) WithPretty ¶ added in v6.8.2 

func (f CCRUnfollow) WithPretty() func(*CCRUnfollowRequest)

WithPretty makes the response body pretty-printed.

type CCRUnfollowRequest ¶ added in v6.8.2 

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.

func (CCRUnfollowRequest) Do ¶ added in v6.8.2 

func (r CCRUnfollowRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Cat ¶ 

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 ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html.

func (CatAliases) WithContext ¶ 

func (f CatAliases) WithContext(v context.Context) func(*CatAliasesRequest)

WithContext sets the request context.

func (CatAliases) WithErrorTrace ¶ 

func (f CatAliases) WithErrorTrace() func(*CatAliasesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatAliases) WithFilterPath ¶ 

func (f CatAliases) WithFilterPath(v ...string) func(*CatAliasesRequest)

WithFilterPath filters the properties of the response body.

func (CatAliases) WithFormat ¶ 

func (f CatAliases) WithFormat(v string) func(*CatAliasesRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatAliases) WithH ¶ 

func (f CatAliases) WithH(v ...string) func(*CatAliasesRequest)

WithH - comma-separated list of column names to display.

func (CatAliases) WithHeader ¶ added in v6.8.2 

func (f CatAliases) WithHeader(h map[string]string) func(*CatAliasesRequest)

WithHeader adds the headers to the HTTP request.

func (CatAliases) WithHelp ¶ 

func (f CatAliases) WithHelp(v bool) func(*CatAliasesRequest)

WithHelp - return help information.

func (CatAliases) WithHuman ¶ 

func (f CatAliases) WithHuman() func(*CatAliasesRequest)

WithHuman makes statistical values human-readable.

func (CatAliases) WithLocal ¶ 

func (f CatAliases) WithLocal(v bool) func(*CatAliasesRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (CatAliases) WithMasterTimeout ¶ 

func (f CatAliases) WithMasterTimeout(v time.Duration) func(*CatAliasesRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatAliases) WithName ¶ 

func (f CatAliases) WithName(v ...string) func(*CatAliasesRequest)

WithName - a list of alias names to return.

func (CatAliases) WithOpaqueID ¶ added in v6.8.5 

func (f CatAliases) WithOpaqueID(s string) func(*CatAliasesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatAliases) WithPretty ¶ 

func (f CatAliases) WithPretty() func(*CatAliasesRequest)

WithPretty makes the response body pretty-printed.

func (CatAliases) WithS ¶ 

func (f CatAliases) WithS(v ...string) func(*CatAliasesRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatAliases) WithV ¶ 

func (f CatAliases) WithV(v bool) func(*CatAliasesRequest)

WithV - verbose mode. display column headers.

type CatAliasesRequest ¶ 

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.

func (CatAliasesRequest) Do ¶ 

func (r CatAliasesRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatAllocation ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html.

func (CatAllocation) WithBytes ¶ 

func (f CatAllocation) WithBytes(v string) func(*CatAllocationRequest)

WithBytes - the unit in which to display byte values.

func (CatAllocation) WithContext ¶ 

func (f CatAllocation) WithContext(v context.Context) func(*CatAllocationRequest)

WithContext sets the request context.

func (CatAllocation) WithErrorTrace ¶ 

func (f CatAllocation) WithErrorTrace() func(*CatAllocationRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatAllocation) WithFilterPath ¶ 

func (f CatAllocation) WithFilterPath(v ...string) func(*CatAllocationRequest)

WithFilterPath filters the properties of the response body.

func (CatAllocation) WithFormat ¶ 

func (f CatAllocation) WithFormat(v string) func(*CatAllocationRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatAllocation) WithH ¶ 

func (f CatAllocation) WithH(v ...string) func(*CatAllocationRequest)

WithH - comma-separated list of column names to display.

func (CatAllocation) WithHeader ¶ added in v6.8.2 

func (f CatAllocation) WithHeader(h map[string]string) func(*CatAllocationRequest)

WithHeader adds the headers to the HTTP request.

func (CatAllocation) WithHelp ¶ 

func (f CatAllocation) WithHelp(v bool) func(*CatAllocationRequest)

WithHelp - return help information.

func (CatAllocation) WithHuman ¶ 

func (f CatAllocation) WithHuman() func(*CatAllocationRequest)

WithHuman makes statistical values human-readable.

func (CatAllocation) WithLocal ¶ 

func (f CatAllocation) WithLocal(v bool) func(*CatAllocationRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (CatAllocation) WithMasterTimeout ¶ 

func (f CatAllocation) WithMasterTimeout(v time.Duration) func(*CatAllocationRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatAllocation) WithNodeID ¶ 

func (f CatAllocation) WithNodeID(v ...string) func(*CatAllocationRequest)

WithNodeID - a list of node ids or names to limit the returned information.

func (CatAllocation) WithOpaqueID ¶ added in v6.8.5 

func (f CatAllocation) WithOpaqueID(s string) func(*CatAllocationRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatAllocation) WithPretty ¶ 

func (f CatAllocation) WithPretty() func(*CatAllocationRequest)

WithPretty makes the response body pretty-printed.

func (CatAllocation) WithS ¶ 

func (f CatAllocation) WithS(v ...string) func(*CatAllocationRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatAllocation) WithV ¶ 

func (f CatAllocation) WithV(v bool) func(*CatAllocationRequest)

WithV - verbose mode. display column headers.

type CatAllocationRequest ¶ 

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.

func (CatAllocationRequest) Do ¶ 

func (r CatAllocationRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatCount ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html.

func (CatCount) WithContext ¶ 

func (f CatCount) WithContext(v context.Context) func(*CatCountRequest)

WithContext sets the request context.

func (CatCount) WithErrorTrace ¶ 

func (f CatCount) WithErrorTrace() func(*CatCountRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatCount) WithFilterPath ¶ 

func (f CatCount) WithFilterPath(v ...string) func(*CatCountRequest)

WithFilterPath filters the properties of the response body.

func (CatCount) WithFormat ¶ 

func (f CatCount) WithFormat(v string) func(*CatCountRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatCount) WithH ¶ 

func (f CatCount) WithH(v ...string) func(*CatCountRequest)

WithH - comma-separated list of column names to display.

func (CatCount) WithHeader ¶ added in v6.8.2 

func (f CatCount) WithHeader(h map[string]string) func(*CatCountRequest)

WithHeader adds the headers to the HTTP request.

func (CatCount) WithHelp ¶ 

func (f CatCount) WithHelp(v bool) func(*CatCountRequest)

WithHelp - return help information.

func (CatCount) WithHuman ¶ 

func (f CatCount) WithHuman() func(*CatCountRequest)

WithHuman makes statistical values human-readable.

func (CatCount) WithIndex ¶ 

func (f CatCount) WithIndex(v ...string) func(*CatCountRequest)

WithIndex - a list of index names to limit the returned information.

func (CatCount) WithLocal ¶ 

func (f CatCount) WithLocal(v bool) func(*CatCountRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (CatCount) WithMasterTimeout ¶ 

func (f CatCount) WithMasterTimeout(v time.Duration) func(*CatCountRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatCount) WithOpaqueID ¶ added in v6.8.5 

func (f CatCount) WithOpaqueID(s string) func(*CatCountRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatCount) WithPretty ¶ 

func (f CatCount) WithPretty() func(*CatCountRequest)

WithPretty makes the response body pretty-printed.

func (CatCount) WithS ¶ 

func (f CatCount) WithS(v ...string) func(*CatCountRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatCount) WithV ¶ 

func (f CatCount) WithV(v bool) func(*CatCountRequest)

WithV - verbose mode. display column headers.

type CatCountRequest ¶ 

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.

func (CatCountRequest) Do ¶ 

func (r CatCountRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatFielddata ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html.

func (CatFielddata) WithBytes ¶ 

func (f CatFielddata) WithBytes(v string) func(*CatFielddataRequest)

WithBytes - the unit in which to display byte values.

func (CatFielddata) WithContext ¶ 

func (f CatFielddata) WithContext(v context.Context) func(*CatFielddataRequest)

WithContext sets the request context.

func (CatFielddata) WithErrorTrace ¶ 

func (f CatFielddata) WithErrorTrace() func(*CatFielddataRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatFielddata) WithFields ¶ 

func (f CatFielddata) WithFields(v ...string) func(*CatFielddataRequest)

WithFields - a list of fields to return the fielddata size.

func (CatFielddata) WithFilterPath ¶ 

func (f CatFielddata) WithFilterPath(v ...string) func(*CatFielddataRequest)

WithFilterPath filters the properties of the response body.

func (CatFielddata) WithFormat ¶ 

func (f CatFielddata) WithFormat(v string) func(*CatFielddataRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatFielddata) WithH ¶ 

func (f CatFielddata) WithH(v ...string) func(*CatFielddataRequest)

WithH - comma-separated list of column names to display.

func (CatFielddata) WithHeader ¶ added in v6.8.2 

func (f CatFielddata) WithHeader(h map[string]string) func(*CatFielddataRequest)

WithHeader adds the headers to the HTTP request.

func (CatFielddata) WithHelp ¶ 

func (f CatFielddata) WithHelp(v bool) func(*CatFielddataRequest)

WithHelp - return help information.

func (CatFielddata) WithHuman ¶ 

func (f CatFielddata) WithHuman() func(*CatFielddataRequest)

WithHuman makes statistical values human-readable.

func (CatFielddata) WithLocal ¶ 

func (f CatFielddata) WithLocal(v bool) func(*CatFielddataRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (CatFielddata) WithMasterTimeout ¶ 

func (f CatFielddata) WithMasterTimeout(v time.Duration) func(*CatFielddataRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatFielddata) WithOpaqueID ¶ added in v6.8.5 

func (f CatFielddata) WithOpaqueID(s string) func(*CatFielddataRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatFielddata) WithPretty ¶ 

func (f CatFielddata) WithPretty() func(*CatFielddataRequest)

WithPretty makes the response body pretty-printed.

func (CatFielddata) WithS ¶ 

func (f CatFielddata) WithS(v ...string) func(*CatFielddataRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatFielddata) WithV ¶ 

func (f CatFielddata) WithV(v bool) func(*CatFielddataRequest)

WithV - verbose mode. display column headers.

type CatFielddataRequest ¶ 

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.

func (CatFielddataRequest) Do ¶ 

func (r CatFielddataRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatHealth ¶ 

type CatHealth func(o ...func(*CatHealthRequest)) (*Response, error)

CatHealth returns a concise representation of the cluster health.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html.

func (CatHealth) WithContext ¶ 

func (f CatHealth) WithContext(v context.Context) func(*CatHealthRequest)

WithContext sets the request context.

func (CatHealth) WithErrorTrace ¶ 

func (f CatHealth) WithErrorTrace() func(*CatHealthRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatHealth) WithFilterPath ¶ 

func (f CatHealth) WithFilterPath(v ...string) func(*CatHealthRequest)

WithFilterPath filters the properties of the response body.

func (CatHealth) WithFormat ¶ 

func (f CatHealth) WithFormat(v string) func(*CatHealthRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatHealth) WithH ¶ 

func (f CatHealth) WithH(v ...string) func(*CatHealthRequest)

WithH - comma-separated list of column names to display.

func (CatHealth) WithHeader ¶ added in v6.8.2 

func (f CatHealth) WithHeader(h map[string]string) func(*CatHealthRequest)

WithHeader adds the headers to the HTTP request.

func (CatHealth) WithHelp ¶ 

func (f CatHealth) WithHelp(v bool) func(*CatHealthRequest)

WithHelp - return help information.

func (CatHealth) WithHuman ¶ 

func (f CatHealth) WithHuman() func(*CatHealthRequest)

WithHuman makes statistical values human-readable.

func (CatHealth) WithLocal ¶ 

func (f CatHealth) WithLocal(v bool) func(*CatHealthRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (CatHealth) WithMasterTimeout ¶ 

func (f CatHealth) WithMasterTimeout(v time.Duration) func(*CatHealthRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatHealth) WithOpaqueID ¶ added in v6.8.5 

func (f CatHealth) WithOpaqueID(s string) func(*CatHealthRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatHealth) WithPretty ¶ 

func (f CatHealth) WithPretty() func(*CatHealthRequest)

WithPretty makes the response body pretty-printed.

func (CatHealth) WithS ¶ 

func (f CatHealth) WithS(v ...string) func(*CatHealthRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatHealth) WithTs ¶ 

func (f CatHealth) WithTs(v bool) func(*CatHealthRequest)

WithTs - set to false to disable timestamping.

func (CatHealth) WithV ¶ 

func (f CatHealth) WithV(v bool) func(*CatHealthRequest)

WithV - verbose mode. display column headers.

type CatHealthRequest ¶ 

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.

func (CatHealthRequest) Do ¶ 

func (r CatHealthRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatHelp ¶ 

type CatHelp func(o ...func(*CatHelpRequest)) (*Response, error)

CatHelp returns help for the Cat APIs.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html.

func (CatHelp) WithContext ¶ 

func (f CatHelp) WithContext(v context.Context) func(*CatHelpRequest)

WithContext sets the request context.

func (CatHelp) WithErrorTrace ¶ 

func (f CatHelp) WithErrorTrace() func(*CatHelpRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatHelp) WithFilterPath ¶ 

func (f CatHelp) WithFilterPath(v ...string) func(*CatHelpRequest)

WithFilterPath filters the properties of the response body.

func (CatHelp) WithHeader ¶ added in v6.8.2 

func (f CatHelp) WithHeader(h map[string]string) func(*CatHelpRequest)

WithHeader adds the headers to the HTTP request.

func (CatHelp) WithHelp ¶ 

func (f CatHelp) WithHelp(v bool) func(*CatHelpRequest)

WithHelp - return help information.

func (CatHelp) WithHuman ¶ 

func (f CatHelp) WithHuman() func(*CatHelpRequest)

WithHuman makes statistical values human-readable.

func (CatHelp) WithOpaqueID ¶ added in v6.8.5 

func (f CatHelp) WithOpaqueID(s string) func(*CatHelpRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatHelp) WithPretty ¶ 

func (f CatHelp) WithPretty() func(*CatHelpRequest)

WithPretty makes the response body pretty-printed.

func (CatHelp) WithS ¶ 

func (f CatHelp) WithS(v ...string) func(*CatHelpRequest)

WithS - comma-separated list of column names or column aliases to sort by.

type CatHelpRequest ¶ 

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.

func (CatHelpRequest) Do ¶ 

func (r CatHelpRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatIndices ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html.

func (CatIndices) WithBytes ¶ 

func (f CatIndices) WithBytes(v string) func(*CatIndicesRequest)

WithBytes - the unit in which to display byte values.

func (CatIndices) WithContext ¶ 

func (f CatIndices) WithContext(v context.Context) func(*CatIndicesRequest)

WithContext sets the request context.

func (CatIndices) WithErrorTrace ¶ 

func (f CatIndices) WithErrorTrace() func(*CatIndicesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatIndices) WithFilterPath ¶ 

func (f CatIndices) WithFilterPath(v ...string) func(*CatIndicesRequest)

WithFilterPath filters the properties of the response body.

func (CatIndices) WithFormat ¶ 

func (f CatIndices) WithFormat(v string) func(*CatIndicesRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatIndices) WithH ¶ 

func (f CatIndices) WithH(v ...string) func(*CatIndicesRequest)

WithH - comma-separated list of column names to display.

func (CatIndices) WithHeader ¶ added in v6.8.2 

func (f CatIndices) WithHeader(h map[string]string) func(*CatIndicesRequest)

WithHeader adds the headers to the HTTP request.

func (CatIndices) WithHealth ¶ 

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 (CatIndices) WithHelp ¶ 

func (f CatIndices) WithHelp(v bool) func(*CatIndicesRequest)

WithHelp - return help information.

func (CatIndices) WithHuman ¶ 

func (f CatIndices) WithHuman() func(*CatIndicesRequest)

WithHuman makes statistical values human-readable.

func (CatIndices) WithIndex ¶ 

func (f CatIndices) WithIndex(v ...string) func(*CatIndicesRequest)

WithIndex - a list of index names to limit the returned information.

func (CatIndices) WithLocal ¶ 

func (f CatIndices) WithLocal(v bool) func(*CatIndicesRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (CatIndices) WithMasterTimeout ¶ 

func (f CatIndices) WithMasterTimeout(v time.Duration) func(*CatIndicesRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatIndices) WithOpaqueID ¶ added in v6.8.5 

func (f CatIndices) WithOpaqueID(s string) func(*CatIndicesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatIndices) WithPretty ¶ 

func (f CatIndices) WithPretty() func(*CatIndicesRequest)

WithPretty makes the response body pretty-printed.

func (CatIndices) WithPri ¶ 

func (f CatIndices) WithPri(v bool) func(*CatIndicesRequest)

WithPri - set to true to return stats only for primary shards.

func (CatIndices) WithS ¶ 

func (f CatIndices) WithS(v ...string) func(*CatIndicesRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatIndices) WithV ¶ 

func (f CatIndices) WithV(v bool) func(*CatIndicesRequest)

WithV - verbose mode. display column headers.

type CatIndicesRequest ¶ 

type CatIndicesRequest struct {
	Index []string

	Bytes         string
	Format        string
	H             []string
	Health        string
	Help          *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.

func (CatIndicesRequest) Do ¶ 

func (r CatIndicesRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatMaster ¶ 

type CatMaster func(o ...func(*CatMasterRequest)) (*Response, error)

CatMaster returns information about the master node.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html.

func (CatMaster) WithContext ¶ 

func (f CatMaster) WithContext(v context.Context) func(*CatMasterRequest)

WithContext sets the request context.

func (CatMaster) WithErrorTrace ¶ 

func (f CatMaster) WithErrorTrace() func(*CatMasterRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatMaster) WithFilterPath ¶ 

func (f CatMaster) WithFilterPath(v ...string) func(*CatMasterRequest)

WithFilterPath filters the properties of the response body.

func (CatMaster) WithFormat ¶ 

func (f CatMaster) WithFormat(v string) func(*CatMasterRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatMaster) WithH ¶ 

func (f CatMaster) WithH(v ...string) func(*CatMasterRequest)

WithH - comma-separated list of column names to display.

func (CatMaster) WithHeader ¶ added in v6.8.2 

func (f CatMaster) WithHeader(h map[string]string) func(*CatMasterRequest)

WithHeader adds the headers to the HTTP request.

func (CatMaster) WithHelp ¶ 

func (f CatMaster) WithHelp(v bool) func(*CatMasterRequest)

WithHelp - return help information.

func (CatMaster) WithHuman ¶ 

func (f CatMaster) WithHuman() func(*CatMasterRequest)

WithHuman makes statistical values human-readable.

func (CatMaster) WithLocal ¶ 

func (f CatMaster) WithLocal(v bool) func(*CatMasterRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (CatMaster) WithMasterTimeout ¶ 

func (f CatMaster) WithMasterTimeout(v time.Duration) func(*CatMasterRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatMaster) WithOpaqueID ¶ added in v6.8.5 

func (f CatMaster) WithOpaqueID(s string) func(*CatMasterRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatMaster) WithPretty ¶ 

func (f CatMaster) WithPretty() func(*CatMasterRequest)

WithPretty makes the response body pretty-printed.

func (CatMaster) WithS ¶ 

func (f CatMaster) WithS(v ...string) func(*CatMasterRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatMaster) WithV ¶ 

func (f CatMaster) WithV(v bool) func(*CatMasterRequest)

WithV - verbose mode. display column headers.

type CatMasterRequest ¶ 

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.

func (CatMasterRequest) Do ¶ 

func (r CatMasterRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatNodeattrs ¶ 

type CatNodeattrs func(o ...func(*CatNodeattrsRequest)) (*Response, error)

CatNodeattrs returns information about custom node attributes.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html.

func (CatNodeattrs) WithContext ¶ 

func (f CatNodeattrs) WithContext(v context.Context) func(*CatNodeattrsRequest)

WithContext sets the request context.

func (CatNodeattrs) WithErrorTrace ¶ 

func (f CatNodeattrs) WithErrorTrace() func(*CatNodeattrsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatNodeattrs) WithFilterPath ¶ 

func (f CatNodeattrs) WithFilterPath(v ...string) func(*CatNodeattrsRequest)

WithFilterPath filters the properties of the response body.

func (CatNodeattrs) WithFormat ¶ 

func (f CatNodeattrs) WithFormat(v string) func(*CatNodeattrsRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatNodeattrs) WithH ¶ 

func (f CatNodeattrs) WithH(v ...string) func(*CatNodeattrsRequest)

WithH - comma-separated list of column names to display.

func (CatNodeattrs) WithHeader ¶ added in v6.8.2 

func (f CatNodeattrs) WithHeader(h map[string]string) func(*CatNodeattrsRequest)

WithHeader adds the headers to the HTTP request.

func (CatNodeattrs) WithHelp ¶ 

func (f CatNodeattrs) WithHelp(v bool) func(*CatNodeattrsRequest)

WithHelp - return help information.

func (CatNodeattrs) WithHuman ¶ 

func (f CatNodeattrs) WithHuman() func(*CatNodeattrsRequest)

WithHuman makes statistical values human-readable.

func (CatNodeattrs) WithLocal ¶ 

func (f CatNodeattrs) WithLocal(v bool) func(*CatNodeattrsRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (CatNodeattrs) WithMasterTimeout ¶ 

func (f CatNodeattrs) WithMasterTimeout(v time.Duration) func(*CatNodeattrsRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatNodeattrs) WithOpaqueID ¶ added in v6.8.5 

func (f CatNodeattrs) WithOpaqueID(s string) func(*CatNodeattrsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatNodeattrs) WithPretty ¶ 

func (f CatNodeattrs) WithPretty() func(*CatNodeattrsRequest)

WithPretty makes the response body pretty-printed.

func (CatNodeattrs) WithS ¶ 

func (f CatNodeattrs) WithS(v ...string) func(*CatNodeattrsRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatNodeattrs) WithV ¶ 

func (f CatNodeattrs) WithV(v bool) func(*CatNodeattrsRequest)

WithV - verbose mode. display column headers.

type CatNodeattrsRequest ¶ 

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.

func (CatNodeattrsRequest) Do ¶ 

func (r CatNodeattrsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatNodes ¶ 

type CatNodes func(o ...func(*CatNodesRequest)) (*Response, error)

CatNodes returns basic statistics about performance of cluster nodes.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html.

func (CatNodes) WithContext ¶ 

func (f CatNodes) WithContext(v context.Context) func(*CatNodesRequest)

WithContext sets the request context.

func (CatNodes) WithErrorTrace ¶ 

func (f CatNodes) WithErrorTrace() func(*CatNodesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatNodes) WithFilterPath ¶ 

func (f CatNodes) WithFilterPath(v ...string) func(*CatNodesRequest)

WithFilterPath filters the properties of the response body.

func (CatNodes) WithFormat ¶ 

func (f CatNodes) WithFormat(v string) func(*CatNodesRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatNodes) WithFullID ¶ 

func (f CatNodes) WithFullID(v bool) func(*CatNodesRequest)

WithFullID - return the full node ID instead of the shortened version (default: false).

func (CatNodes) WithH ¶ 

func (f CatNodes) WithH(v ...string) func(*CatNodesRequest)

WithH - comma-separated list of column names to display.

func (CatNodes) WithHeader ¶ added in v6.8.2 

func (f CatNodes) WithHeader(h map[string]string) func(*CatNodesRequest)

WithHeader adds the headers to the HTTP request.

func (CatNodes) WithHelp ¶ 

func (f CatNodes) WithHelp(v bool) func(*CatNodesRequest)

WithHelp - return help information.

func (CatNodes) WithHuman ¶ 

func (f CatNodes) WithHuman() func(*CatNodesRequest)

WithHuman makes statistical values human-readable.

func (CatNodes) WithLocal ¶ 

func (f CatNodes) WithLocal(v bool) func(*CatNodesRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (CatNodes) WithMasterTimeout ¶ 

func (f CatNodes) WithMasterTimeout(v time.Duration) func(*CatNodesRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatNodes) WithOpaqueID ¶ added in v6.8.5 

func (f CatNodes) WithOpaqueID(s string) func(*CatNodesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatNodes) WithPretty ¶ 

func (f CatNodes) WithPretty() func(*CatNodesRequest)

WithPretty makes the response body pretty-printed.

func (CatNodes) WithS ¶ 

func (f CatNodes) WithS(v ...string) func(*CatNodesRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatNodes) WithV ¶ 

func (f CatNodes) WithV(v bool) func(*CatNodesRequest)

WithV - verbose mode. display column headers.

type CatNodesRequest ¶ 

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.

func (CatNodesRequest) Do ¶ 

func (r CatNodesRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatPendingTasks ¶ 

type CatPendingTasks func(o ...func(*CatPendingTasksRequest)) (*Response, error)

CatPendingTasks returns a concise representation of the cluster pending tasks.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html.

func (CatPendingTasks) WithContext ¶ 

func (f CatPendingTasks) WithContext(v context.Context) func(*CatPendingTasksRequest)

WithContext sets the request context.

func (CatPendingTasks) WithErrorTrace ¶ 

func (f CatPendingTasks) WithErrorTrace() func(*CatPendingTasksRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatPendingTasks) WithFilterPath ¶ 

func (f CatPendingTasks) WithFilterPath(v ...string) func(*CatPendingTasksRequest)

WithFilterPath filters the properties of the response body.

func (CatPendingTasks) WithFormat ¶ 

func (f CatPendingTasks) WithFormat(v string) func(*CatPendingTasksRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatPendingTasks) WithH ¶ 

func (f CatPendingTasks) WithH(v ...string) func(*CatPendingTasksRequest)

WithH - comma-separated list of column names to display.

func (CatPendingTasks) WithHeader ¶ added in v6.8.2 

func (f CatPendingTasks) WithHeader(h map[string]string) func(*CatPendingTasksRequest)

WithHeader adds the headers to the HTTP request.

func (CatPendingTasks) WithHelp ¶ 

func (f CatPendingTasks) WithHelp(v bool) func(*CatPendingTasksRequest)

WithHelp - return help information.

func (CatPendingTasks) WithHuman ¶ 

func (f CatPendingTasks) WithHuman() func(*CatPendingTasksRequest)

WithHuman makes statistical values human-readable.

func (CatPendingTasks) WithLocal ¶ 

func (f CatPendingTasks) WithLocal(v bool) func(*CatPendingTasksRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (CatPendingTasks) WithMasterTimeout ¶ 

func (f CatPendingTasks) WithMasterTimeout(v time.Duration) func(*CatPendingTasksRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatPendingTasks) WithOpaqueID ¶ added in v6.8.5 

func (f CatPendingTasks) WithOpaqueID(s string) func(*CatPendingTasksRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatPendingTasks) WithPretty ¶ 

func (f CatPendingTasks) WithPretty() func(*CatPendingTasksRequest)

WithPretty makes the response body pretty-printed.

func (CatPendingTasks) WithS ¶ 

func (f CatPendingTasks) WithS(v ...string) func(*CatPendingTasksRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatPendingTasks) WithV ¶ 

func (f CatPendingTasks) WithV(v bool) func(*CatPendingTasksRequest)

WithV - verbose mode. display column headers.

type CatPendingTasksRequest ¶ 

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.

func (CatPendingTasksRequest) Do ¶ 

func (r CatPendingTasksRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatPlugins ¶ 

type CatPlugins func(o ...func(*CatPluginsRequest)) (*Response, error)

CatPlugins returns information about installed plugins across nodes node.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html.

func (CatPlugins) WithContext ¶ 

func (f CatPlugins) WithContext(v context.Context) func(*CatPluginsRequest)

WithContext sets the request context.

func (CatPlugins) WithErrorTrace ¶ 

func (f CatPlugins) WithErrorTrace() func(*CatPluginsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatPlugins) WithFilterPath ¶ 

func (f CatPlugins) WithFilterPath(v ...string) func(*CatPluginsRequest)

WithFilterPath filters the properties of the response body.

func (CatPlugins) WithFormat ¶ 

func (f CatPlugins) WithFormat(v string) func(*CatPluginsRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatPlugins) WithH ¶ 

func (f CatPlugins) WithH(v ...string) func(*CatPluginsRequest)

WithH - comma-separated list of column names to display.

func (CatPlugins) WithHeader ¶ added in v6.8.2 

func (f CatPlugins) WithHeader(h map[string]string) func(*CatPluginsRequest)

WithHeader adds the headers to the HTTP request.

func (CatPlugins) WithHelp ¶ 

func (f CatPlugins) WithHelp(v bool) func(*CatPluginsRequest)

WithHelp - return help information.

func (CatPlugins) WithHuman ¶ 

func (f CatPlugins) WithHuman() func(*CatPluginsRequest)

WithHuman makes statistical values human-readable.

func (CatPlugins) WithLocal ¶ 

func (f CatPlugins) WithLocal(v bool) func(*CatPluginsRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (CatPlugins) WithMasterTimeout ¶ 

func (f CatPlugins) WithMasterTimeout(v time.Duration) func(*CatPluginsRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatPlugins) WithOpaqueID ¶ added in v6.8.5 

func (f CatPlugins) WithOpaqueID(s string) func(*CatPluginsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatPlugins) WithPretty ¶ 

func (f CatPlugins) WithPretty() func(*CatPluginsRequest)

WithPretty makes the response body pretty-printed.

func (CatPlugins) WithS ¶ 

func (f CatPlugins) WithS(v ...string) func(*CatPluginsRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatPlugins) WithV ¶ 

func (f CatPlugins) WithV(v bool) func(*CatPluginsRequest)

WithV - verbose mode. display column headers.

type CatPluginsRequest ¶ 

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.

func (CatPluginsRequest) Do ¶ 

func (r CatPluginsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatRecovery ¶ 

type CatRecovery func(o ...func(*CatRecoveryRequest)) (*Response, error)

CatRecovery returns information about index shard recoveries, both on-going completed.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html.

func (CatRecovery) WithBytes ¶ 

func (f CatRecovery) WithBytes(v string) func(*CatRecoveryRequest)

WithBytes - the unit in which to display byte values.

func (CatRecovery) WithContext ¶ 

func (f CatRecovery) WithContext(v context.Context) func(*CatRecoveryRequest)

WithContext sets the request context.

func (CatRecovery) WithErrorTrace ¶ 

func (f CatRecovery) WithErrorTrace() func(*CatRecoveryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatRecovery) WithFilterPath ¶ 

func (f CatRecovery) WithFilterPath(v ...string) func(*CatRecoveryRequest)

WithFilterPath filters the properties of the response body.

func (CatRecovery) WithFormat ¶ 

func (f CatRecovery) WithFormat(v string) func(*CatRecoveryRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatRecovery) WithH ¶ 

func (f CatRecovery) WithH(v ...string) func(*CatRecoveryRequest)

WithH - comma-separated list of column names to display.

func (CatRecovery) WithHeader ¶ added in v6.8.2 

func (f CatRecovery) WithHeader(h map[string]string) func(*CatRecoveryRequest)

WithHeader adds the headers to the HTTP request.

func (CatRecovery) WithHelp ¶ 

func (f CatRecovery) WithHelp(v bool) func(*CatRecoveryRequest)

WithHelp - return help information.

func (CatRecovery) WithHuman ¶ 

func (f CatRecovery) WithHuman() func(*CatRecoveryRequest)

WithHuman makes statistical values human-readable.

func (CatRecovery) WithIndex ¶ 

func (f CatRecovery) WithIndex(v ...string) func(*CatRecoveryRequest)

WithIndex - a list of index names to limit the returned information.

func (CatRecovery) WithMasterTimeout ¶ 

func (f CatRecovery) WithMasterTimeout(v time.Duration) func(*CatRecoveryRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatRecovery) WithOpaqueID ¶ added in v6.8.5 

func (f CatRecovery) WithOpaqueID(s string) func(*CatRecoveryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatRecovery) WithPretty ¶ 

func (f CatRecovery) WithPretty() func(*CatRecoveryRequest)

WithPretty makes the response body pretty-printed.

func (CatRecovery) WithS ¶ 

func (f CatRecovery) WithS(v ...string) func(*CatRecoveryRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatRecovery) WithV ¶ 

func (f CatRecovery) WithV(v bool) func(*CatRecoveryRequest)

WithV - verbose mode. display column headers.

type CatRecoveryRequest ¶ 

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.

func (CatRecoveryRequest) Do ¶ 

func (r CatRecoveryRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatRepositories ¶ 

type CatRepositories func(o ...func(*CatRepositoriesRequest)) (*Response, error)

CatRepositories returns information about snapshot repositories registered in the cluster.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html.

func (CatRepositories) WithContext ¶ 

func (f CatRepositories) WithContext(v context.Context) func(*CatRepositoriesRequest)

WithContext sets the request context.

func (CatRepositories) WithErrorTrace ¶ 

func (f CatRepositories) WithErrorTrace() func(*CatRepositoriesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatRepositories) WithFilterPath ¶ 

func (f CatRepositories) WithFilterPath(v ...string) func(*CatRepositoriesRequest)

WithFilterPath filters the properties of the response body.

func (CatRepositories) WithFormat ¶ 

func (f CatRepositories) WithFormat(v string) func(*CatRepositoriesRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatRepositories) WithH ¶ 

func (f CatRepositories) WithH(v ...string) func(*CatRepositoriesRequest)

WithH - comma-separated list of column names to display.

func (CatRepositories) WithHeader ¶ added in v6.8.2 

func (f CatRepositories) WithHeader(h map[string]string) func(*CatRepositoriesRequest)

WithHeader adds the headers to the HTTP request.

func (CatRepositories) WithHelp ¶ 

func (f CatRepositories) WithHelp(v bool) func(*CatRepositoriesRequest)

WithHelp - return help information.

func (CatRepositories) WithHuman ¶ 

func (f CatRepositories) WithHuman() func(*CatRepositoriesRequest)

WithHuman makes statistical values human-readable.

func (CatRepositories) WithLocal ¶ 

func (f CatRepositories) WithLocal(v bool) func(*CatRepositoriesRequest)

WithLocal - return local information, do not retrieve the state from master node.

func (CatRepositories) WithMasterTimeout ¶ 

func (f CatRepositories) WithMasterTimeout(v time.Duration) func(*CatRepositoriesRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatRepositories) WithOpaqueID ¶ added in v6.8.5 

func (f CatRepositories) WithOpaqueID(s string) func(*CatRepositoriesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatRepositories) WithPretty ¶ 

func (f CatRepositories) WithPretty() func(*CatRepositoriesRequest)

WithPretty makes the response body pretty-printed.

func (CatRepositories) WithS ¶ 

func (f CatRepositories) WithS(v ...string) func(*CatRepositoriesRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatRepositories) WithV ¶ 

func (f CatRepositories) WithV(v bool) func(*CatRepositoriesRequest)

WithV - verbose mode. display column headers.

type CatRepositoriesRequest ¶ 

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.

func (CatRepositoriesRequest) Do ¶ 

func (r CatRepositoriesRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatSegments ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html.

func (CatSegments) WithBytes ¶ 

func (f CatSegments) WithBytes(v string) func(*CatSegmentsRequest)

WithBytes - the unit in which to display byte values.

func (CatSegments) WithContext ¶ 

func (f CatSegments) WithContext(v context.Context) func(*CatSegmentsRequest)

WithContext sets the request context.

func (CatSegments) WithErrorTrace ¶ 

func (f CatSegments) WithErrorTrace() func(*CatSegmentsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatSegments) WithFilterPath ¶ 

func (f CatSegments) WithFilterPath(v ...string) func(*CatSegmentsRequest)

WithFilterPath filters the properties of the response body.

func (CatSegments) WithFormat ¶ 

func (f CatSegments) WithFormat(v string) func(*CatSegmentsRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatSegments) WithH ¶ 

func (f CatSegments) WithH(v ...string) func(*CatSegmentsRequest)

WithH - comma-separated list of column names to display.

func (CatSegments) WithHeader ¶ added in v6.8.2 

func (f CatSegments) WithHeader(h map[string]string) func(*CatSegmentsRequest)

WithHeader adds the headers to the HTTP request.

func (CatSegments) WithHelp ¶ 

func (f CatSegments) WithHelp(v bool) func(*CatSegmentsRequest)

WithHelp - return help information.

func (CatSegments) WithHuman ¶ 

func (f CatSegments) WithHuman() func(*CatSegmentsRequest)

WithHuman makes statistical values human-readable.

func (CatSegments) WithIndex ¶ 

func (f CatSegments) WithIndex(v ...string) func(*CatSegmentsRequest)

WithIndex - a list of index names to limit the returned information.

func (CatSegments) WithOpaqueID ¶ added in v6.8.5 

func (f CatSegments) WithOpaqueID(s string) func(*CatSegmentsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatSegments) WithPretty ¶ 

func (f CatSegments) WithPretty() func(*CatSegmentsRequest)

WithPretty makes the response body pretty-printed.

func (CatSegments) WithS ¶ 

func (f CatSegments) WithS(v ...string) func(*CatSegmentsRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatSegments) WithV ¶ 

func (f CatSegments) WithV(v bool) func(*CatSegmentsRequest)

WithV - verbose mode. display column headers.

type CatSegmentsRequest ¶ 

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.

func (CatSegmentsRequest) Do ¶ 

func (r CatSegmentsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatShards ¶ 

type CatShards func(o ...func(*CatShardsRequest)) (*Response, error)

CatShards provides a detailed view of shard allocation on nodes.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html.

func (CatShards) WithBytes ¶ 

func (f CatShards) WithBytes(v string) func(*CatShardsRequest)

WithBytes - the unit in which to display byte values.

func (CatShards) WithContext ¶ 

func (f CatShards) WithContext(v context.Context) func(*CatShardsRequest)

WithContext sets the request context.

func (CatShards) WithErrorTrace ¶ 

func (f CatShards) WithErrorTrace() func(*CatShardsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatShards) WithFilterPath ¶ 

func (f CatShards) WithFilterPath(v ...string) func(*CatShardsRequest)

WithFilterPath filters the properties of the response body.

func (CatShards) WithFormat ¶ 

func (f CatShards) WithFormat(v string) func(*CatShardsRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatShards) WithH ¶ 

func (f CatShards) WithH(v ...string) func(*CatShardsRequest)

WithH - comma-separated list of column names to display.

func (CatShards) WithHeader ¶ added in v6.8.2 

func (f CatShards) WithHeader(h map[string]string) func(*CatShardsRequest)

WithHeader adds the headers to the HTTP request.

func (CatShards) WithHelp ¶ 

func (f CatShards) WithHelp(v bool) func(*CatShardsRequest)

WithHelp - return help information.

func (CatShards) WithHuman ¶ 

func (f CatShards) WithHuman() func(*CatShardsRequest)

WithHuman makes statistical values human-readable.

func (CatShards) WithIndex ¶ 

func (f CatShards) WithIndex(v ...string) func(*CatShardsRequest)

WithIndex - a list of index names to limit the returned information.

func (CatShards) WithLocal ¶ 

func (f CatShards) WithLocal(v bool) func(*CatShardsRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (CatShards) WithMasterTimeout ¶ 

func (f CatShards) WithMasterTimeout(v time.Duration) func(*CatShardsRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatShards) WithOpaqueID ¶ added in v6.8.5 

func (f CatShards) WithOpaqueID(s string) func(*CatShardsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatShards) WithPretty ¶ 

func (f CatShards) WithPretty() func(*CatShardsRequest)

WithPretty makes the response body pretty-printed.

func (CatShards) WithS ¶ 

func (f CatShards) WithS(v ...string) func(*CatShardsRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatShards) WithV ¶ 

func (f CatShards) WithV(v bool) func(*CatShardsRequest)

WithV - verbose mode. display column headers.

type CatShardsRequest ¶ 

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.

func (CatShardsRequest) Do ¶ 

func (r CatShardsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatSnapshots ¶ 

type CatSnapshots func(o ...func(*CatSnapshotsRequest)) (*Response, error)

CatSnapshots returns all snapshots in a specific repository.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html.

func (CatSnapshots) WithContext ¶ 

func (f CatSnapshots) WithContext(v context.Context) func(*CatSnapshotsRequest)

WithContext sets the request context.

func (CatSnapshots) WithErrorTrace ¶ 

func (f CatSnapshots) WithErrorTrace() func(*CatSnapshotsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatSnapshots) WithFilterPath ¶ 

func (f CatSnapshots) WithFilterPath(v ...string) func(*CatSnapshotsRequest)

WithFilterPath filters the properties of the response body.

func (CatSnapshots) WithFormat ¶ 

func (f CatSnapshots) WithFormat(v string) func(*CatSnapshotsRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatSnapshots) WithH ¶ 

func (f CatSnapshots) WithH(v ...string) func(*CatSnapshotsRequest)

WithH - comma-separated list of column names to display.

func (CatSnapshots) WithHeader ¶ added in v6.8.2 

func (f CatSnapshots) WithHeader(h map[string]string) func(*CatSnapshotsRequest)

WithHeader adds the headers to the HTTP request.

func (CatSnapshots) WithHelp ¶ 

func (f CatSnapshots) WithHelp(v bool) func(*CatSnapshotsRequest)

WithHelp - return help information.

func (CatSnapshots) WithHuman ¶ 

func (f CatSnapshots) WithHuman() func(*CatSnapshotsRequest)

WithHuman makes statistical values human-readable.

func (CatSnapshots) WithIgnoreUnavailable ¶ 

func (f CatSnapshots) WithIgnoreUnavailable(v bool) func(*CatSnapshotsRequest)

WithIgnoreUnavailable - set to true to ignore unavailable snapshots.

func (CatSnapshots) WithMasterTimeout ¶ 

func (f CatSnapshots) WithMasterTimeout(v time.Duration) func(*CatSnapshotsRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatSnapshots) WithOpaqueID ¶ added in v6.8.5 

func (f CatSnapshots) WithOpaqueID(s string) func(*CatSnapshotsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatSnapshots) WithPretty ¶ 

func (f CatSnapshots) WithPretty() func(*CatSnapshotsRequest)

WithPretty makes the response body pretty-printed.

func (CatSnapshots) WithRepository ¶ 

func (f CatSnapshots) WithRepository(v ...string) func(*CatSnapshotsRequest)

WithRepository - name of repository from which to fetch the snapshot information.

func (CatSnapshots) WithS ¶ 

func (f CatSnapshots) WithS(v ...string) func(*CatSnapshotsRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatSnapshots) WithV ¶ 

func (f CatSnapshots) WithV(v bool) func(*CatSnapshotsRequest)

WithV - verbose mode. display column headers.

type CatSnapshotsRequest ¶ 

type CatSnapshotsRequest struct {
	Repository []string

	Format            string
	H                 []string
	Help              *bool
	IgnoreUnavailable *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.

func (CatSnapshotsRequest) Do ¶ 

func (r CatSnapshotsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatTasks ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html.

func (CatTasks) WithActions ¶ 

func (f CatTasks) WithActions(v ...string) func(*CatTasksRequest)

WithActions - a list of actions that should be returned. leave empty to return all..

func (CatTasks) WithContext ¶ 

func (f CatTasks) WithContext(v context.Context) func(*CatTasksRequest)

WithContext sets the request context.

func (CatTasks) WithDetailed ¶ 

func (f CatTasks) WithDetailed(v bool) func(*CatTasksRequest)

WithDetailed - return detailed task information (default: false).

func (CatTasks) WithErrorTrace ¶ 

func (f CatTasks) WithErrorTrace() func(*CatTasksRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatTasks) WithFilterPath ¶ 

func (f CatTasks) WithFilterPath(v ...string) func(*CatTasksRequest)

WithFilterPath filters the properties of the response body.

func (CatTasks) WithFormat ¶ 

func (f CatTasks) WithFormat(v string) func(*CatTasksRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatTasks) WithH ¶ 

func (f CatTasks) WithH(v ...string) func(*CatTasksRequest)

WithH - comma-separated list of column names to display.

func (CatTasks) WithHeader ¶ added in v6.8.2 

func (f CatTasks) WithHeader(h map[string]string) func(*CatTasksRequest)

WithHeader adds the headers to the HTTP request.

func (CatTasks) WithHelp ¶ 

func (f CatTasks) WithHelp(v bool) func(*CatTasksRequest)

WithHelp - return help information.

func (CatTasks) WithHuman ¶ 

func (f CatTasks) WithHuman() func(*CatTasksRequest)

WithHuman makes statistical values human-readable.

func (CatTasks) WithNodeID ¶ 

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 (CatTasks) WithOpaqueID ¶ added in v6.8.5 

func (f CatTasks) WithOpaqueID(s string) func(*CatTasksRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatTasks) WithParentTask ¶ 

func (f CatTasks) WithParentTask(v int) func(*CatTasksRequest)

WithParentTask - return tasks with specified parent task ID. set to -1 to return all..

func (CatTasks) WithPretty ¶ 

func (f CatTasks) WithPretty() func(*CatTasksRequest)

WithPretty makes the response body pretty-printed.

func (CatTasks) WithS ¶ 

func (f CatTasks) WithS(v ...string) func(*CatTasksRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatTasks) WithV ¶ 

func (f CatTasks) WithV(v bool) func(*CatTasksRequest)

WithV - verbose mode. display column headers.

type CatTasksRequest ¶ 

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.

func (CatTasksRequest) Do ¶ 

func (r CatTasksRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatTemplates ¶ 

type CatTemplates func(o ...func(*CatTemplatesRequest)) (*Response, error)

CatTemplates returns information about existing templates.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html.

func (CatTemplates) WithContext ¶ 

func (f CatTemplates) WithContext(v context.Context) func(*CatTemplatesRequest)

WithContext sets the request context.

func (CatTemplates) WithErrorTrace ¶ 

func (f CatTemplates) WithErrorTrace() func(*CatTemplatesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatTemplates) WithFilterPath ¶ 

func (f CatTemplates) WithFilterPath(v ...string) func(*CatTemplatesRequest)

WithFilterPath filters the properties of the response body.

func (CatTemplates) WithFormat ¶ 

func (f CatTemplates) WithFormat(v string) func(*CatTemplatesRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatTemplates) WithH ¶ 

func (f CatTemplates) WithH(v ...string) func(*CatTemplatesRequest)

WithH - comma-separated list of column names to display.

func (CatTemplates) WithHeader ¶ added in v6.8.2 

func (f CatTemplates) WithHeader(h map[string]string) func(*CatTemplatesRequest)

WithHeader adds the headers to the HTTP request.

func (CatTemplates) WithHelp ¶ 

func (f CatTemplates) WithHelp(v bool) func(*CatTemplatesRequest)

WithHelp - return help information.

func (CatTemplates) WithHuman ¶ 

func (f CatTemplates) WithHuman() func(*CatTemplatesRequest)

WithHuman makes statistical values human-readable.

func (CatTemplates) WithLocal ¶ 

func (f CatTemplates) WithLocal(v bool) func(*CatTemplatesRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (CatTemplates) WithMasterTimeout ¶ 

func (f CatTemplates) WithMasterTimeout(v time.Duration) func(*CatTemplatesRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatTemplates) WithName ¶ 

func (f CatTemplates) WithName(v string) func(*CatTemplatesRequest)

WithName - a pattern that returned template names must match.

func (CatTemplates) WithOpaqueID ¶ added in v6.8.5 

func (f CatTemplates) WithOpaqueID(s string) func(*CatTemplatesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatTemplates) WithPretty ¶ 

func (f CatTemplates) WithPretty() func(*CatTemplatesRequest)

WithPretty makes the response body pretty-printed.

func (CatTemplates) WithS ¶ 

func (f CatTemplates) WithS(v ...string) func(*CatTemplatesRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatTemplates) WithV ¶ 

func (f CatTemplates) WithV(v bool) func(*CatTemplatesRequest)

WithV - verbose mode. display column headers.

type CatTemplatesRequest ¶ 

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.

func (CatTemplatesRequest) Do ¶ 

func (r CatTemplatesRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type CatThreadPool ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html.

func (CatThreadPool) WithContext ¶ 

func (f CatThreadPool) WithContext(v context.Context) func(*CatThreadPoolRequest)

WithContext sets the request context.

func (CatThreadPool) WithErrorTrace ¶ 

func (f CatThreadPool) WithErrorTrace() func(*CatThreadPoolRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (CatThreadPool) WithFilterPath ¶ 

func (f CatThreadPool) WithFilterPath(v ...string) func(*CatThreadPoolRequest)

WithFilterPath filters the properties of the response body.

func (CatThreadPool) WithFormat ¶ 

func (f CatThreadPool) WithFormat(v string) func(*CatThreadPoolRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (CatThreadPool) WithH ¶ 

func (f CatThreadPool) WithH(v ...string) func(*CatThreadPoolRequest)

WithH - comma-separated list of column names to display.

func (CatThreadPool) WithHeader ¶ added in v6.8.2 

func (f CatThreadPool) WithHeader(h map[string]string) func(*CatThreadPoolRequest)

WithHeader adds the headers to the HTTP request.

func (CatThreadPool) WithHelp ¶ 

func (f CatThreadPool) WithHelp(v bool) func(*CatThreadPoolRequest)

WithHelp - return help information.

func (CatThreadPool) WithHuman ¶ 

func (f CatThreadPool) WithHuman() func(*CatThreadPoolRequest)

WithHuman makes statistical values human-readable.

func (CatThreadPool) WithLocal ¶ 

func (f CatThreadPool) WithLocal(v bool) func(*CatThreadPoolRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (CatThreadPool) WithMasterTimeout ¶ 

func (f CatThreadPool) WithMasterTimeout(v time.Duration) func(*CatThreadPoolRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatThreadPool) WithOpaqueID ¶ added in v6.8.5 

func (f CatThreadPool) WithOpaqueID(s string) func(*CatThreadPoolRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (CatThreadPool) WithPretty ¶ 

func (f CatThreadPool) WithPretty() func(*CatThreadPoolRequest)

WithPretty makes the response body pretty-printed.

func (CatThreadPool) WithS ¶ 

func (f CatThreadPool) WithS(v ...string) func(*CatThreadPoolRequest)

WithS - comma-separated list of column names or column aliases to sort by.

func (CatThreadPool) WithSize ¶ 

func (f CatThreadPool) WithSize(v string) func(*CatThreadPoolRequest)

WithSize - the multiplier in which to display values.

func (CatThreadPool) WithThreadPoolPatterns ¶ 

func (f CatThreadPool) WithThreadPoolPatterns(v ...string) func(*CatThreadPoolRequest)

WithThreadPoolPatterns - a list of regular-expressions to filter the thread pools in the output.

func (CatThreadPool) WithV ¶ 

func (f CatThreadPool) WithV(v bool) func(*CatThreadPoolRequest)

WithV - verbose mode. display column headers.

type CatThreadPoolRequest ¶ 

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.

func (CatThreadPoolRequest) Do ¶ 

func (r CatThreadPoolRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ClearScroll ¶ 

type ClearScroll func(o ...func(*ClearScrollRequest)) (*Response, error)

ClearScroll explicitly clears the search context for a scroll.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html.

func (ClearScroll) WithBody ¶ 

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 (ClearScroll) WithContext ¶ 

func (f ClearScroll) WithContext(v context.Context) func(*ClearScrollRequest)

WithContext sets the request context.

func (ClearScroll) WithErrorTrace ¶ 

func (f ClearScroll) WithErrorTrace() func(*ClearScrollRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ClearScroll) WithFilterPath ¶ 

func (f ClearScroll) WithFilterPath(v ...string) func(*ClearScrollRequest)

WithFilterPath filters the properties of the response body.

func (ClearScroll) WithHeader ¶ added in v6.8.2 

func (f ClearScroll) WithHeader(h map[string]string) func(*ClearScrollRequest)

WithHeader adds the headers to the HTTP request.

func (ClearScroll) WithHuman ¶ 

func (f ClearScroll) WithHuman() func(*ClearScrollRequest)

WithHuman makes statistical values human-readable.

func (ClearScroll) WithOpaqueID ¶ added in v6.8.5 

func (f ClearScroll) WithOpaqueID(s string) func(*ClearScrollRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ClearScroll) WithPretty ¶ 

func (f ClearScroll) WithPretty() func(*ClearScrollRequest)

WithPretty makes the response body pretty-printed.

func (ClearScroll) WithScrollID ¶ 

func (f ClearScroll) WithScrollID(v ...string) func(*ClearScrollRequest)

WithScrollID - a list of scroll ids to clear.

type ClearScrollRequest ¶ 

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.

func (ClearScrollRequest) Do ¶ 

func (r ClearScrollRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Cluster ¶ 

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 ¶ 

type ClusterAllocationExplain func(o ...func(*ClusterAllocationExplainRequest)) (*Response, error)

ClusterAllocationExplain provides explanations for shard allocations in the cluster.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html.

func (ClusterAllocationExplain) WithBody ¶ 

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 (ClusterAllocationExplain) WithContext ¶ 

func (f ClusterAllocationExplain) WithContext(v context.Context) func(*ClusterAllocationExplainRequest)

WithContext sets the request context.

func (ClusterAllocationExplain) WithErrorTrace ¶ 

func (f ClusterAllocationExplain) WithErrorTrace() func(*ClusterAllocationExplainRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ClusterAllocationExplain) WithFilterPath ¶ 

func (f ClusterAllocationExplain) WithFilterPath(v ...string) func(*ClusterAllocationExplainRequest)

WithFilterPath filters the properties of the response body.

func (ClusterAllocationExplain) WithHeader ¶ added in v6.8.2 

func (f ClusterAllocationExplain) WithHeader(h map[string]string) func(*ClusterAllocationExplainRequest)

WithHeader adds the headers to the HTTP request.

func (ClusterAllocationExplain) WithHuman ¶ 

func (f ClusterAllocationExplain) WithHuman() func(*ClusterAllocationExplainRequest)

WithHuman makes statistical values human-readable.

func (ClusterAllocationExplain) WithIncludeDiskInfo ¶ 

func (f ClusterAllocationExplain) WithIncludeDiskInfo(v bool) func(*ClusterAllocationExplainRequest)

WithIncludeDiskInfo - return information about disk usage and shard sizes (default: false).

func (ClusterAllocationExplain) WithIncludeYesDecisions ¶ 

func (f ClusterAllocationExplain) WithIncludeYesDecisions(v bool) func(*ClusterAllocationExplainRequest)

WithIncludeYesDecisions - return 'yes' decisions in explanation (default: false).

func (ClusterAllocationExplain) WithOpaqueID ¶ added in v6.8.5 

func (f ClusterAllocationExplain) WithOpaqueID(s string) func(*ClusterAllocationExplainRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ClusterAllocationExplain) WithPretty ¶ 

func (f ClusterAllocationExplain) WithPretty() func(*ClusterAllocationExplainRequest)

WithPretty makes the response body pretty-printed.

type ClusterAllocationExplainRequest ¶ 

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 (ClusterAllocationExplainRequest) Do ¶ 

func (r ClusterAllocationExplainRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ClusterGetSettings ¶ 

type ClusterGetSettings func(o ...func(*ClusterGetSettingsRequest)) (*Response, error)

ClusterGetSettings returns cluster settings.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html.

func (ClusterGetSettings) WithContext ¶ 

func (f ClusterGetSettings) WithContext(v context.Context) func(*ClusterGetSettingsRequest)

WithContext sets the request context.

func (ClusterGetSettings) WithErrorTrace ¶ 

func (f ClusterGetSettings) WithErrorTrace() func(*ClusterGetSettingsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ClusterGetSettings) WithFilterPath ¶ 

func (f ClusterGetSettings) WithFilterPath(v ...string) func(*ClusterGetSettingsRequest)

WithFilterPath filters the properties of the response body.

func (ClusterGetSettings) WithFlatSettings ¶ 

func (f ClusterGetSettings) WithFlatSettings(v bool) func(*ClusterGetSettingsRequest)

WithFlatSettings - return settings in flat format (default: false).

func (ClusterGetSettings) WithHeader ¶ added in v6.8.2 

func (f ClusterGetSettings) WithHeader(h map[string]string) func(*ClusterGetSettingsRequest)

WithHeader adds the headers to the HTTP request.

func (ClusterGetSettings) WithHuman ¶ 

func (f ClusterGetSettings) WithHuman() func(*ClusterGetSettingsRequest)

WithHuman makes statistical values human-readable.

func (ClusterGetSettings) WithIncludeDefaults ¶ 

func (f ClusterGetSettings) WithIncludeDefaults(v bool) func(*ClusterGetSettingsRequest)

WithIncludeDefaults - whether to return all default clusters setting..

func (ClusterGetSettings) WithMasterTimeout ¶ 

func (f ClusterGetSettings) WithMasterTimeout(v time.Duration) func(*ClusterGetSettingsRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (ClusterGetSettings) WithOpaqueID ¶ added in v6.8.5 

func (f ClusterGetSettings) WithOpaqueID(s string) func(*ClusterGetSettingsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ClusterGetSettings) WithPretty ¶ 

func (f ClusterGetSettings) WithPretty() func(*ClusterGetSettingsRequest)

WithPretty makes the response body pretty-printed.

func (ClusterGetSettings) WithTimeout ¶ 

func (f ClusterGetSettings) WithTimeout(v time.Duration) func(*ClusterGetSettingsRequest)

WithTimeout - explicit operation timeout.

type ClusterGetSettingsRequest ¶ 

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.

func (ClusterGetSettingsRequest) Do ¶ 

func (r ClusterGetSettingsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ClusterHealth ¶ 

type ClusterHealth func(o ...func(*ClusterHealthRequest)) (*Response, error)

ClusterHealth returns basic information about the health of the cluster.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html.

func (ClusterHealth) WithContext ¶ 

func (f ClusterHealth) WithContext(v context.Context) func(*ClusterHealthRequest)

WithContext sets the request context.

func (ClusterHealth) WithErrorTrace ¶ 

func (f ClusterHealth) WithErrorTrace() func(*ClusterHealthRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ClusterHealth) WithFilterPath ¶ 

func (f ClusterHealth) WithFilterPath(v ...string) func(*ClusterHealthRequest)

WithFilterPath filters the properties of the response body.

func (ClusterHealth) WithHeader ¶ added in v6.8.2 

func (f ClusterHealth) WithHeader(h map[string]string) func(*ClusterHealthRequest)

WithHeader adds the headers to the HTTP request.

func (ClusterHealth) WithHuman ¶ 

func (f ClusterHealth) WithHuman() func(*ClusterHealthRequest)

WithHuman makes statistical values human-readable.

func (ClusterHealth) WithIndex ¶ 

func (f ClusterHealth) WithIndex(v ...string) func(*ClusterHealthRequest)

WithIndex - limit the information returned to a specific index.

func (ClusterHealth) WithLevel ¶ 

func (f ClusterHealth) WithLevel(v string) func(*ClusterHealthRequest)

WithLevel - specify the level of detail for returned information.

func (ClusterHealth) WithLocal ¶ 

func (f ClusterHealth) WithLocal(v bool) func(*ClusterHealthRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (ClusterHealth) WithMasterTimeout ¶ 

func (f ClusterHealth) WithMasterTimeout(v time.Duration) func(*ClusterHealthRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (ClusterHealth) WithOpaqueID ¶ added in v6.8.5 

func (f ClusterHealth) WithOpaqueID(s string) func(*ClusterHealthRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ClusterHealth) WithPretty ¶ 

func (f ClusterHealth) WithPretty() func(*ClusterHealthRequest)

WithPretty makes the response body pretty-printed.

func (ClusterHealth) WithTimeout ¶ 

func (f ClusterHealth) WithTimeout(v time.Duration) func(*ClusterHealthRequest)

WithTimeout - explicit operation timeout.

func (ClusterHealth) WithWaitForActiveShards ¶ 

func (f ClusterHealth) WithWaitForActiveShards(v string) func(*ClusterHealthRequest)

WithWaitForActiveShards - wait until the specified number of shards is active.

func (ClusterHealth) WithWaitForEvents ¶ 

func (f ClusterHealth) WithWaitForEvents(v string) func(*ClusterHealthRequest)

WithWaitForEvents - wait until all currently queued events with the given priority are processed.

func (ClusterHealth) WithWaitForNoInitializingShards ¶ 

func (f ClusterHealth) WithWaitForNoInitializingShards(v bool) func(*ClusterHealthRequest)

WithWaitForNoInitializingShards - whether to wait until there are no initializing shards in the cluster.

func (ClusterHealth) WithWaitForNoRelocatingShards ¶ 

func (f ClusterHealth) WithWaitForNoRelocatingShards(v bool) func(*ClusterHealthRequest)

WithWaitForNoRelocatingShards - whether to wait until there are no relocating shards in the cluster.

func (ClusterHealth) WithWaitForNodes ¶ 

func (f ClusterHealth) WithWaitForNodes(v string) func(*ClusterHealthRequest)

WithWaitForNodes - wait until the specified number of nodes is available.

func (ClusterHealth) WithWaitForStatus ¶ 

func (f ClusterHealth) WithWaitForStatus(v string) func(*ClusterHealthRequest)

WithWaitForStatus - wait until cluster is in a specific state.

type ClusterHealthRequest ¶ 

type ClusterHealthRequest struct {
	Index []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.

func (ClusterHealthRequest) Do ¶ 

func (r ClusterHealthRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ClusterPendingTasks ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html.

func (ClusterPendingTasks) WithContext ¶ 

func (f ClusterPendingTasks) WithContext(v context.Context) func(*ClusterPendingTasksRequest)

WithContext sets the request context.

func (ClusterPendingTasks) WithErrorTrace ¶ 

func (f ClusterPendingTasks) WithErrorTrace() func(*ClusterPendingTasksRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ClusterPendingTasks) WithFilterPath ¶ 

func (f ClusterPendingTasks) WithFilterPath(v ...string) func(*ClusterPendingTasksRequest)

WithFilterPath filters the properties of the response body.

func (ClusterPendingTasks) WithHeader ¶ added in v6.8.2 

func (f ClusterPendingTasks) WithHeader(h map[string]string) func(*ClusterPendingTasksRequest)

WithHeader adds the headers to the HTTP request.

func (ClusterPendingTasks) WithHuman ¶ 

func (f ClusterPendingTasks) WithHuman() func(*ClusterPendingTasksRequest)

WithHuman makes statistical values human-readable.

func (ClusterPendingTasks) WithLocal ¶ 

func (f ClusterPendingTasks) WithLocal(v bool) func(*ClusterPendingTasksRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (ClusterPendingTasks) WithMasterTimeout ¶ 

func (f ClusterPendingTasks) WithMasterTimeout(v time.Duration) func(*ClusterPendingTasksRequest)

WithMasterTimeout - specify timeout for connection to master.

func (ClusterPendingTasks) WithOpaqueID ¶ added in v6.8.5 

func (f ClusterPendingTasks) WithOpaqueID(s string) func(*ClusterPendingTasksRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ClusterPendingTasks) WithPretty ¶ 

func (f ClusterPendingTasks) WithPretty() func(*ClusterPendingTasksRequest)

WithPretty makes the response body pretty-printed.

type ClusterPendingTasksRequest ¶ 

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 (ClusterPendingTasksRequest) Do ¶ 

func (r ClusterPendingTasksRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ClusterPutSettings ¶ 

type ClusterPutSettings func(body io.Reader, o ...func(*ClusterPutSettingsRequest)) (*Response, error)

ClusterPutSettings updates the cluster settings.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html.

func (ClusterPutSettings) WithContext ¶ 

func (f ClusterPutSettings) WithContext(v context.Context) func(*ClusterPutSettingsRequest)

WithContext sets the request context.

func (ClusterPutSettings) WithErrorTrace ¶ 

func (f ClusterPutSettings) WithErrorTrace() func(*ClusterPutSettingsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ClusterPutSettings) WithFilterPath ¶ 

func (f ClusterPutSettings) WithFilterPath(v ...string) func(*ClusterPutSettingsRequest)

WithFilterPath filters the properties of the response body.

func (ClusterPutSettings) WithFlatSettings ¶ 

func (f ClusterPutSettings) WithFlatSettings(v bool) func(*ClusterPutSettingsRequest)

WithFlatSettings - return settings in flat format (default: false).

func (ClusterPutSettings) WithHeader ¶ added in v6.8.2 

func (f ClusterPutSettings) WithHeader(h map[string]string) func(*ClusterPutSettingsRequest)

WithHeader adds the headers to the HTTP request.

func (ClusterPutSettings) WithHuman ¶ 

func (f ClusterPutSettings) WithHuman() func(*ClusterPutSettingsRequest)

WithHuman makes statistical values human-readable.

func (ClusterPutSettings) WithMasterTimeout ¶ 

func (f ClusterPutSettings) WithMasterTimeout(v time.Duration) func(*ClusterPutSettingsRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (ClusterPutSettings) WithOpaqueID ¶ added in v6.8.5 

func (f ClusterPutSettings) WithOpaqueID(s string) func(*ClusterPutSettingsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ClusterPutSettings) WithPretty ¶ 

func (f ClusterPutSettings) WithPretty() func(*ClusterPutSettingsRequest)

WithPretty makes the response body pretty-printed.

func (ClusterPutSettings) WithTimeout ¶ 

func (f ClusterPutSettings) WithTimeout(v time.Duration) func(*ClusterPutSettingsRequest)

WithTimeout - explicit operation timeout.

type ClusterPutSettingsRequest ¶ 

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.

func (ClusterPutSettingsRequest) Do ¶ 

func (r ClusterPutSettingsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ClusterRemoteInfo ¶ 

type ClusterRemoteInfo func(o ...func(*ClusterRemoteInfoRequest)) (*Response, error)

ClusterRemoteInfo returns the information about configured remote clusters.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html.

func (ClusterRemoteInfo) WithContext ¶ 

func (f ClusterRemoteInfo) WithContext(v context.Context) func(*ClusterRemoteInfoRequest)

WithContext sets the request context.

func (ClusterRemoteInfo) WithErrorTrace ¶ 

func (f ClusterRemoteInfo) WithErrorTrace() func(*ClusterRemoteInfoRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ClusterRemoteInfo) WithFilterPath ¶ 

func (f ClusterRemoteInfo) WithFilterPath(v ...string) func(*ClusterRemoteInfoRequest)

WithFilterPath filters the properties of the response body.

func (ClusterRemoteInfo) WithHeader ¶ added in v6.8.2 

func (f ClusterRemoteInfo) WithHeader(h map[string]string) func(*ClusterRemoteInfoRequest)

WithHeader adds the headers to the HTTP request.

func (ClusterRemoteInfo) WithHuman ¶ 

func (f ClusterRemoteInfo) WithHuman() func(*ClusterRemoteInfoRequest)

WithHuman makes statistical values human-readable.

func (ClusterRemoteInfo) WithOpaqueID ¶ added in v6.8.5 

func (f ClusterRemoteInfo) WithOpaqueID(s string) func(*ClusterRemoteInfoRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ClusterRemoteInfo) WithPretty ¶ 

func (f ClusterRemoteInfo) WithPretty() func(*ClusterRemoteInfoRequest)

WithPretty makes the response body pretty-printed.

type ClusterRemoteInfoRequest ¶ 

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.

func (ClusterRemoteInfoRequest) Do ¶ 

func (r ClusterRemoteInfoRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ClusterReroute ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html.

func (ClusterReroute) WithBody ¶ 

func (f ClusterReroute) WithBody(v io.Reader) func(*ClusterRerouteRequest)

WithBody - The definition of `commands` to perform (`move`, `cancel`, `allocate`).

func (ClusterReroute) WithContext ¶ 

func (f ClusterReroute) WithContext(v context.Context) func(*ClusterRerouteRequest)

WithContext sets the request context.

func (ClusterReroute) WithDryRun ¶ 

func (f ClusterReroute) WithDryRun(v bool) func(*ClusterRerouteRequest)

WithDryRun - simulate the operation only and return the resulting state.

func (ClusterReroute) WithErrorTrace ¶ 

func (f ClusterReroute) WithErrorTrace() func(*ClusterRerouteRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ClusterReroute) WithExplain ¶ 

func (f ClusterReroute) WithExplain(v bool) func(*ClusterRerouteRequest)

WithExplain - return an explanation of why the commands can or cannot be executed.

func (ClusterReroute) WithFilterPath ¶ 

func (f ClusterReroute) WithFilterPath(v ...string) func(*ClusterRerouteRequest)

WithFilterPath filters the properties of the response body.

func (ClusterReroute) WithHeader ¶ added in v6.8.2 

func (f ClusterReroute) WithHeader(h map[string]string) func(*ClusterRerouteRequest)

WithHeader adds the headers to the HTTP request.

func (ClusterReroute) WithHuman ¶ 

func (f ClusterReroute) WithHuman() func(*ClusterRerouteRequest)

WithHuman makes statistical values human-readable.

func (ClusterReroute) WithMasterTimeout ¶ 

func (f ClusterReroute) WithMasterTimeout(v time.Duration) func(*ClusterRerouteRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (ClusterReroute) WithMetric ¶ 

func (f ClusterReroute) WithMetric(v ...string) func(*ClusterRerouteRequest)

WithMetric - limit the information returned to the specified metrics. defaults to all but metadata.

func (ClusterReroute) WithOpaqueID ¶ added in v6.8.5 

func (f ClusterReroute) WithOpaqueID(s string) func(*ClusterRerouteRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ClusterReroute) WithPretty ¶ 

func (f ClusterReroute) WithPretty() func(*ClusterRerouteRequest)

WithPretty makes the response body pretty-printed.

func (ClusterReroute) WithRetryFailed ¶ 

func (f ClusterReroute) WithRetryFailed(v bool) func(*ClusterRerouteRequest)

WithRetryFailed - retries allocation of shards that are blocked due to too many subsequent allocation failures.

func (ClusterReroute) WithTimeout ¶ 

func (f ClusterReroute) WithTimeout(v time.Duration) func(*ClusterRerouteRequest)

WithTimeout - explicit operation timeout.

type ClusterRerouteRequest ¶ 

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.

func (ClusterRerouteRequest) Do ¶ 

func (r ClusterRerouteRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ClusterState ¶ 

type ClusterState func(o ...func(*ClusterStateRequest)) (*Response, error)

ClusterState returns a comprehensive information about the state of the cluster.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html.

func (ClusterState) WithAllowNoIndices ¶ 

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 (ClusterState) WithContext ¶ 

func (f ClusterState) WithContext(v context.Context) func(*ClusterStateRequest)

WithContext sets the request context.

func (ClusterState) WithErrorTrace ¶ 

func (f ClusterState) WithErrorTrace() func(*ClusterStateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ClusterState) WithExpandWildcards ¶ 

func (f ClusterState) WithExpandWildcards(v string) func(*ClusterStateRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (ClusterState) WithFilterPath ¶ 

func (f ClusterState) WithFilterPath(v ...string) func(*ClusterStateRequest)

WithFilterPath filters the properties of the response body.

func (ClusterState) WithFlatSettings ¶ 

func (f ClusterState) WithFlatSettings(v bool) func(*ClusterStateRequest)

WithFlatSettings - return settings in flat format (default: false).

func (ClusterState) WithHeader ¶ added in v6.8.2 

func (f ClusterState) WithHeader(h map[string]string) func(*ClusterStateRequest)

WithHeader adds the headers to the HTTP request.

func (ClusterState) WithHuman ¶ 

func (f ClusterState) WithHuman() func(*ClusterStateRequest)

WithHuman makes statistical values human-readable.

func (ClusterState) WithIgnoreUnavailable ¶ 

func (f ClusterState) WithIgnoreUnavailable(v bool) func(*ClusterStateRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (ClusterState) WithIndex ¶ 

func (f ClusterState) WithIndex(v ...string) func(*ClusterStateRequest)

WithIndex - a list of index names; use _all to perform the operation on all indices.

func (ClusterState) WithLocal ¶ 

func (f ClusterState) WithLocal(v bool) func(*ClusterStateRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (ClusterState) WithMasterTimeout ¶ 

func (f ClusterState) WithMasterTimeout(v time.Duration) func(*ClusterStateRequest)

WithMasterTimeout - specify timeout for connection to master.

func (ClusterState) WithMetric ¶ 

func (f ClusterState) WithMetric(v ...string) func(*ClusterStateRequest)

WithMetric - limit the information returned to the specified metrics.

func (ClusterState) WithOpaqueID ¶ added in v6.8.5 

func (f ClusterState) WithOpaqueID(s string) func(*ClusterStateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ClusterState) WithPretty ¶ 

func (f ClusterState) WithPretty() func(*ClusterStateRequest)

WithPretty makes the response body pretty-printed.

func (ClusterState) WithWaitForMetadataVersion ¶ 

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 (ClusterState) WithWaitForTimeout ¶ 

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 ¶ 

type ClusterStateRequest struct {
	Index []string

	Metric []string

	AllowNoIndices         *bool
	ExpandWildcards        string
	FlatSettings           *bool
	IgnoreUnavailable      *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.

func (ClusterStateRequest) Do ¶ 

func (r ClusterStateRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ClusterStats ¶ 

type ClusterStats func(o ...func(*ClusterStatsRequest)) (*Response, error)

ClusterStats returns high-level overview of cluster statistics.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html.

func (ClusterStats) WithContext ¶ 

func (f ClusterStats) WithContext(v context.Context) func(*ClusterStatsRequest)

WithContext sets the request context.

func (ClusterStats) WithErrorTrace ¶ 

func (f ClusterStats) WithErrorTrace() func(*ClusterStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ClusterStats) WithFilterPath ¶ 

func (f ClusterStats) WithFilterPath(v ...string) func(*ClusterStatsRequest)

WithFilterPath filters the properties of the response body.

func (ClusterStats) WithFlatSettings ¶ 

func (f ClusterStats) WithFlatSettings(v bool) func(*ClusterStatsRequest)

WithFlatSettings - return settings in flat format (default: false).

func (ClusterStats) WithHeader ¶ added in v6.8.2 

func (f ClusterStats) WithHeader(h map[string]string) func(*ClusterStatsRequest)

WithHeader adds the headers to the HTTP request.

func (ClusterStats) WithHuman ¶ 

func (f ClusterStats) WithHuman() func(*ClusterStatsRequest)

WithHuman makes statistical values human-readable.

func (ClusterStats) WithNodeID ¶ 

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 (ClusterStats) WithOpaqueID ¶ added in v6.8.5 

func (f ClusterStats) WithOpaqueID(s string) func(*ClusterStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ClusterStats) WithPretty ¶ 

func (f ClusterStats) WithPretty() func(*ClusterStatsRequest)

WithPretty makes the response body pretty-printed.

func (ClusterStats) WithTimeout ¶ 

func (f ClusterStats) WithTimeout(v time.Duration) func(*ClusterStatsRequest)

WithTimeout - explicit operation timeout.

type ClusterStatsRequest ¶ 

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.

func (ClusterStatsRequest) Do ¶ 

func (r ClusterStatsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Count ¶ 

type Count func(o ...func(*CountRequest)) (*Response, error)

Count returns number of documents matching a query.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html.

func (Count) WithAllowNoIndices ¶ 

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 (Count) WithAnalyzeWildcard ¶ 

func (f Count) WithAnalyzeWildcard(v bool) func(*CountRequest)

WithAnalyzeWildcard - specify whether wildcard and prefix queries should be analyzed (default: false).

func (Count) WithAnalyzer ¶ 

func (f Count) WithAnalyzer(v string) func(*CountRequest)

WithAnalyzer - the analyzer to use for the query string.

func (Count) WithBody ¶ 

func (f Count) WithBody(v io.Reader) func(*CountRequest)

WithBody - A query to restrict the results specified with the Query DSL (optional).

func (Count) WithContext ¶ 

func (f Count) WithContext(v context.Context) func(*CountRequest)

WithContext sets the request context.

func (Count) WithDefaultOperator ¶ 

func (f Count) WithDefaultOperator(v string) func(*CountRequest)

WithDefaultOperator - the default operator for query string query (and or or).

func (Count) WithDf ¶ 

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 (Count) WithDocumentType ¶ 

func (f Count) WithDocumentType(v ...string) func(*CountRequest)

WithDocumentType - a list of types to restrict the results.

func (Count) WithErrorTrace ¶ 

func (f Count) WithErrorTrace() func(*CountRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Count) WithExpandWildcards ¶ 

func (f Count) WithExpandWildcards(v string) func(*CountRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (Count) WithFilterPath ¶ 

func (f Count) WithFilterPath(v ...string) func(*CountRequest)

WithFilterPath filters the properties of the response body.

func (Count) WithHeader ¶ added in v6.8.2 

func (f Count) WithHeader(h map[string]string) func(*CountRequest)

WithHeader adds the headers to the HTTP request.

func (Count) WithHuman ¶ 

func (f Count) WithHuman() func(*CountRequest)

WithHuman makes statistical values human-readable.

func (Count) WithIgnoreThrottled ¶ 

func (f Count) WithIgnoreThrottled(v bool) func(*CountRequest)

WithIgnoreThrottled - whether specified concrete, expanded or aliased indices should be ignored when throttled.

func (Count) WithIgnoreUnavailable ¶ 

func (f Count) WithIgnoreUnavailable(v bool) func(*CountRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (Count) WithIndex ¶ 

func (f Count) WithIndex(v ...string) func(*CountRequest)

WithIndex - a list of indices to restrict the results.

func (Count) WithLenient ¶ 

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 (Count) WithMinScore ¶ 

func (f Count) WithMinScore(v int) func(*CountRequest)

WithMinScore - include only documents with a specific `_score` value in the result.

func (Count) WithOpaqueID ¶ added in v6.8.5 

func (f Count) WithOpaqueID(s string) func(*CountRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Count) WithPreference ¶ 

func (f Count) WithPreference(v string) func(*CountRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (Count) WithPretty ¶ 

func (f Count) WithPretty() func(*CountRequest)

WithPretty makes the response body pretty-printed.

func (Count) WithQuery ¶ 

func (f Count) WithQuery(v string) func(*CountRequest)

WithQuery - query in the lucene query string syntax.

func (Count) WithRouting ¶ 

func (f Count) WithRouting(v ...string) func(*CountRequest)

WithRouting - a list of specific routing values.

func (Count) WithTerminateAfter ¶ 

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 ¶ 

type CountRequest struct {
	Index        []string
	DocumentType []string

	Body io.Reader

	AllowNoIndices    *bool
	Analyzer          string
	AnalyzeWildcard   *bool
	DefaultOperator   string
	Df                string
	ExpandWildcards   string
	IgnoreThrottled   *bool
	IgnoreUnavailable *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.

func (CountRequest) Do ¶ 

func (r CountRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Create ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html.

func (Create) WithContext ¶ 

func (f Create) WithContext(v context.Context) func(*CreateRequest)

WithContext sets the request context.

func (Create) WithDocumentType ¶ 

func (f Create) WithDocumentType(v string) func(*CreateRequest)

WithDocumentType - the type of the document.

func (Create) WithErrorTrace ¶ 

func (f Create) WithErrorTrace() func(*CreateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Create) WithFilterPath ¶ 

func (f Create) WithFilterPath(v ...string) func(*CreateRequest)

WithFilterPath filters the properties of the response body.

func (Create) WithHeader ¶ added in v6.8.2 

func (f Create) WithHeader(h map[string]string) func(*CreateRequest)

WithHeader adds the headers to the HTTP request.

func (Create) WithHuman ¶ 

func (f Create) WithHuman() func(*CreateRequest)

WithHuman makes statistical values human-readable.

func (Create) WithOpaqueID ¶ added in v6.8.5 

func (f Create) WithOpaqueID(s string) func(*CreateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Create) WithParent ¶ 

func (f Create) WithParent(v string) func(*CreateRequest)

WithParent - ID of the parent document.

func (Create) WithPipeline ¶ 

func (f Create) WithPipeline(v string) func(*CreateRequest)

WithPipeline - the pipeline ID to preprocess incoming documents with.

func (Create) WithPretty ¶ 

func (f Create) WithPretty() func(*CreateRequest)

WithPretty makes the response body pretty-printed.

func (Create) WithRefresh ¶ 

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 (Create) WithRouting ¶ 

func (f Create) WithRouting(v string) func(*CreateRequest)

WithRouting - specific routing value.

func (Create) WithTimeout ¶ 

func (f Create) WithTimeout(v time.Duration) func(*CreateRequest)

WithTimeout - explicit operation timeout.

func (Create) WithVersion ¶ 

func (f Create) WithVersion(v int) func(*CreateRequest)

WithVersion - explicit version number for concurrency control.

func (Create) WithVersionType ¶ 

func (f Create) WithVersionType(v string) func(*CreateRequest)

WithVersionType - specific version type.

func (Create) WithWaitForActiveShards ¶ 

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 ¶ 

type CreateRequest struct {
	Index        string
	DocumentType string
	DocumentID   string

	Body io.Reader

	Parent              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
}

CreateRequest configures the Create API request.

func (CreateRequest) Do ¶ 

func (r CreateRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Delete ¶ 

type Delete func(index string, id string, o ...func(*DeleteRequest)) (*Response, error)

Delete removes a document from the index.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html.

func (Delete) WithContext ¶ 

func (f Delete) WithContext(v context.Context) func(*DeleteRequest)

WithContext sets the request context.

func (Delete) WithDocumentType ¶ 

func (f Delete) WithDocumentType(v string) func(*DeleteRequest)

WithDocumentType - the type of the document.

func (Delete) WithErrorTrace ¶ 

func (f Delete) WithErrorTrace() func(*DeleteRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Delete) WithFilterPath ¶ 

func (f Delete) WithFilterPath(v ...string) func(*DeleteRequest)

WithFilterPath filters the properties of the response body.

func (Delete) WithHeader ¶ added in v6.8.2 

func (f Delete) WithHeader(h map[string]string) func(*DeleteRequest)

WithHeader adds the headers to the HTTP request.

func (Delete) WithHuman ¶ 

func (f Delete) WithHuman() func(*DeleteRequest)

WithHuman makes statistical values human-readable.

func (Delete) WithIfPrimaryTerm ¶ 

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 (Delete) WithIfSeqNo ¶ 

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 (Delete) WithOpaqueID ¶ added in v6.8.5 

func (f Delete) WithOpaqueID(s string) func(*DeleteRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Delete) WithParent ¶ 

func (f Delete) WithParent(v string) func(*DeleteRequest)

WithParent - ID of parent document.

func (Delete) WithPretty ¶ 

func (f Delete) WithPretty() func(*DeleteRequest)

WithPretty makes the response body pretty-printed.

func (Delete) WithRefresh ¶ 

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 (Delete) WithRouting ¶ 

func (f Delete) WithRouting(v string) func(*DeleteRequest)

WithRouting - specific routing value.

func (Delete) WithTimeout ¶ 

func (f Delete) WithTimeout(v time.Duration) func(*DeleteRequest)

WithTimeout - explicit operation timeout.

func (Delete) WithVersion ¶ 

func (f Delete) WithVersion(v int) func(*DeleteRequest)

WithVersion - explicit version number for concurrency control.

func (Delete) WithVersionType ¶ 

func (f Delete) WithVersionType(v string) func(*DeleteRequest)

WithVersionType - specific version type.

func (Delete) WithWaitForActiveShards ¶ 

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 ¶ 

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 (DeleteByQuery) WithAllowNoIndices ¶ 

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 (DeleteByQuery) WithAnalyzeWildcard ¶ 

func (f DeleteByQuery) WithAnalyzeWildcard(v bool) func(*DeleteByQueryRequest)

WithAnalyzeWildcard - specify whether wildcard and prefix queries should be analyzed (default: false).

func (DeleteByQuery) WithAnalyzer ¶ 

func (f DeleteByQuery) WithAnalyzer(v string) func(*DeleteByQueryRequest)

WithAnalyzer - the analyzer to use for the query string.

func (DeleteByQuery) WithConflicts ¶ 

func (f DeleteByQuery) WithConflicts(v string) func(*DeleteByQueryRequest)

WithConflicts - what to do when the delete by query hits version conflicts?.

func (DeleteByQuery) WithContext ¶ 

func (f DeleteByQuery) WithContext(v context.Context) func(*DeleteByQueryRequest)

WithContext sets the request context.

func (DeleteByQuery) WithDefaultOperator ¶ 

func (f DeleteByQuery) WithDefaultOperator(v string) func(*DeleteByQueryRequest)

WithDefaultOperator - the default operator for query string query (and or or).

func (DeleteByQuery) WithDf ¶ 

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 (DeleteByQuery) WithDocumentType ¶ 

func (f DeleteByQuery) WithDocumentType(v ...string) func(*DeleteByQueryRequest)

WithDocumentType - a list of document types to search; leave empty to perform the operation on all types.

func (DeleteByQuery) WithErrorTrace ¶ 

func (f DeleteByQuery) WithErrorTrace() func(*DeleteByQueryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (DeleteByQuery) WithExpandWildcards ¶ 

func (f DeleteByQuery) WithExpandWildcards(v string) func(*DeleteByQueryRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (DeleteByQuery) WithFilterPath ¶ 

func (f DeleteByQuery) WithFilterPath(v ...string) func(*DeleteByQueryRequest)

WithFilterPath filters the properties of the response body.

func (DeleteByQuery) WithFrom ¶ 

func (f DeleteByQuery) WithFrom(v int) func(*DeleteByQueryRequest)

WithFrom - starting offset (default: 0).

func (DeleteByQuery) WithHeader ¶ added in v6.8.2 

func (f DeleteByQuery) WithHeader(h map[string]string) func(*DeleteByQueryRequest)

WithHeader adds the headers to the HTTP request.

func (DeleteByQuery) WithHuman ¶ 

func (f DeleteByQuery) WithHuman() func(*DeleteByQueryRequest)

WithHuman makes statistical values human-readable.

func (DeleteByQuery) WithIgnoreUnavailable ¶ 

func (f DeleteByQuery) WithIgnoreUnavailable(v bool) func(*DeleteByQueryRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (DeleteByQuery) WithLenient ¶ 

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 (DeleteByQuery) WithOpaqueID ¶ added in v6.8.5 

func (f DeleteByQuery) WithOpaqueID(s string) func(*DeleteByQueryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (DeleteByQuery) WithPreference ¶ 

func (f DeleteByQuery) WithPreference(v string) func(*DeleteByQueryRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (DeleteByQuery) WithPretty ¶ 

func (f DeleteByQuery) WithPretty() func(*DeleteByQueryRequest)

WithPretty makes the response body pretty-printed.

func (DeleteByQuery) WithQuery ¶ 

func (f DeleteByQuery) WithQuery(v string) func(*DeleteByQueryRequest)

WithQuery - query in the lucene query string syntax.

func (DeleteByQuery) WithRefresh ¶ 

func (f DeleteByQuery) WithRefresh(v bool) func(*DeleteByQueryRequest)

WithRefresh - should the effected indexes be refreshed?.

func (DeleteByQuery) WithRequestCache ¶ 

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 (DeleteByQuery) WithRequestsPerSecond ¶ 

func (f DeleteByQuery) WithRequestsPerSecond(v int) func(*DeleteByQueryRequest)

WithRequestsPerSecond - the throttle for this request in sub-requests per second. -1 means no throttle..

func (DeleteByQuery) WithRouting ¶ 

func (f DeleteByQuery) WithRouting(v ...string) func(*DeleteByQueryRequest)

WithRouting - a list of specific routing values.

func (DeleteByQuery) WithScroll ¶ 

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 (DeleteByQuery) WithScrollSize ¶ 

func (f DeleteByQuery) WithScrollSize(v int) func(*DeleteByQueryRequest)

WithScrollSize - size on the scroll request powering the delete by query.

func (DeleteByQuery) WithSearchTimeout ¶ 

func (f DeleteByQuery) WithSearchTimeout(v time.Duration) func(*DeleteByQueryRequest)

WithSearchTimeout - explicit timeout for each search request. defaults to no timeout..

func (DeleteByQuery) WithSearchType ¶ 

func (f DeleteByQuery) WithSearchType(v string) func(*DeleteByQueryRequest)

WithSearchType - search operation type.

func (DeleteByQuery) WithSize ¶ 

func (f DeleteByQuery) WithSize(v int) func(*DeleteByQueryRequest)

WithSize - number of hits to return (default: 10).

func (DeleteByQuery) WithSlices ¶ 

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 (DeleteByQuery) WithSort ¶ 

func (f DeleteByQuery) WithSort(v ...string) func(*DeleteByQueryRequest)

WithSort - a list of <field>:<direction> pairs.

func (DeleteByQuery) WithSource ¶ 

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 (DeleteByQuery) WithSourceExcludes ¶ 

func (f DeleteByQuery) WithSourceExcludes(v ...string) func(*DeleteByQueryRequest)

WithSourceExcludes - a list of fields to exclude from the returned _source field.

func (DeleteByQuery) WithSourceIncludes ¶ 

func (f DeleteByQuery) WithSourceIncludes(v ...string) func(*DeleteByQueryRequest)

WithSourceIncludes - a list of fields to extract and return from the _source field.

func (DeleteByQuery) WithStats ¶ 

func (f DeleteByQuery) WithStats(v ...string) func(*DeleteByQueryRequest)

WithStats - specific 'tag' of the request for logging and statistical purposes.

func (DeleteByQuery) WithTerminateAfter ¶ 

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 (DeleteByQuery) WithTimeout ¶ 

func (f DeleteByQuery) WithTimeout(v time.Duration) func(*DeleteByQueryRequest)

WithTimeout - time each individual bulk request should wait for shards that are unavailable..

func (DeleteByQuery) WithVersion ¶ 

func (f DeleteByQuery) WithVersion(v bool) func(*DeleteByQueryRequest)

WithVersion - specify whether to return document version as part of a hit.

func (DeleteByQuery) WithWaitForActiveShards ¶ 

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 (DeleteByQuery) WithWaitForCompletion ¶ 

func (f DeleteByQuery) WithWaitForCompletion(v bool) func(*DeleteByQueryRequest)

WithWaitForCompletion - should the request should block until the delete by query is complete..

type DeleteByQueryRequest ¶ 

type DeleteByQueryRequest struct {
	Index        []string
	DocumentType []string

	Body io.Reader

	AllowNoIndices      *bool
	Analyzer            string
	AnalyzeWildcard     *bool
	Conflicts           string
	DefaultOperator     string
	Df                  string
	ExpandWildcards     string
	From                *int
	IgnoreUnavailable   *bool
	Lenient             *bool
	Preference          string
	Query               string
	Refresh             *bool
	RequestCache        *bool
	RequestsPerSecond   *int
	Routing             []string
	Scroll              time.Duration
	ScrollSize          *int
	SearchTimeout       time.Duration
	SearchType          string
	Size                *int
	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.

func (DeleteByQueryRequest) Do ¶ 

func (r DeleteByQueryRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type DeleteByQueryRethrottle ¶ 

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 (DeleteByQueryRethrottle) WithContext ¶ 

func (f DeleteByQueryRethrottle) WithContext(v context.Context) func(*DeleteByQueryRethrottleRequest)

WithContext sets the request context.

func (DeleteByQueryRethrottle) WithErrorTrace ¶ 

func (f DeleteByQueryRethrottle) WithErrorTrace() func(*DeleteByQueryRethrottleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (DeleteByQueryRethrottle) WithFilterPath ¶ 

func (f DeleteByQueryRethrottle) WithFilterPath(v ...string) func(*DeleteByQueryRethrottleRequest)

WithFilterPath filters the properties of the response body.

func (DeleteByQueryRethrottle) WithHeader ¶ added in v6.8.2 

func (f DeleteByQueryRethrottle) WithHeader(h map[string]string) func(*DeleteByQueryRethrottleRequest)

WithHeader adds the headers to the HTTP request.

func (DeleteByQueryRethrottle) WithHuman ¶ 

func (f DeleteByQueryRethrottle) WithHuman() func(*DeleteByQueryRethrottleRequest)

WithHuman makes statistical values human-readable.

func (DeleteByQueryRethrottle) WithOpaqueID ¶ added in v6.8.5 

func (f DeleteByQueryRethrottle) WithOpaqueID(s string) func(*DeleteByQueryRethrottleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (DeleteByQueryRethrottle) WithPretty ¶ 

func (f DeleteByQueryRethrottle) WithPretty() func(*DeleteByQueryRethrottleRequest)

WithPretty makes the response body pretty-printed.

func (DeleteByQueryRethrottle) WithRequestsPerSecond ¶ 

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 ¶ 

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 (DeleteByQueryRethrottleRequest) Do ¶ 

func (r DeleteByQueryRethrottleRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type DeleteRequest ¶ 

type DeleteRequest struct {
	Index        string
	DocumentType string
	DocumentID   string

	IfPrimaryTerm       *int
	IfSeqNo             *int
	Parent              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
}

DeleteRequest configures the Delete API request.

func (DeleteRequest) Do ¶ 

func (r DeleteRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type DeleteScript ¶ 

type DeleteScript func(id string, o ...func(*DeleteScriptRequest)) (*Response, error)

DeleteScript deletes a script.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html.

func (DeleteScript) WithContext ¶ 

func (f DeleteScript) WithContext(v context.Context) func(*DeleteScriptRequest)

WithContext sets the request context.

func (DeleteScript) WithErrorTrace ¶ 

func (f DeleteScript) WithErrorTrace() func(*DeleteScriptRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (DeleteScript) WithFilterPath ¶ 

func (f DeleteScript) WithFilterPath(v ...string) func(*DeleteScriptRequest)

WithFilterPath filters the properties of the response body.

func (DeleteScript) WithHeader ¶ added in v6.8.2 

func (f DeleteScript) WithHeader(h map[string]string) func(*DeleteScriptRequest)

WithHeader adds the headers to the HTTP request.

func (DeleteScript) WithHuman ¶ 

func (f DeleteScript) WithHuman() func(*DeleteScriptRequest)

WithHuman makes statistical values human-readable.

func (DeleteScript) WithMasterTimeout ¶ 

func (f DeleteScript) WithMasterTimeout(v time.Duration) func(*DeleteScriptRequest)

WithMasterTimeout - specify timeout for connection to master.

func (DeleteScript) WithOpaqueID ¶ added in v6.8.5 

func (f DeleteScript) WithOpaqueID(s string) func(*DeleteScriptRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (DeleteScript) WithPretty ¶ 

func (f DeleteScript) WithPretty() func(*DeleteScriptRequest)

WithPretty makes the response body pretty-printed.

func (DeleteScript) WithTimeout ¶ 

func (f DeleteScript) WithTimeout(v time.Duration) func(*DeleteScriptRequest)

WithTimeout - explicit operation timeout.

type DeleteScriptRequest ¶ 

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.

func (DeleteScriptRequest) Do ¶ 

func (r DeleteScriptRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Exists ¶ 

type Exists func(index string, id string, o ...func(*ExistsRequest)) (*Response, error)

Exists returns information about whether a document exists in an index.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html.

func (Exists) WithContext ¶ 

func (f Exists) WithContext(v context.Context) func(*ExistsRequest)

WithContext sets the request context.

func (Exists) WithDocumentType ¶ 

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 (Exists) WithErrorTrace ¶ 

func (f Exists) WithErrorTrace() func(*ExistsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Exists) WithFilterPath ¶ 

func (f Exists) WithFilterPath(v ...string) func(*ExistsRequest)

WithFilterPath filters the properties of the response body.

func (Exists) WithHeader ¶ added in v6.8.2 

func (f Exists) WithHeader(h map[string]string) func(*ExistsRequest)

WithHeader adds the headers to the HTTP request.

func (Exists) WithHuman ¶ 

func (f Exists) WithHuman() func(*ExistsRequest)

WithHuman makes statistical values human-readable.

func (Exists) WithOpaqueID ¶ added in v6.8.5 

func (f Exists) WithOpaqueID(s string) func(*ExistsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Exists) WithParent ¶ 

func (f Exists) WithParent(v string) func(*ExistsRequest)

WithParent - the ID of the parent document.

func (Exists) WithPreference ¶ 

func (f Exists) WithPreference(v string) func(*ExistsRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (Exists) WithPretty ¶ 

func (f Exists) WithPretty() func(*ExistsRequest)

WithPretty makes the response body pretty-printed.

func (Exists) WithRealtime ¶ 

func (f Exists) WithRealtime(v bool) func(*ExistsRequest)

WithRealtime - specify whether to perform the operation in realtime or search mode.

func (Exists) WithRefresh ¶ 

func (f Exists) WithRefresh(v bool) func(*ExistsRequest)

WithRefresh - refresh the shard containing the document before performing the operation.

func (Exists) WithRouting ¶ 

func (f Exists) WithRouting(v string) func(*ExistsRequest)

WithRouting - specific routing value.

func (Exists) WithSource ¶ 

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 (Exists) WithSourceExcludes ¶ 

func (f Exists) WithSourceExcludes(v ...string) func(*ExistsRequest)

WithSourceExcludes - a list of fields to exclude from the returned _source field.

func (Exists) WithSourceIncludes ¶ 

func (f Exists) WithSourceIncludes(v ...string) func(*ExistsRequest)

WithSourceIncludes - a list of fields to extract and return from the _source field.

func (Exists) WithStoredFields ¶ 

func (f Exists) WithStoredFields(v ...string) func(*ExistsRequest)

WithStoredFields - a list of stored fields to return in the response.

func (Exists) WithVersion ¶ 

func (f Exists) WithVersion(v int) func(*ExistsRequest)

WithVersion - explicit version number for concurrency control.

func (Exists) WithVersionType ¶ 

func (f Exists) WithVersionType(v string) func(*ExistsRequest)

WithVersionType - specific version type.

type ExistsRequest ¶ 

type ExistsRequest struct {
	Index        string
	DocumentType string
	DocumentID   string

	Parent         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.

func (ExistsRequest) Do ¶ 

func (r ExistsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ExistsSource ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html.

func (ExistsSource) WithContext ¶ 

func (f ExistsSource) WithContext(v context.Context) func(*ExistsSourceRequest)

WithContext sets the request context.

func (ExistsSource) WithDocumentType ¶ 

func (f ExistsSource) WithDocumentType(v string) func(*ExistsSourceRequest)

WithDocumentType - the type of the document; use `_all` to fetch the first document matching the ID across all types.

func (ExistsSource) WithErrorTrace ¶ 

func (f ExistsSource) WithErrorTrace() func(*ExistsSourceRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ExistsSource) WithFilterPath ¶ 

func (f ExistsSource) WithFilterPath(v ...string) func(*ExistsSourceRequest)

WithFilterPath filters the properties of the response body.

func (ExistsSource) WithHeader ¶ added in v6.8.2 

func (f ExistsSource) WithHeader(h map[string]string) func(*ExistsSourceRequest)

WithHeader adds the headers to the HTTP request.

func (ExistsSource) WithHuman ¶ 

func (f ExistsSource) WithHuman() func(*ExistsSourceRequest)

WithHuman makes statistical values human-readable.

func (ExistsSource) WithOpaqueID ¶ added in v6.8.5 

func (f ExistsSource) WithOpaqueID(s string) func(*ExistsSourceRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ExistsSource) WithParent ¶ 

func (f ExistsSource) WithParent(v string) func(*ExistsSourceRequest)

WithParent - the ID of the parent document.

func (ExistsSource) WithPreference ¶ 

func (f ExistsSource) WithPreference(v string) func(*ExistsSourceRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (ExistsSource) WithPretty ¶ 

func (f ExistsSource) WithPretty() func(*ExistsSourceRequest)

WithPretty makes the response body pretty-printed.

func (ExistsSource) WithRealtime ¶ 

func (f ExistsSource) WithRealtime(v bool) func(*ExistsSourceRequest)

WithRealtime - specify whether to perform the operation in realtime or search mode.

func (ExistsSource) WithRefresh ¶ 

func (f ExistsSource) WithRefresh(v bool) func(*ExistsSourceRequest)

WithRefresh - refresh the shard containing the document before performing the operation.

func (ExistsSource) WithRouting ¶ 

func (f ExistsSource) WithRouting(v string) func(*ExistsSourceRequest)

WithRouting - specific routing value.

func (ExistsSource) WithSource ¶ 

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 (ExistsSource) WithSourceExcludes ¶ 

func (f ExistsSource) WithSourceExcludes(v ...string) func(*ExistsSourceRequest)

WithSourceExcludes - a list of fields to exclude from the returned _source field.

func (ExistsSource) WithSourceIncludes ¶ 

func (f ExistsSource) WithSourceIncludes(v ...string) func(*ExistsSourceRequest)

WithSourceIncludes - a list of fields to extract and return from the _source field.

func (ExistsSource) WithVersion ¶ 

func (f ExistsSource) WithVersion(v int) func(*ExistsSourceRequest)

WithVersion - explicit version number for concurrency control.

func (ExistsSource) WithVersionType ¶ 

func (f ExistsSource) WithVersionType(v string) func(*ExistsSourceRequest)

WithVersionType - specific version type.

type ExistsSourceRequest ¶ 

type ExistsSourceRequest struct {
	Index        string
	DocumentType string
	DocumentID   string

	Parent         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.

func (ExistsSourceRequest) Do ¶ 

func (r ExistsSourceRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Explain ¶ 

type Explain func(index string, id string, o ...func(*ExplainRequest)) (*Response, error)

Explain returns information about why a specific matches (or doesn't match) a query.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html.

func (Explain) WithAnalyzeWildcard ¶ 

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 (Explain) WithAnalyzer ¶ 

func (f Explain) WithAnalyzer(v string) func(*ExplainRequest)

WithAnalyzer - the analyzer for the query string query.

func (Explain) WithBody ¶ 

func (f Explain) WithBody(v io.Reader) func(*ExplainRequest)

WithBody - The query definition using the Query DSL.

func (Explain) WithContext ¶ 

func (f Explain) WithContext(v context.Context) func(*ExplainRequest)

WithContext sets the request context.

func (Explain) WithDefaultOperator ¶ 

func (f Explain) WithDefaultOperator(v string) func(*ExplainRequest)

WithDefaultOperator - the default operator for query string query (and or or).

func (Explain) WithDf ¶ 

func (f Explain) WithDf(v string) func(*ExplainRequest)

WithDf - the default field for query string query (default: _all).

func (Explain) WithDocumentType ¶ 

func (f Explain) WithDocumentType(v string) func(*ExplainRequest)

WithDocumentType - the type of the document.

func (Explain) WithErrorTrace ¶ 

func (f Explain) WithErrorTrace() func(*ExplainRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Explain) WithFilterPath ¶ 

func (f Explain) WithFilterPath(v ...string) func(*ExplainRequest)

WithFilterPath filters the properties of the response body.

func (Explain) WithHeader ¶ added in v6.8.2 

func (f Explain) WithHeader(h map[string]string) func(*ExplainRequest)

WithHeader adds the headers to the HTTP request.

func (Explain) WithHuman ¶ 

func (f Explain) WithHuman() func(*ExplainRequest)

WithHuman makes statistical values human-readable.

func (Explain) WithLenient ¶ 

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 (Explain) WithOpaqueID ¶ added in v6.8.5 

func (f Explain) WithOpaqueID(s string) func(*ExplainRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Explain) WithParent ¶ 

func (f Explain) WithParent(v string) func(*ExplainRequest)

WithParent - the ID of the parent document.

func (Explain) WithPreference ¶ 

func (f Explain) WithPreference(v string) func(*ExplainRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (Explain) WithPretty ¶ 

func (f Explain) WithPretty() func(*ExplainRequest)

WithPretty makes the response body pretty-printed.

func (Explain) WithQuery ¶ 

func (f Explain) WithQuery(v string) func(*ExplainRequest)

WithQuery - query in the lucene query string syntax.

func (Explain) WithRouting ¶ 

func (f Explain) WithRouting(v string) func(*ExplainRequest)

WithRouting - specific routing value.

func (Explain) WithSource ¶ 

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 (Explain) WithSourceExcludes ¶ 

func (f Explain) WithSourceExcludes(v ...string) func(*ExplainRequest)

WithSourceExcludes - a list of fields to exclude from the returned _source field.

func (Explain) WithSourceIncludes ¶ 

func (f Explain) WithSourceIncludes(v ...string) func(*ExplainRequest)

WithSourceIncludes - a list of fields to extract and return from the _source field.

func (Explain) WithStoredFields ¶ 

func (f Explain) WithStoredFields(v ...string) func(*ExplainRequest)

WithStoredFields - a list of stored fields to return in the response.

type ExplainRequest ¶ 

type ExplainRequest struct {
	Index        string
	DocumentType string
	DocumentID   string

	Body io.Reader

	Analyzer        string
	AnalyzeWildcard *bool
	DefaultOperator string
	Df              string
	Lenient         *bool
	Parent          string
	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.

func (ExplainRequest) Do ¶ 

func (r ExplainRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type FieldCaps ¶ 

type FieldCaps func(o ...func(*FieldCapsRequest)) (*Response, error)

FieldCaps returns the information about the capabilities of fields among multiple indices.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html.

func (FieldCaps) WithAllowNoIndices ¶ 

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 (FieldCaps) WithBody ¶ 

func (f FieldCaps) WithBody(v io.Reader) func(*FieldCapsRequest)

WithBody - Field json objects containing an array of field names.

func (FieldCaps) WithContext ¶ 

func (f FieldCaps) WithContext(v context.Context) func(*FieldCapsRequest)

WithContext sets the request context.

func (FieldCaps) WithErrorTrace ¶ 

func (f FieldCaps) WithErrorTrace() func(*FieldCapsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (FieldCaps) WithExpandWildcards ¶ 

func (f FieldCaps) WithExpandWildcards(v string) func(*FieldCapsRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (FieldCaps) WithFields ¶ 

func (f FieldCaps) WithFields(v ...string) func(*FieldCapsRequest)

WithFields - a list of field names.

func (FieldCaps) WithFilterPath ¶ 

func (f FieldCaps) WithFilterPath(v ...string) func(*FieldCapsRequest)

WithFilterPath filters the properties of the response body.

func (FieldCaps) WithHeader ¶ added in v6.8.2 

func (f FieldCaps) WithHeader(h map[string]string) func(*FieldCapsRequest)

WithHeader adds the headers to the HTTP request.

func (FieldCaps) WithHuman ¶ 

func (f FieldCaps) WithHuman() func(*FieldCapsRequest)

WithHuman makes statistical values human-readable.

func (FieldCaps) WithIgnoreUnavailable ¶ 

func (f FieldCaps) WithIgnoreUnavailable(v bool) func(*FieldCapsRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (FieldCaps) WithIndex ¶ 

func (f FieldCaps) WithIndex(v ...string) func(*FieldCapsRequest)

WithIndex - a list of index names; use _all to perform the operation on all indices.

func (FieldCaps) WithOpaqueID ¶ added in v6.8.5 

func (f FieldCaps) WithOpaqueID(s string) func(*FieldCapsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (FieldCaps) WithPretty ¶ 

func (f FieldCaps) WithPretty() func(*FieldCapsRequest)

WithPretty makes the response body pretty-printed.

type FieldCapsRequest ¶ 

type FieldCapsRequest struct {
	Index []string

	Body io.Reader

	AllowNoIndices    *bool
	ExpandWildcards   string
	Fields            []string
	IgnoreUnavailable *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

FieldCapsRequest configures the Field Caps API request.

func (FieldCapsRequest) Do ¶ 

func (r FieldCapsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Get ¶ 

type Get func(index string, id string, o ...func(*GetRequest)) (*Response, error)

Get returns a document.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html.

func (Get) WithContext ¶ 

func (f Get) WithContext(v context.Context) func(*GetRequest)

WithContext sets the request context.

func (Get) WithDocumentType ¶ 

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 (Get) WithErrorTrace ¶ 

func (f Get) WithErrorTrace() func(*GetRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Get) WithFilterPath ¶ 

func (f Get) WithFilterPath(v ...string) func(*GetRequest)

WithFilterPath filters the properties of the response body.

func (Get) WithHeader ¶ added in v6.8.2 

func (f Get) WithHeader(h map[string]string) func(*GetRequest)

WithHeader adds the headers to the HTTP request.

func (Get) WithHuman ¶ 

func (f Get) WithHuman() func(*GetRequest)

WithHuman makes statistical values human-readable.

func (Get) WithOpaqueID ¶ added in v6.8.5 

func (f Get) WithOpaqueID(s string) func(*GetRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Get) WithParent ¶ 

func (f Get) WithParent(v string) func(*GetRequest)

WithParent - the ID of the parent document.

func (Get) WithPreference ¶ 

func (f Get) WithPreference(v string) func(*GetRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (Get) WithPretty ¶ 

func (f Get) WithPretty() func(*GetRequest)

WithPretty makes the response body pretty-printed.

func (Get) WithRealtime ¶ 

func (f Get) WithRealtime(v bool) func(*GetRequest)

WithRealtime - specify whether to perform the operation in realtime or search mode.

func (Get) WithRefresh ¶ 

func (f Get) WithRefresh(v bool) func(*GetRequest)

WithRefresh - refresh the shard containing the document before performing the operation.

func (Get) WithRouting ¶ 

func (f Get) WithRouting(v string) func(*GetRequest)

WithRouting - specific routing value.

func (Get) WithSource ¶ 

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 (Get) WithSourceExclude ¶ 

func (f Get) WithSourceExclude(v ...string) func(*GetRequest)

WithSourceExclude - a list of fields to exclude from the returned _source field.

func (Get) WithSourceExcludes ¶ 

func (f Get) WithSourceExcludes(v ...string) func(*GetRequest)

WithSourceExcludes - a list of fields to exclude from the returned _source field.

func (Get) WithSourceInclude ¶ 

func (f Get) WithSourceInclude(v ...string) func(*GetRequest)

WithSourceInclude - a list of fields to extract and return from the _source field.

func (Get) WithSourceIncludes ¶ 

func (f Get) WithSourceIncludes(v ...string) func(*GetRequest)

WithSourceIncludes - a list of fields to extract and return from the _source field.

func (Get) WithStoredFields ¶ 

func (f Get) WithStoredFields(v ...string) func(*GetRequest)

WithStoredFields - a list of stored fields to return in the response.

func (Get) WithVersion ¶ 

func (f Get) WithVersion(v int) func(*GetRequest)

WithVersion - explicit version number for concurrency control.

func (Get) WithVersionType ¶ 

func (f Get) WithVersionType(v string) func(*GetRequest)

WithVersionType - specific version type.

type GetRequest ¶ 

type GetRequest struct {
	Index        string
	DocumentType string
	DocumentID   string

	Parent         string
	Preference     string
	Realtime       *bool
	Refresh        *bool
	Routing        string
	Source         []string
	SourceExclude  []string
	SourceExcludes []string
	SourceInclude  []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.

func (GetRequest) Do ¶ 

func (r GetRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type GetScript ¶ 

type GetScript func(id string, o ...func(*GetScriptRequest)) (*Response, error)

GetScript returns a script.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html.

func (GetScript) WithContext ¶ 

func (f GetScript) WithContext(v context.Context) func(*GetScriptRequest)

WithContext sets the request context.

func (GetScript) WithErrorTrace ¶ 

func (f GetScript) WithErrorTrace() func(*GetScriptRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (GetScript) WithFilterPath ¶ 

func (f GetScript) WithFilterPath(v ...string) func(*GetScriptRequest)

WithFilterPath filters the properties of the response body.

func (GetScript) WithHeader ¶ added in v6.8.2 

func (f GetScript) WithHeader(h map[string]string) func(*GetScriptRequest)

WithHeader adds the headers to the HTTP request.

func (GetScript) WithHuman ¶ 

func (f GetScript) WithHuman() func(*GetScriptRequest)

WithHuman makes statistical values human-readable.

func (GetScript) WithMasterTimeout ¶ 

func (f GetScript) WithMasterTimeout(v time.Duration) func(*GetScriptRequest)

WithMasterTimeout - specify timeout for connection to master.

func (GetScript) WithOpaqueID ¶ added in v6.8.5 

func (f GetScript) WithOpaqueID(s string) func(*GetScriptRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (GetScript) WithPretty ¶ 

func (f GetScript) WithPretty() func(*GetScriptRequest)

WithPretty makes the response body pretty-printed.

type GetScriptRequest ¶ 

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.

func (GetScriptRequest) Do ¶ 

func (r GetScriptRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type GetSource ¶ 

type GetSource func(index string, id string, o ...func(*GetSourceRequest)) (*Response, error)

GetSource returns the source of a document.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html.

func (GetSource) WithContext ¶ 

func (f GetSource) WithContext(v context.Context) func(*GetSourceRequest)

WithContext sets the request context.

func (GetSource) WithDocumentType ¶ 

func (f GetSource) WithDocumentType(v string) func(*GetSourceRequest)

WithDocumentType - the type of the document; use `_all` to fetch the first document matching the ID across all types.

func (GetSource) WithErrorTrace ¶ 

func (f GetSource) WithErrorTrace() func(*GetSourceRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (GetSource) WithFilterPath ¶ 

func (f GetSource) WithFilterPath(v ...string) func(*GetSourceRequest)

WithFilterPath filters the properties of the response body.

func (GetSource) WithHeader ¶ added in v6.8.2 

func (f GetSource) WithHeader(h map[string]string) func(*GetSourceRequest)

WithHeader adds the headers to the HTTP request.

func (GetSource) WithHuman ¶ 

func (f GetSource) WithHuman() func(*GetSourceRequest)

WithHuman makes statistical values human-readable.

func (GetSource) WithOpaqueID ¶ added in v6.8.5 

func (f GetSource) WithOpaqueID(s string) func(*GetSourceRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (GetSource) WithParent ¶ 

func (f GetSource) WithParent(v string) func(*GetSourceRequest)

WithParent - the ID of the parent document.

func (GetSource) WithPreference ¶ 

func (f GetSource) WithPreference(v string) func(*GetSourceRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (GetSource) WithPretty ¶ 

func (f GetSource) WithPretty() func(*GetSourceRequest)

WithPretty makes the response body pretty-printed.

func (GetSource) WithRealtime ¶ 

func (f GetSource) WithRealtime(v bool) func(*GetSourceRequest)

WithRealtime - specify whether to perform the operation in realtime or search mode.

func (GetSource) WithRefresh ¶ 

func (f GetSource) WithRefresh(v bool) func(*GetSourceRequest)

WithRefresh - refresh the shard containing the document before performing the operation.

func (GetSource) WithRouting ¶ 

func (f GetSource) WithRouting(v string) func(*GetSourceRequest)

WithRouting - specific routing value.

func (GetSource) WithSource ¶ 

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 (GetSource) WithSourceExcludes ¶ 

func (f GetSource) WithSourceExcludes(v ...string) func(*GetSourceRequest)

WithSourceExcludes - a list of fields to exclude from the returned _source field.

func (GetSource) WithSourceIncludes ¶ 

func (f GetSource) WithSourceIncludes(v ...string) func(*GetSourceRequest)

WithSourceIncludes - a list of fields to extract and return from the _source field.

func (GetSource) WithVersion ¶ 

func (f GetSource) WithVersion(v int) func(*GetSourceRequest)

WithVersion - explicit version number for concurrency control.

func (GetSource) WithVersionType ¶ 

func (f GetSource) WithVersionType(v string) func(*GetSourceRequest)

WithVersionType - specific version type.

type GetSourceRequest ¶ 

type GetSourceRequest struct {
	Index        string
	DocumentType string
	DocumentID   string

	Parent         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.

func (GetSourceRequest) Do ¶ 

func (r GetSourceRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILM ¶ added in v6.8.2 

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 ¶ added in v6.8.2 

type ILMDeleteLifecycle func(o ...func(*ILMDeleteLifecycleRequest)) (*Response, error)

ILMDeleteLifecycle - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html

func (ILMDeleteLifecycle) WithContext ¶ added in v6.8.2 

func (f ILMDeleteLifecycle) WithContext(v context.Context) func(*ILMDeleteLifecycleRequest)

WithContext sets the request context.

func (ILMDeleteLifecycle) WithErrorTrace ¶ added in v6.8.2 

func (f ILMDeleteLifecycle) WithErrorTrace() func(*ILMDeleteLifecycleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ILMDeleteLifecycle) WithFilterPath ¶ added in v6.8.2 

func (f ILMDeleteLifecycle) WithFilterPath(v ...string) func(*ILMDeleteLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (ILMDeleteLifecycle) WithHeader ¶ added in v6.8.2 

func (f ILMDeleteLifecycle) WithHeader(h map[string]string) func(*ILMDeleteLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (ILMDeleteLifecycle) WithHuman ¶ added in v6.8.2 

func (f ILMDeleteLifecycle) WithHuman() func(*ILMDeleteLifecycleRequest)

WithHuman makes statistical values human-readable.

func (ILMDeleteLifecycle) WithOpaqueID ¶ added in v6.8.5 

func (f ILMDeleteLifecycle) WithOpaqueID(s string) func(*ILMDeleteLifecycleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ILMDeleteLifecycle) WithPolicy ¶ added in v6.8.2 

func (f ILMDeleteLifecycle) WithPolicy(v string) func(*ILMDeleteLifecycleRequest)

WithPolicy - the name of the index lifecycle policy.

func (ILMDeleteLifecycle) WithPretty ¶ added in v6.8.2 

func (f ILMDeleteLifecycle) WithPretty() func(*ILMDeleteLifecycleRequest)

WithPretty makes the response body pretty-printed.

type ILMDeleteLifecycleRequest ¶ added in v6.8.2 

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.

func (ILMDeleteLifecycleRequest) Do ¶ added in v6.8.2 

func (r ILMDeleteLifecycleRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMExplainLifecycle ¶ added in v6.8.2 

type ILMExplainLifecycle func(o ...func(*ILMExplainLifecycleRequest)) (*Response, error)

ILMExplainLifecycle - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html

func (ILMExplainLifecycle) WithContext ¶ added in v6.8.2 

func (f ILMExplainLifecycle) WithContext(v context.Context) func(*ILMExplainLifecycleRequest)

WithContext sets the request context.

func (ILMExplainLifecycle) WithErrorTrace ¶ added in v6.8.2 

func (f ILMExplainLifecycle) WithErrorTrace() func(*ILMExplainLifecycleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ILMExplainLifecycle) WithFilterPath ¶ added in v6.8.2 

func (f ILMExplainLifecycle) WithFilterPath(v ...string) func(*ILMExplainLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (ILMExplainLifecycle) WithHeader ¶ added in v6.8.2 

func (f ILMExplainLifecycle) WithHeader(h map[string]string) func(*ILMExplainLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (ILMExplainLifecycle) WithHuman ¶ added in v6.8.2 

func (f ILMExplainLifecycle) WithHuman() func(*ILMExplainLifecycleRequest)

WithHuman makes statistical values human-readable.

func (ILMExplainLifecycle) WithIndex ¶ added in v6.8.2 

func (f ILMExplainLifecycle) WithIndex(v string) func(*ILMExplainLifecycleRequest)

WithIndex - the name of the index to explain.

func (ILMExplainLifecycle) WithOpaqueID ¶ added in v6.8.5 

func (f ILMExplainLifecycle) WithOpaqueID(s string) func(*ILMExplainLifecycleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ILMExplainLifecycle) WithPretty ¶ added in v6.8.2 

func (f ILMExplainLifecycle) WithPretty() func(*ILMExplainLifecycleRequest)

WithPretty makes the response body pretty-printed.

type ILMExplainLifecycleRequest ¶ added in v6.8.2 

type ILMExplainLifecycleRequest struct {
	Index string

	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 (ILMExplainLifecycleRequest) Do ¶ added in v6.8.2 

func (r ILMExplainLifecycleRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMGetLifecycle ¶ added in v6.8.2 

type ILMGetLifecycle func(o ...func(*ILMGetLifecycleRequest)) (*Response, error)

ILMGetLifecycle - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html

func (ILMGetLifecycle) WithContext ¶ added in v6.8.2 

func (f ILMGetLifecycle) WithContext(v context.Context) func(*ILMGetLifecycleRequest)

WithContext sets the request context.

func (ILMGetLifecycle) WithErrorTrace ¶ added in v6.8.2 

func (f ILMGetLifecycle) WithErrorTrace() func(*ILMGetLifecycleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ILMGetLifecycle) WithFilterPath ¶ added in v6.8.2 

func (f ILMGetLifecycle) WithFilterPath(v ...string) func(*ILMGetLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (ILMGetLifecycle) WithHeader ¶ added in v6.8.2 

func (f ILMGetLifecycle) WithHeader(h map[string]string) func(*ILMGetLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (ILMGetLifecycle) WithHuman ¶ added in v6.8.2 

func (f ILMGetLifecycle) WithHuman() func(*ILMGetLifecycleRequest)

WithHuman makes statistical values human-readable.

func (ILMGetLifecycle) WithOpaqueID ¶ added in v6.8.5 

func (f ILMGetLifecycle) WithOpaqueID(s string) func(*ILMGetLifecycleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ILMGetLifecycle) WithPolicy ¶ added in v6.8.2 

func (f ILMGetLifecycle) WithPolicy(v string) func(*ILMGetLifecycleRequest)

WithPolicy - the name of the index lifecycle policy.

func (ILMGetLifecycle) WithPretty ¶ added in v6.8.2 

func (f ILMGetLifecycle) WithPretty() func(*ILMGetLifecycleRequest)

WithPretty makes the response body pretty-printed.

type ILMGetLifecycleRequest ¶ added in v6.8.2 

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.

func (ILMGetLifecycleRequest) Do ¶ added in v6.8.2 

func (r ILMGetLifecycleRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMGetStatus ¶ added in v6.8.2 

type ILMGetStatus func(o ...func(*ILMGetStatusRequest)) (*Response, error)

ILMGetStatus - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html

func (ILMGetStatus) WithContext ¶ added in v6.8.2 

func (f ILMGetStatus) WithContext(v context.Context) func(*ILMGetStatusRequest)

WithContext sets the request context.

func (ILMGetStatus) WithErrorTrace ¶ added in v6.8.2 

func (f ILMGetStatus) WithErrorTrace() func(*ILMGetStatusRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ILMGetStatus) WithFilterPath ¶ added in v6.8.2 

func (f ILMGetStatus) WithFilterPath(v ...string) func(*ILMGetStatusRequest)

WithFilterPath filters the properties of the response body.

func (ILMGetStatus) WithHeader ¶ added in v6.8.2 

func (f ILMGetStatus) WithHeader(h map[string]string) func(*ILMGetStatusRequest)

WithHeader adds the headers to the HTTP request.

func (ILMGetStatus) WithHuman ¶ added in v6.8.2 

func (f ILMGetStatus) WithHuman() func(*ILMGetStatusRequest)

WithHuman makes statistical values human-readable.

func (ILMGetStatus) WithOpaqueID ¶ added in v6.8.5 

func (f ILMGetStatus) WithOpaqueID(s string) func(*ILMGetStatusRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ILMGetStatus) WithPretty ¶ added in v6.8.2 

func (f ILMGetStatus) WithPretty() func(*ILMGetStatusRequest)

WithPretty makes the response body pretty-printed.

type ILMGetStatusRequest ¶ added in v6.8.2 

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.

func (ILMGetStatusRequest) Do ¶ added in v6.8.2 

func (r ILMGetStatusRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMMoveToStep ¶ added in v6.8.2 

type ILMMoveToStep func(o ...func(*ILMMoveToStepRequest)) (*Response, error)

ILMMoveToStep - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html

func (ILMMoveToStep) WithBody ¶ added in v6.8.2 

func (f ILMMoveToStep) WithBody(v io.Reader) func(*ILMMoveToStepRequest)

WithBody - The new lifecycle step to move to.

func (ILMMoveToStep) WithContext ¶ added in v6.8.2 

func (f ILMMoveToStep) WithContext(v context.Context) func(*ILMMoveToStepRequest)

WithContext sets the request context.

func (ILMMoveToStep) WithErrorTrace ¶ added in v6.8.2 

func (f ILMMoveToStep) WithErrorTrace() func(*ILMMoveToStepRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ILMMoveToStep) WithFilterPath ¶ added in v6.8.2 

func (f ILMMoveToStep) WithFilterPath(v ...string) func(*ILMMoveToStepRequest)

WithFilterPath filters the properties of the response body.

func (ILMMoveToStep) WithHeader ¶ added in v6.8.2 

func (f ILMMoveToStep) WithHeader(h map[string]string) func(*ILMMoveToStepRequest)

WithHeader adds the headers to the HTTP request.

func (ILMMoveToStep) WithHuman ¶ added in v6.8.2 

func (f ILMMoveToStep) WithHuman() func(*ILMMoveToStepRequest)

WithHuman makes statistical values human-readable.

func (ILMMoveToStep) WithIndex ¶ added in v6.8.2 

func (f ILMMoveToStep) WithIndex(v string) func(*ILMMoveToStepRequest)

WithIndex - the name of the index whose lifecycle step is to change.

func (ILMMoveToStep) WithOpaqueID ¶ added in v6.8.5 

func (f ILMMoveToStep) WithOpaqueID(s string) func(*ILMMoveToStepRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ILMMoveToStep) WithPretty ¶ added in v6.8.2 

func (f ILMMoveToStep) WithPretty() func(*ILMMoveToStepRequest)

WithPretty makes the response body pretty-printed.

type ILMMoveToStepRequest ¶ added in v6.8.2 

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.

func (ILMMoveToStepRequest) Do ¶ added in v6.8.2 

func (r ILMMoveToStepRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMPutLifecycle ¶ added in v6.8.2 

type ILMPutLifecycle func(o ...func(*ILMPutLifecycleRequest)) (*Response, error)

ILMPutLifecycle - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html

func (ILMPutLifecycle) WithBody ¶ added in v6.8.2 

func (f ILMPutLifecycle) WithBody(v io.Reader) func(*ILMPutLifecycleRequest)

WithBody - The lifecycle policy definition to register.

func (ILMPutLifecycle) WithContext ¶ added in v6.8.2 

func (f ILMPutLifecycle) WithContext(v context.Context) func(*ILMPutLifecycleRequest)

WithContext sets the request context.

func (ILMPutLifecycle) WithErrorTrace ¶ added in v6.8.2 

func (f ILMPutLifecycle) WithErrorTrace() func(*ILMPutLifecycleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ILMPutLifecycle) WithFilterPath ¶ added in v6.8.2 

func (f ILMPutLifecycle) WithFilterPath(v ...string) func(*ILMPutLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (ILMPutLifecycle) WithHeader ¶ added in v6.8.2 

func (f ILMPutLifecycle) WithHeader(h map[string]string) func(*ILMPutLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (ILMPutLifecycle) WithHuman ¶ added in v6.8.2 

func (f ILMPutLifecycle) WithHuman() func(*ILMPutLifecycleRequest)

WithHuman makes statistical values human-readable.

func (ILMPutLifecycle) WithOpaqueID ¶ added in v6.8.5 

func (f ILMPutLifecycle) WithOpaqueID(s string) func(*ILMPutLifecycleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ILMPutLifecycle) WithPolicy ¶ added in v6.8.2 

func (f ILMPutLifecycle) WithPolicy(v string) func(*ILMPutLifecycleRequest)

WithPolicy - the name of the index lifecycle policy.

func (ILMPutLifecycle) WithPretty ¶ added in v6.8.2 

func (f ILMPutLifecycle) WithPretty() func(*ILMPutLifecycleRequest)

WithPretty makes the response body pretty-printed.

type ILMPutLifecycleRequest ¶ added in v6.8.2 

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.

func (ILMPutLifecycleRequest) Do ¶ added in v6.8.2 

func (r ILMPutLifecycleRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMRemovePolicy ¶ added in v6.8.2 

type ILMRemovePolicy func(o ...func(*ILMRemovePolicyRequest)) (*Response, error)

ILMRemovePolicy - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html

func (ILMRemovePolicy) WithContext ¶ added in v6.8.2 

func (f ILMRemovePolicy) WithContext(v context.Context) func(*ILMRemovePolicyRequest)

WithContext sets the request context.

func (ILMRemovePolicy) WithErrorTrace ¶ added in v6.8.2 

func (f ILMRemovePolicy) WithErrorTrace() func(*ILMRemovePolicyRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ILMRemovePolicy) WithFilterPath ¶ added in v6.8.2 

func (f ILMRemovePolicy) WithFilterPath(v ...string) func(*ILMRemovePolicyRequest)

WithFilterPath filters the properties of the response body.

func (ILMRemovePolicy) WithHeader ¶ added in v6.8.2 

func (f ILMRemovePolicy) WithHeader(h map[string]string) func(*ILMRemovePolicyRequest)

WithHeader adds the headers to the HTTP request.

func (ILMRemovePolicy) WithHuman ¶ added in v6.8.2 

func (f ILMRemovePolicy) WithHuman() func(*ILMRemovePolicyRequest)

WithHuman makes statistical values human-readable.

func (ILMRemovePolicy) WithIndex ¶ added in v6.8.2 

func (f ILMRemovePolicy) WithIndex(v string) func(*ILMRemovePolicyRequest)

WithIndex - the name of the index to remove policy on.

func (ILMRemovePolicy) WithOpaqueID ¶ added in v6.8.5 

func (f ILMRemovePolicy) WithOpaqueID(s string) func(*ILMRemovePolicyRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ILMRemovePolicy) WithPretty ¶ added in v6.8.2 

func (f ILMRemovePolicy) WithPretty() func(*ILMRemovePolicyRequest)

WithPretty makes the response body pretty-printed.

type ILMRemovePolicyRequest ¶ added in v6.8.2 

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.

func (ILMRemovePolicyRequest) Do ¶ added in v6.8.2 

func (r ILMRemovePolicyRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMRetry ¶ added in v6.8.2 

type ILMRetry func(o ...func(*ILMRetryRequest)) (*Response, error)

ILMRetry - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html

func (ILMRetry) WithContext ¶ added in v6.8.2 

func (f ILMRetry) WithContext(v context.Context) func(*ILMRetryRequest)

WithContext sets the request context.

func (ILMRetry) WithErrorTrace ¶ added in v6.8.2 

func (f ILMRetry) WithErrorTrace() func(*ILMRetryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ILMRetry) WithFilterPath ¶ added in v6.8.2 

func (f ILMRetry) WithFilterPath(v ...string) func(*ILMRetryRequest)

WithFilterPath filters the properties of the response body.

func (ILMRetry) WithHeader ¶ added in v6.8.2 

func (f ILMRetry) WithHeader(h map[string]string) func(*ILMRetryRequest)

WithHeader adds the headers to the HTTP request.

func (ILMRetry) WithHuman ¶ added in v6.8.2 

func (f ILMRetry) WithHuman() func(*ILMRetryRequest)

WithHuman makes statistical values human-readable.

func (ILMRetry) WithIndex ¶ added in v6.8.2 

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 (ILMRetry) WithOpaqueID ¶ added in v6.8.5 

func (f ILMRetry) WithOpaqueID(s string) func(*ILMRetryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ILMRetry) WithPretty ¶ added in v6.8.2 

func (f ILMRetry) WithPretty() func(*ILMRetryRequest)

WithPretty makes the response body pretty-printed.

type ILMRetryRequest ¶ added in v6.8.2 

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.

func (ILMRetryRequest) Do ¶ added in v6.8.2 

func (r ILMRetryRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMStart ¶ added in v6.8.2 

type ILMStart func(o ...func(*ILMStartRequest)) (*Response, error)

ILMStart - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html

func (ILMStart) WithContext ¶ added in v6.8.2 

func (f ILMStart) WithContext(v context.Context) func(*ILMStartRequest)

WithContext sets the request context.

func (ILMStart) WithErrorTrace ¶ added in v6.8.2 

func (f ILMStart) WithErrorTrace() func(*ILMStartRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ILMStart) WithFilterPath ¶ added in v6.8.2 

func (f ILMStart) WithFilterPath(v ...string) func(*ILMStartRequest)

WithFilterPath filters the properties of the response body.

func (ILMStart) WithHeader ¶ added in v6.8.2 

func (f ILMStart) WithHeader(h map[string]string) func(*ILMStartRequest)

WithHeader adds the headers to the HTTP request.

func (ILMStart) WithHuman ¶ added in v6.8.2 

func (f ILMStart) WithHuman() func(*ILMStartRequest)

WithHuman makes statistical values human-readable.

func (ILMStart) WithOpaqueID ¶ added in v6.8.5 

func (f ILMStart) WithOpaqueID(s string) func(*ILMStartRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ILMStart) WithPretty ¶ added in v6.8.2 

func (f ILMStart) WithPretty() func(*ILMStartRequest)

WithPretty makes the response body pretty-printed.

type ILMStartRequest ¶ added in v6.8.2 

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.

func (ILMStartRequest) Do ¶ added in v6.8.2 

func (r ILMStartRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMStop ¶ added in v6.8.2 

type ILMStop func(o ...func(*ILMStopRequest)) (*Response, error)

ILMStop - https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html

func (ILMStop) WithContext ¶ added in v6.8.2 

func (f ILMStop) WithContext(v context.Context) func(*ILMStopRequest)

WithContext sets the request context.

func (ILMStop) WithErrorTrace ¶ added in v6.8.2 

func (f ILMStop) WithErrorTrace() func(*ILMStopRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ILMStop) WithFilterPath ¶ added in v6.8.2 

func (f ILMStop) WithFilterPath(v ...string) func(*ILMStopRequest)

WithFilterPath filters the properties of the response body.

func (ILMStop) WithHeader ¶ added in v6.8.2 

func (f ILMStop) WithHeader(h map[string]string) func(*ILMStopRequest)

WithHeader adds the headers to the HTTP request.

func (ILMStop) WithHuman ¶ added in v6.8.2 

func (f ILMStop) WithHuman() func(*ILMStopRequest)

WithHuman makes statistical values human-readable.

func (ILMStop) WithOpaqueID ¶ added in v6.8.5 

func (f ILMStop) WithOpaqueID(s string) func(*ILMStopRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ILMStop) WithPretty ¶ added in v6.8.2 

func (f ILMStop) WithPretty() func(*ILMStopRequest)

WithPretty makes the response body pretty-printed.

type ILMStopRequest ¶ added in v6.8.2 

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.

func (ILMStopRequest) Do ¶ added in v6.8.2 

func (r ILMStopRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Index ¶ 

type Index func(index string, body io.Reader, o ...func(*IndexRequest)) (*Response, error)

Index creates or updates a document in an index.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html.

func (Index) WithContext ¶ 

func (f Index) WithContext(v context.Context) func(*IndexRequest)

WithContext sets the request context.

func (Index) WithDocumentID ¶ 

func (f Index) WithDocumentID(v string) func(*IndexRequest)

WithDocumentID - document ID.

func (Index) WithDocumentType ¶ 

func (f Index) WithDocumentType(v string) func(*IndexRequest)

WithDocumentType - the type of the document.

func (Index) WithErrorTrace ¶ 

func (f Index) WithErrorTrace() func(*IndexRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Index) WithFilterPath ¶ 

func (f Index) WithFilterPath(v ...string) func(*IndexRequest)

WithFilterPath filters the properties of the response body.

func (Index) WithHeader ¶ added in v6.8.2 

func (f Index) WithHeader(h map[string]string) func(*IndexRequest)

WithHeader adds the headers to the HTTP request.

func (Index) WithHuman ¶ 

func (f Index) WithHuman() func(*IndexRequest)

WithHuman makes statistical values human-readable.

func (Index) WithIfPrimaryTerm ¶ 

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 (Index) WithIfSeqNo ¶ 

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 (Index) WithOpType ¶ 

func (f Index) WithOpType(v string) func(*IndexRequest)

WithOpType - explicit operation type.

func (Index) WithOpaqueID ¶ added in v6.8.5 

func (f Index) WithOpaqueID(s string) func(*IndexRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Index) WithParent ¶ 

func (f Index) WithParent(v string) func(*IndexRequest)

WithParent - ID of the parent document.

func (Index) WithPipeline ¶ 

func (f Index) WithPipeline(v string) func(*IndexRequest)

WithPipeline - the pipeline ID to preprocess incoming documents with.

func (Index) WithPretty ¶ 

func (f Index) WithPretty() func(*IndexRequest)

WithPretty makes the response body pretty-printed.

func (Index) WithRefresh ¶ 

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 (Index) WithRouting ¶ 

func (f Index) WithRouting(v string) func(*IndexRequest)

WithRouting - specific routing value.

func (Index) WithTimeout ¶ 

func (f Index) WithTimeout(v time.Duration) func(*IndexRequest)

WithTimeout - explicit operation timeout.

func (Index) WithVersion ¶ 

func (f Index) WithVersion(v int) func(*IndexRequest)

WithVersion - explicit version number for concurrency control.

func (Index) WithVersionType ¶ 

func (f Index) WithVersionType(v string) func(*IndexRequest)

WithVersionType - specific version type.

func (Index) WithWaitForActiveShards ¶ 

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 ¶ 

type IndexRequest struct {
	Index        string
	DocumentType string
	DocumentID   string

	Body io.Reader

	IfPrimaryTerm       *int
	IfSeqNo             *int
	OpType              string
	Parent              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.

func (IndexRequest) Do ¶ 

func (r IndexRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Indices ¶ 

type Indices struct {
	Analyze            IndicesAnalyze
	ClearCache         IndicesClearCache
	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
	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 ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html.

func (IndicesAnalyze) WithBody ¶ 

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 (IndicesAnalyze) WithContext ¶ 

func (f IndicesAnalyze) WithContext(v context.Context) func(*IndicesAnalyzeRequest)

WithContext sets the request context.

func (IndicesAnalyze) WithErrorTrace ¶ 

func (f IndicesAnalyze) WithErrorTrace() func(*IndicesAnalyzeRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesAnalyze) WithFilterPath ¶ 

func (f IndicesAnalyze) WithFilterPath(v ...string) func(*IndicesAnalyzeRequest)

WithFilterPath filters the properties of the response body.

func (IndicesAnalyze) WithHeader ¶ added in v6.8.2 

func (f IndicesAnalyze) WithHeader(h map[string]string) func(*IndicesAnalyzeRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesAnalyze) WithHuman ¶ 

func (f IndicesAnalyze) WithHuman() func(*IndicesAnalyzeRequest)

WithHuman makes statistical values human-readable.

func (IndicesAnalyze) WithIndex ¶ 

func (f IndicesAnalyze) WithIndex(v string) func(*IndicesAnalyzeRequest)

WithIndex - the name of the index to scope the operation.

func (IndicesAnalyze) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesAnalyze) WithOpaqueID(s string) func(*IndicesAnalyzeRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesAnalyze) WithPretty ¶ 

func (f IndicesAnalyze) WithPretty() func(*IndicesAnalyzeRequest)

WithPretty makes the response body pretty-printed.

type IndicesAnalyzeRequest ¶ 

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.

func (IndicesAnalyzeRequest) Do ¶ 

func (r IndicesAnalyzeRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesClearCache ¶ 

type IndicesClearCache func(o ...func(*IndicesClearCacheRequest)) (*Response, error)

IndicesClearCache clears all or specific caches for one or more indices.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html.

func (IndicesClearCache) WithAllowNoIndices ¶ 

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 (IndicesClearCache) WithContext ¶ 

func (f IndicesClearCache) WithContext(v context.Context) func(*IndicesClearCacheRequest)

WithContext sets the request context.

func (IndicesClearCache) WithErrorTrace ¶ 

func (f IndicesClearCache) WithErrorTrace() func(*IndicesClearCacheRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesClearCache) WithExpandWildcards ¶ 

func (f IndicesClearCache) WithExpandWildcards(v string) func(*IndicesClearCacheRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesClearCache) WithFieldData ¶ 

func (f IndicesClearCache) WithFieldData(v bool) func(*IndicesClearCacheRequest)

WithFieldData - clear field data. this is deprecated. prefer `fielddata`..

func (IndicesClearCache) WithFielddata ¶ 

func (f IndicesClearCache) WithFielddata(v bool) func(*IndicesClearCacheRequest)

WithFielddata - clear field data.

func (IndicesClearCache) WithFields ¶ 

func (f IndicesClearCache) WithFields(v ...string) func(*IndicesClearCacheRequest)

WithFields - a list of fields to clear when using the `fielddata` parameter (default: all).

func (IndicesClearCache) WithFilterPath ¶ 

func (f IndicesClearCache) WithFilterPath(v ...string) func(*IndicesClearCacheRequest)

WithFilterPath filters the properties of the response body.

func (IndicesClearCache) WithHeader ¶ added in v6.8.2 

func (f IndicesClearCache) WithHeader(h map[string]string) func(*IndicesClearCacheRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesClearCache) WithHuman ¶ 

func (f IndicesClearCache) WithHuman() func(*IndicesClearCacheRequest)

WithHuman makes statistical values human-readable.

func (IndicesClearCache) WithIgnoreUnavailable ¶ 

func (f IndicesClearCache) WithIgnoreUnavailable(v bool) func(*IndicesClearCacheRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesClearCache) WithIndex ¶ 

func (f IndicesClearCache) WithIndex(v ...string) func(*IndicesClearCacheRequest)

WithIndex - a list of index name to limit the operation.

func (IndicesClearCache) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesClearCache) WithOpaqueID(s string) func(*IndicesClearCacheRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesClearCache) WithPretty ¶ 

func (f IndicesClearCache) WithPretty() func(*IndicesClearCacheRequest)

WithPretty makes the response body pretty-printed.

func (IndicesClearCache) WithQuery ¶ 

func (f IndicesClearCache) WithQuery(v bool) func(*IndicesClearCacheRequest)

WithQuery - clear query caches.

func (IndicesClearCache) WithRequest ¶ 

func (f IndicesClearCache) WithRequest(v bool) func(*IndicesClearCacheRequest)

WithRequest - clear request cache.

func (IndicesClearCache) WithRequestCache ¶ 

func (f IndicesClearCache) WithRequestCache(v bool) func(*IndicesClearCacheRequest)

WithRequestCache - clear request cache.

type IndicesClearCacheRequest ¶ 

type IndicesClearCacheRequest struct {
	Index []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	Fielddata         *bool
	FieldData         *bool
	Fields            []string
	IgnoreUnavailable *bool
	Query             *bool
	Request           *bool
	RequestCache      *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.

func (IndicesClearCacheRequest) Do ¶ 

func (r IndicesClearCacheRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesClose ¶ 

type IndicesClose func(index []string, o ...func(*IndicesCloseRequest)) (*Response, error)

IndicesClose closes an index.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html.

func (IndicesClose) WithAllowNoIndices ¶ 

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 (IndicesClose) WithContext ¶ 

func (f IndicesClose) WithContext(v context.Context) func(*IndicesCloseRequest)

WithContext sets the request context.

func (IndicesClose) WithErrorTrace ¶ 

func (f IndicesClose) WithErrorTrace() func(*IndicesCloseRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesClose) WithExpandWildcards ¶ 

func (f IndicesClose) WithExpandWildcards(v string) func(*IndicesCloseRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesClose) WithFilterPath ¶ 

func (f IndicesClose) WithFilterPath(v ...string) func(*IndicesCloseRequest)

WithFilterPath filters the properties of the response body.

func (IndicesClose) WithHeader ¶ added in v6.8.2 

func (f IndicesClose) WithHeader(h map[string]string) func(*IndicesCloseRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesClose) WithHuman ¶ 

func (f IndicesClose) WithHuman() func(*IndicesCloseRequest)

WithHuman makes statistical values human-readable.

func (IndicesClose) WithIgnoreUnavailable ¶ 

func (f IndicesClose) WithIgnoreUnavailable(v bool) func(*IndicesCloseRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesClose) WithMasterTimeout ¶ 

func (f IndicesClose) WithMasterTimeout(v time.Duration) func(*IndicesCloseRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesClose) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesClose) WithOpaqueID(s string) func(*IndicesCloseRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesClose) WithPretty ¶ 

func (f IndicesClose) WithPretty() func(*IndicesCloseRequest)

WithPretty makes the response body pretty-printed.

func (IndicesClose) WithTimeout ¶ 

func (f IndicesClose) WithTimeout(v time.Duration) func(*IndicesCloseRequest)

WithTimeout - explicit operation timeout.

type IndicesCloseRequest ¶ 

type IndicesCloseRequest struct {
	Index []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *bool
	MasterTimeout     time.Duration
	Timeout           time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesCloseRequest configures the Indices Close API request.

func (IndicesCloseRequest) Do ¶ 

func (r IndicesCloseRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesCreate ¶ 

type IndicesCreate func(index string, o ...func(*IndicesCreateRequest)) (*Response, error)

IndicesCreate creates an index with optional settings and mappings.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html.

func (IndicesCreate) WithBody ¶ 

func (f IndicesCreate) WithBody(v io.Reader) func(*IndicesCreateRequest)

WithBody - The configuration for the index (`settings` and `mappings`).

func (IndicesCreate) WithContext ¶ 

func (f IndicesCreate) WithContext(v context.Context) func(*IndicesCreateRequest)

WithContext sets the request context.

func (IndicesCreate) WithErrorTrace ¶ 

func (f IndicesCreate) WithErrorTrace() func(*IndicesCreateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesCreate) WithFilterPath ¶ 

func (f IndicesCreate) WithFilterPath(v ...string) func(*IndicesCreateRequest)

WithFilterPath filters the properties of the response body.

func (IndicesCreate) WithHeader ¶ added in v6.8.2 

func (f IndicesCreate) WithHeader(h map[string]string) func(*IndicesCreateRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesCreate) WithHuman ¶ 

func (f IndicesCreate) WithHuman() func(*IndicesCreateRequest)

WithHuman makes statistical values human-readable.

func (IndicesCreate) WithIncludeTypeName ¶ 

func (f IndicesCreate) WithIncludeTypeName(v bool) func(*IndicesCreateRequest)

WithIncludeTypeName - whether a type should be expected in the body of the mappings..

func (IndicesCreate) WithMasterTimeout ¶ 

func (f IndicesCreate) WithMasterTimeout(v time.Duration) func(*IndicesCreateRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesCreate) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesCreate) WithOpaqueID(s string) func(*IndicesCreateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesCreate) WithPretty ¶ 

func (f IndicesCreate) WithPretty() func(*IndicesCreateRequest)

WithPretty makes the response body pretty-printed.

func (IndicesCreate) WithTimeout ¶ 

func (f IndicesCreate) WithTimeout(v time.Duration) func(*IndicesCreateRequest)

WithTimeout - explicit operation timeout.

func (IndicesCreate) WithUpdateAllTypes ¶ 

func (f IndicesCreate) WithUpdateAllTypes(v bool) func(*IndicesCreateRequest)

WithUpdateAllTypes - whether to update the mapping for all fields with the same name across all types or not.

func (IndicesCreate) WithWaitForActiveShards ¶ 

func (f IndicesCreate) WithWaitForActiveShards(v string) func(*IndicesCreateRequest)

WithWaitForActiveShards - set the number of active shards to wait for before the operation returns..

type IndicesCreateRequest ¶ 

type IndicesCreateRequest struct {
	Index string

	Body io.Reader

	IncludeTypeName     *bool
	MasterTimeout       time.Duration
	Timeout             time.Duration
	UpdateAllTypes      *bool
	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.

func (IndicesCreateRequest) Do ¶ 

func (r IndicesCreateRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesDelete ¶ 

type IndicesDelete func(index []string, o ...func(*IndicesDeleteRequest)) (*Response, error)

IndicesDelete deletes an index.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html.

func (IndicesDelete) WithAllowNoIndices ¶ 

func (f IndicesDelete) WithAllowNoIndices(v bool) func(*IndicesDeleteRequest)

WithAllowNoIndices - ignore if a wildcard expression resolves to no concrete indices (default: false).

func (IndicesDelete) WithContext ¶ 

func (f IndicesDelete) WithContext(v context.Context) func(*IndicesDeleteRequest)

WithContext sets the request context.

func (IndicesDelete) WithErrorTrace ¶ 

func (f IndicesDelete) WithErrorTrace() func(*IndicesDeleteRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesDelete) WithExpandWildcards ¶ 

func (f IndicesDelete) WithExpandWildcards(v string) func(*IndicesDeleteRequest)

WithExpandWildcards - whether wildcard expressions should get expanded to open or closed indices (default: open).

func (IndicesDelete) WithFilterPath ¶ 

func (f IndicesDelete) WithFilterPath(v ...string) func(*IndicesDeleteRequest)

WithFilterPath filters the properties of the response body.

func (IndicesDelete) WithHeader ¶ added in v6.8.2 

func (f IndicesDelete) WithHeader(h map[string]string) func(*IndicesDeleteRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesDelete) WithHuman ¶ 

func (f IndicesDelete) WithHuman() func(*IndicesDeleteRequest)

WithHuman makes statistical values human-readable.

func (IndicesDelete) WithIgnoreUnavailable ¶ 

func (f IndicesDelete) WithIgnoreUnavailable(v bool) func(*IndicesDeleteRequest)

WithIgnoreUnavailable - ignore unavailable indexes (default: false).

func (IndicesDelete) WithMasterTimeout ¶ 

func (f IndicesDelete) WithMasterTimeout(v time.Duration) func(*IndicesDeleteRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesDelete) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesDelete) WithOpaqueID(s string) func(*IndicesDeleteRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesDelete) WithPretty ¶ 

func (f IndicesDelete) WithPretty() func(*IndicesDeleteRequest)

WithPretty makes the response body pretty-printed.

func (IndicesDelete) WithTimeout ¶ 

func (f IndicesDelete) WithTimeout(v time.Duration) func(*IndicesDeleteRequest)

WithTimeout - explicit operation timeout.

type IndicesDeleteAlias ¶ 

type IndicesDeleteAlias func(index []string, name []string, o ...func(*IndicesDeleteAliasRequest)) (*Response, error)

IndicesDeleteAlias deletes an alias.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html.

func (IndicesDeleteAlias) WithContext ¶ 

func (f IndicesDeleteAlias) WithContext(v context.Context) func(*IndicesDeleteAliasRequest)

WithContext sets the request context.

func (IndicesDeleteAlias) WithErrorTrace ¶ 

func (f IndicesDeleteAlias) WithErrorTrace() func(*IndicesDeleteAliasRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesDeleteAlias) WithFilterPath ¶ 

func (f IndicesDeleteAlias) WithFilterPath(v ...string) func(*IndicesDeleteAliasRequest)

WithFilterPath filters the properties of the response body.

func (IndicesDeleteAlias) WithHeader ¶ added in v6.8.2 

func (f IndicesDeleteAlias) WithHeader(h map[string]string) func(*IndicesDeleteAliasRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesDeleteAlias) WithHuman ¶ 

func (f IndicesDeleteAlias) WithHuman() func(*IndicesDeleteAliasRequest)

WithHuman makes statistical values human-readable.

func (IndicesDeleteAlias) WithMasterTimeout ¶ 

func (f IndicesDeleteAlias) WithMasterTimeout(v time.Duration) func(*IndicesDeleteAliasRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesDeleteAlias) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesDeleteAlias) WithOpaqueID(s string) func(*IndicesDeleteAliasRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesDeleteAlias) WithPretty ¶ 

func (f IndicesDeleteAlias) WithPretty() func(*IndicesDeleteAliasRequest)

WithPretty makes the response body pretty-printed.

func (IndicesDeleteAlias) WithTimeout ¶ 

func (f IndicesDeleteAlias) WithTimeout(v time.Duration) func(*IndicesDeleteAliasRequest)

WithTimeout - explicit timestamp for the document.

type IndicesDeleteAliasRequest ¶ 

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.

func (IndicesDeleteAliasRequest) Do ¶ 

func (r IndicesDeleteAliasRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesDeleteRequest ¶ 

type IndicesDeleteRequest struct {
	Index []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *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.

func (IndicesDeleteRequest) Do ¶ 

func (r IndicesDeleteRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesDeleteTemplate ¶ 

type IndicesDeleteTemplate func(name string, o ...func(*IndicesDeleteTemplateRequest)) (*Response, error)

IndicesDeleteTemplate deletes an index template.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html.

func (IndicesDeleteTemplate) WithContext ¶ 

func (f IndicesDeleteTemplate) WithContext(v context.Context) func(*IndicesDeleteTemplateRequest)

WithContext sets the request context.

func (IndicesDeleteTemplate) WithErrorTrace ¶ 

func (f IndicesDeleteTemplate) WithErrorTrace() func(*IndicesDeleteTemplateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesDeleteTemplate) WithFilterPath ¶ 

func (f IndicesDeleteTemplate) WithFilterPath(v ...string) func(*IndicesDeleteTemplateRequest)

WithFilterPath filters the properties of the response body.

func (IndicesDeleteTemplate) WithHeader ¶ added in v6.8.2 

func (f IndicesDeleteTemplate) WithHeader(h map[string]string) func(*IndicesDeleteTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesDeleteTemplate) WithHuman ¶ 

func (f IndicesDeleteTemplate) WithHuman() func(*IndicesDeleteTemplateRequest)

WithHuman makes statistical values human-readable.

func (IndicesDeleteTemplate) WithMasterTimeout ¶ 

func (f IndicesDeleteTemplate) WithMasterTimeout(v time.Duration) func(*IndicesDeleteTemplateRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesDeleteTemplate) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesDeleteTemplate) WithOpaqueID(s string) func(*IndicesDeleteTemplateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesDeleteTemplate) WithPretty ¶ 

func (f IndicesDeleteTemplate) WithPretty() func(*IndicesDeleteTemplateRequest)

WithPretty makes the response body pretty-printed.

func (IndicesDeleteTemplate) WithTimeout ¶ 

func (f IndicesDeleteTemplate) WithTimeout(v time.Duration) func(*IndicesDeleteTemplateRequest)

WithTimeout - explicit operation timeout.

type IndicesDeleteTemplateRequest ¶ 

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 (IndicesDeleteTemplateRequest) Do ¶ 

func (r IndicesDeleteTemplateRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesExists ¶ 

type IndicesExists func(index []string, o ...func(*IndicesExistsRequest)) (*Response, error)

IndicesExists returns information about whether a particular index exists.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html.

func (IndicesExists) WithAllowNoIndices ¶ 

func (f IndicesExists) WithAllowNoIndices(v bool) func(*IndicesExistsRequest)

WithAllowNoIndices - ignore if a wildcard expression resolves to no concrete indices (default: false).

func (IndicesExists) WithContext ¶ 

func (f IndicesExists) WithContext(v context.Context) func(*IndicesExistsRequest)

WithContext sets the request context.

func (IndicesExists) WithErrorTrace ¶ 

func (f IndicesExists) WithErrorTrace() func(*IndicesExistsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesExists) WithExpandWildcards ¶ 

func (f IndicesExists) WithExpandWildcards(v string) func(*IndicesExistsRequest)

WithExpandWildcards - whether wildcard expressions should get expanded to open or closed indices (default: open).

func (IndicesExists) WithFilterPath ¶ 

func (f IndicesExists) WithFilterPath(v ...string) func(*IndicesExistsRequest)

WithFilterPath filters the properties of the response body.

func (IndicesExists) WithFlatSettings ¶ 

func (f IndicesExists) WithFlatSettings(v bool) func(*IndicesExistsRequest)

WithFlatSettings - return settings in flat format (default: false).

func (IndicesExists) WithHeader ¶ added in v6.8.2 

func (f IndicesExists) WithHeader(h map[string]string) func(*IndicesExistsRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesExists) WithHuman ¶ 

func (f IndicesExists) WithHuman() func(*IndicesExistsRequest)

WithHuman makes statistical values human-readable.

func (IndicesExists) WithIgnoreUnavailable ¶ 

func (f IndicesExists) WithIgnoreUnavailable(v bool) func(*IndicesExistsRequest)

WithIgnoreUnavailable - ignore unavailable indexes (default: false).

func (IndicesExists) WithIncludeDefaults ¶ 

func (f IndicesExists) WithIncludeDefaults(v bool) func(*IndicesExistsRequest)

WithIncludeDefaults - whether to return all default setting for each of the indices..

func (IndicesExists) WithLocal ¶ 

func (f IndicesExists) WithLocal(v bool) func(*IndicesExistsRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (IndicesExists) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesExists) WithOpaqueID(s string) func(*IndicesExistsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesExists) WithPretty ¶ 

func (f IndicesExists) WithPretty() func(*IndicesExistsRequest)

WithPretty makes the response body pretty-printed.

type IndicesExistsAlias ¶ 

type IndicesExistsAlias func(name []string, o ...func(*IndicesExistsAliasRequest)) (*Response, error)

IndicesExistsAlias returns information about whether a particular alias exists.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html.

func (IndicesExistsAlias) WithAllowNoIndices ¶ 

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 (IndicesExistsAlias) WithContext ¶ 

func (f IndicesExistsAlias) WithContext(v context.Context) func(*IndicesExistsAliasRequest)

WithContext sets the request context.

func (IndicesExistsAlias) WithErrorTrace ¶ 

func (f IndicesExistsAlias) WithErrorTrace() func(*IndicesExistsAliasRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesExistsAlias) WithExpandWildcards ¶ 

func (f IndicesExistsAlias) WithExpandWildcards(v string) func(*IndicesExistsAliasRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesExistsAlias) WithFilterPath ¶ 

func (f IndicesExistsAlias) WithFilterPath(v ...string) func(*IndicesExistsAliasRequest)

WithFilterPath filters the properties of the response body.

func (IndicesExistsAlias) WithHeader ¶ added in v6.8.2 

func (f IndicesExistsAlias) WithHeader(h map[string]string) func(*IndicesExistsAliasRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesExistsAlias) WithHuman ¶ 

func (f IndicesExistsAlias) WithHuman() func(*IndicesExistsAliasRequest)

WithHuman makes statistical values human-readable.

func (IndicesExistsAlias) WithIgnoreUnavailable ¶ 

func (f IndicesExistsAlias) WithIgnoreUnavailable(v bool) func(*IndicesExistsAliasRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesExistsAlias) WithIndex ¶ 

func (f IndicesExistsAlias) WithIndex(v ...string) func(*IndicesExistsAliasRequest)

WithIndex - a list of index names to filter aliases.

func (IndicesExistsAlias) WithLocal ¶ 

func (f IndicesExistsAlias) WithLocal(v bool) func(*IndicesExistsAliasRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (IndicesExistsAlias) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesExistsAlias) WithOpaqueID(s string) func(*IndicesExistsAliasRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesExistsAlias) WithPretty ¶ 

func (f IndicesExistsAlias) WithPretty() func(*IndicesExistsAliasRequest)

WithPretty makes the response body pretty-printed.

type IndicesExistsAliasRequest ¶ 

type IndicesExistsAliasRequest struct {
	Index []string

	Name []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *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.

func (IndicesExistsAliasRequest) Do ¶ 

func (r IndicesExistsAliasRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesExistsDocumentType ¶ added in v6.8.2 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html.

func (IndicesExistsDocumentType) WithAllowNoIndices ¶ added in v6.8.2 

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 (IndicesExistsDocumentType) WithContext ¶ added in v6.8.2 

func (f IndicesExistsDocumentType) WithContext(v context.Context) func(*IndicesExistsDocumentTypeRequest)

WithContext sets the request context.

func (IndicesExistsDocumentType) WithDocumentType ¶ added in v6.8.2 

func (f IndicesExistsDocumentType) WithDocumentType(v ...string) func(*IndicesExistsDocumentTypeRequest)

WithDocumentType - a list of document types to check.

func (IndicesExistsDocumentType) WithErrorTrace ¶ added in v6.8.2 

func (f IndicesExistsDocumentType) WithErrorTrace() func(*IndicesExistsDocumentTypeRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesExistsDocumentType) WithExpandWildcards ¶ added in v6.8.2 

func (f IndicesExistsDocumentType) WithExpandWildcards(v string) func(*IndicesExistsDocumentTypeRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesExistsDocumentType) WithFilterPath ¶ added in v6.8.2 

func (f IndicesExistsDocumentType) WithFilterPath(v ...string) func(*IndicesExistsDocumentTypeRequest)

WithFilterPath filters the properties of the response body.

func (IndicesExistsDocumentType) WithHeader ¶ added in v6.8.2 

func (f IndicesExistsDocumentType) WithHeader(h map[string]string) func(*IndicesExistsDocumentTypeRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesExistsDocumentType) WithHuman ¶ added in v6.8.2 

func (f IndicesExistsDocumentType) WithHuman() func(*IndicesExistsDocumentTypeRequest)

WithHuman makes statistical values human-readable.

func (IndicesExistsDocumentType) WithIgnoreUnavailable ¶ added in v6.8.2 

func (f IndicesExistsDocumentType) WithIgnoreUnavailable(v bool) func(*IndicesExistsDocumentTypeRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesExistsDocumentType) WithLocal ¶ added in v6.8.2 

func (f IndicesExistsDocumentType) WithLocal(v bool) func(*IndicesExistsDocumentTypeRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (IndicesExistsDocumentType) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesExistsDocumentType) WithOpaqueID(s string) func(*IndicesExistsDocumentTypeRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesExistsDocumentType) WithPretty ¶ added in v6.8.2 

func (f IndicesExistsDocumentType) WithPretty() func(*IndicesExistsDocumentTypeRequest)

WithPretty makes the response body pretty-printed.

type IndicesExistsDocumentTypeRequest ¶ added in v6.8.2 

type IndicesExistsDocumentTypeRequest struct {
	Index        []string
	DocumentType []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *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 (IndicesExistsDocumentTypeRequest) Do ¶ added in v6.8.2 

func (r IndicesExistsDocumentTypeRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesExistsRequest ¶ 

type IndicesExistsRequest struct {
	Index []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	FlatSettings      *bool
	IgnoreUnavailable *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.

func (IndicesExistsRequest) Do ¶ 

func (r IndicesExistsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesExistsTemplate ¶ 

type IndicesExistsTemplate func(name []string, o ...func(*IndicesExistsTemplateRequest)) (*Response, error)

IndicesExistsTemplate returns information about whether a particular index template exists.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html.

func (IndicesExistsTemplate) WithContext ¶ 

func (f IndicesExistsTemplate) WithContext(v context.Context) func(*IndicesExistsTemplateRequest)

WithContext sets the request context.

func (IndicesExistsTemplate) WithErrorTrace ¶ 

func (f IndicesExistsTemplate) WithErrorTrace() func(*IndicesExistsTemplateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesExistsTemplate) WithFilterPath ¶ 

func (f IndicesExistsTemplate) WithFilterPath(v ...string) func(*IndicesExistsTemplateRequest)

WithFilterPath filters the properties of the response body.

func (IndicesExistsTemplate) WithFlatSettings ¶ 

func (f IndicesExistsTemplate) WithFlatSettings(v bool) func(*IndicesExistsTemplateRequest)

WithFlatSettings - return settings in flat format (default: false).

func (IndicesExistsTemplate) WithHeader ¶ added in v6.8.2 

func (f IndicesExistsTemplate) WithHeader(h map[string]string) func(*IndicesExistsTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesExistsTemplate) WithHuman ¶ 

func (f IndicesExistsTemplate) WithHuman() func(*IndicesExistsTemplateRequest)

WithHuman makes statistical values human-readable.

func (IndicesExistsTemplate) WithLocal ¶ 

func (f IndicesExistsTemplate) WithLocal(v bool) func(*IndicesExistsTemplateRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (IndicesExistsTemplate) WithMasterTimeout ¶ 

func (f IndicesExistsTemplate) WithMasterTimeout(v time.Duration) func(*IndicesExistsTemplateRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (IndicesExistsTemplate) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesExistsTemplate) WithOpaqueID(s string) func(*IndicesExistsTemplateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesExistsTemplate) WithPretty ¶ 

func (f IndicesExistsTemplate) WithPretty() func(*IndicesExistsTemplateRequest)

WithPretty makes the response body pretty-printed.

type IndicesExistsTemplateRequest ¶ 

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 (IndicesExistsTemplateRequest) Do ¶ 

func (r IndicesExistsTemplateRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesFlush ¶ 

type IndicesFlush func(o ...func(*IndicesFlushRequest)) (*Response, error)

IndicesFlush performs the flush operation on one or more indices.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html.

func (IndicesFlush) WithAllowNoIndices ¶ 

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 (IndicesFlush) WithContext ¶ 

func (f IndicesFlush) WithContext(v context.Context) func(*IndicesFlushRequest)

WithContext sets the request context.

func (IndicesFlush) WithErrorTrace ¶ 

func (f IndicesFlush) WithErrorTrace() func(*IndicesFlushRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesFlush) WithExpandWildcards ¶ 

func (f IndicesFlush) WithExpandWildcards(v string) func(*IndicesFlushRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesFlush) WithFilterPath ¶ 

func (f IndicesFlush) WithFilterPath(v ...string) func(*IndicesFlushRequest)

WithFilterPath filters the properties of the response body.

func (IndicesFlush) WithForce ¶ 

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 (IndicesFlush) WithHeader ¶ added in v6.8.2 

func (f IndicesFlush) WithHeader(h map[string]string) func(*IndicesFlushRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesFlush) WithHuman ¶ 

func (f IndicesFlush) WithHuman() func(*IndicesFlushRequest)

WithHuman makes statistical values human-readable.

func (IndicesFlush) WithIgnoreUnavailable ¶ 

func (f IndicesFlush) WithIgnoreUnavailable(v bool) func(*IndicesFlushRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesFlush) WithIndex ¶ 

func (f IndicesFlush) WithIndex(v ...string) func(*IndicesFlushRequest)

WithIndex - a list of index names; use _all for all indices.

func (IndicesFlush) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesFlush) WithOpaqueID(s string) func(*IndicesFlushRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesFlush) WithPretty ¶ 

func (f IndicesFlush) WithPretty() func(*IndicesFlushRequest)

WithPretty makes the response body pretty-printed.

func (IndicesFlush) WithWaitIfOngoing ¶ 

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 ¶ 

type IndicesFlushRequest struct {
	Index []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	Force             *bool
	IgnoreUnavailable *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.

func (IndicesFlushRequest) Do ¶ 

func (r IndicesFlushRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesFlushSynced ¶ 

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-synced-flush.html.

func (IndicesFlushSynced) WithAllowNoIndices ¶ 

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 (IndicesFlushSynced) WithContext ¶ 

func (f IndicesFlushSynced) WithContext(v context.Context) func(*IndicesFlushSyncedRequest)

WithContext sets the request context.

func (IndicesFlushSynced) WithErrorTrace ¶ 

func (f IndicesFlushSynced) WithErrorTrace() func(*IndicesFlushSyncedRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesFlushSynced) WithExpandWildcards ¶ 

func (f IndicesFlushSynced) WithExpandWildcards(v string) func(*IndicesFlushSyncedRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesFlushSynced) WithFilterPath ¶ 

func (f IndicesFlushSynced) WithFilterPath(v ...string) func(*IndicesFlushSyncedRequest)

WithFilterPath filters the properties of the response body.

func (IndicesFlushSynced) WithHeader ¶ added in v6.8.2 

func (f IndicesFlushSynced) WithHeader(h map[string]string) func(*IndicesFlushSyncedRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesFlushSynced) WithHuman ¶ 

func (f IndicesFlushSynced) WithHuman() func(*IndicesFlushSyncedRequest)

WithHuman makes statistical values human-readable.

func (IndicesFlushSynced) WithIgnoreUnavailable ¶ 

func (f IndicesFlushSynced) WithIgnoreUnavailable(v bool) func(*IndicesFlushSyncedRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesFlushSynced) WithIndex ¶ 

func (f IndicesFlushSynced) WithIndex(v ...string) func(*IndicesFlushSyncedRequest)

WithIndex - a list of index names; use _all for all indices.

func (IndicesFlushSynced) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesFlushSynced) WithOpaqueID(s string) func(*IndicesFlushSyncedRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesFlushSynced) WithPretty ¶ 

func (f IndicesFlushSynced) WithPretty() func(*IndicesFlushSyncedRequest)

WithPretty makes the response body pretty-printed.

type IndicesFlushSyncedRequest ¶ 

type IndicesFlushSyncedRequest struct {
	Index []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *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.

func (IndicesFlushSyncedRequest) Do ¶ 

func (r IndicesFlushSyncedRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesForcemerge ¶ 

type IndicesForcemerge func(o ...func(*IndicesForcemergeRequest)) (*Response, error)

IndicesForcemerge performs the force merge operation on one or more indices.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html.

func (IndicesForcemerge) WithAllowNoIndices ¶ 

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 (IndicesForcemerge) WithContext ¶ 

func (f IndicesForcemerge) WithContext(v context.Context) func(*IndicesForcemergeRequest)

WithContext sets the request context.

func (IndicesForcemerge) WithErrorTrace ¶ 

func (f IndicesForcemerge) WithErrorTrace() func(*IndicesForcemergeRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesForcemerge) WithExpandWildcards ¶ 

func (f IndicesForcemerge) WithExpandWildcards(v string) func(*IndicesForcemergeRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesForcemerge) WithFilterPath ¶ 

func (f IndicesForcemerge) WithFilterPath(v ...string) func(*IndicesForcemergeRequest)

WithFilterPath filters the properties of the response body.

func (IndicesForcemerge) WithFlush ¶ 

func (f IndicesForcemerge) WithFlush(v bool) func(*IndicesForcemergeRequest)

WithFlush - specify whether the index should be flushed after performing the operation (default: true).

func (IndicesForcemerge) WithHeader ¶ added in v6.8.2 

func (f IndicesForcemerge) WithHeader(h map[string]string) func(*IndicesForcemergeRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesForcemerge) WithHuman ¶ 

func (f IndicesForcemerge) WithHuman() func(*IndicesForcemergeRequest)

WithHuman makes statistical values human-readable.

func (IndicesForcemerge) WithIgnoreUnavailable ¶ 

func (f IndicesForcemerge) WithIgnoreUnavailable(v bool) func(*IndicesForcemergeRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesForcemerge) WithIndex ¶ 

func (f IndicesForcemerge) WithIndex(v ...string) func(*IndicesForcemergeRequest)

WithIndex - a list of index names; use _all to perform the operation on all indices.

func (IndicesForcemerge) WithMaxNumSegments ¶ 

func (f IndicesForcemerge) WithMaxNumSegments(v int) func(*IndicesForcemergeRequest)

WithMaxNumSegments - the number of segments the index should be merged into (default: dynamic).

func (IndicesForcemerge) WithOnlyExpungeDeletes ¶ 

func (f IndicesForcemerge) WithOnlyExpungeDeletes(v bool) func(*IndicesForcemergeRequest)

WithOnlyExpungeDeletes - specify whether the operation should only expunge deleted documents.

func (IndicesForcemerge) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesForcemerge) WithOpaqueID(s string) func(*IndicesForcemergeRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesForcemerge) WithPretty ¶ 

func (f IndicesForcemerge) WithPretty() func(*IndicesForcemergeRequest)

WithPretty makes the response body pretty-printed.

type IndicesForcemergeRequest ¶ 

type IndicesForcemergeRequest struct {
	Index []string

	AllowNoIndices     *bool
	ExpandWildcards    string
	Flush              *bool
	IgnoreUnavailable  *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.

func (IndicesForcemergeRequest) Do ¶ 

func (r IndicesForcemergeRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesFreeze ¶ added in v6.8.2 

type IndicesFreeze func(index string, o ...func(*IndicesFreezeRequest)) (*Response, error)

IndicesFreeze - https://www.elastic.co/guide/en/elasticsearch/reference/current/frozen.html

func (IndicesFreeze) WithAllowNoIndices ¶ added in v6.8.2 

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 (IndicesFreeze) WithContext ¶ added in v6.8.2 

func (f IndicesFreeze) WithContext(v context.Context) func(*IndicesFreezeRequest)

WithContext sets the request context.

func (IndicesFreeze) WithErrorTrace ¶ added in v6.8.2 

func (f IndicesFreeze) WithErrorTrace() func(*IndicesFreezeRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesFreeze) WithExpandWildcards ¶ added in v6.8.2 

func (f IndicesFreeze) WithExpandWildcards(v string) func(*IndicesFreezeRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesFreeze) WithFilterPath ¶ added in v6.8.2 

func (f IndicesFreeze) WithFilterPath(v ...string) func(*IndicesFreezeRequest)

WithFilterPath filters the properties of the response body.

func (IndicesFreeze) WithHeader ¶ added in v6.8.2 

func (f IndicesFreeze) WithHeader(h map[string]string) func(*IndicesFreezeRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesFreeze) WithHuman ¶ added in v6.8.2 

func (f IndicesFreeze) WithHuman() func(*IndicesFreezeRequest)

WithHuman makes statistical values human-readable.

func (IndicesFreeze) WithIgnoreUnavailable ¶ added in v6.8.2 

func (f IndicesFreeze) WithIgnoreUnavailable(v bool) func(*IndicesFreezeRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesFreeze) WithMasterTimeout ¶ added in v6.8.2 

func (f IndicesFreeze) WithMasterTimeout(v time.Duration) func(*IndicesFreezeRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesFreeze) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesFreeze) WithOpaqueID(s string) func(*IndicesFreezeRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesFreeze) WithPretty ¶ added in v6.8.2 

func (f IndicesFreeze) WithPretty() func(*IndicesFreezeRequest)

WithPretty makes the response body pretty-printed.

func (IndicesFreeze) WithTimeout ¶ added in v6.8.2 

func (f IndicesFreeze) WithTimeout(v time.Duration) func(*IndicesFreezeRequest)

WithTimeout - explicit operation timeout.

func (IndicesFreeze) WithWaitForActiveShards ¶ added in v6.8.2 

func (f IndicesFreeze) WithWaitForActiveShards(v string) func(*IndicesFreezeRequest)

WithWaitForActiveShards - sets the number of active shards to wait for before the operation returns..

type IndicesFreezeRequest ¶ added in v6.8.2 

type IndicesFreezeRequest struct {
	Index string

	AllowNoIndices      *bool
	ExpandWildcards     string
	IgnoreUnavailable   *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.

func (IndicesFreezeRequest) Do ¶ added in v6.8.2 

func (r IndicesFreezeRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesGet ¶ 

type IndicesGet func(index []string, o ...func(*IndicesGetRequest)) (*Response, error)

IndicesGet returns information about one or more indices.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html.

func (IndicesGet) WithAllowNoIndices ¶ 

func (f IndicesGet) WithAllowNoIndices(v bool) func(*IndicesGetRequest)

WithAllowNoIndices - ignore if a wildcard expression resolves to no concrete indices (default: false).

func (IndicesGet) WithContext ¶ 

func (f IndicesGet) WithContext(v context.Context) func(*IndicesGetRequest)

WithContext sets the request context.

func (IndicesGet) WithErrorTrace ¶ 

func (f IndicesGet) WithErrorTrace() func(*IndicesGetRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesGet) WithExpandWildcards ¶ 

func (f IndicesGet) WithExpandWildcards(v string) func(*IndicesGetRequest)

WithExpandWildcards - whether wildcard expressions should get expanded to open or closed indices (default: open).

func (IndicesGet) WithFilterPath ¶ 

func (f IndicesGet) WithFilterPath(v ...string) func(*IndicesGetRequest)

WithFilterPath filters the properties of the response body.

func (IndicesGet) WithFlatSettings ¶ 

func (f IndicesGet) WithFlatSettings(v bool) func(*IndicesGetRequest)

WithFlatSettings - return settings in flat format (default: false).

func (IndicesGet) WithHeader ¶ added in v6.8.2 

func (f IndicesGet) WithHeader(h map[string]string) func(*IndicesGetRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesGet) WithHuman ¶ 

func (f IndicesGet) WithHuman() func(*IndicesGetRequest)

WithHuman makes statistical values human-readable.

func (IndicesGet) WithIgnoreUnavailable ¶ 

func (f IndicesGet) WithIgnoreUnavailable(v bool) func(*IndicesGetRequest)

WithIgnoreUnavailable - ignore unavailable indexes (default: false).

func (IndicesGet) WithIncludeDefaults ¶ 

func (f IndicesGet) WithIncludeDefaults(v bool) func(*IndicesGetRequest)

WithIncludeDefaults - whether to return all default setting for each of the indices..

func (IndicesGet) WithIncludeTypeName ¶ 

func (f IndicesGet) WithIncludeTypeName(v bool) func(*IndicesGetRequest)

WithIncludeTypeName - whether to add the type name to the response (default: true).

func (IndicesGet) WithLocal ¶ 

func (f IndicesGet) WithLocal(v bool) func(*IndicesGetRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (IndicesGet) WithMasterTimeout ¶ 

func (f IndicesGet) WithMasterTimeout(v time.Duration) func(*IndicesGetRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesGet) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesGet) WithOpaqueID(s string) func(*IndicesGetRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesGet) WithPretty ¶ 

func (f IndicesGet) WithPretty() func(*IndicesGetRequest)

WithPretty makes the response body pretty-printed.

type IndicesGetAlias ¶ 

type IndicesGetAlias func(o ...func(*IndicesGetAliasRequest)) (*Response, error)

IndicesGetAlias returns an alias.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html.

func (IndicesGetAlias) WithAllowNoIndices ¶ 

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 (IndicesGetAlias) WithContext ¶ 

func (f IndicesGetAlias) WithContext(v context.Context) func(*IndicesGetAliasRequest)

WithContext sets the request context.

func (IndicesGetAlias) WithErrorTrace ¶ 

func (f IndicesGetAlias) WithErrorTrace() func(*IndicesGetAliasRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesGetAlias) WithExpandWildcards ¶ 

func (f IndicesGetAlias) WithExpandWildcards(v string) func(*IndicesGetAliasRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesGetAlias) WithFilterPath ¶ 

func (f IndicesGetAlias) WithFilterPath(v ...string) func(*IndicesGetAliasRequest)

WithFilterPath filters the properties of the response body.

func (IndicesGetAlias) WithHeader ¶ added in v6.8.2 

func (f IndicesGetAlias) WithHeader(h map[string]string) func(*IndicesGetAliasRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesGetAlias) WithHuman ¶ 

func (f IndicesGetAlias) WithHuman() func(*IndicesGetAliasRequest)

WithHuman makes statistical values human-readable.

func (IndicesGetAlias) WithIgnoreUnavailable ¶ 

func (f IndicesGetAlias) WithIgnoreUnavailable(v bool) func(*IndicesGetAliasRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesGetAlias) WithIndex ¶ 

func (f IndicesGetAlias) WithIndex(v ...string) func(*IndicesGetAliasRequest)

WithIndex - a list of index names to filter aliases.

func (IndicesGetAlias) WithLocal ¶ 

func (f IndicesGetAlias) WithLocal(v bool) func(*IndicesGetAliasRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (IndicesGetAlias) WithName ¶ 

func (f IndicesGetAlias) WithName(v ...string) func(*IndicesGetAliasRequest)

WithName - a list of alias names to return.

func (IndicesGetAlias) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesGetAlias) WithOpaqueID(s string) func(*IndicesGetAliasRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesGetAlias) WithPretty ¶ 

func (f IndicesGetAlias) WithPretty() func(*IndicesGetAliasRequest)

WithPretty makes the response body pretty-printed.

type IndicesGetAliasRequest ¶ 

type IndicesGetAliasRequest struct {
	Index []string

	Name []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *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.

func (IndicesGetAliasRequest) Do ¶ 

func (r IndicesGetAliasRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesGetFieldMapping ¶ 

type IndicesGetFieldMapping func(fields []string, o ...func(*IndicesGetFieldMappingRequest)) (*Response, error)

IndicesGetFieldMapping returns mapping for one or more fields.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html.

func (IndicesGetFieldMapping) WithAllowNoIndices ¶ 

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 (IndicesGetFieldMapping) WithContext ¶ 

func (f IndicesGetFieldMapping) WithContext(v context.Context) func(*IndicesGetFieldMappingRequest)

WithContext sets the request context.

func (IndicesGetFieldMapping) WithDocumentType ¶ 

func (f IndicesGetFieldMapping) WithDocumentType(v ...string) func(*IndicesGetFieldMappingRequest)

WithDocumentType - a list of document types.

func (IndicesGetFieldMapping) WithErrorTrace ¶ 

func (f IndicesGetFieldMapping) WithErrorTrace() func(*IndicesGetFieldMappingRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesGetFieldMapping) WithExpandWildcards ¶ 

func (f IndicesGetFieldMapping) WithExpandWildcards(v string) func(*IndicesGetFieldMappingRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesGetFieldMapping) WithFilterPath ¶ 

func (f IndicesGetFieldMapping) WithFilterPath(v ...string) func(*IndicesGetFieldMappingRequest)

WithFilterPath filters the properties of the response body.

func (IndicesGetFieldMapping) WithHeader ¶ added in v6.8.2 

func (f IndicesGetFieldMapping) WithHeader(h map[string]string) func(*IndicesGetFieldMappingRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesGetFieldMapping) WithHuman ¶ 

func (f IndicesGetFieldMapping) WithHuman() func(*IndicesGetFieldMappingRequest)

WithHuman makes statistical values human-readable.

func (IndicesGetFieldMapping) WithIgnoreUnavailable ¶ 

func (f IndicesGetFieldMapping) WithIgnoreUnavailable(v bool) func(*IndicesGetFieldMappingRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesGetFieldMapping) WithIncludeDefaults ¶ 

func (f IndicesGetFieldMapping) WithIncludeDefaults(v bool) func(*IndicesGetFieldMappingRequest)

WithIncludeDefaults - whether the default mapping values should be returned as well.

func (IndicesGetFieldMapping) WithIncludeTypeName ¶ 

func (f IndicesGetFieldMapping) WithIncludeTypeName(v bool) func(*IndicesGetFieldMappingRequest)

WithIncludeTypeName - whether a type should be returned in the body of the mappings..

func (IndicesGetFieldMapping) WithIndex ¶ 

func (f IndicesGetFieldMapping) WithIndex(v ...string) func(*IndicesGetFieldMappingRequest)

WithIndex - a list of index names.

func (IndicesGetFieldMapping) WithLocal ¶ 

func (f IndicesGetFieldMapping) WithLocal(v bool) func(*IndicesGetFieldMappingRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (IndicesGetFieldMapping) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesGetFieldMapping) WithOpaqueID(s string) func(*IndicesGetFieldMappingRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesGetFieldMapping) WithPretty ¶ 

func (f IndicesGetFieldMapping) WithPretty() func(*IndicesGetFieldMappingRequest)

WithPretty makes the response body pretty-printed.

type IndicesGetFieldMappingRequest ¶ 

type IndicesGetFieldMappingRequest struct {
	Index        []string
	DocumentType []string

	Fields []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *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 (IndicesGetFieldMappingRequest) Do ¶ 

func (r IndicesGetFieldMappingRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesGetMapping ¶ 

type IndicesGetMapping func(o ...func(*IndicesGetMappingRequest)) (*Response, error)

IndicesGetMapping returns mappings for one or more indices.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html.

func (IndicesGetMapping) WithAllowNoIndices ¶ 

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 (IndicesGetMapping) WithContext ¶ 

func (f IndicesGetMapping) WithContext(v context.Context) func(*IndicesGetMappingRequest)

WithContext sets the request context.

func (IndicesGetMapping) WithDocumentType ¶ 

func (f IndicesGetMapping) WithDocumentType(v ...string) func(*IndicesGetMappingRequest)

WithDocumentType - a list of document types.

func (IndicesGetMapping) WithErrorTrace ¶ 

func (f IndicesGetMapping) WithErrorTrace() func(*IndicesGetMappingRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesGetMapping) WithExpandWildcards ¶ 

func (f IndicesGetMapping) WithExpandWildcards(v string) func(*IndicesGetMappingRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesGetMapping) WithFilterPath ¶ 

func (f IndicesGetMapping) WithFilterPath(v ...string) func(*IndicesGetMappingRequest)

WithFilterPath filters the properties of the response body.

func (IndicesGetMapping) WithHeader ¶ added in v6.8.2 

func (f IndicesGetMapping) WithHeader(h map[string]string) func(*IndicesGetMappingRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesGetMapping) WithHuman ¶ 

func (f IndicesGetMapping) WithHuman() func(*IndicesGetMappingRequest)

WithHuman makes statistical values human-readable.

func (IndicesGetMapping) WithIgnoreUnavailable ¶ 

func (f IndicesGetMapping) WithIgnoreUnavailable(v bool) func(*IndicesGetMappingRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesGetMapping) WithIncludeTypeName ¶ 

func (f IndicesGetMapping) WithIncludeTypeName(v bool) func(*IndicesGetMappingRequest)

WithIncludeTypeName - whether to add the type name to the response..

func (IndicesGetMapping) WithIndex ¶ 

func (f IndicesGetMapping) WithIndex(v ...string) func(*IndicesGetMappingRequest)

WithIndex - a list of index names.

func (IndicesGetMapping) WithLocal ¶ 

func (f IndicesGetMapping) WithLocal(v bool) func(*IndicesGetMappingRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (IndicesGetMapping) WithMasterTimeout ¶ 

func (f IndicesGetMapping) WithMasterTimeout(v time.Duration) func(*IndicesGetMappingRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesGetMapping) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesGetMapping) WithOpaqueID(s string) func(*IndicesGetMappingRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesGetMapping) WithPretty ¶ 

func (f IndicesGetMapping) WithPretty() func(*IndicesGetMappingRequest)

WithPretty makes the response body pretty-printed.

type IndicesGetMappingRequest ¶ 

type IndicesGetMappingRequest struct {
	Index        []string
	DocumentType []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *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.

func (IndicesGetMappingRequest) Do ¶ 

func (r IndicesGetMappingRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesGetRequest ¶ 

type IndicesGetRequest struct {
	Index []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	FlatSettings      *bool
	IgnoreUnavailable *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.

func (IndicesGetRequest) Do ¶ 

func (r IndicesGetRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesGetSettings ¶ 

type IndicesGetSettings func(o ...func(*IndicesGetSettingsRequest)) (*Response, error)

IndicesGetSettings returns settings for one or more indices.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html.

func (IndicesGetSettings) WithAllowNoIndices ¶ 

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 (IndicesGetSettings) WithContext ¶ 

func (f IndicesGetSettings) WithContext(v context.Context) func(*IndicesGetSettingsRequest)

WithContext sets the request context.

func (IndicesGetSettings) WithErrorTrace ¶ 

func (f IndicesGetSettings) WithErrorTrace() func(*IndicesGetSettingsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesGetSettings) WithExpandWildcards ¶ 

func (f IndicesGetSettings) WithExpandWildcards(v string) func(*IndicesGetSettingsRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesGetSettings) WithFilterPath ¶ 

func (f IndicesGetSettings) WithFilterPath(v ...string) func(*IndicesGetSettingsRequest)

WithFilterPath filters the properties of the response body.

func (IndicesGetSettings) WithFlatSettings ¶ 

func (f IndicesGetSettings) WithFlatSettings(v bool) func(*IndicesGetSettingsRequest)

WithFlatSettings - return settings in flat format (default: false).

func (IndicesGetSettings) WithHeader ¶ added in v6.8.2 

func (f IndicesGetSettings) WithHeader(h map[string]string) func(*IndicesGetSettingsRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesGetSettings) WithHuman ¶ 

func (f IndicesGetSettings) WithHuman() func(*IndicesGetSettingsRequest)

WithHuman makes statistical values human-readable.

func (IndicesGetSettings) WithIgnoreUnavailable ¶ 

func (f IndicesGetSettings) WithIgnoreUnavailable(v bool) func(*IndicesGetSettingsRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesGetSettings) WithIncludeDefaults ¶ 

func (f IndicesGetSettings) WithIncludeDefaults(v bool) func(*IndicesGetSettingsRequest)

WithIncludeDefaults - whether to return all default setting for each of the indices..

func (IndicesGetSettings) WithIndex ¶ 

func (f IndicesGetSettings) WithIndex(v ...string) func(*IndicesGetSettingsRequest)

WithIndex - a list of index names; use _all to perform the operation on all indices.

func (IndicesGetSettings) WithLocal ¶ 

func (f IndicesGetSettings) WithLocal(v bool) func(*IndicesGetSettingsRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (IndicesGetSettings) WithMasterTimeout ¶ 

func (f IndicesGetSettings) WithMasterTimeout(v time.Duration) func(*IndicesGetSettingsRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesGetSettings) WithName ¶ 

func (f IndicesGetSettings) WithName(v ...string) func(*IndicesGetSettingsRequest)

WithName - the name of the settings that should be included.

func (IndicesGetSettings) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesGetSettings) WithOpaqueID(s string) func(*IndicesGetSettingsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesGetSettings) WithPretty ¶ 

func (f IndicesGetSettings) WithPretty() func(*IndicesGetSettingsRequest)

WithPretty makes the response body pretty-printed.

type IndicesGetSettingsRequest ¶ 

type IndicesGetSettingsRequest struct {
	Index []string

	Name []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	FlatSettings      *bool
	IgnoreUnavailable *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.

func (IndicesGetSettingsRequest) Do ¶ 

func (r IndicesGetSettingsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesGetTemplate ¶ 

type IndicesGetTemplate func(o ...func(*IndicesGetTemplateRequest)) (*Response, error)

IndicesGetTemplate returns an index template.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html.

func (IndicesGetTemplate) WithContext ¶ 

func (f IndicesGetTemplate) WithContext(v context.Context) func(*IndicesGetTemplateRequest)

WithContext sets the request context.

func (IndicesGetTemplate) WithErrorTrace ¶ 

func (f IndicesGetTemplate) WithErrorTrace() func(*IndicesGetTemplateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesGetTemplate) WithFilterPath ¶ 

func (f IndicesGetTemplate) WithFilterPath(v ...string) func(*IndicesGetTemplateRequest)

WithFilterPath filters the properties of the response body.

func (IndicesGetTemplate) WithFlatSettings ¶ 

func (f IndicesGetTemplate) WithFlatSettings(v bool) func(*IndicesGetTemplateRequest)

WithFlatSettings - return settings in flat format (default: false).

func (IndicesGetTemplate) WithHeader ¶ added in v6.8.2 

func (f IndicesGetTemplate) WithHeader(h map[string]string) func(*IndicesGetTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesGetTemplate) WithHuman ¶ 

func (f IndicesGetTemplate) WithHuman() func(*IndicesGetTemplateRequest)

WithHuman makes statistical values human-readable.

func (IndicesGetTemplate) WithIncludeTypeName ¶ 

func (f IndicesGetTemplate) WithIncludeTypeName(v bool) func(*IndicesGetTemplateRequest)

WithIncludeTypeName - whether a type should be returned in the body of the mappings..

func (IndicesGetTemplate) WithLocal ¶ 

func (f IndicesGetTemplate) WithLocal(v bool) func(*IndicesGetTemplateRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (IndicesGetTemplate) WithMasterTimeout ¶ 

func (f IndicesGetTemplate) WithMasterTimeout(v time.Duration) func(*IndicesGetTemplateRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (IndicesGetTemplate) WithName ¶ 

func (f IndicesGetTemplate) WithName(v ...string) func(*IndicesGetTemplateRequest)

WithName - the comma separated names of the index templates.

func (IndicesGetTemplate) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesGetTemplate) WithOpaqueID(s string) func(*IndicesGetTemplateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesGetTemplate) WithPretty ¶ 

func (f IndicesGetTemplate) WithPretty() func(*IndicesGetTemplateRequest)

WithPretty makes the response body pretty-printed.

type IndicesGetTemplateRequest ¶ 

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.

func (IndicesGetTemplateRequest) Do ¶ 

func (r IndicesGetTemplateRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesGetUpgrade ¶ 

type IndicesGetUpgrade func(o ...func(*IndicesGetUpgradeRequest)) (*Response, error)

IndicesGetUpgrade the _upgrade API is no longer useful and will be removed.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html.

func (IndicesGetUpgrade) WithAllowNoIndices ¶ 

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 (IndicesGetUpgrade) WithContext ¶ 

func (f IndicesGetUpgrade) WithContext(v context.Context) func(*IndicesGetUpgradeRequest)

WithContext sets the request context.

func (IndicesGetUpgrade) WithErrorTrace ¶ 

func (f IndicesGetUpgrade) WithErrorTrace() func(*IndicesGetUpgradeRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesGetUpgrade) WithExpandWildcards ¶ 

func (f IndicesGetUpgrade) WithExpandWildcards(v string) func(*IndicesGetUpgradeRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesGetUpgrade) WithFilterPath ¶ 

func (f IndicesGetUpgrade) WithFilterPath(v ...string) func(*IndicesGetUpgradeRequest)

WithFilterPath filters the properties of the response body.

func (IndicesGetUpgrade) WithHeader ¶ added in v6.8.2 

func (f IndicesGetUpgrade) WithHeader(h map[string]string) func(*IndicesGetUpgradeRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesGetUpgrade) WithHuman ¶ 

func (f IndicesGetUpgrade) WithHuman() func(*IndicesGetUpgradeRequest)

WithHuman makes statistical values human-readable.

func (IndicesGetUpgrade) WithIgnoreUnavailable ¶ 

func (f IndicesGetUpgrade) WithIgnoreUnavailable(v bool) func(*IndicesGetUpgradeRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesGetUpgrade) WithIndex ¶ 

func (f IndicesGetUpgrade) WithIndex(v ...string) func(*IndicesGetUpgradeRequest)

WithIndex - a list of index names; use _all to perform the operation on all indices.

func (IndicesGetUpgrade) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesGetUpgrade) WithOpaqueID(s string) func(*IndicesGetUpgradeRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesGetUpgrade) WithPretty ¶ 

func (f IndicesGetUpgrade) WithPretty() func(*IndicesGetUpgradeRequest)

WithPretty makes the response body pretty-printed.

type IndicesGetUpgradeRequest ¶ 

type IndicesGetUpgradeRequest struct {
	Index []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *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.

func (IndicesGetUpgradeRequest) Do ¶ 

func (r IndicesGetUpgradeRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesOpen ¶ 

type IndicesOpen func(index []string, o ...func(*IndicesOpenRequest)) (*Response, error)

IndicesOpen opens an index.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html.

func (IndicesOpen) WithAllowNoIndices ¶ 

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 (IndicesOpen) WithContext ¶ 

func (f IndicesOpen) WithContext(v context.Context) func(*IndicesOpenRequest)

WithContext sets the request context.

func (IndicesOpen) WithErrorTrace ¶ 

func (f IndicesOpen) WithErrorTrace() func(*IndicesOpenRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesOpen) WithExpandWildcards ¶ 

func (f IndicesOpen) WithExpandWildcards(v string) func(*IndicesOpenRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesOpen) WithFilterPath ¶ 

func (f IndicesOpen) WithFilterPath(v ...string) func(*IndicesOpenRequest)

WithFilterPath filters the properties of the response body.

func (IndicesOpen) WithHeader ¶ added in v6.8.2 

func (f IndicesOpen) WithHeader(h map[string]string) func(*IndicesOpenRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesOpen) WithHuman ¶ 

func (f IndicesOpen) WithHuman() func(*IndicesOpenRequest)

WithHuman makes statistical values human-readable.

func (IndicesOpen) WithIgnoreUnavailable ¶ 

func (f IndicesOpen) WithIgnoreUnavailable(v bool) func(*IndicesOpenRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesOpen) WithMasterTimeout ¶ 

func (f IndicesOpen) WithMasterTimeout(v time.Duration) func(*IndicesOpenRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesOpen) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesOpen) WithOpaqueID(s string) func(*IndicesOpenRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesOpen) WithPretty ¶ 

func (f IndicesOpen) WithPretty() func(*IndicesOpenRequest)

WithPretty makes the response body pretty-printed.

func (IndicesOpen) WithTimeout ¶ 

func (f IndicesOpen) WithTimeout(v time.Duration) func(*IndicesOpenRequest)

WithTimeout - explicit operation timeout.

func (IndicesOpen) WithWaitForActiveShards ¶ 

func (f IndicesOpen) WithWaitForActiveShards(v string) func(*IndicesOpenRequest)

WithWaitForActiveShards - sets the number of active shards to wait for before the operation returns..

type IndicesOpenRequest ¶ 

type IndicesOpenRequest struct {
	Index []string

	AllowNoIndices      *bool
	ExpandWildcards     string
	IgnoreUnavailable   *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.

func (IndicesOpenRequest) Do ¶ 

func (r IndicesOpenRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesPutAlias ¶ 

type IndicesPutAlias func(index []string, name string, o ...func(*IndicesPutAliasRequest)) (*Response, error)

IndicesPutAlias creates or updates an alias.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html.

func (IndicesPutAlias) WithBody ¶ 

func (f IndicesPutAlias) WithBody(v io.Reader) func(*IndicesPutAliasRequest)

WithBody - The settings for the alias, such as `routing` or `filter`.

func (IndicesPutAlias) WithContext ¶ 

func (f IndicesPutAlias) WithContext(v context.Context) func(*IndicesPutAliasRequest)

WithContext sets the request context.

func (IndicesPutAlias) WithErrorTrace ¶ 

func (f IndicesPutAlias) WithErrorTrace() func(*IndicesPutAliasRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesPutAlias) WithFilterPath ¶ 

func (f IndicesPutAlias) WithFilterPath(v ...string) func(*IndicesPutAliasRequest)

WithFilterPath filters the properties of the response body.

func (IndicesPutAlias) WithHeader ¶ added in v6.8.2 

func (f IndicesPutAlias) WithHeader(h map[string]string) func(*IndicesPutAliasRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesPutAlias) WithHuman ¶ 

func (f IndicesPutAlias) WithHuman() func(*IndicesPutAliasRequest)

WithHuman makes statistical values human-readable.

func (IndicesPutAlias) WithMasterTimeout ¶ 

func (f IndicesPutAlias) WithMasterTimeout(v time.Duration) func(*IndicesPutAliasRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesPutAlias) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesPutAlias) WithOpaqueID(s string) func(*IndicesPutAliasRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesPutAlias) WithPretty ¶ 

func (f IndicesPutAlias) WithPretty() func(*IndicesPutAliasRequest)

WithPretty makes the response body pretty-printed.

func (IndicesPutAlias) WithTimeout ¶ 

func (f IndicesPutAlias) WithTimeout(v time.Duration) func(*IndicesPutAliasRequest)

WithTimeout - explicit timestamp for the document.

type IndicesPutAliasRequest ¶ 

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.

func (IndicesPutAliasRequest) Do ¶ 

func (r IndicesPutAliasRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesPutMapping ¶ 

type IndicesPutMapping func(body io.Reader, o ...func(*IndicesPutMappingRequest)) (*Response, error)

IndicesPutMapping updates the index mappings.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html.

func (IndicesPutMapping) WithAllowNoIndices ¶ 

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 (IndicesPutMapping) WithContext ¶ 

func (f IndicesPutMapping) WithContext(v context.Context) func(*IndicesPutMappingRequest)

WithContext sets the request context.

func (IndicesPutMapping) WithDocumentType ¶ 

func (f IndicesPutMapping) WithDocumentType(v string) func(*IndicesPutMappingRequest)

WithDocumentType - the name of the document type.

func (IndicesPutMapping) WithErrorTrace ¶ 

func (f IndicesPutMapping) WithErrorTrace() func(*IndicesPutMappingRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesPutMapping) WithExpandWildcards ¶ 

func (f IndicesPutMapping) WithExpandWildcards(v string) func(*IndicesPutMappingRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesPutMapping) WithFilterPath ¶ 

func (f IndicesPutMapping) WithFilterPath(v ...string) func(*IndicesPutMappingRequest)

WithFilterPath filters the properties of the response body.

func (IndicesPutMapping) WithHeader ¶ added in v6.8.2 

func (f IndicesPutMapping) WithHeader(h map[string]string) func(*IndicesPutMappingRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesPutMapping) WithHuman ¶ 

func (f IndicesPutMapping) WithHuman() func(*IndicesPutMappingRequest)

WithHuman makes statistical values human-readable.

func (IndicesPutMapping) WithIgnoreUnavailable ¶ 

func (f IndicesPutMapping) WithIgnoreUnavailable(v bool) func(*IndicesPutMappingRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesPutMapping) WithIncludeTypeName ¶ 

func (f IndicesPutMapping) WithIncludeTypeName(v bool) func(*IndicesPutMappingRequest)

WithIncludeTypeName - whether a type should be expected in the body of the mappings..

func (IndicesPutMapping) WithIndex ¶ 

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 (IndicesPutMapping) WithMasterTimeout ¶ 

func (f IndicesPutMapping) WithMasterTimeout(v time.Duration) func(*IndicesPutMappingRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesPutMapping) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesPutMapping) WithOpaqueID(s string) func(*IndicesPutMappingRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesPutMapping) WithPretty ¶ 

func (f IndicesPutMapping) WithPretty() func(*IndicesPutMappingRequest)

WithPretty makes the response body pretty-printed.

func (IndicesPutMapping) WithTimeout ¶ 

func (f IndicesPutMapping) WithTimeout(v time.Duration) func(*IndicesPutMappingRequest)

WithTimeout - explicit operation timeout.

func (IndicesPutMapping) WithUpdateAllTypes ¶ 

func (f IndicesPutMapping) WithUpdateAllTypes(v bool) func(*IndicesPutMappingRequest)

WithUpdateAllTypes - whether to update the mapping for all fields with the same name across all types or not.

type IndicesPutMappingRequest ¶ 

type IndicesPutMappingRequest struct {
	Index        []string
	DocumentType string

	Body io.Reader

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *bool
	IncludeTypeName   *bool
	MasterTimeout     time.Duration
	Timeout           time.Duration
	UpdateAllTypes    *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesPutMappingRequest configures the Indices Put Mapping API request.

func (IndicesPutMappingRequest) Do ¶ 

func (r IndicesPutMappingRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesPutSettings ¶ 

type IndicesPutSettings func(body io.Reader, o ...func(*IndicesPutSettingsRequest)) (*Response, error)

IndicesPutSettings updates the index settings.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html.

func (IndicesPutSettings) WithAllowNoIndices ¶ 

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 (IndicesPutSettings) WithContext ¶ 

func (f IndicesPutSettings) WithContext(v context.Context) func(*IndicesPutSettingsRequest)

WithContext sets the request context.

func (IndicesPutSettings) WithErrorTrace ¶ 

func (f IndicesPutSettings) WithErrorTrace() func(*IndicesPutSettingsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesPutSettings) WithExpandWildcards ¶ 

func (f IndicesPutSettings) WithExpandWildcards(v string) func(*IndicesPutSettingsRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesPutSettings) WithFilterPath ¶ 

func (f IndicesPutSettings) WithFilterPath(v ...string) func(*IndicesPutSettingsRequest)

WithFilterPath filters the properties of the response body.

func (IndicesPutSettings) WithFlatSettings ¶ 

func (f IndicesPutSettings) WithFlatSettings(v bool) func(*IndicesPutSettingsRequest)

WithFlatSettings - return settings in flat format (default: false).

func (IndicesPutSettings) WithHeader ¶ added in v6.8.2 

func (f IndicesPutSettings) WithHeader(h map[string]string) func(*IndicesPutSettingsRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesPutSettings) WithHuman ¶ 

func (f IndicesPutSettings) WithHuman() func(*IndicesPutSettingsRequest)

WithHuman makes statistical values human-readable.

func (IndicesPutSettings) WithIgnoreUnavailable ¶ 

func (f IndicesPutSettings) WithIgnoreUnavailable(v bool) func(*IndicesPutSettingsRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesPutSettings) WithIndex ¶ 

func (f IndicesPutSettings) WithIndex(v ...string) func(*IndicesPutSettingsRequest)

WithIndex - a list of index names; use _all to perform the operation on all indices.

func (IndicesPutSettings) WithMasterTimeout ¶ 

func (f IndicesPutSettings) WithMasterTimeout(v time.Duration) func(*IndicesPutSettingsRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesPutSettings) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesPutSettings) WithOpaqueID(s string) func(*IndicesPutSettingsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesPutSettings) WithPreserveExisting ¶ 

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 (IndicesPutSettings) WithPretty ¶ 

func (f IndicesPutSettings) WithPretty() func(*IndicesPutSettingsRequest)

WithPretty makes the response body pretty-printed.

func (IndicesPutSettings) WithTimeout ¶ 

func (f IndicesPutSettings) WithTimeout(v time.Duration) func(*IndicesPutSettingsRequest)

WithTimeout - explicit operation timeout.

type IndicesPutSettingsRequest ¶ 

type IndicesPutSettingsRequest struct {
	Index []string

	Body io.Reader

	AllowNoIndices    *bool
	ExpandWildcards   string
	FlatSettings      *bool
	IgnoreUnavailable *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.

func (IndicesPutSettingsRequest) Do ¶ 

func (r IndicesPutSettingsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesPutTemplate ¶ 

type IndicesPutTemplate func(name string, body io.Reader, o ...func(*IndicesPutTemplateRequest)) (*Response, error)

IndicesPutTemplate creates or updates an index template.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html.

func (IndicesPutTemplate) WithContext ¶ 

func (f IndicesPutTemplate) WithContext(v context.Context) func(*IndicesPutTemplateRequest)

WithContext sets the request context.

func (IndicesPutTemplate) WithCreate ¶ 

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 (IndicesPutTemplate) WithErrorTrace ¶ 

func (f IndicesPutTemplate) WithErrorTrace() func(*IndicesPutTemplateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesPutTemplate) WithFilterPath ¶ 

func (f IndicesPutTemplate) WithFilterPath(v ...string) func(*IndicesPutTemplateRequest)

WithFilterPath filters the properties of the response body.

func (IndicesPutTemplate) WithFlatSettings ¶ 

func (f IndicesPutTemplate) WithFlatSettings(v bool) func(*IndicesPutTemplateRequest)

WithFlatSettings - return settings in flat format (default: false).

func (IndicesPutTemplate) WithHeader ¶ added in v6.8.2 

func (f IndicesPutTemplate) WithHeader(h map[string]string) func(*IndicesPutTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesPutTemplate) WithHuman ¶ 

func (f IndicesPutTemplate) WithHuman() func(*IndicesPutTemplateRequest)

WithHuman makes statistical values human-readable.

func (IndicesPutTemplate) WithIncludeTypeName ¶ 

func (f IndicesPutTemplate) WithIncludeTypeName(v bool) func(*IndicesPutTemplateRequest)

WithIncludeTypeName - whether a type should be returned in the body of the mappings..

func (IndicesPutTemplate) WithMasterTimeout ¶ 

func (f IndicesPutTemplate) WithMasterTimeout(v time.Duration) func(*IndicesPutTemplateRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesPutTemplate) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesPutTemplate) WithOpaqueID(s string) func(*IndicesPutTemplateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesPutTemplate) WithOrder ¶ 

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 (IndicesPutTemplate) WithPretty ¶ 

func (f IndicesPutTemplate) WithPretty() func(*IndicesPutTemplateRequest)

WithPretty makes the response body pretty-printed.

func (IndicesPutTemplate) WithTimeout ¶ 

func (f IndicesPutTemplate) WithTimeout(v time.Duration) func(*IndicesPutTemplateRequest)

WithTimeout - explicit operation timeout.

type IndicesPutTemplateRequest ¶ 

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.

func (IndicesPutTemplateRequest) Do ¶ 

func (r IndicesPutTemplateRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesRecovery ¶ 

type IndicesRecovery func(o ...func(*IndicesRecoveryRequest)) (*Response, error)

IndicesRecovery returns information about ongoing index shard recoveries.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html.

func (IndicesRecovery) WithActiveOnly ¶ 

func (f IndicesRecovery) WithActiveOnly(v bool) func(*IndicesRecoveryRequest)

WithActiveOnly - display only those recoveries that are currently on-going.

func (IndicesRecovery) WithContext ¶ 

func (f IndicesRecovery) WithContext(v context.Context) func(*IndicesRecoveryRequest)

WithContext sets the request context.

func (IndicesRecovery) WithDetailed ¶ 

func (f IndicesRecovery) WithDetailed(v bool) func(*IndicesRecoveryRequest)

WithDetailed - whether to display detailed information about shard recovery.

func (IndicesRecovery) WithErrorTrace ¶ 

func (f IndicesRecovery) WithErrorTrace() func(*IndicesRecoveryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesRecovery) WithFilterPath ¶ 

func (f IndicesRecovery) WithFilterPath(v ...string) func(*IndicesRecoveryRequest)

WithFilterPath filters the properties of the response body.

func (IndicesRecovery) WithHeader ¶ added in v6.8.2 

func (f IndicesRecovery) WithHeader(h map[string]string) func(*IndicesRecoveryRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesRecovery) WithHuman ¶ 

func (f IndicesRecovery) WithHuman() func(*IndicesRecoveryRequest)

WithHuman makes statistical values human-readable.

func (IndicesRecovery) WithIndex ¶ 

func (f IndicesRecovery) WithIndex(v ...string) func(*IndicesRecoveryRequest)

WithIndex - a list of index names; use _all to perform the operation on all indices.

func (IndicesRecovery) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesRecovery) WithOpaqueID(s string) func(*IndicesRecoveryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesRecovery) WithPretty ¶ 

func (f IndicesRecovery) WithPretty() func(*IndicesRecoveryRequest)

WithPretty makes the response body pretty-printed.

type IndicesRecoveryRequest ¶ 

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.

func (IndicesRecoveryRequest) Do ¶ 

func (r IndicesRecoveryRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesRefresh ¶ 

type IndicesRefresh func(o ...func(*IndicesRefreshRequest)) (*Response, error)

IndicesRefresh performs the refresh operation in one or more indices.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html.

func (IndicesRefresh) WithAllowNoIndices ¶ 

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 (IndicesRefresh) WithContext ¶ 

func (f IndicesRefresh) WithContext(v context.Context) func(*IndicesRefreshRequest)

WithContext sets the request context.

func (IndicesRefresh) WithErrorTrace ¶ 

func (f IndicesRefresh) WithErrorTrace() func(*IndicesRefreshRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesRefresh) WithExpandWildcards ¶ 

func (f IndicesRefresh) WithExpandWildcards(v string) func(*IndicesRefreshRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesRefresh) WithFilterPath ¶ 

func (f IndicesRefresh) WithFilterPath(v ...string) func(*IndicesRefreshRequest)

WithFilterPath filters the properties of the response body.

func (IndicesRefresh) WithHeader ¶ added in v6.8.2 

func (f IndicesRefresh) WithHeader(h map[string]string) func(*IndicesRefreshRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesRefresh) WithHuman ¶ 

func (f IndicesRefresh) WithHuman() func(*IndicesRefreshRequest)

WithHuman makes statistical values human-readable.

func (IndicesRefresh) WithIgnoreUnavailable ¶ 

func (f IndicesRefresh) WithIgnoreUnavailable(v bool) func(*IndicesRefreshRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesRefresh) WithIndex ¶ 

func (f IndicesRefresh) WithIndex(v ...string) func(*IndicesRefreshRequest)

WithIndex - a list of index names; use _all to perform the operation on all indices.

func (IndicesRefresh) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesRefresh) WithOpaqueID(s string) func(*IndicesRefreshRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesRefresh) WithPretty ¶ 

func (f IndicesRefresh) WithPretty() func(*IndicesRefreshRequest)

WithPretty makes the response body pretty-printed.

type IndicesRefreshRequest ¶ 

type IndicesRefreshRequest struct {
	Index []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesRefreshRequest configures the Indices Refresh API request.

func (IndicesRefreshRequest) Do ¶ 

func (r IndicesRefreshRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesRollover ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html.

func (IndicesRollover) WithBody ¶ 

func (f IndicesRollover) WithBody(v io.Reader) func(*IndicesRolloverRequest)

WithBody - The conditions that needs to be met for executing rollover.

func (IndicesRollover) WithContext ¶ 

func (f IndicesRollover) WithContext(v context.Context) func(*IndicesRolloverRequest)

WithContext sets the request context.

func (IndicesRollover) WithDryRun ¶ 

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 (IndicesRollover) WithErrorTrace ¶ 

func (f IndicesRollover) WithErrorTrace() func(*IndicesRolloverRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesRollover) WithFilterPath ¶ 

func (f IndicesRollover) WithFilterPath(v ...string) func(*IndicesRolloverRequest)

WithFilterPath filters the properties of the response body.

func (IndicesRollover) WithHeader ¶ added in v6.8.2 

func (f IndicesRollover) WithHeader(h map[string]string) func(*IndicesRolloverRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesRollover) WithHuman ¶ 

func (f IndicesRollover) WithHuman() func(*IndicesRolloverRequest)

WithHuman makes statistical values human-readable.

func (IndicesRollover) WithIncludeTypeName ¶ 

func (f IndicesRollover) WithIncludeTypeName(v bool) func(*IndicesRolloverRequest)

WithIncludeTypeName - whether a type should be included in the body of the mappings..

func (IndicesRollover) WithMasterTimeout ¶ 

func (f IndicesRollover) WithMasterTimeout(v time.Duration) func(*IndicesRolloverRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesRollover) WithNewIndex ¶ 

func (f IndicesRollover) WithNewIndex(v string) func(*IndicesRolloverRequest)

WithNewIndex - the name of the rollover index.

func (IndicesRollover) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesRollover) WithOpaqueID(s string) func(*IndicesRolloverRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesRollover) WithPretty ¶ 

func (f IndicesRollover) WithPretty() func(*IndicesRolloverRequest)

WithPretty makes the response body pretty-printed.

func (IndicesRollover) WithTimeout ¶ 

func (f IndicesRollover) WithTimeout(v time.Duration) func(*IndicesRolloverRequest)

WithTimeout - explicit operation timeout.

func (IndicesRollover) WithWaitForActiveShards ¶ 

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 ¶ 

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.

func (IndicesRolloverRequest) Do ¶ 

func (r IndicesRolloverRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesSegments ¶ 

type IndicesSegments func(o ...func(*IndicesSegmentsRequest)) (*Response, error)

IndicesSegments provides low-level information about segments in a Lucene index.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html.

func (IndicesSegments) WithAllowNoIndices ¶ 

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 (IndicesSegments) WithContext ¶ 

func (f IndicesSegments) WithContext(v context.Context) func(*IndicesSegmentsRequest)

WithContext sets the request context.

func (IndicesSegments) WithErrorTrace ¶ 

func (f IndicesSegments) WithErrorTrace() func(*IndicesSegmentsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesSegments) WithExpandWildcards ¶ 

func (f IndicesSegments) WithExpandWildcards(v string) func(*IndicesSegmentsRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesSegments) WithFilterPath ¶ 

func (f IndicesSegments) WithFilterPath(v ...string) func(*IndicesSegmentsRequest)

WithFilterPath filters the properties of the response body.

func (IndicesSegments) WithHeader ¶ added in v6.8.2 

func (f IndicesSegments) WithHeader(h map[string]string) func(*IndicesSegmentsRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesSegments) WithHuman ¶ 

func (f IndicesSegments) WithHuman() func(*IndicesSegmentsRequest)

WithHuman makes statistical values human-readable.

func (IndicesSegments) WithIgnoreUnavailable ¶ 

func (f IndicesSegments) WithIgnoreUnavailable(v bool) func(*IndicesSegmentsRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesSegments) WithIndex ¶ 

func (f IndicesSegments) WithIndex(v ...string) func(*IndicesSegmentsRequest)

WithIndex - a list of index names; use _all to perform the operation on all indices.

func (IndicesSegments) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesSegments) WithOpaqueID(s string) func(*IndicesSegmentsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesSegments) WithPretty ¶ 

func (f IndicesSegments) WithPretty() func(*IndicesSegmentsRequest)

WithPretty makes the response body pretty-printed.

func (IndicesSegments) WithVerbose ¶ 

func (f IndicesSegments) WithVerbose(v bool) func(*IndicesSegmentsRequest)

WithVerbose - includes detailed memory usage by lucene..

type IndicesSegmentsRequest ¶ 

type IndicesSegmentsRequest struct {
	Index []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *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.

func (IndicesSegmentsRequest) Do ¶ 

func (r IndicesSegmentsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesShardStores ¶ 

type IndicesShardStores func(o ...func(*IndicesShardStoresRequest)) (*Response, error)

IndicesShardStores provides store information for shard copies of indices.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html.

func (IndicesShardStores) WithAllowNoIndices ¶ 

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 (IndicesShardStores) WithContext ¶ 

func (f IndicesShardStores) WithContext(v context.Context) func(*IndicesShardStoresRequest)

WithContext sets the request context.

func (IndicesShardStores) WithErrorTrace ¶ 

func (f IndicesShardStores) WithErrorTrace() func(*IndicesShardStoresRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesShardStores) WithExpandWildcards ¶ 

func (f IndicesShardStores) WithExpandWildcards(v string) func(*IndicesShardStoresRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesShardStores) WithFilterPath ¶ 

func (f IndicesShardStores) WithFilterPath(v ...string) func(*IndicesShardStoresRequest)

WithFilterPath filters the properties of the response body.

func (IndicesShardStores) WithHeader ¶ added in v6.8.2 

func (f IndicesShardStores) WithHeader(h map[string]string) func(*IndicesShardStoresRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesShardStores) WithHuman ¶ 

func (f IndicesShardStores) WithHuman() func(*IndicesShardStoresRequest)

WithHuman makes statistical values human-readable.

func (IndicesShardStores) WithIgnoreUnavailable ¶ 

func (f IndicesShardStores) WithIgnoreUnavailable(v bool) func(*IndicesShardStoresRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesShardStores) WithIndex ¶ 

func (f IndicesShardStores) WithIndex(v ...string) func(*IndicesShardStoresRequest)

WithIndex - a list of index names; use _all to perform the operation on all indices.

func (IndicesShardStores) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesShardStores) WithOpaqueID(s string) func(*IndicesShardStoresRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesShardStores) WithPretty ¶ 

func (f IndicesShardStores) WithPretty() func(*IndicesShardStoresRequest)

WithPretty makes the response body pretty-printed.

func (IndicesShardStores) WithStatus ¶ 

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 ¶ 

type IndicesShardStoresRequest struct {
	Index []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *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.

func (IndicesShardStoresRequest) Do ¶ 

func (r IndicesShardStoresRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesShrink ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-index.html.

func (IndicesShrink) WithBody ¶ 

func (f IndicesShrink) WithBody(v io.Reader) func(*IndicesShrinkRequest)

WithBody - The configuration for the target index (`settings` and `aliases`).

func (IndicesShrink) WithContext ¶ 

func (f IndicesShrink) WithContext(v context.Context) func(*IndicesShrinkRequest)

WithContext sets the request context.

func (IndicesShrink) WithCopySettings ¶ 

func (f IndicesShrink) WithCopySettings(v bool) func(*IndicesShrinkRequest)

WithCopySettings - whether or not to copy settings from the source index (defaults to false).

func (IndicesShrink) WithErrorTrace ¶ 

func (f IndicesShrink) WithErrorTrace() func(*IndicesShrinkRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesShrink) WithFilterPath ¶ 

func (f IndicesShrink) WithFilterPath(v ...string) func(*IndicesShrinkRequest)

WithFilterPath filters the properties of the response body.

func (IndicesShrink) WithHeader ¶ added in v6.8.2 

func (f IndicesShrink) WithHeader(h map[string]string) func(*IndicesShrinkRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesShrink) WithHuman ¶ 

func (f IndicesShrink) WithHuman() func(*IndicesShrinkRequest)

WithHuman makes statistical values human-readable.

func (IndicesShrink) WithMasterTimeout ¶ 

func (f IndicesShrink) WithMasterTimeout(v time.Duration) func(*IndicesShrinkRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesShrink) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesShrink) WithOpaqueID(s string) func(*IndicesShrinkRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesShrink) WithPretty ¶ 

func (f IndicesShrink) WithPretty() func(*IndicesShrinkRequest)

WithPretty makes the response body pretty-printed.

func (IndicesShrink) WithTimeout ¶ 

func (f IndicesShrink) WithTimeout(v time.Duration) func(*IndicesShrinkRequest)

WithTimeout - explicit operation timeout.

func (IndicesShrink) WithWaitForActiveShards ¶ 

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 ¶ 

type IndicesShrinkRequest struct {
	Index string

	Body io.Reader

	Target string

	CopySettings        *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
}

IndicesShrinkRequest configures the Indices Shrink API request.

func (IndicesShrinkRequest) Do ¶ 

func (r IndicesShrinkRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesSplit ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html.

func (IndicesSplit) WithBody ¶ 

func (f IndicesSplit) WithBody(v io.Reader) func(*IndicesSplitRequest)

WithBody - The configuration for the target index (`settings` and `aliases`).

func (IndicesSplit) WithContext ¶ 

func (f IndicesSplit) WithContext(v context.Context) func(*IndicesSplitRequest)

WithContext sets the request context.

func (IndicesSplit) WithCopySettings ¶ 

func (f IndicesSplit) WithCopySettings(v bool) func(*IndicesSplitRequest)

WithCopySettings - whether or not to copy settings from the source index (defaults to false).

func (IndicesSplit) WithErrorTrace ¶ 

func (f IndicesSplit) WithErrorTrace() func(*IndicesSplitRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesSplit) WithFilterPath ¶ 

func (f IndicesSplit) WithFilterPath(v ...string) func(*IndicesSplitRequest)

WithFilterPath filters the properties of the response body.

func (IndicesSplit) WithHeader ¶ added in v6.8.2 

func (f IndicesSplit) WithHeader(h map[string]string) func(*IndicesSplitRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesSplit) WithHuman ¶ 

func (f IndicesSplit) WithHuman() func(*IndicesSplitRequest)

WithHuman makes statistical values human-readable.

func (IndicesSplit) WithMasterTimeout ¶ 

func (f IndicesSplit) WithMasterTimeout(v time.Duration) func(*IndicesSplitRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesSplit) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesSplit) WithOpaqueID(s string) func(*IndicesSplitRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesSplit) WithPretty ¶ 

func (f IndicesSplit) WithPretty() func(*IndicesSplitRequest)

WithPretty makes the response body pretty-printed.

func (IndicesSplit) WithTimeout ¶ 

func (f IndicesSplit) WithTimeout(v time.Duration) func(*IndicesSplitRequest)

WithTimeout - explicit operation timeout.

func (IndicesSplit) WithWaitForActiveShards ¶ 

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 ¶ 

type IndicesSplitRequest struct {
	Index string

	Body io.Reader

	Target string

	CopySettings        *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
}

IndicesSplitRequest configures the Indices Split API request.

func (IndicesSplitRequest) Do ¶ 

func (r IndicesSplitRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesStats ¶ 

type IndicesStats func(o ...func(*IndicesStatsRequest)) (*Response, error)

IndicesStats provides statistics on operations happening in an index.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html.

func (IndicesStats) WithCompletionFields ¶ 

func (f IndicesStats) WithCompletionFields(v ...string) func(*IndicesStatsRequest)

WithCompletionFields - a list of fields for `fielddata` and `suggest` index metric (supports wildcards).

func (IndicesStats) WithContext ¶ 

func (f IndicesStats) WithContext(v context.Context) func(*IndicesStatsRequest)

WithContext sets the request context.

func (IndicesStats) WithErrorTrace ¶ 

func (f IndicesStats) WithErrorTrace() func(*IndicesStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesStats) WithFielddataFields ¶ 

func (f IndicesStats) WithFielddataFields(v ...string) func(*IndicesStatsRequest)

WithFielddataFields - a list of fields for `fielddata` index metric (supports wildcards).

func (IndicesStats) WithFields ¶ 

func (f IndicesStats) WithFields(v ...string) func(*IndicesStatsRequest)

WithFields - a list of fields for `fielddata` and `completion` index metric (supports wildcards).

func (IndicesStats) WithFilterPath ¶ 

func (f IndicesStats) WithFilterPath(v ...string) func(*IndicesStatsRequest)

WithFilterPath filters the properties of the response body.

func (IndicesStats) WithGroups ¶ 

func (f IndicesStats) WithGroups(v ...string) func(*IndicesStatsRequest)

WithGroups - a list of search groups for `search` index metric.

func (IndicesStats) WithHeader ¶ added in v6.8.2 

func (f IndicesStats) WithHeader(h map[string]string) func(*IndicesStatsRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesStats) WithHuman ¶ 

func (f IndicesStats) WithHuman() func(*IndicesStatsRequest)

WithHuman makes statistical values human-readable.

func (IndicesStats) WithIncludeSegmentFileSizes ¶ 

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 (IndicesStats) WithIndex ¶ 

func (f IndicesStats) WithIndex(v ...string) func(*IndicesStatsRequest)

WithIndex - a list of index names; use _all to perform the operation on all indices.

func (IndicesStats) WithLevel ¶ 

func (f IndicesStats) WithLevel(v string) func(*IndicesStatsRequest)

WithLevel - return stats aggregated at cluster, index or shard level.

func (IndicesStats) WithMetric ¶ 

func (f IndicesStats) WithMetric(v ...string) func(*IndicesStatsRequest)

WithMetric - limit the information returned the specific metrics..

func (IndicesStats) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesStats) WithOpaqueID(s string) func(*IndicesStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesStats) WithPretty ¶ 

func (f IndicesStats) WithPretty() func(*IndicesStatsRequest)

WithPretty makes the response body pretty-printed.

func (IndicesStats) WithTypes ¶ 

func (f IndicesStats) WithTypes(v ...string) func(*IndicesStatsRequest)

WithTypes - a list of document types for the `indexing` index metric.

type IndicesStatsRequest ¶ 

type IndicesStatsRequest struct {
	Index []string

	Metric []string

	CompletionFields        []string
	FielddataFields         []string
	Fields                  []string
	Groups                  []string
	IncludeSegmentFileSizes *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.

func (IndicesStatsRequest) Do ¶ 

func (r IndicesStatsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesUnfreeze ¶ added in v6.8.2 

type IndicesUnfreeze func(index string, o ...func(*IndicesUnfreezeRequest)) (*Response, error)

IndicesUnfreeze - https://www.elastic.co/guide/en/elasticsearch/reference/current/frozen.html

func (IndicesUnfreeze) WithAllowNoIndices ¶ added in v6.8.2 

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 (IndicesUnfreeze) WithContext ¶ added in v6.8.2 

func (f IndicesUnfreeze) WithContext(v context.Context) func(*IndicesUnfreezeRequest)

WithContext sets the request context.

func (IndicesUnfreeze) WithErrorTrace ¶ added in v6.8.2 

func (f IndicesUnfreeze) WithErrorTrace() func(*IndicesUnfreezeRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesUnfreeze) WithExpandWildcards ¶ added in v6.8.2 

func (f IndicesUnfreeze) WithExpandWildcards(v string) func(*IndicesUnfreezeRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesUnfreeze) WithFilterPath ¶ added in v6.8.2 

func (f IndicesUnfreeze) WithFilterPath(v ...string) func(*IndicesUnfreezeRequest)

WithFilterPath filters the properties of the response body.

func (IndicesUnfreeze) WithHeader ¶ added in v6.8.2 

func (f IndicesUnfreeze) WithHeader(h map[string]string) func(*IndicesUnfreezeRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesUnfreeze) WithHuman ¶ added in v6.8.2 

func (f IndicesUnfreeze) WithHuman() func(*IndicesUnfreezeRequest)

WithHuman makes statistical values human-readable.

func (IndicesUnfreeze) WithIgnoreUnavailable ¶ added in v6.8.2 

func (f IndicesUnfreeze) WithIgnoreUnavailable(v bool) func(*IndicesUnfreezeRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesUnfreeze) WithMasterTimeout ¶ added in v6.8.2 

func (f IndicesUnfreeze) WithMasterTimeout(v time.Duration) func(*IndicesUnfreezeRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesUnfreeze) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesUnfreeze) WithOpaqueID(s string) func(*IndicesUnfreezeRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesUnfreeze) WithPretty ¶ added in v6.8.2 

func (f IndicesUnfreeze) WithPretty() func(*IndicesUnfreezeRequest)

WithPretty makes the response body pretty-printed.

func (IndicesUnfreeze) WithTimeout ¶ added in v6.8.2 

func (f IndicesUnfreeze) WithTimeout(v time.Duration) func(*IndicesUnfreezeRequest)

WithTimeout - explicit operation timeout.

func (IndicesUnfreeze) WithWaitForActiveShards ¶ added in v6.8.2 

func (f IndicesUnfreeze) WithWaitForActiveShards(v string) func(*IndicesUnfreezeRequest)

WithWaitForActiveShards - sets the number of active shards to wait for before the operation returns..

type IndicesUnfreezeRequest ¶ added in v6.8.2 

type IndicesUnfreezeRequest struct {
	Index string

	AllowNoIndices      *bool
	ExpandWildcards     string
	IgnoreUnavailable   *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.

func (IndicesUnfreezeRequest) Do ¶ added in v6.8.2 

func (r IndicesUnfreezeRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesUpdateAliases ¶ 

type IndicesUpdateAliases func(body io.Reader, o ...func(*IndicesUpdateAliasesRequest)) (*Response, error)

IndicesUpdateAliases updates index aliases.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html.

func (IndicesUpdateAliases) WithContext ¶ 

func (f IndicesUpdateAliases) WithContext(v context.Context) func(*IndicesUpdateAliasesRequest)

WithContext sets the request context.

func (IndicesUpdateAliases) WithErrorTrace ¶ 

func (f IndicesUpdateAliases) WithErrorTrace() func(*IndicesUpdateAliasesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesUpdateAliases) WithFilterPath ¶ 

func (f IndicesUpdateAliases) WithFilterPath(v ...string) func(*IndicesUpdateAliasesRequest)

WithFilterPath filters the properties of the response body.

func (IndicesUpdateAliases) WithHeader ¶ added in v6.8.2 

func (f IndicesUpdateAliases) WithHeader(h map[string]string) func(*IndicesUpdateAliasesRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesUpdateAliases) WithHuman ¶ 

func (f IndicesUpdateAliases) WithHuman() func(*IndicesUpdateAliasesRequest)

WithHuman makes statistical values human-readable.

func (IndicesUpdateAliases) WithMasterTimeout ¶ 

func (f IndicesUpdateAliases) WithMasterTimeout(v time.Duration) func(*IndicesUpdateAliasesRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesUpdateAliases) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesUpdateAliases) WithOpaqueID(s string) func(*IndicesUpdateAliasesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesUpdateAliases) WithPretty ¶ 

func (f IndicesUpdateAliases) WithPretty() func(*IndicesUpdateAliasesRequest)

WithPretty makes the response body pretty-printed.

func (IndicesUpdateAliases) WithTimeout ¶ 

func (f IndicesUpdateAliases) WithTimeout(v time.Duration) func(*IndicesUpdateAliasesRequest)

WithTimeout - request timeout.

type IndicesUpdateAliasesRequest ¶ 

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 (IndicesUpdateAliasesRequest) Do ¶ 

func (r IndicesUpdateAliasesRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesUpgrade ¶ 

type IndicesUpgrade func(o ...func(*IndicesUpgradeRequest)) (*Response, error)

IndicesUpgrade the _upgrade API is no longer useful and will be removed.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html.

func (IndicesUpgrade) WithAllowNoIndices ¶ 

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 (IndicesUpgrade) WithContext ¶ 

func (f IndicesUpgrade) WithContext(v context.Context) func(*IndicesUpgradeRequest)

WithContext sets the request context.

func (IndicesUpgrade) WithErrorTrace ¶ 

func (f IndicesUpgrade) WithErrorTrace() func(*IndicesUpgradeRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesUpgrade) WithExpandWildcards ¶ 

func (f IndicesUpgrade) WithExpandWildcards(v string) func(*IndicesUpgradeRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesUpgrade) WithFilterPath ¶ 

func (f IndicesUpgrade) WithFilterPath(v ...string) func(*IndicesUpgradeRequest)

WithFilterPath filters the properties of the response body.

func (IndicesUpgrade) WithHeader ¶ added in v6.8.2 

func (f IndicesUpgrade) WithHeader(h map[string]string) func(*IndicesUpgradeRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesUpgrade) WithHuman ¶ 

func (f IndicesUpgrade) WithHuman() func(*IndicesUpgradeRequest)

WithHuman makes statistical values human-readable.

func (IndicesUpgrade) WithIgnoreUnavailable ¶ 

func (f IndicesUpgrade) WithIgnoreUnavailable(v bool) func(*IndicesUpgradeRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesUpgrade) WithIndex ¶ 

func (f IndicesUpgrade) WithIndex(v ...string) func(*IndicesUpgradeRequest)

WithIndex - a list of index names; use _all to perform the operation on all indices.

func (IndicesUpgrade) WithOnlyAncientSegments ¶ 

func (f IndicesUpgrade) WithOnlyAncientSegments(v bool) func(*IndicesUpgradeRequest)

WithOnlyAncientSegments - if true, only ancient (an older lucene major release) segments will be upgraded.

func (IndicesUpgrade) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesUpgrade) WithOpaqueID(s string) func(*IndicesUpgradeRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesUpgrade) WithPretty ¶ 

func (f IndicesUpgrade) WithPretty() func(*IndicesUpgradeRequest)

WithPretty makes the response body pretty-printed.

func (IndicesUpgrade) WithWaitForCompletion ¶ 

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 ¶ 

type IndicesUpgradeRequest struct {
	Index []string

	AllowNoIndices      *bool
	ExpandWildcards     string
	IgnoreUnavailable   *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.

func (IndicesUpgradeRequest) Do ¶ 

func (r IndicesUpgradeRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesValidateQuery ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html.

func (IndicesValidateQuery) WithAllShards ¶ 

func (f IndicesValidateQuery) WithAllShards(v bool) func(*IndicesValidateQueryRequest)

WithAllShards - execute validation on all shards instead of one random shard per index.

func (IndicesValidateQuery) WithAllowNoIndices ¶ 

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 (IndicesValidateQuery) WithAnalyzeWildcard ¶ 

func (f IndicesValidateQuery) WithAnalyzeWildcard(v bool) func(*IndicesValidateQueryRequest)

WithAnalyzeWildcard - specify whether wildcard and prefix queries should be analyzed (default: false).

func (IndicesValidateQuery) WithAnalyzer ¶ 

func (f IndicesValidateQuery) WithAnalyzer(v string) func(*IndicesValidateQueryRequest)

WithAnalyzer - the analyzer to use for the query string.

func (IndicesValidateQuery) WithBody ¶ 

func (f IndicesValidateQuery) WithBody(v io.Reader) func(*IndicesValidateQueryRequest)

WithBody - The query definition specified with the Query DSL.

func (IndicesValidateQuery) WithContext ¶ 

func (f IndicesValidateQuery) WithContext(v context.Context) func(*IndicesValidateQueryRequest)

WithContext sets the request context.

func (IndicesValidateQuery) WithDefaultOperator ¶ 

func (f IndicesValidateQuery) WithDefaultOperator(v string) func(*IndicesValidateQueryRequest)

WithDefaultOperator - the default operator for query string query (and or or).

func (IndicesValidateQuery) WithDf ¶ 

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 (IndicesValidateQuery) WithDocumentType ¶ 

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 (IndicesValidateQuery) WithErrorTrace ¶ 

func (f IndicesValidateQuery) WithErrorTrace() func(*IndicesValidateQueryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IndicesValidateQuery) WithExpandWildcards ¶ 

func (f IndicesValidateQuery) WithExpandWildcards(v string) func(*IndicesValidateQueryRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesValidateQuery) WithExplain ¶ 

func (f IndicesValidateQuery) WithExplain(v bool) func(*IndicesValidateQueryRequest)

WithExplain - return detailed information about the error.

func (IndicesValidateQuery) WithFilterPath ¶ 

func (f IndicesValidateQuery) WithFilterPath(v ...string) func(*IndicesValidateQueryRequest)

WithFilterPath filters the properties of the response body.

func (IndicesValidateQuery) WithHeader ¶ added in v6.8.2 

func (f IndicesValidateQuery) WithHeader(h map[string]string) func(*IndicesValidateQueryRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesValidateQuery) WithHuman ¶ 

func (f IndicesValidateQuery) WithHuman() func(*IndicesValidateQueryRequest)

WithHuman makes statistical values human-readable.

func (IndicesValidateQuery) WithIgnoreUnavailable ¶ 

func (f IndicesValidateQuery) WithIgnoreUnavailable(v bool) func(*IndicesValidateQueryRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesValidateQuery) WithIndex ¶ 

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 (IndicesValidateQuery) WithLenient ¶ 

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 (IndicesValidateQuery) WithOpaqueID ¶ added in v6.8.5 

func (f IndicesValidateQuery) WithOpaqueID(s string) func(*IndicesValidateQueryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IndicesValidateQuery) WithPretty ¶ 

func (f IndicesValidateQuery) WithPretty() func(*IndicesValidateQueryRequest)

WithPretty makes the response body pretty-printed.

func (IndicesValidateQuery) WithQuery ¶ 

func (f IndicesValidateQuery) WithQuery(v string) func(*IndicesValidateQueryRequest)

WithQuery - query in the lucene query string syntax.

func (IndicesValidateQuery) WithRewrite ¶ 

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 ¶ 

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
	IgnoreUnavailable *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 (IndicesValidateQueryRequest) Do ¶ 

func (r IndicesValidateQueryRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Info ¶ 

type Info func(o ...func(*InfoRequest)) (*Response, error)

Info returns basic information about the cluster.

See full documentation at http://www.elastic.co/guide/.

func (Info) WithContext ¶ 

func (f Info) WithContext(v context.Context) func(*InfoRequest)

WithContext sets the request context.

func (Info) WithErrorTrace ¶ 

func (f Info) WithErrorTrace() func(*InfoRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Info) WithFilterPath ¶ 

func (f Info) WithFilterPath(v ...string) func(*InfoRequest)

WithFilterPath filters the properties of the response body.

func (Info) WithHeader ¶ added in v6.8.2 

func (f Info) WithHeader(h map[string]string) func(*InfoRequest)

WithHeader adds the headers to the HTTP request.

func (Info) WithHuman ¶ 

func (f Info) WithHuman() func(*InfoRequest)

WithHuman makes statistical values human-readable.

func (Info) WithOpaqueID ¶ added in v6.8.5 

func (f Info) WithOpaqueID(s string) func(*InfoRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

type InfoRequest ¶ 

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.

func (InfoRequest) Do ¶ 

func (r InfoRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Ingest ¶ 

type Ingest struct {
	DeletePipeline IngestDeletePipeline
	GetPipeline    IngestGetPipeline
	ProcessorGrok  IngestProcessorGrok
	PutPipeline    IngestPutPipeline
	Simulate       IngestSimulate
}

Ingest contains the Ingest APIs

type IngestDeletePipeline ¶ 

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 (IngestDeletePipeline) WithContext ¶ 

func (f IngestDeletePipeline) WithContext(v context.Context) func(*IngestDeletePipelineRequest)

WithContext sets the request context.

func (IngestDeletePipeline) WithErrorTrace ¶ 

func (f IngestDeletePipeline) WithErrorTrace() func(*IngestDeletePipelineRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IngestDeletePipeline) WithFilterPath ¶ 

func (f IngestDeletePipeline) WithFilterPath(v ...string) func(*IngestDeletePipelineRequest)

WithFilterPath filters the properties of the response body.

func (IngestDeletePipeline) WithHeader ¶ added in v6.8.2 

func (f IngestDeletePipeline) WithHeader(h map[string]string) func(*IngestDeletePipelineRequest)

WithHeader adds the headers to the HTTP request.

func (IngestDeletePipeline) WithHuman ¶ 

func (f IngestDeletePipeline) WithHuman() func(*IngestDeletePipelineRequest)

WithHuman makes statistical values human-readable.

func (IngestDeletePipeline) WithMasterTimeout ¶ 

func (f IngestDeletePipeline) WithMasterTimeout(v time.Duration) func(*IngestDeletePipelineRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (IngestDeletePipeline) WithOpaqueID ¶ added in v6.8.5 

func (f IngestDeletePipeline) WithOpaqueID(s string) func(*IngestDeletePipelineRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IngestDeletePipeline) WithPretty ¶ 

func (f IngestDeletePipeline) WithPretty() func(*IngestDeletePipelineRequest)

WithPretty makes the response body pretty-printed.

func (IngestDeletePipeline) WithTimeout ¶ 

func (f IngestDeletePipeline) WithTimeout(v time.Duration) func(*IngestDeletePipelineRequest)

WithTimeout - explicit operation timeout.

type IngestDeletePipelineRequest ¶ 

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 (IngestDeletePipelineRequest) Do ¶ 

func (r IngestDeletePipelineRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IngestGetPipeline ¶ 

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 (IngestGetPipeline) WithContext ¶ 

func (f IngestGetPipeline) WithContext(v context.Context) func(*IngestGetPipelineRequest)

WithContext sets the request context.

func (IngestGetPipeline) WithErrorTrace ¶ 

func (f IngestGetPipeline) WithErrorTrace() func(*IngestGetPipelineRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IngestGetPipeline) WithFilterPath ¶ 

func (f IngestGetPipeline) WithFilterPath(v ...string) func(*IngestGetPipelineRequest)

WithFilterPath filters the properties of the response body.

func (IngestGetPipeline) WithHeader ¶ added in v6.8.2 

func (f IngestGetPipeline) WithHeader(h map[string]string) func(*IngestGetPipelineRequest)

WithHeader adds the headers to the HTTP request.

func (IngestGetPipeline) WithHuman ¶ 

func (f IngestGetPipeline) WithHuman() func(*IngestGetPipelineRequest)

WithHuman makes statistical values human-readable.

func (IngestGetPipeline) WithMasterTimeout ¶ 

func (f IngestGetPipeline) WithMasterTimeout(v time.Duration) func(*IngestGetPipelineRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (IngestGetPipeline) WithOpaqueID ¶ added in v6.8.5 

func (f IngestGetPipeline) WithOpaqueID(s string) func(*IngestGetPipelineRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IngestGetPipeline) WithPipelineID ¶ added in v6.8.2 

func (f IngestGetPipeline) WithPipelineID(v string) func(*IngestGetPipelineRequest)

WithPipelineID - comma separated list of pipeline ids. wildcards supported.

func (IngestGetPipeline) WithPretty ¶ 

func (f IngestGetPipeline) WithPretty() func(*IngestGetPipelineRequest)

WithPretty makes the response body pretty-printed.

type IngestGetPipelineRequest ¶ 

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.

func (IngestGetPipelineRequest) Do ¶ 

func (r IngestGetPipelineRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IngestProcessorGrok ¶ 

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 (IngestProcessorGrok) WithContext ¶ 

func (f IngestProcessorGrok) WithContext(v context.Context) func(*IngestProcessorGrokRequest)

WithContext sets the request context.

func (IngestProcessorGrok) WithErrorTrace ¶ 

func (f IngestProcessorGrok) WithErrorTrace() func(*IngestProcessorGrokRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IngestProcessorGrok) WithFilterPath ¶ 

func (f IngestProcessorGrok) WithFilterPath(v ...string) func(*IngestProcessorGrokRequest)

WithFilterPath filters the properties of the response body.

func (IngestProcessorGrok) WithHeader ¶ added in v6.8.2 

func (f IngestProcessorGrok) WithHeader(h map[string]string) func(*IngestProcessorGrokRequest)

WithHeader adds the headers to the HTTP request.

func (IngestProcessorGrok) WithHuman ¶ 

func (f IngestProcessorGrok) WithHuman() func(*IngestProcessorGrokRequest)

WithHuman makes statistical values human-readable.

func (IngestProcessorGrok) WithOpaqueID ¶ added in v6.8.5 

func (f IngestProcessorGrok) WithOpaqueID(s string) func(*IngestProcessorGrokRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IngestProcessorGrok) WithPretty ¶ 

func (f IngestProcessorGrok) WithPretty() func(*IngestProcessorGrokRequest)

WithPretty makes the response body pretty-printed.

type IngestProcessorGrokRequest ¶ 

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 (IngestProcessorGrokRequest) Do ¶ 

func (r IngestProcessorGrokRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IngestPutPipeline ¶ 

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 (IngestPutPipeline) WithContext ¶ 

func (f IngestPutPipeline) WithContext(v context.Context) func(*IngestPutPipelineRequest)

WithContext sets the request context.

func (IngestPutPipeline) WithErrorTrace ¶ 

func (f IngestPutPipeline) WithErrorTrace() func(*IngestPutPipelineRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IngestPutPipeline) WithFilterPath ¶ 

func (f IngestPutPipeline) WithFilterPath(v ...string) func(*IngestPutPipelineRequest)

WithFilterPath filters the properties of the response body.

func (IngestPutPipeline) WithHeader ¶ added in v6.8.2 

func (f IngestPutPipeline) WithHeader(h map[string]string) func(*IngestPutPipelineRequest)

WithHeader adds the headers to the HTTP request.

func (IngestPutPipeline) WithHuman ¶ 

func (f IngestPutPipeline) WithHuman() func(*IngestPutPipelineRequest)

WithHuman makes statistical values human-readable.

func (IngestPutPipeline) WithMasterTimeout ¶ 

func (f IngestPutPipeline) WithMasterTimeout(v time.Duration) func(*IngestPutPipelineRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (IngestPutPipeline) WithOpaqueID ¶ added in v6.8.5 

func (f IngestPutPipeline) WithOpaqueID(s string) func(*IngestPutPipelineRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IngestPutPipeline) WithPretty ¶ 

func (f IngestPutPipeline) WithPretty() func(*IngestPutPipelineRequest)

WithPretty makes the response body pretty-printed.

func (IngestPutPipeline) WithTimeout ¶ 

func (f IngestPutPipeline) WithTimeout(v time.Duration) func(*IngestPutPipelineRequest)

WithTimeout - explicit operation timeout.

type IngestPutPipelineRequest ¶ 

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.

func (IngestPutPipelineRequest) Do ¶ 

func (r IngestPutPipelineRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IngestSimulate ¶ 

type IngestSimulate func(body io.Reader, o ...func(*IngestSimulateRequest)) (*Response, 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 (IngestSimulate) WithContext ¶ 

func (f IngestSimulate) WithContext(v context.Context) func(*IngestSimulateRequest)

WithContext sets the request context.

func (IngestSimulate) WithErrorTrace ¶ 

func (f IngestSimulate) WithErrorTrace() func(*IngestSimulateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IngestSimulate) WithFilterPath ¶ 

func (f IngestSimulate) WithFilterPath(v ...string) func(*IngestSimulateRequest)

WithFilterPath filters the properties of the response body.

func (IngestSimulate) WithHeader ¶ added in v6.8.2 

func (f IngestSimulate) WithHeader(h map[string]string) func(*IngestSimulateRequest)

WithHeader adds the headers to the HTTP request.

func (IngestSimulate) WithHuman ¶ 

func (f IngestSimulate) WithHuman() func(*IngestSimulateRequest)

WithHuman makes statistical values human-readable.

func (IngestSimulate) WithOpaqueID ¶ added in v6.8.5 

func (f IngestSimulate) WithOpaqueID(s string) func(*IngestSimulateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IngestSimulate) WithPipelineID ¶ added in v6.8.2 

func (f IngestSimulate) WithPipelineID(v string) func(*IngestSimulateRequest)

WithPipelineID - pipeline ID.

func (IngestSimulate) WithPretty ¶ 

func (f IngestSimulate) WithPretty() func(*IngestSimulateRequest)

WithPretty makes the response body pretty-printed.

func (IngestSimulate) WithVerbose ¶ 

func (f IngestSimulate) WithVerbose(v bool) func(*IngestSimulateRequest)

WithVerbose - verbose mode. display data output for each processor in executed pipeline.

type IngestSimulateRequest ¶ 

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.

func (IngestSimulateRequest) Do ¶ 

func (r IngestSimulateRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type License ¶ added in v6.8.2 

type License struct {
	Delete         XPackLicenseDelete
	GetBasicStatus XPackLicenseGetBasicStatus
	Get            XPackLicenseGet
	GetTrialStatus XPackLicenseGetTrialStatus
	Post           XPackLicensePost
	PostStartBasic XPackLicensePostStartBasic
	PostStartTrial XPackLicensePostStartTrial
}

License contains the License APIs

type ML ¶ added in v6.8.2 

type ML struct {
	CloseJob            XPackMLCloseJob
	DeleteCalendarEvent XPackMLDeleteCalendarEvent
	DeleteCalendarJob   XPackMLDeleteCalendarJob
	DeleteCalendar      XPackMLDeleteCalendar
	DeleteDatafeed      XPackMLDeleteDatafeed
	DeleteExpiredData   XPackMLDeleteExpiredData
	DeleteFilter        XPackMLDeleteFilter
	DeleteForecast      XPackMLDeleteForecast
	DeleteJob           XPackMLDeleteJob
	DeleteModelSnapshot XPackMLDeleteModelSnapshot
	FindFileStructure   XPackMLFindFileStructure
	FlushJob            XPackMLFlushJob
	Forecast            XPackMLForecast
	GetBuckets          XPackMLGetBuckets
	GetCalendarEvents   XPackMLGetCalendarEvents
	GetCalendars        XPackMLGetCalendars
	GetCategories       XPackMLGetCategories
	GetDatafeedStats    XPackMLGetDatafeedStats
	GetDatafeeds        XPackMLGetDatafeeds
	GetFilters          XPackMLGetFilters
	GetInfluencers      XPackMLGetInfluencers
	GetJobStats         XPackMLGetJobStats
	GetJobs             XPackMLGetJobs
	GetModelSnapshots   XPackMLGetModelSnapshots
	GetOverallBuckets   XPackMLGetOverallBuckets
	GetRecords          XPackMLGetRecords
	Info                XPackMLInfo
	OpenJob             XPackMLOpenJob
	PostCalendarEvents  XPackMLPostCalendarEvents
	PostData            XPackMLPostData
	PreviewDatafeed     XPackMLPreviewDatafeed
	PutCalendarJob      XPackMLPutCalendarJob
	PutCalendar         XPackMLPutCalendar
	PutDatafeed         XPackMLPutDatafeed
	PutFilter           XPackMLPutFilter
	PutJob              XPackMLPutJob
	RevertModelSnapshot XPackMLRevertModelSnapshot
	SetUpgradeMode      XPackMLSetUpgradeMode
	StartDatafeed       XPackMLStartDatafeed
	StopDatafeed        XPackMLStopDatafeed
	UpdateDatafeed      XPackMLUpdateDatafeed
	UpdateFilter        XPackMLUpdateFilter
	UpdateJob           XPackMLUpdateJob
	UpdateModelSnapshot XPackMLUpdateModelSnapshot
	ValidateDetector    XPackMLValidateDetector
	Validate            XPackMLValidate
}

ML contains the ML APIs

type Mget ¶ 

type Mget func(body io.Reader, o ...func(*MgetRequest)) (*Response, error)

Mget allows to get multiple documents in one request.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html.

func (Mget) WithContext ¶ 

func (f Mget) WithContext(v context.Context) func(*MgetRequest)

WithContext sets the request context.

func (Mget) WithDocumentType ¶ 

func (f Mget) WithDocumentType(v string) func(*MgetRequest)

WithDocumentType - the type of the document.

func (Mget) WithErrorTrace ¶ 

func (f Mget) WithErrorTrace() func(*MgetRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Mget) WithFilterPath ¶ 

func (f Mget) WithFilterPath(v ...string) func(*MgetRequest)

WithFilterPath filters the properties of the response body.

func (Mget) WithHeader ¶ added in v6.8.2 

func (f Mget) WithHeader(h map[string]string) func(*MgetRequest)

WithHeader adds the headers to the HTTP request.

func (Mget) WithHuman ¶ 

func (f Mget) WithHuman() func(*MgetRequest)

WithHuman makes statistical values human-readable.

func (Mget) WithIndex ¶ 

func (f Mget) WithIndex(v string) func(*MgetRequest)

WithIndex - the name of the index.

func (Mget) WithOpaqueID ¶ added in v6.8.5 

func (f Mget) WithOpaqueID(s string) func(*MgetRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Mget) WithPreference ¶ 

func (f Mget) WithPreference(v string) func(*MgetRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (Mget) WithPretty ¶ 

func (f Mget) WithPretty() func(*MgetRequest)

WithPretty makes the response body pretty-printed.

func (Mget) WithRealtime ¶ 

func (f Mget) WithRealtime(v bool) func(*MgetRequest)

WithRealtime - specify whether to perform the operation in realtime or search mode.

func (Mget) WithRefresh ¶ 

func (f Mget) WithRefresh(v bool) func(*MgetRequest)

WithRefresh - refresh the shard containing the document before performing the operation.

func (Mget) WithRouting ¶ 

func (f Mget) WithRouting(v string) func(*MgetRequest)

WithRouting - specific routing value.

func (Mget) WithSource ¶ 

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 (Mget) WithSourceExcludes ¶ 

func (f Mget) WithSourceExcludes(v ...string) func(*MgetRequest)

WithSourceExcludes - a list of fields to exclude from the returned _source field.

func (Mget) WithSourceIncludes ¶ 

func (f Mget) WithSourceIncludes(v ...string) func(*MgetRequest)

WithSourceIncludes - a list of fields to extract and return from the _source field.

func (Mget) WithStoredFields ¶ 

func (f Mget) WithStoredFields(v ...string) func(*MgetRequest)

WithStoredFields - a list of stored fields to return in the response.

type MgetRequest ¶ 

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.

func (MgetRequest) Do ¶ 

func (r MgetRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Migration ¶ added in v6.8.2 

type Migration struct {
	Deprecations  XPackMigrationDeprecations
	GetAssistance XPackMigrationGetAssistance
	Upgrade       XPackMigrationUpgrade
}

Migration contains the Migration APIs

type Monitoring ¶ added in v6.8.2 

type Monitoring struct {
	Bulk XPackMonitoringBulk
}

Monitoring contains the Monitoring APIs

type Msearch ¶ 

type Msearch func(body io.Reader, o ...func(*MsearchRequest)) (*Response, error)

Msearch allows to execute several search operations in one request.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html.

func (Msearch) WithContext ¶ 

func (f Msearch) WithContext(v context.Context) func(*MsearchRequest)

WithContext sets the request context.

func (Msearch) WithDocumentType ¶ 

func (f Msearch) WithDocumentType(v ...string) func(*MsearchRequest)

WithDocumentType - a list of document types to use as default.

func (Msearch) WithErrorTrace ¶ 

func (f Msearch) WithErrorTrace() func(*MsearchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Msearch) WithFilterPath ¶ 

func (f Msearch) WithFilterPath(v ...string) func(*MsearchRequest)

WithFilterPath filters the properties of the response body.

func (Msearch) WithHeader ¶ added in v6.8.2 

func (f Msearch) WithHeader(h map[string]string) func(*MsearchRequest)

WithHeader adds the headers to the HTTP request.

func (Msearch) WithHuman ¶ 

func (f Msearch) WithHuman() func(*MsearchRequest)

WithHuman makes statistical values human-readable.

func (Msearch) WithIndex ¶ 

func (f Msearch) WithIndex(v ...string) func(*MsearchRequest)

WithIndex - a list of index names to use as default.

func (Msearch) WithMaxConcurrentSearches ¶ 

func (f Msearch) WithMaxConcurrentSearches(v int) func(*MsearchRequest)

WithMaxConcurrentSearches - controls the maximum number of concurrent searches the multi search api will execute.

func (Msearch) WithMaxConcurrentShardRequests ¶ 

func (f Msearch) WithMaxConcurrentShardRequests(v int) func(*MsearchRequest)

WithMaxConcurrentShardRequests - the number of concurrent shard requests each sub 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 (Msearch) WithOpaqueID ¶ added in v6.8.5 

func (f Msearch) WithOpaqueID(s string) func(*MsearchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Msearch) WithPreFilterShardSize ¶ 

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 (Msearch) WithPretty ¶ 

func (f Msearch) WithPretty() func(*MsearchRequest)

WithPretty makes the response body pretty-printed.

func (Msearch) WithRestTotalHitsAsInt ¶ 

func (f Msearch) WithRestTotalHitsAsInt(v bool) func(*MsearchRequest)

WithRestTotalHitsAsInt - this parameter is ignored in this version. it is used in the next major version to control whether the rest response should render the total.hits as an object or a number.

func (Msearch) WithSearchType ¶ 

func (f Msearch) WithSearchType(v string) func(*MsearchRequest)

WithSearchType - search operation type.

func (Msearch) WithTypedKeys ¶ 

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 ¶ 

type MsearchRequest struct {
	Index        []string
	DocumentType []string

	Body io.Reader

	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.

func (MsearchRequest) Do ¶ 

func (r MsearchRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MsearchTemplate ¶ 

type MsearchTemplate func(body io.Reader, o ...func(*MsearchTemplateRequest)) (*Response, error)

MsearchTemplate allows to execute several search template operations in one request.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html.

func (MsearchTemplate) WithContext ¶ 

func (f MsearchTemplate) WithContext(v context.Context) func(*MsearchTemplateRequest)

WithContext sets the request context.

func (MsearchTemplate) WithDocumentType ¶ 

func (f MsearchTemplate) WithDocumentType(v ...string) func(*MsearchTemplateRequest)

WithDocumentType - a list of document types to use as default.

func (MsearchTemplate) WithErrorTrace ¶ 

func (f MsearchTemplate) WithErrorTrace() func(*MsearchTemplateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MsearchTemplate) WithFilterPath ¶ 

func (f MsearchTemplate) WithFilterPath(v ...string) func(*MsearchTemplateRequest)

WithFilterPath filters the properties of the response body.

func (MsearchTemplate) WithHeader ¶ added in v6.8.2 

func (f MsearchTemplate) WithHeader(h map[string]string) func(*MsearchTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (MsearchTemplate) WithHuman ¶ 

func (f MsearchTemplate) WithHuman() func(*MsearchTemplateRequest)

WithHuman makes statistical values human-readable.

func (MsearchTemplate) WithIndex ¶ 

func (f MsearchTemplate) WithIndex(v ...string) func(*MsearchTemplateRequest)

WithIndex - a list of index names to use as default.

func (MsearchTemplate) WithMaxConcurrentSearches ¶ 

func (f MsearchTemplate) WithMaxConcurrentSearches(v int) func(*MsearchTemplateRequest)

WithMaxConcurrentSearches - controls the maximum number of concurrent searches the multi search api will execute.

func (MsearchTemplate) WithOpaqueID ¶ added in v6.8.5 

func (f MsearchTemplate) WithOpaqueID(s string) func(*MsearchTemplateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MsearchTemplate) WithPretty ¶ 

func (f MsearchTemplate) WithPretty() func(*MsearchTemplateRequest)

WithPretty makes the response body pretty-printed.

func (MsearchTemplate) WithRestTotalHitsAsInt ¶ 

func (f MsearchTemplate) WithRestTotalHitsAsInt(v bool) func(*MsearchTemplateRequest)

WithRestTotalHitsAsInt - this parameter is ignored in this version. it is used in the next major version to control whether the rest response should render the total.hits as an object or a number.

func (MsearchTemplate) WithSearchType ¶ 

func (f MsearchTemplate) WithSearchType(v string) func(*MsearchTemplateRequest)

WithSearchType - search operation type.

func (MsearchTemplate) WithTypedKeys ¶ 

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 ¶ 

type MsearchTemplateRequest struct {
	Index        []string
	DocumentType []string

	Body io.Reader

	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.

func (MsearchTemplateRequest) Do ¶ 

func (r MsearchTemplateRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Mtermvectors ¶ 

type Mtermvectors func(o ...func(*MtermvectorsRequest)) (*Response, error)

Mtermvectors returns multiple termvectors in one request.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html.

func (Mtermvectors) WithBody ¶ 

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 (Mtermvectors) WithContext ¶ 

func (f Mtermvectors) WithContext(v context.Context) func(*MtermvectorsRequest)

WithContext sets the request context.

func (Mtermvectors) WithDocumentType ¶ 

func (f Mtermvectors) WithDocumentType(v string) func(*MtermvectorsRequest)

WithDocumentType - the type of the document..

func (Mtermvectors) WithErrorTrace ¶ 

func (f Mtermvectors) WithErrorTrace() func(*MtermvectorsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Mtermvectors) WithFieldStatistics ¶ 

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 (Mtermvectors) WithFields ¶ 

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 (Mtermvectors) WithFilterPath ¶ 

func (f Mtermvectors) WithFilterPath(v ...string) func(*MtermvectorsRequest)

WithFilterPath filters the properties of the response body.

func (Mtermvectors) WithHeader ¶ added in v6.8.2 

func (f Mtermvectors) WithHeader(h map[string]string) func(*MtermvectorsRequest)

WithHeader adds the headers to the HTTP request.

func (Mtermvectors) WithHuman ¶ 

func (f Mtermvectors) WithHuman() func(*MtermvectorsRequest)

WithHuman makes statistical values human-readable.

func (Mtermvectors) WithIds ¶ 

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 (Mtermvectors) WithIndex ¶ 

func (f Mtermvectors) WithIndex(v string) func(*MtermvectorsRequest)

WithIndex - the index in which the document resides..

func (Mtermvectors) WithOffsets ¶ 

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 (Mtermvectors) WithOpaqueID ¶ added in v6.8.5 

func (f Mtermvectors) WithOpaqueID(s string) func(*MtermvectorsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Mtermvectors) WithParent ¶ 

func (f Mtermvectors) WithParent(v string) func(*MtermvectorsRequest)

WithParent - parent ID of documents. applies to all returned documents unless otherwise specified in body "params" or "docs"..

func (Mtermvectors) WithPayloads ¶ 

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 (Mtermvectors) WithPositions ¶ 

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 (Mtermvectors) WithPreference ¶ 

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 (Mtermvectors) WithPretty ¶ 

func (f Mtermvectors) WithPretty() func(*MtermvectorsRequest)

WithPretty makes the response body pretty-printed.

func (Mtermvectors) WithRealtime ¶ 

func (f Mtermvectors) WithRealtime(v bool) func(*MtermvectorsRequest)

WithRealtime - specifies if requests are real-time as opposed to near-real-time (default: true)..

func (Mtermvectors) WithRouting ¶ 

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 (Mtermvectors) WithTermStatistics ¶ 

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 (Mtermvectors) WithVersion ¶ 

func (f Mtermvectors) WithVersion(v int) func(*MtermvectorsRequest)

WithVersion - explicit version number for concurrency control.

func (Mtermvectors) WithVersionType ¶ 

func (f Mtermvectors) WithVersionType(v string) func(*MtermvectorsRequest)

WithVersionType - specific version type.

type MtermvectorsRequest ¶ 

type MtermvectorsRequest struct {
	Index        string
	DocumentType string

	Body io.Reader

	Fields          []string
	FieldStatistics *bool
	Ids             []string
	Offsets         *bool
	Parent          string
	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.

func (MtermvectorsRequest) Do ¶ 

func (r MtermvectorsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Nodes ¶ 

type Nodes struct {
	HotThreads           NodesHotThreads
	Info                 NodesInfo
	ReloadSecureSettings NodesReloadSecureSettings
	Stats                NodesStats
	Usage                NodesUsage
}

Nodes contains the Nodes APIs

type NodesHotThreads ¶ 

type NodesHotThreads func(o ...func(*NodesHotThreadsRequest)) (*Response, error)

NodesHotThreads returns information about hot threads on each node in the cluster.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html.

func (NodesHotThreads) WithContext ¶ 

func (f NodesHotThreads) WithContext(v context.Context) func(*NodesHotThreadsRequest)

WithContext sets the request context.

func (NodesHotThreads) WithDocumentType ¶ 

func (f NodesHotThreads) WithDocumentType(v string) func(*NodesHotThreadsRequest)

WithDocumentType - the type to sample (default: cpu).

func (NodesHotThreads) WithErrorTrace ¶ 

func (f NodesHotThreads) WithErrorTrace() func(*NodesHotThreadsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (NodesHotThreads) WithFilterPath ¶ 

func (f NodesHotThreads) WithFilterPath(v ...string) func(*NodesHotThreadsRequest)

WithFilterPath filters the properties of the response body.

func (NodesHotThreads) WithHeader ¶ added in v6.8.2 

func (f NodesHotThreads) WithHeader(h map[string]string) func(*NodesHotThreadsRequest)

WithHeader adds the headers to the HTTP request.

func (NodesHotThreads) WithHuman ¶ 

func (f NodesHotThreads) WithHuman() func(*NodesHotThreadsRequest)

WithHuman makes statistical values human-readable.

func (NodesHotThreads) WithIgnoreIdleThreads ¶ 

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 (NodesHotThreads) WithInterval ¶ 

func (f NodesHotThreads) WithInterval(v time.Duration) func(*NodesHotThreadsRequest)

WithInterval - the interval for the second sampling of threads.

func (NodesHotThreads) WithNodeID ¶ 

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 (NodesHotThreads) WithOpaqueID ¶ added in v6.8.5 

func (f NodesHotThreads) WithOpaqueID(s string) func(*NodesHotThreadsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (NodesHotThreads) WithPretty ¶ 

func (f NodesHotThreads) WithPretty() func(*NodesHotThreadsRequest)

WithPretty makes the response body pretty-printed.

func (NodesHotThreads) WithSnapshots ¶ 

func (f NodesHotThreads) WithSnapshots(v int) func(*NodesHotThreadsRequest)

WithSnapshots - number of samples of thread stacktrace (default: 10).

func (NodesHotThreads) WithThreads ¶ 

func (f NodesHotThreads) WithThreads(v int) func(*NodesHotThreadsRequest)

WithThreads - specify the number of threads to provide information for (default: 3).

func (NodesHotThreads) WithTimeout ¶ 

func (f NodesHotThreads) WithTimeout(v time.Duration) func(*NodesHotThreadsRequest)

WithTimeout - explicit operation timeout.

type NodesHotThreadsRequest ¶ 

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.

func (NodesHotThreadsRequest) Do ¶ 

func (r NodesHotThreadsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type NodesInfo ¶ 

type NodesInfo func(o ...func(*NodesInfoRequest)) (*Response, error)

NodesInfo returns information about nodes in the cluster.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html.

func (NodesInfo) WithContext ¶ 

func (f NodesInfo) WithContext(v context.Context) func(*NodesInfoRequest)

WithContext sets the request context.

func (NodesInfo) WithErrorTrace ¶ 

func (f NodesInfo) WithErrorTrace() func(*NodesInfoRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (NodesInfo) WithFilterPath ¶ 

func (f NodesInfo) WithFilterPath(v ...string) func(*NodesInfoRequest)

WithFilterPath filters the properties of the response body.

func (NodesInfo) WithFlatSettings ¶ 

func (f NodesInfo) WithFlatSettings(v bool) func(*NodesInfoRequest)

WithFlatSettings - return settings in flat format (default: false).

func (NodesInfo) WithHeader ¶ added in v6.8.2 

func (f NodesInfo) WithHeader(h map[string]string) func(*NodesInfoRequest)

WithHeader adds the headers to the HTTP request.

func (NodesInfo) WithHuman ¶ 

func (f NodesInfo) WithHuman() func(*NodesInfoRequest)

WithHuman makes statistical values human-readable.

func (NodesInfo) WithMetric ¶ 

func (f NodesInfo) WithMetric(v ...string) func(*NodesInfoRequest)

WithMetric - a list of metrics you wish returned. leave empty to return all..

func (NodesInfo) WithNodeID ¶ 

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 (NodesInfo) WithOpaqueID ¶ added in v6.8.5 

func (f NodesInfo) WithOpaqueID(s string) func(*NodesInfoRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (NodesInfo) WithPretty ¶ 

func (f NodesInfo) WithPretty() func(*NodesInfoRequest)

WithPretty makes the response body pretty-printed.

func (NodesInfo) WithTimeout ¶ 

func (f NodesInfo) WithTimeout(v time.Duration) func(*NodesInfoRequest)

WithTimeout - explicit operation timeout.

type NodesInfoRequest ¶ 

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.

func (NodesInfoRequest) Do ¶ 

func (r NodesInfoRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type NodesReloadSecureSettings ¶ 

type NodesReloadSecureSettings func(o ...func(*NodesReloadSecureSettingsRequest)) (*Response, error)

NodesReloadSecureSettings reloads secure settings.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/6.x/secure-settings.html#reloadable-secure-settings.

func (NodesReloadSecureSettings) WithContext ¶ 

func (f NodesReloadSecureSettings) WithContext(v context.Context) func(*NodesReloadSecureSettingsRequest)

WithContext sets the request context.

func (NodesReloadSecureSettings) WithErrorTrace ¶ 

func (f NodesReloadSecureSettings) WithErrorTrace() func(*NodesReloadSecureSettingsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (NodesReloadSecureSettings) WithFilterPath ¶ 

func (f NodesReloadSecureSettings) WithFilterPath(v ...string) func(*NodesReloadSecureSettingsRequest)

WithFilterPath filters the properties of the response body.

func (NodesReloadSecureSettings) WithHeader ¶ added in v6.8.2 

func (f NodesReloadSecureSettings) WithHeader(h map[string]string) func(*NodesReloadSecureSettingsRequest)

WithHeader adds the headers to the HTTP request.

func (NodesReloadSecureSettings) WithHuman ¶ 

func (f NodesReloadSecureSettings) WithHuman() func(*NodesReloadSecureSettingsRequest)

WithHuman makes statistical values human-readable.

func (NodesReloadSecureSettings) WithNodeID ¶ 

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 (NodesReloadSecureSettings) WithOpaqueID ¶ added in v6.8.5 

func (f NodesReloadSecureSettings) WithOpaqueID(s string) func(*NodesReloadSecureSettingsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (NodesReloadSecureSettings) WithPretty ¶ 

func (f NodesReloadSecureSettings) WithPretty() func(*NodesReloadSecureSettingsRequest)

WithPretty makes the response body pretty-printed.

func (NodesReloadSecureSettings) WithTimeout ¶ 

func (f NodesReloadSecureSettings) WithTimeout(v time.Duration) func(*NodesReloadSecureSettingsRequest)

WithTimeout - explicit operation timeout.

type NodesReloadSecureSettingsRequest ¶ 

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 (NodesReloadSecureSettingsRequest) Do ¶ 

func (r NodesReloadSecureSettingsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type NodesStats ¶ 

type NodesStats func(o ...func(*NodesStatsRequest)) (*Response, error)

NodesStats returns statistical information about nodes in the cluster.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html.

func (NodesStats) WithCompletionFields ¶ 

func (f NodesStats) WithCompletionFields(v ...string) func(*NodesStatsRequest)

WithCompletionFields - a list of fields for `fielddata` and `suggest` index metric (supports wildcards).

func (NodesStats) WithContext ¶ 

func (f NodesStats) WithContext(v context.Context) func(*NodesStatsRequest)

WithContext sets the request context.

func (NodesStats) WithErrorTrace ¶ 

func (f NodesStats) WithErrorTrace() func(*NodesStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (NodesStats) WithFielddataFields ¶ 

func (f NodesStats) WithFielddataFields(v ...string) func(*NodesStatsRequest)

WithFielddataFields - a list of fields for `fielddata` index metric (supports wildcards).

func (NodesStats) WithFields ¶ 

func (f NodesStats) WithFields(v ...string) func(*NodesStatsRequest)

WithFields - a list of fields for `fielddata` and `completion` index metric (supports wildcards).

func (NodesStats) WithFilterPath ¶ 

func (f NodesStats) WithFilterPath(v ...string) func(*NodesStatsRequest)

WithFilterPath filters the properties of the response body.

func (NodesStats) WithGroups ¶ 

func (f NodesStats) WithGroups(v bool) func(*NodesStatsRequest)

WithGroups - a list of search groups for `search` index metric.

func (NodesStats) WithHeader ¶ added in v6.8.2 

func (f NodesStats) WithHeader(h map[string]string) func(*NodesStatsRequest)

WithHeader adds the headers to the HTTP request.

func (NodesStats) WithHuman ¶ 

func (f NodesStats) WithHuman() func(*NodesStatsRequest)

WithHuman makes statistical values human-readable.

func (NodesStats) WithIncludeSegmentFileSizes ¶ 

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 (NodesStats) WithIndexMetric ¶ 

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 (NodesStats) WithLevel ¶ 

func (f NodesStats) WithLevel(v string) func(*NodesStatsRequest)

WithLevel - return indices stats aggregated at index, node or shard level.

func (NodesStats) WithMetric ¶ 

func (f NodesStats) WithMetric(v ...string) func(*NodesStatsRequest)

WithMetric - limit the information returned to the specified metrics.

func (NodesStats) WithNodeID ¶ 

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 (NodesStats) WithOpaqueID ¶ added in v6.8.5 

func (f NodesStats) WithOpaqueID(s string) func(*NodesStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (NodesStats) WithPretty ¶ 

func (f NodesStats) WithPretty() func(*NodesStatsRequest)

WithPretty makes the response body pretty-printed.

func (NodesStats) WithTimeout ¶ 

func (f NodesStats) WithTimeout(v time.Duration) func(*NodesStatsRequest)

WithTimeout - explicit operation timeout.

func (NodesStats) WithTypes ¶ 

func (f NodesStats) WithTypes(v ...string) func(*NodesStatsRequest)

WithTypes - a list of document types for the `indexing` index metric.

type NodesStatsRequest ¶ 

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.

func (NodesStatsRequest) Do ¶ 

func (r NodesStatsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type NodesUsage ¶ 

type NodesUsage func(o ...func(*NodesUsageRequest)) (*Response, error)

NodesUsage returns low-level information about REST actions usage on nodes.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-usage.html.

func (NodesUsage) WithContext ¶ 

func (f NodesUsage) WithContext(v context.Context) func(*NodesUsageRequest)

WithContext sets the request context.

func (NodesUsage) WithErrorTrace ¶ 

func (f NodesUsage) WithErrorTrace() func(*NodesUsageRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (NodesUsage) WithFilterPath ¶ 

func (f NodesUsage) WithFilterPath(v ...string) func(*NodesUsageRequest)

WithFilterPath filters the properties of the response body.

func (NodesUsage) WithHeader ¶ added in v6.8.2 

func (f NodesUsage) WithHeader(h map[string]string) func(*NodesUsageRequest)

WithHeader adds the headers to the HTTP request.

func (NodesUsage) WithHuman ¶ 

func (f NodesUsage) WithHuman() func(*NodesUsageRequest)

WithHuman makes statistical values human-readable.

func (NodesUsage) WithMetric ¶ 

func (f NodesUsage) WithMetric(v ...string) func(*NodesUsageRequest)

WithMetric - limit the information returned to the specified metrics.

func (NodesUsage) WithNodeID ¶ 

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 (NodesUsage) WithOpaqueID ¶ added in v6.8.5 

func (f NodesUsage) WithOpaqueID(s string) func(*NodesUsageRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (NodesUsage) WithPretty ¶ 

func (f NodesUsage) WithPretty() func(*NodesUsageRequest)

WithPretty makes the response body pretty-printed.

func (NodesUsage) WithTimeout ¶ 

func (f NodesUsage) WithTimeout(v time.Duration) func(*NodesUsageRequest)

WithTimeout - explicit operation timeout.

type NodesUsageRequest ¶ 

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.

func (NodesUsageRequest) Do ¶ 

func (r NodesUsageRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Ping ¶ 

type Ping func(o ...func(*PingRequest)) (*Response, error)

Ping returns whether the cluster is running.

See full documentation at http://www.elastic.co/guide/.

func (Ping) WithContext ¶ 

func (f Ping) WithContext(v context.Context) func(*PingRequest)

WithContext sets the request context.

func (Ping) WithErrorTrace ¶ 

func (f Ping) WithErrorTrace() func(*PingRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Ping) WithFilterPath ¶ 

func (f Ping) WithFilterPath(v ...string) func(*PingRequest)

WithFilterPath filters the properties of the response body.

func (Ping) WithHeader ¶ added in v6.8.2 

func (f Ping) WithHeader(h map[string]string) func(*PingRequest)

WithHeader adds the headers to the HTTP request.

func (Ping) WithHuman ¶ 

func (f Ping) WithHuman() func(*PingRequest)

WithHuman makes statistical values human-readable.

func (Ping) WithOpaqueID ¶ added in v6.8.5 

func (f Ping) WithOpaqueID(s string) func(*PingRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Ping) WithPretty ¶ 

func (f Ping) WithPretty() func(*PingRequest)

WithPretty makes the response body pretty-printed.

type PingRequest ¶ 

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.

func (PingRequest) Do ¶ 

func (r PingRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type PutScript ¶ 

type PutScript func(id string, body io.Reader, o ...func(*PutScriptRequest)) (*Response, error)

PutScript creates or updates a script.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html.

func (PutScript) WithContext ¶ 

func (f PutScript) WithContext(v context.Context) func(*PutScriptRequest)

WithContext sets the request context.

func (PutScript) WithErrorTrace ¶ 

func (f PutScript) WithErrorTrace() func(*PutScriptRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (PutScript) WithFilterPath ¶ 

func (f PutScript) WithFilterPath(v ...string) func(*PutScriptRequest)

WithFilterPath filters the properties of the response body.

func (PutScript) WithHeader ¶ added in v6.8.2 

func (f PutScript) WithHeader(h map[string]string) func(*PutScriptRequest)

WithHeader adds the headers to the HTTP request.

func (PutScript) WithHuman ¶ 

func (f PutScript) WithHuman() func(*PutScriptRequest)

WithHuman makes statistical values human-readable.

func (PutScript) WithMasterTimeout ¶ 

func (f PutScript) WithMasterTimeout(v time.Duration) func(*PutScriptRequest)

WithMasterTimeout - specify timeout for connection to master.

func (PutScript) WithOpaqueID ¶ added in v6.8.5 

func (f PutScript) WithOpaqueID(s string) func(*PutScriptRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (PutScript) WithPretty ¶ 

func (f PutScript) WithPretty() func(*PutScriptRequest)

WithPretty makes the response body pretty-printed.

func (PutScript) WithScriptContext ¶ 

func (f PutScript) WithScriptContext(v string) func(*PutScriptRequest)

WithScriptContext - script context.

func (PutScript) WithTimeout ¶ 

func (f PutScript) WithTimeout(v time.Duration) func(*PutScriptRequest)

WithTimeout - explicit operation timeout.

type PutScriptRequest ¶ 

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.

func (PutScriptRequest) Do ¶ 

func (r PutScriptRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type RankEval ¶ 

type RankEval func(body io.Reader, o ...func(*RankEvalRequest)) (*Response, 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 (RankEval) WithAllowNoIndices ¶ 

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 (RankEval) WithContext ¶ 

func (f RankEval) WithContext(v context.Context) func(*RankEvalRequest)

WithContext sets the request context.

func (RankEval) WithErrorTrace ¶ 

func (f RankEval) WithErrorTrace() func(*RankEvalRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (RankEval) WithExpandWildcards ¶ 

func (f RankEval) WithExpandWildcards(v string) func(*RankEvalRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (RankEval) WithFilterPath ¶ 

func (f RankEval) WithFilterPath(v ...string) func(*RankEvalRequest)

WithFilterPath filters the properties of the response body.

func (RankEval) WithHeader ¶ added in v6.8.2 

func (f RankEval) WithHeader(h map[string]string) func(*RankEvalRequest)

WithHeader adds the headers to the HTTP request.

func (RankEval) WithHuman ¶ 

func (f RankEval) WithHuman() func(*RankEvalRequest)

WithHuman makes statistical values human-readable.

func (RankEval) WithIgnoreUnavailable ¶ 

func (f RankEval) WithIgnoreUnavailable(v bool) func(*RankEvalRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (RankEval) WithIndex ¶ 

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 (RankEval) WithOpaqueID ¶ added in v6.8.5 

func (f RankEval) WithOpaqueID(s string) func(*RankEvalRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (RankEval) WithPretty ¶ 

func (f RankEval) WithPretty() func(*RankEvalRequest)

WithPretty makes the response body pretty-printed.

type RankEvalRequest ¶ 

type RankEvalRequest struct {
	Index []string

	Body io.Reader

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

RankEvalRequest configures the Rank Eval API request.

func (RankEvalRequest) Do ¶ 

func (r RankEvalRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Reindex ¶ 

type Reindex func(body io.Reader, o ...func(*ReindexRequest)) (*Response, 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 (Reindex) WithContext ¶ 

func (f Reindex) WithContext(v context.Context) func(*ReindexRequest)

WithContext sets the request context.

func (Reindex) WithErrorTrace ¶ 

func (f Reindex) WithErrorTrace() func(*ReindexRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Reindex) WithFilterPath ¶ 

func (f Reindex) WithFilterPath(v ...string) func(*ReindexRequest)

WithFilterPath filters the properties of the response body.

func (Reindex) WithHeader ¶ added in v6.8.2 

func (f Reindex) WithHeader(h map[string]string) func(*ReindexRequest)

WithHeader adds the headers to the HTTP request.

func (Reindex) WithHuman ¶ 

func (f Reindex) WithHuman() func(*ReindexRequest)

WithHuman makes statistical values human-readable.

func (Reindex) WithOpaqueID ¶ added in v6.8.5 

func (f Reindex) WithOpaqueID(s string) func(*ReindexRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Reindex) WithPretty ¶ 

func (f Reindex) WithPretty() func(*ReindexRequest)

WithPretty makes the response body pretty-printed.

func (Reindex) WithRefresh ¶ 

func (f Reindex) WithRefresh(v bool) func(*ReindexRequest)

WithRefresh - should the effected indexes be refreshed?.

func (Reindex) WithRequestsPerSecond ¶ 

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 (Reindex) WithSlices ¶ 

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 (Reindex) WithTimeout ¶ 

func (f Reindex) WithTimeout(v time.Duration) func(*ReindexRequest)

WithTimeout - time each individual bulk request should wait for shards that are unavailable..

func (Reindex) WithWaitForActiveShards ¶ 

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 (Reindex) WithWaitForCompletion ¶ 

func (f Reindex) WithWaitForCompletion(v bool) func(*ReindexRequest)

WithWaitForCompletion - should the request should block until the reindex is complete..

type ReindexRequest ¶ 

type ReindexRequest struct {
	Body io.Reader

	Refresh             *bool
	RequestsPerSecond   *int
	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.

func (ReindexRequest) Do ¶ 

func (r ReindexRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ReindexRethrottle ¶ 

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 (ReindexRethrottle) WithContext ¶ 

func (f ReindexRethrottle) WithContext(v context.Context) func(*ReindexRethrottleRequest)

WithContext sets the request context.

func (ReindexRethrottle) WithErrorTrace ¶ 

func (f ReindexRethrottle) WithErrorTrace() func(*ReindexRethrottleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ReindexRethrottle) WithFilterPath ¶ 

func (f ReindexRethrottle) WithFilterPath(v ...string) func(*ReindexRethrottleRequest)

WithFilterPath filters the properties of the response body.

func (ReindexRethrottle) WithHeader ¶ added in v6.8.2 

func (f ReindexRethrottle) WithHeader(h map[string]string) func(*ReindexRethrottleRequest)

WithHeader adds the headers to the HTTP request.

func (ReindexRethrottle) WithHuman ¶ 

func (f ReindexRethrottle) WithHuman() func(*ReindexRethrottleRequest)

WithHuman makes statistical values human-readable.

func (ReindexRethrottle) WithOpaqueID ¶ added in v6.8.5 

func (f ReindexRethrottle) WithOpaqueID(s string) func(*ReindexRethrottleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ReindexRethrottle) WithPretty ¶ 

func (f ReindexRethrottle) WithPretty() func(*ReindexRethrottleRequest)

WithPretty makes the response body pretty-printed.

func (ReindexRethrottle) WithRequestsPerSecond ¶ 

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 ¶ 

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.

func (ReindexRethrottleRequest) Do ¶ 

func (r ReindexRethrottleRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Remote ¶ 

type Remote struct {
}

Remote contains the Remote APIs

type RenderSearchTemplate ¶ 

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 http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html.

func (RenderSearchTemplate) WithBody ¶ 

func (f RenderSearchTemplate) WithBody(v io.Reader) func(*RenderSearchTemplateRequest)

WithBody - The search definition template and its params.

func (RenderSearchTemplate) WithContext ¶ 

func (f RenderSearchTemplate) WithContext(v context.Context) func(*RenderSearchTemplateRequest)

WithContext sets the request context.

func (RenderSearchTemplate) WithErrorTrace ¶ 

func (f RenderSearchTemplate) WithErrorTrace() func(*RenderSearchTemplateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (RenderSearchTemplate) WithFilterPath ¶ 

func (f RenderSearchTemplate) WithFilterPath(v ...string) func(*RenderSearchTemplateRequest)

WithFilterPath filters the properties of the response body.

func (RenderSearchTemplate) WithHeader ¶ added in v6.8.2 

func (f RenderSearchTemplate) WithHeader(h map[string]string) func(*RenderSearchTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (RenderSearchTemplate) WithHuman ¶ 

func (f RenderSearchTemplate) WithHuman() func(*RenderSearchTemplateRequest)

WithHuman makes statistical values human-readable.

func (RenderSearchTemplate) WithOpaqueID ¶ added in v6.8.5 

func (f RenderSearchTemplate) WithOpaqueID(s string) func(*RenderSearchTemplateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (RenderSearchTemplate) WithPretty ¶ 

func (f RenderSearchTemplate) WithPretty() func(*RenderSearchTemplateRequest)

WithPretty makes the response body pretty-printed.

func (RenderSearchTemplate) WithTemplateID ¶ added in v6.8.2 

func (f RenderSearchTemplate) WithTemplateID(v string) func(*RenderSearchTemplateRequest)

WithTemplateID - the ID of the stored search template.

type RenderSearchTemplateRequest ¶ 

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 (RenderSearchTemplateRequest) Do ¶ 

func (r RenderSearchTemplateRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Request ¶ 

type Request interface {
	Do(ctx context.Context, transport Transport) (*Response, error)
}

Request defines the API request.

type Response ¶ 

type Response struct {
	StatusCode int
	Header     http.Header
	Body       io.ReadCloser
}

Response represents the API response.

func (*Response) HasWarnings ¶ added in v6.8.10 

func (r *Response) HasWarnings() bool

HasWarnings returns true when the response headers contain deprecation warnings.

func (*Response) IsError ¶ 

func (r *Response) IsError() bool

IsError returns true when the response status indicates failure.

Example ¶ 
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)

Output:

func (*Response) Status ¶ 

func (r *Response) Status() string

Status returns the response status as a string.

Example ¶ 
es, _ := elasticsearch.NewDefaultClient()

res, _ := es.Info()
log.Println(res.Status())

// 200 OK

Output:

func (*Response) String ¶ 

func (r *Response) String() string

String returns the response as a string.

The intended usage is for testing or debugging only.

Example ¶ 
es, _ := elasticsearch.NewDefaultClient()

res, _ := es.Info()
log.Println(res.String())

// [200 OK] {
// "name" : "es1",
// "cluster_name" : "go-elasticsearch",
// ...
// }

Output:

func (*Response) Warnings ¶ added in v6.8.10 

func (r *Response) Warnings() []string

Warnings returns the deprecation warnings from response headers.

type Rollup ¶ added in v6.8.2 

type Rollup struct {
	DeleteJob    XPackRollupDeleteJob
	GetJobs      XPackRollupGetJobs
	GetCaps      XPackRollupGetRollupCaps
	GetIndexCaps XPackRollupGetRollupIndexCaps
	PutJob       XPackRollupPutJob
	Search       XPackRollupRollupSearch
	StartJob     XPackRollupStartJob
	StopJob      XPackRollupStopJob
}

Rollup contains the Rollup APIs

type SQL ¶ added in v6.8.2 

type SQL struct {
	ClearCursor XPackSQLClearCursor
	Query       XPackSQLQuery
	Translate   XPackSQLTranslate
}

SQL contains the SQL APIs

type SSL ¶ added in v6.8.2 

type SSL struct {
	Certificates XPackSSLCertificates
}

SSL contains the SSL APIs

type ScriptsPainlessExecute ¶ 

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 (ScriptsPainlessExecute) WithBody ¶ 

func (f ScriptsPainlessExecute) WithBody(v io.Reader) func(*ScriptsPainlessExecuteRequest)

WithBody - The script to execute.

func (ScriptsPainlessExecute) WithContext ¶ 

func (f ScriptsPainlessExecute) WithContext(v context.Context) func(*ScriptsPainlessExecuteRequest)

WithContext sets the request context.

func (ScriptsPainlessExecute) WithErrorTrace ¶ 

func (f ScriptsPainlessExecute) WithErrorTrace() func(*ScriptsPainlessExecuteRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ScriptsPainlessExecute) WithFilterPath ¶ 

func (f ScriptsPainlessExecute) WithFilterPath(v ...string) func(*ScriptsPainlessExecuteRequest)

WithFilterPath filters the properties of the response body.

func (ScriptsPainlessExecute) WithHeader ¶ added in v6.8.2 

func (f ScriptsPainlessExecute) WithHeader(h map[string]string) func(*ScriptsPainlessExecuteRequest)

WithHeader adds the headers to the HTTP request.

func (ScriptsPainlessExecute) WithHuman ¶ 

func (f ScriptsPainlessExecute) WithHuman() func(*ScriptsPainlessExecuteRequest)

WithHuman makes statistical values human-readable.

func (ScriptsPainlessExecute) WithOpaqueID ¶ added in v6.8.5 

func (f ScriptsPainlessExecute) WithOpaqueID(s string) func(*ScriptsPainlessExecuteRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ScriptsPainlessExecute) WithPretty ¶ 

func (f ScriptsPainlessExecute) WithPretty() func(*ScriptsPainlessExecuteRequest)

WithPretty makes the response body pretty-printed.

type ScriptsPainlessExecuteRequest ¶ 

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 (ScriptsPainlessExecuteRequest) Do ¶ 

func (r ScriptsPainlessExecuteRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Scroll ¶ 

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-scroll.html.

func (Scroll) WithBody ¶ 

func (f Scroll) WithBody(v io.Reader) func(*ScrollRequest)

WithBody - The scroll ID if not passed by URL or query parameter..

func (Scroll) WithContext ¶ 

func (f Scroll) WithContext(v context.Context) func(*ScrollRequest)

WithContext sets the request context.

func (Scroll) WithErrorTrace ¶ 

func (f Scroll) WithErrorTrace() func(*ScrollRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Scroll) WithFilterPath ¶ 

func (f Scroll) WithFilterPath(v ...string) func(*ScrollRequest)

WithFilterPath filters the properties of the response body.

func (Scroll) WithHeader ¶ added in v6.8.2 

func (f Scroll) WithHeader(h map[string]string) func(*ScrollRequest)

WithHeader adds the headers to the HTTP request.

func (Scroll) WithHuman ¶ 

func (f Scroll) WithHuman() func(*ScrollRequest)

WithHuman makes statistical values human-readable.

func (Scroll) WithOpaqueID ¶ added in v6.8.5 

func (f Scroll) WithOpaqueID(s string) func(*ScrollRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Scroll) WithPretty ¶ 

func (f Scroll) WithPretty() func(*ScrollRequest)

WithPretty makes the response body pretty-printed.

func (Scroll) WithRestTotalHitsAsInt ¶ 

func (f Scroll) WithRestTotalHitsAsInt(v bool) func(*ScrollRequest)

WithRestTotalHitsAsInt - this parameter is ignored in this version. it is used in the next major version to control whether the rest response should render the total.hits as an object or a number.

func (Scroll) WithScroll ¶ 

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 (Scroll) WithScrollID ¶ 

func (f Scroll) WithScrollID(v string) func(*ScrollRequest)

WithScrollID - the scroll ID.

type ScrollRequest ¶ 

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.

func (ScrollRequest) Do ¶ 

func (r ScrollRequest) Do(ctx context.Context, transport Transport) (*Response, error)

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html.

func (Search) WithAllowNoIndices ¶ 

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 (Search) WithAllowPartialSearchResults ¶ 

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 (Search) WithAnalyzeWildcard ¶ 

func (f Search) WithAnalyzeWildcard(v bool) func(*SearchRequest)

WithAnalyzeWildcard - specify whether wildcard and prefix queries should be analyzed (default: false).

func (Search) WithAnalyzer ¶ 

func (f Search) WithAnalyzer(v string) func(*SearchRequest)

WithAnalyzer - the analyzer to use for the query string.

func (Search) WithBatchedReduceSize ¶ 

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 (Search) WithBody ¶ 

func (f Search) WithBody(v io.Reader) func(*SearchRequest)

WithBody - The search definition using the Query DSL.

func (Search) WithContext ¶ 

func (f Search) WithContext(v context.Context) func(*SearchRequest)

WithContext sets the request context.

func (Search) WithDefaultOperator ¶ 

func (f Search) WithDefaultOperator(v string) func(*SearchRequest)

WithDefaultOperator - the default operator for query string query (and or or).

func (Search) WithDf ¶ 

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 (Search) WithDocumentType ¶ 

func (f Search) WithDocumentType(v ...string) func(*SearchRequest)

WithDocumentType - a list of document types to search; leave empty to perform the operation on all types.

func (Search) WithDocvalueFields ¶ 

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 (Search) WithErrorTrace ¶ 

func (f Search) WithErrorTrace() func(*SearchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Search) WithExpandWildcards ¶ 

func (f Search) WithExpandWildcards(v string) func(*SearchRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (Search) WithExplain ¶ 

func (f Search) WithExplain(v bool) func(*SearchRequest)

WithExplain - specify whether to return detailed information about score computation as part of a hit.

func (Search) WithFilterPath ¶ 

func (f Search) WithFilterPath(v ...string) func(*SearchRequest)

WithFilterPath filters the properties of the response body.

func (Search) WithFrom ¶ 

func (f Search) WithFrom(v int) func(*SearchRequest)

WithFrom - starting offset (default: 0).

func (Search) WithHeader ¶ added in v6.8.2 

func (f Search) WithHeader(h map[string]string) func(*SearchRequest)

WithHeader adds the headers to the HTTP request.

func (Search) WithHuman ¶ 

func (f Search) WithHuman() func(*SearchRequest)

WithHuman makes statistical values human-readable.

func (Search) WithIgnoreThrottled ¶ 

func (f Search) WithIgnoreThrottled(v bool) func(*SearchRequest)

WithIgnoreThrottled - whether specified concrete, expanded or aliased indices should be ignored when throttled.

func (Search) WithIgnoreUnavailable ¶ 

func (f Search) WithIgnoreUnavailable(v bool) func(*SearchRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (Search) WithIndex ¶ 

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 (Search) WithLenient ¶ 

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 (Search) WithMaxConcurrentShardRequests ¶ 

func (f Search) WithMaxConcurrentShardRequests(v int) func(*SearchRequest)

WithMaxConcurrentShardRequests - the number of concurrent shard requests 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 (Search) WithOpaqueID ¶ added in v6.8.5 

func (f Search) WithOpaqueID(s string) func(*SearchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Search) WithPreFilterShardSize ¶ 

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 (Search) WithPreference ¶ 

func (f Search) WithPreference(v string) func(*SearchRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (Search) WithPretty ¶ 

func (f Search) WithPretty() func(*SearchRequest)

WithPretty makes the response body pretty-printed.

func (Search) WithQuery ¶ 

func (f Search) WithQuery(v string) func(*SearchRequest)

WithQuery - query in the lucene query string syntax.

func (Search) WithRequestCache ¶ 

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 (Search) WithRestTotalHitsAsInt ¶ 

func (f Search) WithRestTotalHitsAsInt(v bool) func(*SearchRequest)

WithRestTotalHitsAsInt - this parameter is ignored in this version. it is used in the next major version to control whether the rest response should render the total.hits as an object or a number.

func (Search) WithRouting ¶ 

func (f Search) WithRouting(v ...string) func(*SearchRequest)

WithRouting - a list of specific routing values.

func (Search) WithScroll ¶ 

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 (Search) WithSearchType ¶ 

func (f Search) WithSearchType(v string) func(*SearchRequest)

WithSearchType - search operation type.

func (Search) WithSeqNoPrimaryTerm ¶ 

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 (Search) WithSize ¶ 

func (f Search) WithSize(v int) func(*SearchRequest)

WithSize - number of hits to return (default: 10).

func (Search) WithSort ¶ 

func (f Search) WithSort(v ...string) func(*SearchRequest)

WithSort - a list of <field>:<direction> pairs.

func (Search) WithSource ¶ 

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 (Search) WithSourceExcludes ¶ 

func (f Search) WithSourceExcludes(v ...string) func(*SearchRequest)

WithSourceExcludes - a list of fields to exclude from the returned _source field.

func (Search) WithSourceIncludes ¶ 

func (f Search) WithSourceIncludes(v ...string) func(*SearchRequest)

WithSourceIncludes - a list of fields to extract and return from the _source field.

func (Search) WithStats ¶ 

func (f Search) WithStats(v ...string) func(*SearchRequest)

WithStats - specific 'tag' of the request for logging and statistical purposes.

func (Search) WithStoredFields ¶ 

func (f Search) WithStoredFields(v ...string) func(*SearchRequest)

WithStoredFields - a list of stored fields to return as part of a hit.

func (Search) WithSuggestField ¶ 

func (f Search) WithSuggestField(v string) func(*SearchRequest)

WithSuggestField - specify which field to use for suggestions.

func (Search) WithSuggestMode ¶ 

func (f Search) WithSuggestMode(v string) func(*SearchRequest)

WithSuggestMode - specify suggest mode.

func (Search) WithSuggestSize ¶ 

func (f Search) WithSuggestSize(v int) func(*SearchRequest)

WithSuggestSize - how many suggestions to return in response.

func (Search) WithSuggestText ¶ 

func (f Search) WithSuggestText(v string) func(*SearchRequest)

WithSuggestText - the source text for which the suggestions should be returned.

func (Search) WithTerminateAfter ¶ 

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 (Search) WithTimeout ¶ 

func (f Search) WithTimeout(v time.Duration) func(*SearchRequest)

WithTimeout - explicit operation timeout.

func (Search) WithTrackScores ¶ 

func (f Search) WithTrackScores(v bool) func(*SearchRequest)

WithTrackScores - whether to calculate and return scores even if they are not used for sorting.

func (Search) WithTrackTotalHits ¶ 

func (f Search) WithTrackTotalHits(v interface{}) func(*SearchRequest)

WithTrackTotalHits - indicate if the number of documents that match the query should be tracked.

func (Search) WithTypedKeys ¶ 

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 (Search) WithVersion ¶ 

func (f Search) WithVersion(v bool) func(*SearchRequest)

WithVersion - specify whether to return document version as part of a hit.

type SearchRequest ¶ 

type SearchRequest struct {
	Index        []string
	DocumentType []string

	Body io.Reader

	AllowNoIndices             *bool
	AllowPartialSearchResults  *bool
	Analyzer                   string
	AnalyzeWildcard            *bool
	BatchedReduceSize          *int
	DefaultOperator            string
	Df                         string
	DocvalueFields             []string
	ExpandWildcards            string
	Explain                    *bool
	From                       *int
	IgnoreThrottled            *bool
	IgnoreUnavailable          *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.

func (SearchRequest) Do ¶ 

func (r SearchRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchShards ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html.

func (SearchShards) WithAllowNoIndices ¶ 

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 (SearchShards) WithContext ¶ 

func (f SearchShards) WithContext(v context.Context) func(*SearchShardsRequest)

WithContext sets the request context.

func (SearchShards) WithErrorTrace ¶ 

func (f SearchShards) WithErrorTrace() func(*SearchShardsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchShards) WithExpandWildcards ¶ 

func (f SearchShards) WithExpandWildcards(v string) func(*SearchShardsRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (SearchShards) WithFilterPath ¶ 

func (f SearchShards) WithFilterPath(v ...string) func(*SearchShardsRequest)

WithFilterPath filters the properties of the response body.

func (SearchShards) WithHeader ¶ added in v6.8.2 

func (f SearchShards) WithHeader(h map[string]string) func(*SearchShardsRequest)

WithHeader adds the headers to the HTTP request.

func (SearchShards) WithHuman ¶ 

func (f SearchShards) WithHuman() func(*SearchShardsRequest)

WithHuman makes statistical values human-readable.

func (SearchShards) WithIgnoreUnavailable ¶ 

func (f SearchShards) WithIgnoreUnavailable(v bool) func(*SearchShardsRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (SearchShards) WithIndex ¶ 

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 (SearchShards) WithLocal ¶ 

func (f SearchShards) WithLocal(v bool) func(*SearchShardsRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (SearchShards) WithOpaqueID ¶ added in v6.8.5 

func (f SearchShards) WithOpaqueID(s string) func(*SearchShardsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchShards) WithPreference ¶ 

func (f SearchShards) WithPreference(v string) func(*SearchShardsRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (SearchShards) WithPretty ¶ 

func (f SearchShards) WithPretty() func(*SearchShardsRequest)

WithPretty makes the response body pretty-printed.

func (SearchShards) WithRouting ¶ 

func (f SearchShards) WithRouting(v string) func(*SearchShardsRequest)

WithRouting - specific routing value.

type SearchShardsRequest ¶ 

type SearchShardsRequest struct {
	Index []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *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.

func (SearchShardsRequest) Do ¶ 

func (r SearchShardsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchTemplate ¶ 

type SearchTemplate func(body io.Reader, o ...func(*SearchTemplateRequest)) (*Response, error)

SearchTemplate allows to use the Mustache language to pre-render a search definition.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html.

func (SearchTemplate) WithAllowNoIndices ¶ 

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 (SearchTemplate) WithContext ¶ 

func (f SearchTemplate) WithContext(v context.Context) func(*SearchTemplateRequest)

WithContext sets the request context.

func (SearchTemplate) WithDocumentType ¶ 

func (f SearchTemplate) WithDocumentType(v ...string) func(*SearchTemplateRequest)

WithDocumentType - a list of document types to search; leave empty to perform the operation on all types.

func (SearchTemplate) WithErrorTrace ¶ 

func (f SearchTemplate) WithErrorTrace() func(*SearchTemplateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchTemplate) WithExpandWildcards ¶ 

func (f SearchTemplate) WithExpandWildcards(v string) func(*SearchTemplateRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (SearchTemplate) WithExplain ¶ 

func (f SearchTemplate) WithExplain(v bool) func(*SearchTemplateRequest)

WithExplain - specify whether to return detailed information about score computation as part of a hit.

func (SearchTemplate) WithFilterPath ¶ 

func (f SearchTemplate) WithFilterPath(v ...string) func(*SearchTemplateRequest)

WithFilterPath filters the properties of the response body.

func (SearchTemplate) WithHeader ¶ added in v6.8.2 

func (f SearchTemplate) WithHeader(h map[string]string) func(*SearchTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (SearchTemplate) WithHuman ¶ 

func (f SearchTemplate) WithHuman() func(*SearchTemplateRequest)

WithHuman makes statistical values human-readable.

func (SearchTemplate) WithIgnoreThrottled ¶ 

func (f SearchTemplate) WithIgnoreThrottled(v bool) func(*SearchTemplateRequest)

WithIgnoreThrottled - whether specified concrete, expanded or aliased indices should be ignored when throttled.

func (SearchTemplate) WithIgnoreUnavailable ¶ 

func (f SearchTemplate) WithIgnoreUnavailable(v bool) func(*SearchTemplateRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (SearchTemplate) WithIndex ¶ 

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 (SearchTemplate) WithOpaqueID ¶ added in v6.8.5 

func (f SearchTemplate) WithOpaqueID(s string) func(*SearchTemplateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchTemplate) WithPreference ¶ 

func (f SearchTemplate) WithPreference(v string) func(*SearchTemplateRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (SearchTemplate) WithPretty ¶ 

func (f SearchTemplate) WithPretty() func(*SearchTemplateRequest)

WithPretty makes the response body pretty-printed.

func (SearchTemplate) WithProfile ¶ 

func (f SearchTemplate) WithProfile(v bool) func(*SearchTemplateRequest)

WithProfile - specify whether to profile the query execution.

func (SearchTemplate) WithRestTotalHitsAsInt ¶ 

func (f SearchTemplate) WithRestTotalHitsAsInt(v bool) func(*SearchTemplateRequest)

WithRestTotalHitsAsInt - this parameter is ignored in this version. it is used in the next major version to control whether the rest response should render the total.hits as an object or a number.

func (SearchTemplate) WithRouting ¶ 

func (f SearchTemplate) WithRouting(v ...string) func(*SearchTemplateRequest)

WithRouting - a list of specific routing values.

func (SearchTemplate) WithScroll ¶ 

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 (SearchTemplate) WithSearchType ¶ 

func (f SearchTemplate) WithSearchType(v string) func(*SearchTemplateRequest)

WithSearchType - search operation type.

func (SearchTemplate) WithTypedKeys ¶ 

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 ¶ 

type SearchTemplateRequest struct {
	Index        []string
	DocumentType []string

	Body io.Reader

	AllowNoIndices     *bool
	ExpandWildcards    string
	Explain            *bool
	IgnoreThrottled    *bool
	IgnoreUnavailable  *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.

func (SearchTemplateRequest) Do ¶ 

func (r SearchTemplateRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Security ¶ added in v6.8.2 

type Security struct {
	CreateAPIKey      SecurityCreateAPIKey
	GetAPIKey         SecurityGetAPIKey
	InvalidateAPIKey  SecurityInvalidateAPIKey
	Authenticate      XPackSecurityAuthenticate
	ChangePassword    XPackSecurityChangePassword
	ClearCachedRealms XPackSecurityClearCachedRealms
	ClearCachedRoles  XPackSecurityClearCachedRoles
	DeletePrivileges  XPackSecurityDeletePrivileges
	DeleteRoleMapping XPackSecurityDeleteRoleMapping
	DeleteRole        XPackSecurityDeleteRole
	DeleteUser        XPackSecurityDeleteUser
	DisableUser       XPackSecurityDisableUser
	EnableUser        XPackSecurityEnableUser
	GetPrivileges     XPackSecurityGetPrivileges
	GetRoleMapping    XPackSecurityGetRoleMapping
	GetRole           XPackSecurityGetRole
	GetToken          XPackSecurityGetToken
	GetUserPrivileges XPackSecurityGetUserPrivileges
	GetUser           XPackSecurityGetUser
	HasPrivileges     XPackSecurityHasPrivileges
	InvalidateToken   XPackSecurityInvalidateToken
	PutPrivileges     XPackSecurityPutPrivileges
	PutRoleMapping    XPackSecurityPutRoleMapping
	PutRole           XPackSecurityPutRole
	PutUser           XPackSecurityPutUser
}

Security contains the Security APIs

type SecurityCreateAPIKey ¶ added in v6.8.2 

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 (SecurityCreateAPIKey) WithContext ¶ added in v6.8.2 

func (f SecurityCreateAPIKey) WithContext(v context.Context) func(*SecurityCreateAPIKeyRequest)

WithContext sets the request context.

func (SecurityCreateAPIKey) WithErrorTrace ¶ added in v6.8.2 

func (f SecurityCreateAPIKey) WithErrorTrace() func(*SecurityCreateAPIKeyRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityCreateAPIKey) WithFilterPath ¶ added in v6.8.2 

func (f SecurityCreateAPIKey) WithFilterPath(v ...string) func(*SecurityCreateAPIKeyRequest)

WithFilterPath filters the properties of the response body.

func (SecurityCreateAPIKey) WithHeader ¶ added in v6.8.2 

func (f SecurityCreateAPIKey) WithHeader(h map[string]string) func(*SecurityCreateAPIKeyRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityCreateAPIKey) WithHuman ¶ added in v6.8.2 

func (f SecurityCreateAPIKey) WithHuman() func(*SecurityCreateAPIKeyRequest)

WithHuman makes statistical values human-readable.

func (SecurityCreateAPIKey) WithOpaqueID ¶ added in v6.8.5 

func (f SecurityCreateAPIKey) WithOpaqueID(s string) func(*SecurityCreateAPIKeyRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityCreateAPIKey) WithPretty ¶ added in v6.8.2 

func (f SecurityCreateAPIKey) WithPretty() func(*SecurityCreateAPIKeyRequest)

WithPretty makes the response body pretty-printed.

func (SecurityCreateAPIKey) WithRefresh ¶ added in v6.8.2 

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 ¶ added in v6.8.2 

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 (SecurityCreateAPIKeyRequest) Do ¶ added in v6.8.2 

func (r SecurityCreateAPIKeyRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityGetAPIKey ¶ added in v6.8.2 

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 (SecurityGetAPIKey) WithContext ¶ added in v6.8.2 

func (f SecurityGetAPIKey) WithContext(v context.Context) func(*SecurityGetAPIKeyRequest)

WithContext sets the request context.

func (SecurityGetAPIKey) WithErrorTrace ¶ added in v6.8.2 

func (f SecurityGetAPIKey) WithErrorTrace() func(*SecurityGetAPIKeyRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityGetAPIKey) WithFilterPath ¶ added in v6.8.2 

func (f SecurityGetAPIKey) WithFilterPath(v ...string) func(*SecurityGetAPIKeyRequest)

WithFilterPath filters the properties of the response body.

func (SecurityGetAPIKey) WithHeader ¶ added in v6.8.2 

func (f SecurityGetAPIKey) WithHeader(h map[string]string) func(*SecurityGetAPIKeyRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityGetAPIKey) WithHuman ¶ added in v6.8.2 

func (f SecurityGetAPIKey) WithHuman() func(*SecurityGetAPIKeyRequest)

WithHuman makes statistical values human-readable.

func (SecurityGetAPIKey) WithID ¶ added in v6.8.2 

func (f SecurityGetAPIKey) WithID(v string) func(*SecurityGetAPIKeyRequest)

WithID - api key ID of the api key to be retrieved.

func (SecurityGetAPIKey) WithName ¶ added in v6.8.2 

func (f SecurityGetAPIKey) WithName(v string) func(*SecurityGetAPIKeyRequest)

WithName - api key name of the api key to be retrieved.

func (SecurityGetAPIKey) WithOpaqueID ¶ added in v6.8.5 

func (f SecurityGetAPIKey) WithOpaqueID(s string) func(*SecurityGetAPIKeyRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityGetAPIKey) WithPretty ¶ added in v6.8.2 

func (f SecurityGetAPIKey) WithPretty() func(*SecurityGetAPIKeyRequest)

WithPretty makes the response body pretty-printed.

func (SecurityGetAPIKey) WithRealmName ¶ added in v6.8.2 

func (f SecurityGetAPIKey) WithRealmName(v string) func(*SecurityGetAPIKeyRequest)

WithRealmName - realm name of the user who created this api key to be retrieved.

func (SecurityGetAPIKey) WithUsername ¶ added in v6.8.2 

func (f SecurityGetAPIKey) WithUsername(v string) func(*SecurityGetAPIKeyRequest)

WithUsername - user name of the user who created this api key to be retrieved.

type SecurityGetAPIKeyRequest ¶ added in v6.8.2 

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.

func (SecurityGetAPIKeyRequest) Do ¶ added in v6.8.2 

func (r SecurityGetAPIKeyRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityInvalidateAPIKey ¶ added in v6.8.2 

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 (SecurityInvalidateAPIKey) WithContext ¶ added in v6.8.2 

func (f SecurityInvalidateAPIKey) WithContext(v context.Context) func(*SecurityInvalidateAPIKeyRequest)

WithContext sets the request context.

func (SecurityInvalidateAPIKey) WithErrorTrace ¶ added in v6.8.2 

func (f SecurityInvalidateAPIKey) WithErrorTrace() func(*SecurityInvalidateAPIKeyRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityInvalidateAPIKey) WithFilterPath ¶ added in v6.8.2 

func (f SecurityInvalidateAPIKey) WithFilterPath(v ...string) func(*SecurityInvalidateAPIKeyRequest)

WithFilterPath filters the properties of the response body.

func (SecurityInvalidateAPIKey) WithHeader ¶ added in v6.8.2 

func (f SecurityInvalidateAPIKey) WithHeader(h map[string]string) func(*SecurityInvalidateAPIKeyRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityInvalidateAPIKey) WithHuman ¶ added in v6.8.2 

func (f SecurityInvalidateAPIKey) WithHuman() func(*SecurityInvalidateAPIKeyRequest)

WithHuman makes statistical values human-readable.

func (SecurityInvalidateAPIKey) WithOpaqueID ¶ added in v6.8.5 

func (f SecurityInvalidateAPIKey) WithOpaqueID(s string) func(*SecurityInvalidateAPIKeyRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityInvalidateAPIKey) WithPretty ¶ added in v6.8.2 

func (f SecurityInvalidateAPIKey) WithPretty() func(*SecurityInvalidateAPIKeyRequest)

WithPretty makes the response body pretty-printed.

type SecurityInvalidateAPIKeyRequest ¶ added in v6.8.2 

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 (SecurityInvalidateAPIKeyRequest) Do ¶ added in v6.8.2 

func (r SecurityInvalidateAPIKeyRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Snapshot ¶ 

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 ¶ 

type SnapshotCreate func(repository string, snapshot string, o ...func(*SnapshotCreateRequest)) (*Response, error)

SnapshotCreate creates a snapshot in a repository.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotCreate) WithBody ¶ 

func (f SnapshotCreate) WithBody(v io.Reader) func(*SnapshotCreateRequest)

WithBody - The snapshot definition.

func (SnapshotCreate) WithContext ¶ 

func (f SnapshotCreate) WithContext(v context.Context) func(*SnapshotCreateRequest)

WithContext sets the request context.

func (SnapshotCreate) WithErrorTrace ¶ 

func (f SnapshotCreate) WithErrorTrace() func(*SnapshotCreateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotCreate) WithFilterPath ¶ 

func (f SnapshotCreate) WithFilterPath(v ...string) func(*SnapshotCreateRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotCreate) WithHeader ¶ added in v6.8.2 

func (f SnapshotCreate) WithHeader(h map[string]string) func(*SnapshotCreateRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotCreate) WithHuman ¶ 

func (f SnapshotCreate) WithHuman() func(*SnapshotCreateRequest)

WithHuman makes statistical values human-readable.

func (SnapshotCreate) WithMasterTimeout ¶ 

func (f SnapshotCreate) WithMasterTimeout(v time.Duration) func(*SnapshotCreateRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotCreate) WithOpaqueID ¶ added in v6.8.5 

func (f SnapshotCreate) WithOpaqueID(s string) func(*SnapshotCreateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotCreate) WithPretty ¶ 

func (f SnapshotCreate) WithPretty() func(*SnapshotCreateRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotCreate) WithWaitForCompletion ¶ 

func (f SnapshotCreate) WithWaitForCompletion(v bool) func(*SnapshotCreateRequest)

WithWaitForCompletion - should this request wait until the operation has completed before returning.

type SnapshotCreateRepository ¶ 

type SnapshotCreateRepository func(repository string, body io.Reader, o ...func(*SnapshotCreateRepositoryRequest)) (*Response, error)

SnapshotCreateRepository creates a repository.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotCreateRepository) WithContext ¶ 

func (f SnapshotCreateRepository) WithContext(v context.Context) func(*SnapshotCreateRepositoryRequest)

WithContext sets the request context.

func (SnapshotCreateRepository) WithErrorTrace ¶ 

func (f SnapshotCreateRepository) WithErrorTrace() func(*SnapshotCreateRepositoryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotCreateRepository) WithFilterPath ¶ 

func (f SnapshotCreateRepository) WithFilterPath(v ...string) func(*SnapshotCreateRepositoryRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotCreateRepository) WithHeader ¶ added in v6.8.2 

func (f SnapshotCreateRepository) WithHeader(h map[string]string) func(*SnapshotCreateRepositoryRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotCreateRepository) WithHuman ¶ 

func (f SnapshotCreateRepository) WithHuman() func(*SnapshotCreateRepositoryRequest)

WithHuman makes statistical values human-readable.

func (SnapshotCreateRepository) WithMasterTimeout ¶ 

func (f SnapshotCreateRepository) WithMasterTimeout(v time.Duration) func(*SnapshotCreateRepositoryRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotCreateRepository) WithOpaqueID ¶ added in v6.8.5 

func (f SnapshotCreateRepository) WithOpaqueID(s string) func(*SnapshotCreateRepositoryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotCreateRepository) WithPretty ¶ 

func (f SnapshotCreateRepository) WithPretty() func(*SnapshotCreateRepositoryRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotCreateRepository) WithTimeout ¶ 

func (f SnapshotCreateRepository) WithTimeout(v time.Duration) func(*SnapshotCreateRepositoryRequest)

WithTimeout - explicit operation timeout.

func (SnapshotCreateRepository) WithVerify ¶ 

func (f SnapshotCreateRepository) WithVerify(v bool) func(*SnapshotCreateRepositoryRequest)

WithVerify - whether to verify the repository after creation.

type SnapshotCreateRepositoryRequest ¶ 

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 (SnapshotCreateRepositoryRequest) Do ¶ 

func (r SnapshotCreateRepositoryRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotCreateRequest ¶ 

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.

func (SnapshotCreateRequest) Do ¶ 

func (r SnapshotCreateRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotDelete ¶ 

type SnapshotDelete func(repository string, snapshot string, o ...func(*SnapshotDeleteRequest)) (*Response, error)

SnapshotDelete deletes a snapshot.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotDelete) WithContext ¶ 

func (f SnapshotDelete) WithContext(v context.Context) func(*SnapshotDeleteRequest)

WithContext sets the request context.

func (SnapshotDelete) WithErrorTrace ¶ 

func (f SnapshotDelete) WithErrorTrace() func(*SnapshotDeleteRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotDelete) WithFilterPath ¶ 

func (f SnapshotDelete) WithFilterPath(v ...string) func(*SnapshotDeleteRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotDelete) WithHeader ¶ added in v6.8.2 

func (f SnapshotDelete) WithHeader(h map[string]string) func(*SnapshotDeleteRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotDelete) WithHuman ¶ 

func (f SnapshotDelete) WithHuman() func(*SnapshotDeleteRequest)

WithHuman makes statistical values human-readable.

func (SnapshotDelete) WithMasterTimeout ¶ 

func (f SnapshotDelete) WithMasterTimeout(v time.Duration) func(*SnapshotDeleteRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotDelete) WithOpaqueID ¶ added in v6.8.5 

func (f SnapshotDelete) WithOpaqueID(s string) func(*SnapshotDeleteRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotDelete) WithPretty ¶ 

func (f SnapshotDelete) WithPretty() func(*SnapshotDeleteRequest)

WithPretty makes the response body pretty-printed.

type SnapshotDeleteRepository ¶ 

type SnapshotDeleteRepository func(repository []string, o ...func(*SnapshotDeleteRepositoryRequest)) (*Response, error)

SnapshotDeleteRepository deletes a repository.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotDeleteRepository) WithContext ¶ 

func (f SnapshotDeleteRepository) WithContext(v context.Context) func(*SnapshotDeleteRepositoryRequest)

WithContext sets the request context.

func (SnapshotDeleteRepository) WithErrorTrace ¶ 

func (f SnapshotDeleteRepository) WithErrorTrace() func(*SnapshotDeleteRepositoryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotDeleteRepository) WithFilterPath ¶ 

func (f SnapshotDeleteRepository) WithFilterPath(v ...string) func(*SnapshotDeleteRepositoryRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotDeleteRepository) WithHeader ¶ added in v6.8.2 

func (f SnapshotDeleteRepository) WithHeader(h map[string]string) func(*SnapshotDeleteRepositoryRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotDeleteRepository) WithHuman ¶ 

func (f SnapshotDeleteRepository) WithHuman() func(*SnapshotDeleteRepositoryRequest)

WithHuman makes statistical values human-readable.

func (SnapshotDeleteRepository) WithMasterTimeout ¶ 

func (f SnapshotDeleteRepository) WithMasterTimeout(v time.Duration) func(*SnapshotDeleteRepositoryRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotDeleteRepository) WithOpaqueID ¶ added in v6.8.5 

func (f SnapshotDeleteRepository) WithOpaqueID(s string) func(*SnapshotDeleteRepositoryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotDeleteRepository) WithPretty ¶ 

func (f SnapshotDeleteRepository) WithPretty() func(*SnapshotDeleteRepositoryRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotDeleteRepository) WithTimeout ¶ 

func (f SnapshotDeleteRepository) WithTimeout(v time.Duration) func(*SnapshotDeleteRepositoryRequest)

WithTimeout - explicit operation timeout.

type SnapshotDeleteRepositoryRequest ¶ 

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 (SnapshotDeleteRepositoryRequest) Do ¶ 

func (r SnapshotDeleteRepositoryRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotDeleteRequest ¶ 

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.

func (SnapshotDeleteRequest) Do ¶ 

func (r SnapshotDeleteRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotGet ¶ 

type SnapshotGet func(repository string, snapshot []string, o ...func(*SnapshotGetRequest)) (*Response, error)

SnapshotGet returns information about a snapshot.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotGet) WithContext ¶ 

func (f SnapshotGet) WithContext(v context.Context) func(*SnapshotGetRequest)

WithContext sets the request context.

func (SnapshotGet) WithErrorTrace ¶ 

func (f SnapshotGet) WithErrorTrace() func(*SnapshotGetRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotGet) WithFilterPath ¶ 

func (f SnapshotGet) WithFilterPath(v ...string) func(*SnapshotGetRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotGet) WithHeader ¶ added in v6.8.2 

func (f SnapshotGet) WithHeader(h map[string]string) func(*SnapshotGetRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotGet) WithHuman ¶ 

func (f SnapshotGet) WithHuman() func(*SnapshotGetRequest)

WithHuman makes statistical values human-readable.

func (SnapshotGet) WithIgnoreUnavailable ¶ 

func (f SnapshotGet) WithIgnoreUnavailable(v bool) func(*SnapshotGetRequest)

WithIgnoreUnavailable - whether to ignore unavailable snapshots, defaults to false which means a snapshotmissingexception is thrown.

func (SnapshotGet) WithMasterTimeout ¶ 

func (f SnapshotGet) WithMasterTimeout(v time.Duration) func(*SnapshotGetRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotGet) WithOpaqueID ¶ added in v6.8.5 

func (f SnapshotGet) WithOpaqueID(s string) func(*SnapshotGetRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotGet) WithPretty ¶ 

func (f SnapshotGet) WithPretty() func(*SnapshotGetRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotGet) WithVerbose ¶ 

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 ¶ 

type SnapshotGetRepository func(o ...func(*SnapshotGetRepositoryRequest)) (*Response, error)

SnapshotGetRepository returns information about a repository.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotGetRepository) WithContext ¶ 

func (f SnapshotGetRepository) WithContext(v context.Context) func(*SnapshotGetRepositoryRequest)

WithContext sets the request context.

func (SnapshotGetRepository) WithErrorTrace ¶ 

func (f SnapshotGetRepository) WithErrorTrace() func(*SnapshotGetRepositoryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotGetRepository) WithFilterPath ¶ 

func (f SnapshotGetRepository) WithFilterPath(v ...string) func(*SnapshotGetRepositoryRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotGetRepository) WithHeader ¶ added in v6.8.2 

func (f SnapshotGetRepository) WithHeader(h map[string]string) func(*SnapshotGetRepositoryRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotGetRepository) WithHuman ¶ 

func (f SnapshotGetRepository) WithHuman() func(*SnapshotGetRepositoryRequest)

WithHuman makes statistical values human-readable.

func (SnapshotGetRepository) WithLocal ¶ 

func (f SnapshotGetRepository) WithLocal(v bool) func(*SnapshotGetRepositoryRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (SnapshotGetRepository) WithMasterTimeout ¶ 

func (f SnapshotGetRepository) WithMasterTimeout(v time.Duration) func(*SnapshotGetRepositoryRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotGetRepository) WithOpaqueID ¶ added in v6.8.5 

func (f SnapshotGetRepository) WithOpaqueID(s string) func(*SnapshotGetRepositoryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotGetRepository) WithPretty ¶ 

func (f SnapshotGetRepository) WithPretty() func(*SnapshotGetRepositoryRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotGetRepository) WithRepository ¶ 

func (f SnapshotGetRepository) WithRepository(v ...string) func(*SnapshotGetRepositoryRequest)

WithRepository - a list of repository names.

type SnapshotGetRepositoryRequest ¶ 

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 (SnapshotGetRepositoryRequest) Do ¶ 

func (r SnapshotGetRepositoryRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotGetRequest ¶ 

type SnapshotGetRequest struct {
	Repository string
	Snapshot   []string

	IgnoreUnavailable *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.

func (SnapshotGetRequest) Do ¶ 

func (r SnapshotGetRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotRestore ¶ 

type SnapshotRestore func(repository string, snapshot string, o ...func(*SnapshotRestoreRequest)) (*Response, error)

SnapshotRestore restores a snapshot.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotRestore) WithBody ¶ 

func (f SnapshotRestore) WithBody(v io.Reader) func(*SnapshotRestoreRequest)

WithBody - Details of what to restore.

func (SnapshotRestore) WithContext ¶ 

func (f SnapshotRestore) WithContext(v context.Context) func(*SnapshotRestoreRequest)

WithContext sets the request context.

func (SnapshotRestore) WithErrorTrace ¶ 

func (f SnapshotRestore) WithErrorTrace() func(*SnapshotRestoreRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotRestore) WithFilterPath ¶ 

func (f SnapshotRestore) WithFilterPath(v ...string) func(*SnapshotRestoreRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotRestore) WithHeader ¶ added in v6.8.2 

func (f SnapshotRestore) WithHeader(h map[string]string) func(*SnapshotRestoreRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotRestore) WithHuman ¶ 

func (f SnapshotRestore) WithHuman() func(*SnapshotRestoreRequest)

WithHuman makes statistical values human-readable.

func (SnapshotRestore) WithMasterTimeout ¶ 

func (f SnapshotRestore) WithMasterTimeout(v time.Duration) func(*SnapshotRestoreRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotRestore) WithOpaqueID ¶ added in v6.8.5 

func (f SnapshotRestore) WithOpaqueID(s string) func(*SnapshotRestoreRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotRestore) WithPretty ¶ 

func (f SnapshotRestore) WithPretty() func(*SnapshotRestoreRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotRestore) WithWaitForCompletion ¶ 

func (f SnapshotRestore) WithWaitForCompletion(v bool) func(*SnapshotRestoreRequest)

WithWaitForCompletion - should this request wait until the operation has completed before returning.

type SnapshotRestoreRequest ¶ 

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.

func (SnapshotRestoreRequest) Do ¶ 

func (r SnapshotRestoreRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotStatus ¶ 

type SnapshotStatus func(o ...func(*SnapshotStatusRequest)) (*Response, error)

SnapshotStatus returns information about the status of a snapshot.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotStatus) WithContext ¶ 

func (f SnapshotStatus) WithContext(v context.Context) func(*SnapshotStatusRequest)

WithContext sets the request context.

func (SnapshotStatus) WithErrorTrace ¶ 

func (f SnapshotStatus) WithErrorTrace() func(*SnapshotStatusRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotStatus) WithFilterPath ¶ 

func (f SnapshotStatus) WithFilterPath(v ...string) func(*SnapshotStatusRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotStatus) WithHeader ¶ added in v6.8.2 

func (f SnapshotStatus) WithHeader(h map[string]string) func(*SnapshotStatusRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotStatus) WithHuman ¶ 

func (f SnapshotStatus) WithHuman() func(*SnapshotStatusRequest)

WithHuman makes statistical values human-readable.

func (SnapshotStatus) WithIgnoreUnavailable ¶ 

func (f SnapshotStatus) WithIgnoreUnavailable(v bool) func(*SnapshotStatusRequest)

WithIgnoreUnavailable - whether to ignore unavailable snapshots, defaults to false which means a snapshotmissingexception is thrown.

func (SnapshotStatus) WithMasterTimeout ¶ 

func (f SnapshotStatus) WithMasterTimeout(v time.Duration) func(*SnapshotStatusRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotStatus) WithOpaqueID ¶ added in v6.8.5 

func (f SnapshotStatus) WithOpaqueID(s string) func(*SnapshotStatusRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotStatus) WithPretty ¶ 

func (f SnapshotStatus) WithPretty() func(*SnapshotStatusRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotStatus) WithRepository ¶ 

func (f SnapshotStatus) WithRepository(v string) func(*SnapshotStatusRequest)

WithRepository - a repository name.

func (SnapshotStatus) WithSnapshot ¶ 

func (f SnapshotStatus) WithSnapshot(v ...string) func(*SnapshotStatusRequest)

WithSnapshot - a list of snapshot names.

type SnapshotStatusRequest ¶ 

type SnapshotStatusRequest struct {
	Repository string
	Snapshot   []string

	IgnoreUnavailable *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.

func (SnapshotStatusRequest) Do ¶ 

func (r SnapshotStatusRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotVerifyRepository ¶ 

type SnapshotVerifyRepository func(repository string, o ...func(*SnapshotVerifyRepositoryRequest)) (*Response, error)

SnapshotVerifyRepository verifies a repository.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotVerifyRepository) WithContext ¶ 

func (f SnapshotVerifyRepository) WithContext(v context.Context) func(*SnapshotVerifyRepositoryRequest)

WithContext sets the request context.

func (SnapshotVerifyRepository) WithErrorTrace ¶ 

func (f SnapshotVerifyRepository) WithErrorTrace() func(*SnapshotVerifyRepositoryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotVerifyRepository) WithFilterPath ¶ 

func (f SnapshotVerifyRepository) WithFilterPath(v ...string) func(*SnapshotVerifyRepositoryRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotVerifyRepository) WithHeader ¶ added in v6.8.2 

func (f SnapshotVerifyRepository) WithHeader(h map[string]string) func(*SnapshotVerifyRepositoryRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotVerifyRepository) WithHuman ¶ 

func (f SnapshotVerifyRepository) WithHuman() func(*SnapshotVerifyRepositoryRequest)

WithHuman makes statistical values human-readable.

func (SnapshotVerifyRepository) WithMasterTimeout ¶ 

func (f SnapshotVerifyRepository) WithMasterTimeout(v time.Duration) func(*SnapshotVerifyRepositoryRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotVerifyRepository) WithOpaqueID ¶ added in v6.8.5 

func (f SnapshotVerifyRepository) WithOpaqueID(s string) func(*SnapshotVerifyRepositoryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotVerifyRepository) WithPretty ¶ 

func (f SnapshotVerifyRepository) WithPretty() func(*SnapshotVerifyRepositoryRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotVerifyRepository) WithTimeout ¶ 

func (f SnapshotVerifyRepository) WithTimeout(v time.Duration) func(*SnapshotVerifyRepositoryRequest)

WithTimeout - explicit operation timeout.

type SnapshotVerifyRepositoryRequest ¶ 

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 (SnapshotVerifyRepositoryRequest) Do ¶ 

func (r SnapshotVerifyRepositoryRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Tasks ¶ 

type Tasks struct {
	Cancel TasksCancel
	Get    TasksGet
	List   TasksList
}

Tasks contains the Tasks APIs

type TasksCancel ¶ 

type TasksCancel func(o ...func(*TasksCancelRequest)) (*Response, error)

TasksCancel cancels a task, if it can be cancelled through an API.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html.

func (TasksCancel) WithActions ¶ 

func (f TasksCancel) WithActions(v ...string) func(*TasksCancelRequest)

WithActions - a list of actions that should be cancelled. leave empty to cancel all..

func (TasksCancel) WithContext ¶ 

func (f TasksCancel) WithContext(v context.Context) func(*TasksCancelRequest)

WithContext sets the request context.

func (TasksCancel) WithErrorTrace ¶ 

func (f TasksCancel) WithErrorTrace() func(*TasksCancelRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TasksCancel) WithFilterPath ¶ 

func (f TasksCancel) WithFilterPath(v ...string) func(*TasksCancelRequest)

WithFilterPath filters the properties of the response body.

func (TasksCancel) WithHeader ¶ added in v6.8.2 

func (f TasksCancel) WithHeader(h map[string]string) func(*TasksCancelRequest)

WithHeader adds the headers to the HTTP request.

func (TasksCancel) WithHuman ¶ 

func (f TasksCancel) WithHuman() func(*TasksCancelRequest)

WithHuman makes statistical values human-readable.

func (TasksCancel) WithNodes ¶ 

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 (TasksCancel) WithOpaqueID ¶ added in v6.8.5 

func (f TasksCancel) WithOpaqueID(s string) func(*TasksCancelRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TasksCancel) WithParentTaskID ¶ 

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 (TasksCancel) WithPretty ¶ 

func (f TasksCancel) WithPretty() func(*TasksCancelRequest)

WithPretty makes the response body pretty-printed.

func (TasksCancel) WithTaskID ¶ 

func (f TasksCancel) WithTaskID(v string) func(*TasksCancelRequest)

WithTaskID - cancel the task with specified task ID (node_id:task_number).

type TasksCancelRequest ¶ 

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.

func (TasksCancelRequest) Do ¶ 

func (r TasksCancelRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TasksGet ¶ 

type TasksGet func(task_id string, o ...func(*TasksGetRequest)) (*Response, error)

TasksGet returns information about a task.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html.

func (TasksGet) WithContext ¶ 

func (f TasksGet) WithContext(v context.Context) func(*TasksGetRequest)

WithContext sets the request context.

func (TasksGet) WithErrorTrace ¶ 

func (f TasksGet) WithErrorTrace() func(*TasksGetRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TasksGet) WithFilterPath ¶ 

func (f TasksGet) WithFilterPath(v ...string) func(*TasksGetRequest)

WithFilterPath filters the properties of the response body.

func (TasksGet) WithHeader ¶ added in v6.8.2 

func (f TasksGet) WithHeader(h map[string]string) func(*TasksGetRequest)

WithHeader adds the headers to the HTTP request.

func (TasksGet) WithHuman ¶ 

func (f TasksGet) WithHuman() func(*TasksGetRequest)

WithHuman makes statistical values human-readable.

func (TasksGet) WithOpaqueID ¶ added in v6.8.5 

func (f TasksGet) WithOpaqueID(s string) func(*TasksGetRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TasksGet) WithPretty ¶ 

func (f TasksGet) WithPretty() func(*TasksGetRequest)

WithPretty makes the response body pretty-printed.

func (TasksGet) WithTimeout ¶ 

func (f TasksGet) WithTimeout(v time.Duration) func(*TasksGetRequest)

WithTimeout - explicit operation timeout.

func (TasksGet) WithWaitForCompletion ¶ 

func (f TasksGet) WithWaitForCompletion(v bool) func(*TasksGetRequest)

WithWaitForCompletion - wait for the matching tasks to complete (default: false).

type TasksGetRequest ¶ 

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.

func (TasksGetRequest) Do ¶ 

func (r TasksGetRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TasksList ¶ 

type TasksList func(o ...func(*TasksListRequest)) (*Response, error)

TasksList returns a list of tasks.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html.

func (TasksList) WithActions ¶ 

func (f TasksList) WithActions(v ...string) func(*TasksListRequest)

WithActions - a list of actions that should be returned. leave empty to return all..

func (TasksList) WithContext ¶ 

func (f TasksList) WithContext(v context.Context) func(*TasksListRequest)

WithContext sets the request context.

func (TasksList) WithDetailed ¶ 

func (f TasksList) WithDetailed(v bool) func(*TasksListRequest)

WithDetailed - return detailed task information (default: false).

func (TasksList) WithErrorTrace ¶ 

func (f TasksList) WithErrorTrace() func(*TasksListRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TasksList) WithFilterPath ¶ 

func (f TasksList) WithFilterPath(v ...string) func(*TasksListRequest)

WithFilterPath filters the properties of the response body.

func (TasksList) WithGroupBy ¶ 

func (f TasksList) WithGroupBy(v string) func(*TasksListRequest)

WithGroupBy - group tasks by nodes or parent/child relationships.

func (TasksList) WithHeader ¶ added in v6.8.2 

func (f TasksList) WithHeader(h map[string]string) func(*TasksListRequest)

WithHeader adds the headers to the HTTP request.

func (TasksList) WithHuman ¶ 

func (f TasksList) WithHuman() func(*TasksListRequest)

WithHuman makes statistical values human-readable.

func (TasksList) WithNodes ¶ 

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 (TasksList) WithOpaqueID ¶ added in v6.8.5 

func (f TasksList) WithOpaqueID(s string) func(*TasksListRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TasksList) WithParentTaskID ¶ 

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 (TasksList) WithPretty ¶ 

func (f TasksList) WithPretty() func(*TasksListRequest)

WithPretty makes the response body pretty-printed.

func (TasksList) WithTimeout ¶ 

func (f TasksList) WithTimeout(v time.Duration) func(*TasksListRequest)

WithTimeout - explicit operation timeout.

func (TasksList) WithWaitForCompletion ¶ 

func (f TasksList) WithWaitForCompletion(v bool) func(*TasksListRequest)

WithWaitForCompletion - wait for the matching tasks to complete (default: false).

type TasksListRequest ¶ 

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.

func (TasksListRequest) Do ¶ 

func (r TasksListRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Termvectors ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html.

func (Termvectors) WithBody ¶ 

func (f Termvectors) WithBody(v io.Reader) func(*TermvectorsRequest)

WithBody - Define parameters and or supply a document to get termvectors for. See documentation..

func (Termvectors) WithContext ¶ 

func (f Termvectors) WithContext(v context.Context) func(*TermvectorsRequest)

WithContext sets the request context.

func (Termvectors) WithDocumentID ¶ 

func (f Termvectors) WithDocumentID(v string) func(*TermvectorsRequest)

WithDocumentID - the ID of the document, when not specified a doc param should be supplied..

func (Termvectors) WithDocumentType ¶ 

func (f Termvectors) WithDocumentType(v string) func(*TermvectorsRequest)

WithDocumentType - the type of the document..

func (Termvectors) WithErrorTrace ¶ 

func (f Termvectors) WithErrorTrace() func(*TermvectorsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Termvectors) WithFieldStatistics ¶ 

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 (Termvectors) WithFields ¶ 

func (f Termvectors) WithFields(v ...string) func(*TermvectorsRequest)

WithFields - a list of fields to return..

func (Termvectors) WithFilterPath ¶ 

func (f Termvectors) WithFilterPath(v ...string) func(*TermvectorsRequest)

WithFilterPath filters the properties of the response body.

func (Termvectors) WithHeader ¶ added in v6.8.2 

func (f Termvectors) WithHeader(h map[string]string) func(*TermvectorsRequest)

WithHeader adds the headers to the HTTP request.

func (Termvectors) WithHuman ¶ 

func (f Termvectors) WithHuman() func(*TermvectorsRequest)

WithHuman makes statistical values human-readable.

func (Termvectors) WithOffsets ¶ 

func (f Termvectors) WithOffsets(v bool) func(*TermvectorsRequest)

WithOffsets - specifies if term offsets should be returned..

func (Termvectors) WithOpaqueID ¶ added in v6.8.5 

func (f Termvectors) WithOpaqueID(s string) func(*TermvectorsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Termvectors) WithParent ¶ 

func (f Termvectors) WithParent(v string) func(*TermvectorsRequest)

WithParent - parent ID of documents..

func (Termvectors) WithPayloads ¶ 

func (f Termvectors) WithPayloads(v bool) func(*TermvectorsRequest)

WithPayloads - specifies if term payloads should be returned..

func (Termvectors) WithPositions ¶ 

func (f Termvectors) WithPositions(v bool) func(*TermvectorsRequest)

WithPositions - specifies if term positions should be returned..

func (Termvectors) WithPreference ¶ 

func (f Termvectors) WithPreference(v string) func(*TermvectorsRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random)..

func (Termvectors) WithPretty ¶ 

func (f Termvectors) WithPretty() func(*TermvectorsRequest)

WithPretty makes the response body pretty-printed.

func (Termvectors) WithRealtime ¶ 

func (f Termvectors) WithRealtime(v bool) func(*TermvectorsRequest)

WithRealtime - specifies if request is real-time as opposed to near-real-time (default: true)..

func (Termvectors) WithRouting ¶ 

func (f Termvectors) WithRouting(v string) func(*TermvectorsRequest)

WithRouting - specific routing value..

func (Termvectors) WithTermStatistics ¶ 

func (f Termvectors) WithTermStatistics(v bool) func(*TermvectorsRequest)

WithTermStatistics - specifies if total term frequency and document frequency should be returned..

func (Termvectors) WithVersion ¶ 

func (f Termvectors) WithVersion(v int) func(*TermvectorsRequest)

WithVersion - explicit version number for concurrency control.

func (Termvectors) WithVersionType ¶ 

func (f Termvectors) WithVersionType(v string) func(*TermvectorsRequest)

WithVersionType - specific version type.

type TermvectorsRequest ¶ 

type TermvectorsRequest struct {
	Index        string
	DocumentType string
	DocumentID   string

	Body io.Reader

	Fields          []string
	FieldStatistics *bool
	Offsets         *bool
	Parent          string
	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.

func (TermvectorsRequest) Do ¶ 

func (r TermvectorsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Transport ¶ 

type Transport interface {
	Perform(*http.Request) (*http.Response, error)
}

Transport defines the interface for an API client.

type Update ¶ 

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 http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html.

func (Update) WithContext ¶ 

func (f Update) WithContext(v context.Context) func(*UpdateRequest)

WithContext sets the request context.

func (Update) WithDocumentType ¶ 

func (f Update) WithDocumentType(v string) func(*UpdateRequest)

WithDocumentType - the type of the document.

func (Update) WithErrorTrace ¶ 

func (f Update) WithErrorTrace() func(*UpdateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Update) WithFields ¶ 

func (f Update) WithFields(v ...string) func(*UpdateRequest)

WithFields - a list of fields to return in the response.

func (Update) WithFilterPath ¶ 

func (f Update) WithFilterPath(v ...string) func(*UpdateRequest)

WithFilterPath filters the properties of the response body.

func (Update) WithHeader ¶ added in v6.8.2 

func (f Update) WithHeader(h map[string]string) func(*UpdateRequest)

WithHeader adds the headers to the HTTP request.

func (Update) WithHuman ¶ 

func (f Update) WithHuman() func(*UpdateRequest)

WithHuman makes statistical values human-readable.

func (Update) WithIfPrimaryTerm ¶ 

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 (Update) WithIfSeqNo ¶ 

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 (Update) WithLang ¶ 

func (f Update) WithLang(v string) func(*UpdateRequest)

WithLang - the script language (default: painless).

func (Update) WithOpaqueID ¶ added in v6.8.5 

func (f Update) WithOpaqueID(s string) func(*UpdateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Update) WithParent ¶ 

func (f Update) WithParent(v string) func(*UpdateRequest)

WithParent - ID of the parent document. is is only used for routing and when for the upsert request.

func (Update) WithPretty ¶ 

func (f Update) WithPretty() func(*UpdateRequest)

WithPretty makes the response body pretty-printed.

func (Update) WithRefresh ¶ 

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 (Update) WithRetryOnConflict ¶ 

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 (Update) WithRouting ¶ 

func (f Update) WithRouting(v string) func(*UpdateRequest)

WithRouting - specific routing value.

func (Update) WithSource ¶ 

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 (Update) WithSourceExcludes ¶ 

func (f Update) WithSourceExcludes(v ...string) func(*UpdateRequest)

WithSourceExcludes - a list of fields to exclude from the returned _source field.

func (Update) WithSourceIncludes ¶ 

func (f Update) WithSourceIncludes(v ...string) func(*UpdateRequest)

WithSourceIncludes - a list of fields to extract and return from the _source field.

func (Update) WithTimeout ¶ 

func (f Update) WithTimeout(v time.Duration) func(*UpdateRequest)

WithTimeout - explicit operation timeout.

func (Update) WithVersion ¶ 

func (f Update) WithVersion(v int) func(*UpdateRequest)

WithVersion - explicit version number for concurrency control.

func (Update) WithVersionType ¶ 

func (f Update) WithVersionType(v string) func(*UpdateRequest)

WithVersionType - specific version type.

func (Update) WithWaitForActiveShards ¶ 

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 ¶ 

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 (UpdateByQuery) WithAllowNoIndices ¶ 

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 (UpdateByQuery) WithAnalyzeWildcard ¶ 

func (f UpdateByQuery) WithAnalyzeWildcard(v bool) func(*UpdateByQueryRequest)

WithAnalyzeWildcard - specify whether wildcard and prefix queries should be analyzed (default: false).

func (UpdateByQuery) WithAnalyzer ¶ 

func (f UpdateByQuery) WithAnalyzer(v string) func(*UpdateByQueryRequest)

WithAnalyzer - the analyzer to use for the query string.

func (UpdateByQuery) WithBody ¶ 

func (f UpdateByQuery) WithBody(v io.Reader) func(*UpdateByQueryRequest)

WithBody - The search definition using the Query DSL.

func (UpdateByQuery) WithConflicts ¶ 

func (f UpdateByQuery) WithConflicts(v string) func(*UpdateByQueryRequest)

WithConflicts - what to do when the update by query hits version conflicts?.

func (UpdateByQuery) WithContext ¶ 

func (f UpdateByQuery) WithContext(v context.Context) func(*UpdateByQueryRequest)

WithContext sets the request context.

func (UpdateByQuery) WithDefaultOperator ¶ 

func (f UpdateByQuery) WithDefaultOperator(v string) func(*UpdateByQueryRequest)

WithDefaultOperator - the default operator for query string query (and or or).

func (UpdateByQuery) WithDf ¶ 

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 (UpdateByQuery) WithDocumentType ¶ 

func (f UpdateByQuery) WithDocumentType(v ...string) func(*UpdateByQueryRequest)

WithDocumentType - a list of document types to search; leave empty to perform the operation on all types.

func (UpdateByQuery) WithErrorTrace ¶ 

func (f UpdateByQuery) WithErrorTrace() func(*UpdateByQueryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (UpdateByQuery) WithExpandWildcards ¶ 

func (f UpdateByQuery) WithExpandWildcards(v string) func(*UpdateByQueryRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (UpdateByQuery) WithFilterPath ¶ 

func (f UpdateByQuery) WithFilterPath(v ...string) func(*UpdateByQueryRequest)

WithFilterPath filters the properties of the response body.

func (UpdateByQuery) WithFrom ¶ 

func (f UpdateByQuery) WithFrom(v int) func(*UpdateByQueryRequest)

WithFrom - starting offset (default: 0).

func (UpdateByQuery) WithHeader ¶ added in v6.8.2 

func (f UpdateByQuery) WithHeader(h map[string]string) func(*UpdateByQueryRequest)

WithHeader adds the headers to the HTTP request.

func (UpdateByQuery) WithHuman ¶ 

func (f UpdateByQuery) WithHuman() func(*UpdateByQueryRequest)

WithHuman makes statistical values human-readable.

func (UpdateByQuery) WithIgnoreUnavailable ¶ 

func (f UpdateByQuery) WithIgnoreUnavailable(v bool) func(*UpdateByQueryRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (UpdateByQuery) WithLenient ¶ 

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 (UpdateByQuery) WithOpaqueID ¶ added in v6.8.5 

func (f UpdateByQuery) WithOpaqueID(s string) func(*UpdateByQueryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (UpdateByQuery) WithPipeline ¶ 

func (f UpdateByQuery) WithPipeline(v string) func(*UpdateByQueryRequest)

WithPipeline - ingest pipeline to set on index requests made by this action. (default: none).

func (UpdateByQuery) WithPreference ¶ 

func (f UpdateByQuery) WithPreference(v string) func(*UpdateByQueryRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (UpdateByQuery) WithPretty ¶ 

func (f UpdateByQuery) WithPretty() func(*UpdateByQueryRequest)

WithPretty makes the response body pretty-printed.

func (UpdateByQuery) WithQuery ¶ 

func (f UpdateByQuery) WithQuery(v string) func(*UpdateByQueryRequest)

WithQuery - query in the lucene query string syntax.

func (UpdateByQuery) WithRefresh ¶ 

func (f UpdateByQuery) WithRefresh(v bool) func(*UpdateByQueryRequest)

WithRefresh - should the effected indexes be refreshed?.

func (UpdateByQuery) WithRequestCache ¶ 

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 (UpdateByQuery) WithRequestsPerSecond ¶ 

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 (UpdateByQuery) WithRouting ¶ 

func (f UpdateByQuery) WithRouting(v ...string) func(*UpdateByQueryRequest)

WithRouting - a list of specific routing values.

func (UpdateByQuery) WithScroll ¶ 

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 (UpdateByQuery) WithScrollSize ¶ 

func (f UpdateByQuery) WithScrollSize(v int) func(*UpdateByQueryRequest)

WithScrollSize - size on the scroll request powering the update by query.

func (UpdateByQuery) WithSearchTimeout ¶ 

func (f UpdateByQuery) WithSearchTimeout(v time.Duration) func(*UpdateByQueryRequest)

WithSearchTimeout - explicit timeout for each search request. defaults to no timeout..

func (UpdateByQuery) WithSearchType ¶ 

func (f UpdateByQuery) WithSearchType(v string) func(*UpdateByQueryRequest)

WithSearchType - search operation type.

func (UpdateByQuery) WithSize ¶ 

func (f UpdateByQuery) WithSize(v int) func(*UpdateByQueryRequest)

WithSize - number of hits to return (default: 10).

func (UpdateByQuery) WithSlices ¶ 

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 (UpdateByQuery) WithSort ¶ 

func (f UpdateByQuery) WithSort(v ...string) func(*UpdateByQueryRequest)

WithSort - a list of <field>:<direction> pairs.

func (UpdateByQuery) WithSource ¶ 

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 (UpdateByQuery) WithSourceExcludes ¶ 

func (f UpdateByQuery) WithSourceExcludes(v ...string) func(*UpdateByQueryRequest)

WithSourceExcludes - a list of fields to exclude from the returned _source field.

func (UpdateByQuery) WithSourceIncludes ¶ 

func (f UpdateByQuery) WithSourceIncludes(v ...string) func(*UpdateByQueryRequest)

WithSourceIncludes - a list of fields to extract and return from the _source field.

func (UpdateByQuery) WithStats ¶ 

func (f UpdateByQuery) WithStats(v ...string) func(*UpdateByQueryRequest)

WithStats - specific 'tag' of the request for logging and statistical purposes.

func (UpdateByQuery) WithTerminateAfter ¶ 

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 (UpdateByQuery) WithTimeout ¶ 

func (f UpdateByQuery) WithTimeout(v time.Duration) func(*UpdateByQueryRequest)

WithTimeout - time each individual bulk request should wait for shards that are unavailable..

func (UpdateByQuery) WithVersion ¶ 

func (f UpdateByQuery) WithVersion(v bool) func(*UpdateByQueryRequest)

WithVersion - specify whether to return document version as part of a hit.

func (UpdateByQuery) WithVersionType ¶ 

func (f UpdateByQuery) WithVersionType(v bool) func(*UpdateByQueryRequest)

WithVersionType - should the document increment the version number (internal) on hit or not (reindex).

func (UpdateByQuery) WithWaitForActiveShards ¶ 

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 (UpdateByQuery) WithWaitForCompletion ¶ 

func (f UpdateByQuery) WithWaitForCompletion(v bool) func(*UpdateByQueryRequest)

WithWaitForCompletion - should the request should block until the update by query operation is complete..

type UpdateByQueryRequest ¶ 

type UpdateByQueryRequest struct {
	Index        []string
	DocumentType []string

	Body io.Reader

	AllowNoIndices      *bool
	Analyzer            string
	AnalyzeWildcard     *bool
	Conflicts           string
	DefaultOperator     string
	Df                  string
	ExpandWildcards     string
	From                *int
	IgnoreUnavailable   *bool
	Lenient             *bool
	Pipeline            string
	Preference          string
	Query               string
	Refresh             *bool
	RequestCache        *bool
	RequestsPerSecond   *int
	Routing             []string
	Scroll              time.Duration
	ScrollSize          *int
	SearchTimeout       time.Duration
	SearchType          string
	Size                *int
	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.

func (UpdateByQueryRequest) Do ¶ 

func (r UpdateByQueryRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type UpdateByQueryRethrottle ¶ 

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 (UpdateByQueryRethrottle) WithContext ¶ 

func (f UpdateByQueryRethrottle) WithContext(v context.Context) func(*UpdateByQueryRethrottleRequest)

WithContext sets the request context.

func (UpdateByQueryRethrottle) WithErrorTrace ¶ 

func (f UpdateByQueryRethrottle) WithErrorTrace() func(*UpdateByQueryRethrottleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (UpdateByQueryRethrottle) WithFilterPath ¶ 

func (f UpdateByQueryRethrottle) WithFilterPath(v ...string) func(*UpdateByQueryRethrottleRequest)

WithFilterPath filters the properties of the response body.

func (UpdateByQueryRethrottle) WithHeader ¶ added in v6.8.2 

func (f UpdateByQueryRethrottle) WithHeader(h map[string]string) func(*UpdateByQueryRethrottleRequest)

WithHeader adds the headers to the HTTP request.

func (UpdateByQueryRethrottle) WithHuman ¶ 

func (f UpdateByQueryRethrottle) WithHuman() func(*UpdateByQueryRethrottleRequest)

WithHuman makes statistical values human-readable.

func (UpdateByQueryRethrottle) WithOpaqueID ¶ added in v6.8.5 

func (f UpdateByQueryRethrottle) WithOpaqueID(s string) func(*UpdateByQueryRethrottleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (UpdateByQueryRethrottle) WithPretty ¶ 

func (f UpdateByQueryRethrottle) WithPretty() func(*UpdateByQueryRethrottleRequest)

WithPretty makes the response body pretty-printed.

func (UpdateByQueryRethrottle) WithRequestsPerSecond ¶ 

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 ¶ 

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 (UpdateByQueryRethrottleRequest) Do ¶ 

func (r UpdateByQueryRethrottleRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type UpdateRequest ¶ 

type UpdateRequest struct {
	Index        string
	DocumentType string
	DocumentID   string

	Body io.Reader

	Fields              []string
	IfPrimaryTerm       *int
	IfSeqNo             *int
	Lang                string
	Parent              string
	Refresh             string
	RetryOnConflict     *int
	Routing             string
	Source              []string
	SourceExcludes      []string
	SourceIncludes      []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
}

UpdateRequest configures the Update API request.

func (UpdateRequest) Do ¶ 

func (r UpdateRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Watcher ¶ added in v6.8.2 

type Watcher struct {
	AckWatch        XPackWatcherAckWatch
	ActivateWatch   XPackWatcherActivateWatch
	DeactivateWatch XPackWatcherDeactivateWatch
	DeleteWatch     XPackWatcherDeleteWatch
	ExecuteWatch    XPackWatcherExecuteWatch
	GetWatch        XPackWatcherGetWatch
	PutWatch        XPackWatcherPutWatch
	Restart         XPackWatcherRestart
	Start           XPackWatcherStart
	Stats           XPackWatcherStats
	Stop            XPackWatcherStop
}

Watcher contains the Watcher APIs

type XPack ¶ added in v6.8.2 

type XPack struct {
	GraphExplore              XPackGraphExplore
	Info                      XPackInfo
	LicenseDelete             XPackLicenseDelete
	LicenseGetBasicStatus     XPackLicenseGetBasicStatus
	LicenseGet                XPackLicenseGet
	LicenseGetTrialStatus     XPackLicenseGetTrialStatus
	LicensePost               XPackLicensePost
	LicensePostStartBasic     XPackLicensePostStartBasic
	LicensePostStartTrial     XPackLicensePostStartTrial
	MLCloseJob                XPackMLCloseJob
	MLDeleteCalendarEvent     XPackMLDeleteCalendarEvent
	MLDeleteCalendarJob       XPackMLDeleteCalendarJob
	MLDeleteCalendar          XPackMLDeleteCalendar
	MLDeleteDatafeed          XPackMLDeleteDatafeed
	MLDeleteExpiredData       XPackMLDeleteExpiredData
	MLDeleteFilter            XPackMLDeleteFilter
	MLDeleteForecast          XPackMLDeleteForecast
	MLDeleteJob               XPackMLDeleteJob
	MLDeleteModelSnapshot     XPackMLDeleteModelSnapshot
	MLFindFileStructure       XPackMLFindFileStructure
	MLFlushJob                XPackMLFlushJob
	MLForecast                XPackMLForecast
	MLGetBuckets              XPackMLGetBuckets
	MLGetCalendarEvents       XPackMLGetCalendarEvents
	MLGetCalendars            XPackMLGetCalendars
	MLGetCategories           XPackMLGetCategories
	MLGetDatafeedStats        XPackMLGetDatafeedStats
	MLGetDatafeeds            XPackMLGetDatafeeds
	MLGetFilters              XPackMLGetFilters
	MLGetInfluencers          XPackMLGetInfluencers
	MLGetJobStats             XPackMLGetJobStats
	MLGetJobs                 XPackMLGetJobs
	MLGetModelSnapshots       XPackMLGetModelSnapshots
	MLGetOverallBuckets       XPackMLGetOverallBuckets
	MLGetRecords              XPackMLGetRecords
	MLInfo                    XPackMLInfo
	MLOpenJob                 XPackMLOpenJob
	MLPostCalendarEvents      XPackMLPostCalendarEvents
	MLPostData                XPackMLPostData
	MLPreviewDatafeed         XPackMLPreviewDatafeed
	MLPutCalendarJob          XPackMLPutCalendarJob
	MLPutCalendar             XPackMLPutCalendar
	MLPutDatafeed             XPackMLPutDatafeed
	MLPutFilter               XPackMLPutFilter
	MLPutJob                  XPackMLPutJob
	MLRevertModelSnapshot     XPackMLRevertModelSnapshot
	MLSetUpgradeMode          XPackMLSetUpgradeMode
	MLStartDatafeed           XPackMLStartDatafeed
	MLStopDatafeed            XPackMLStopDatafeed
	MLUpdateDatafeed          XPackMLUpdateDatafeed
	MLUpdateFilter            XPackMLUpdateFilter
	MLUpdateJob               XPackMLUpdateJob
	MLUpdateModelSnapshot     XPackMLUpdateModelSnapshot
	MLValidateDetector        XPackMLValidateDetector
	MLValidate                XPackMLValidate
	MigrationDeprecations     XPackMigrationDeprecations
	MigrationGetAssistance    XPackMigrationGetAssistance
	MigrationUpgrade          XPackMigrationUpgrade
	MonitoringBulk            XPackMonitoringBulk
	RollupDeleteJob           XPackRollupDeleteJob
	RollupGetJobs             XPackRollupGetJobs
	RollupGetRollupCaps       XPackRollupGetRollupCaps
	RollupGetRollupIndexCaps  XPackRollupGetRollupIndexCaps
	RollupPutJob              XPackRollupPutJob
	RollupRollupSearch        XPackRollupRollupSearch
	RollupStartJob            XPackRollupStartJob
	RollupStopJob             XPackRollupStopJob
	SQLClearCursor            XPackSQLClearCursor
	SQLQuery                  XPackSQLQuery
	SQLTranslate              XPackSQLTranslate
	SSLCertificates           XPackSSLCertificates
	SecurityAuthenticate      XPackSecurityAuthenticate
	SecurityChangePassword    XPackSecurityChangePassword
	SecurityClearCachedRealms XPackSecurityClearCachedRealms
	SecurityClearCachedRoles  XPackSecurityClearCachedRoles
	SecurityDeletePrivileges  XPackSecurityDeletePrivileges
	SecurityDeleteRoleMapping XPackSecurityDeleteRoleMapping
	SecurityDeleteRole        XPackSecurityDeleteRole
	SecurityDeleteUser        XPackSecurityDeleteUser
	SecurityDisableUser       XPackSecurityDisableUser
	SecurityEnableUser        XPackSecurityEnableUser
	SecurityGetPrivileges     XPackSecurityGetPrivileges
	SecurityGetRoleMapping    XPackSecurityGetRoleMapping
	SecurityGetRole           XPackSecurityGetRole
	SecurityGetToken          XPackSecurityGetToken
	SecurityGetUserPrivileges XPackSecurityGetUserPrivileges
	SecurityGetUser           XPackSecurityGetUser
	SecurityHasPrivileges     XPackSecurityHasPrivileges
	SecurityInvalidateToken   XPackSecurityInvalidateToken
	SecurityPutPrivileges     XPackSecurityPutPrivileges
	SecurityPutRoleMapping    XPackSecurityPutRoleMapping
	SecurityPutRole           XPackSecurityPutRole
	SecurityPutUser           XPackSecurityPutUser
	Usage                     XPackUsage
	WatcherAckWatch           XPackWatcherAckWatch
	WatcherActivateWatch      XPackWatcherActivateWatch
	WatcherDeactivateWatch    XPackWatcherDeactivateWatch
	WatcherDeleteWatch        XPackWatcherDeleteWatch
	WatcherExecuteWatch       XPackWatcherExecuteWatch
	WatcherGetWatch           XPackWatcherGetWatch
	WatcherPutWatch           XPackWatcherPutWatch
	WatcherRestart            XPackWatcherRestart
	WatcherStart              XPackWatcherStart
	WatcherStats              XPackWatcherStats
	WatcherStop               XPackWatcherStop
	CCR                       *CCR
	ILM                       *ILM
	License                   *License
	Migration                 *Migration
	ML                        *ML
	Monitoring                *Monitoring
	Rollup                    *Rollup
	Security                  *Security
	SQL                       *SQL
	SSL                       *SSL
	Watcher                   *Watcher
	XPack                     *XPack
}

XPack contains the XPack APIs

type XPackGraphExplore ¶ added in v6.8.2 

type XPackGraphExplore func(o ...func(*XPackGraphExploreRequest)) (*Response, error)

XPackGraphExplore - https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html

func (XPackGraphExplore) WithBody ¶ added in v6.8.2 

func (f XPackGraphExplore) WithBody(v io.Reader) func(*XPackGraphExploreRequest)

WithBody - Graph Query DSL.

func (XPackGraphExplore) WithContext ¶ added in v6.8.2 

func (f XPackGraphExplore) WithContext(v context.Context) func(*XPackGraphExploreRequest)

WithContext sets the request context.

func (XPackGraphExplore) WithDocumentType ¶ added in v6.8.2 

func (f XPackGraphExplore) WithDocumentType(v ...string) func(*XPackGraphExploreRequest)

WithDocumentType - a list of document types to search; leave empty to perform the operation on all types.

func (XPackGraphExplore) WithErrorTrace ¶ added in v6.8.2 

func (f XPackGraphExplore) WithErrorTrace() func(*XPackGraphExploreRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackGraphExplore) WithFilterPath ¶ added in v6.8.2 

func (f XPackGraphExplore) WithFilterPath(v ...string) func(*XPackGraphExploreRequest)

WithFilterPath filters the properties of the response body.

func (XPackGraphExplore) WithHeader ¶ added in v6.8.2 

func (f XPackGraphExplore) WithHeader(h map[string]string) func(*XPackGraphExploreRequest)

WithHeader adds the headers to the HTTP request.

func (XPackGraphExplore) WithHuman ¶ added in v6.8.2 

func (f XPackGraphExplore) WithHuman() func(*XPackGraphExploreRequest)

WithHuman makes statistical values human-readable.

func (XPackGraphExplore) WithIndex ¶ added in v6.8.2 

func (f XPackGraphExplore) WithIndex(v ...string) func(*XPackGraphExploreRequest)

WithIndex - a list of index names to search; use _all to perform the operation on all indices.

func (XPackGraphExplore) WithOpaqueID ¶ added in v6.8.5 

func (f XPackGraphExplore) WithOpaqueID(s string) func(*XPackGraphExploreRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackGraphExplore) WithPretty ¶ added in v6.8.2 

func (f XPackGraphExplore) WithPretty() func(*XPackGraphExploreRequest)

WithPretty makes the response body pretty-printed.

func (XPackGraphExplore) WithRouting ¶ added in v6.8.2 

func (f XPackGraphExplore) WithRouting(v string) func(*XPackGraphExploreRequest)

WithRouting - specific routing value.

func (XPackGraphExplore) WithTimeout ¶ added in v6.8.2 

func (f XPackGraphExplore) WithTimeout(v time.Duration) func(*XPackGraphExploreRequest)

WithTimeout - explicit operation timeout.

type XPackGraphExploreRequest ¶ added in v6.8.2 

type XPackGraphExploreRequest 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
}

XPackGraphExploreRequest configures the X Pack Graph Explore API request.

func (XPackGraphExploreRequest) Do ¶ added in v6.8.2 

func (r XPackGraphExploreRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackInfo ¶ added in v6.8.2 

type XPackInfo func(o ...func(*XPackInfoRequest)) (*Response, error)

XPackInfo - https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html

func (XPackInfo) WithCategories ¶ added in v6.8.2 

func (f XPackInfo) WithCategories(v ...string) func(*XPackInfoRequest)

WithCategories - comma-separated list of info categories. can be any of: build, license, features.

func (XPackInfo) WithContext ¶ added in v6.8.2 

func (f XPackInfo) WithContext(v context.Context) func(*XPackInfoRequest)

WithContext sets the request context.

func (XPackInfo) WithErrorTrace ¶ added in v6.8.2 

func (f XPackInfo) WithErrorTrace() func(*XPackInfoRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackInfo) WithFilterPath ¶ added in v6.8.2 

func (f XPackInfo) WithFilterPath(v ...string) func(*XPackInfoRequest)

WithFilterPath filters the properties of the response body.

func (XPackInfo) WithHeader ¶ added in v6.8.2 

func (f XPackInfo) WithHeader(h map[string]string) func(*XPackInfoRequest)

WithHeader adds the headers to the HTTP request.

func (XPackInfo) WithHuman ¶ added in v6.8.2 

func (f XPackInfo) WithHuman() func(*XPackInfoRequest)

WithHuman makes statistical values human-readable.

func (XPackInfo) WithOpaqueID ¶ added in v6.8.5 

func (f XPackInfo) WithOpaqueID(s string) func(*XPackInfoRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackInfo) WithPretty ¶ added in v6.8.2 

func (f XPackInfo) WithPretty() func(*XPackInfoRequest)

WithPretty makes the response body pretty-printed.

type XPackInfoRequest ¶ added in v6.8.2 

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.

func (XPackInfoRequest) Do ¶ added in v6.8.2 

func (r XPackInfoRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackLicenseDelete ¶ added in v6.8.2 

type XPackLicenseDelete func(o ...func(*XPackLicenseDeleteRequest)) (*Response, error)

XPackLicenseDelete - https://www.elastic.co/guide/en/elasticsearch/reference/6.7/delete-license.html

func (XPackLicenseDelete) WithContext ¶ added in v6.8.2 

func (f XPackLicenseDelete) WithContext(v context.Context) func(*XPackLicenseDeleteRequest)

WithContext sets the request context.

func (XPackLicenseDelete) WithErrorTrace ¶ added in v6.8.2 

func (f XPackLicenseDelete) WithErrorTrace() func(*XPackLicenseDeleteRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackLicenseDelete) WithFilterPath ¶ added in v6.8.2 

func (f XPackLicenseDelete) WithFilterPath(v ...string) func(*XPackLicenseDeleteRequest)

WithFilterPath filters the properties of the response body.

func (XPackLicenseDelete) WithHeader ¶ added in v6.8.2 

func (f XPackLicenseDelete) WithHeader(h map[string]string) func(*XPackLicenseDeleteRequest)

WithHeader adds the headers to the HTTP request.

func (XPackLicenseDelete) WithHuman ¶ added in v6.8.2 

func (f XPackLicenseDelete) WithHuman() func(*XPackLicenseDeleteRequest)

WithHuman makes statistical values human-readable.

func (XPackLicenseDelete) WithOpaqueID ¶ added in v6.8.5 

func (f XPackLicenseDelete) WithOpaqueID(s string) func(*XPackLicenseDeleteRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackLicenseDelete) WithPretty ¶ added in v6.8.2 

func (f XPackLicenseDelete) WithPretty() func(*XPackLicenseDeleteRequest)

WithPretty makes the response body pretty-printed.

type XPackLicenseDeleteRequest ¶ added in v6.8.2 

type XPackLicenseDeleteRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackLicenseDeleteRequest configures the X Pack License Delete API request.

func (XPackLicenseDeleteRequest) Do ¶ added in v6.8.2 

func (r XPackLicenseDeleteRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackLicenseGet ¶ added in v6.8.2 

type XPackLicenseGet func(o ...func(*XPackLicenseGetRequest)) (*Response, error)

XPackLicenseGet - https://www.elastic.co/guide/en/elasticsearch/reference/6.7/get-license.html

func (XPackLicenseGet) WithContext ¶ added in v6.8.2 

func (f XPackLicenseGet) WithContext(v context.Context) func(*XPackLicenseGetRequest)

WithContext sets the request context.

func (XPackLicenseGet) WithErrorTrace ¶ added in v6.8.2 

func (f XPackLicenseGet) WithErrorTrace() func(*XPackLicenseGetRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackLicenseGet) WithFilterPath ¶ added in v6.8.2 

func (f XPackLicenseGet) WithFilterPath(v ...string) func(*XPackLicenseGetRequest)

WithFilterPath filters the properties of the response body.

func (XPackLicenseGet) WithHeader ¶ added in v6.8.2 

func (f XPackLicenseGet) WithHeader(h map[string]string) func(*XPackLicenseGetRequest)

WithHeader adds the headers to the HTTP request.

func (XPackLicenseGet) WithHuman ¶ added in v6.8.2 

func (f XPackLicenseGet) WithHuman() func(*XPackLicenseGetRequest)

WithHuman makes statistical values human-readable.

func (XPackLicenseGet) WithLocal ¶ added in v6.8.2 

func (f XPackLicenseGet) WithLocal(v bool) func(*XPackLicenseGetRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (XPackLicenseGet) WithOpaqueID ¶ added in v6.8.5 

func (f XPackLicenseGet) WithOpaqueID(s string) func(*XPackLicenseGetRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackLicenseGet) WithPretty ¶ added in v6.8.2 

func (f XPackLicenseGet) WithPretty() func(*XPackLicenseGetRequest)

WithPretty makes the response body pretty-printed.

type XPackLicenseGetBasicStatus ¶ added in v6.8.2 

type XPackLicenseGetBasicStatus func(o ...func(*XPackLicenseGetBasicStatusRequest)) (*Response, error)

XPackLicenseGetBasicStatus - https://www.elastic.co/guide/en/elasticsearch/reference/6.7/get-trial-status.html

func (XPackLicenseGetBasicStatus) WithContext ¶ added in v6.8.2 

func (f XPackLicenseGetBasicStatus) WithContext(v context.Context) func(*XPackLicenseGetBasicStatusRequest)

WithContext sets the request context.

func (XPackLicenseGetBasicStatus) WithErrorTrace ¶ added in v6.8.2 

func (f XPackLicenseGetBasicStatus) WithErrorTrace() func(*XPackLicenseGetBasicStatusRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackLicenseGetBasicStatus) WithFilterPath ¶ added in v6.8.2 

func (f XPackLicenseGetBasicStatus) WithFilterPath(v ...string) func(*XPackLicenseGetBasicStatusRequest)

WithFilterPath filters the properties of the response body.

func (XPackLicenseGetBasicStatus) WithHeader ¶ added in v6.8.2 

func (f XPackLicenseGetBasicStatus) WithHeader(h map[string]string) func(*XPackLicenseGetBasicStatusRequest)

WithHeader adds the headers to the HTTP request.

func (XPackLicenseGetBasicStatus) WithHuman ¶ added in v6.8.2 

func (f XPackLicenseGetBasicStatus) WithHuman() func(*XPackLicenseGetBasicStatusRequest)

WithHuman makes statistical values human-readable.

func (XPackLicenseGetBasicStatus) WithOpaqueID ¶ added in v6.8.5 

func (f XPackLicenseGetBasicStatus) WithOpaqueID(s string) func(*XPackLicenseGetBasicStatusRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackLicenseGetBasicStatus) WithPretty ¶ added in v6.8.2 

func (f XPackLicenseGetBasicStatus) WithPretty() func(*XPackLicenseGetBasicStatusRequest)

WithPretty makes the response body pretty-printed.

type XPackLicenseGetBasicStatusRequest ¶ added in v6.8.2 

type XPackLicenseGetBasicStatusRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackLicenseGetBasicStatusRequest configures the X Pack License Get Basic Status API request.

func (XPackLicenseGetBasicStatusRequest) Do ¶ added in v6.8.2 

func (r XPackLicenseGetBasicStatusRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackLicenseGetRequest ¶ added in v6.8.2 

type XPackLicenseGetRequest struct {
	Local *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackLicenseGetRequest configures the X Pack License Get API request.

func (XPackLicenseGetRequest) Do ¶ added in v6.8.2 

func (r XPackLicenseGetRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackLicenseGetTrialStatus ¶ added in v6.8.2 

type XPackLicenseGetTrialStatus func(o ...func(*XPackLicenseGetTrialStatusRequest)) (*Response, error)

XPackLicenseGetTrialStatus - https://www.elastic.co/guide/en/elasticsearch/reference/6.7/get-basic-status.html

func (XPackLicenseGetTrialStatus) WithContext ¶ added in v6.8.2 

func (f XPackLicenseGetTrialStatus) WithContext(v context.Context) func(*XPackLicenseGetTrialStatusRequest)

WithContext sets the request context.

func (XPackLicenseGetTrialStatus) WithErrorTrace ¶ added in v6.8.2 

func (f XPackLicenseGetTrialStatus) WithErrorTrace() func(*XPackLicenseGetTrialStatusRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackLicenseGetTrialStatus) WithFilterPath ¶ added in v6.8.2 

func (f XPackLicenseGetTrialStatus) WithFilterPath(v ...string) func(*XPackLicenseGetTrialStatusRequest)

WithFilterPath filters the properties of the response body.

func (XPackLicenseGetTrialStatus) WithHeader ¶ added in v6.8.2 

func (f XPackLicenseGetTrialStatus) WithHeader(h map[string]string) func(*XPackLicenseGetTrialStatusRequest)

WithHeader adds the headers to the HTTP request.

func (XPackLicenseGetTrialStatus) WithHuman ¶ added in v6.8.2 

func (f XPackLicenseGetTrialStatus) WithHuman() func(*XPackLicenseGetTrialStatusRequest)

WithHuman makes statistical values human-readable.

func (XPackLicenseGetTrialStatus) WithOpaqueID ¶ added in v6.8.5 

func (f XPackLicenseGetTrialStatus) WithOpaqueID(s string) func(*XPackLicenseGetTrialStatusRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackLicenseGetTrialStatus) WithPretty ¶ added in v6.8.2 

func (f XPackLicenseGetTrialStatus) WithPretty() func(*XPackLicenseGetTrialStatusRequest)

WithPretty makes the response body pretty-printed.

type XPackLicenseGetTrialStatusRequest ¶ added in v6.8.2 

type XPackLicenseGetTrialStatusRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackLicenseGetTrialStatusRequest configures the X Pack License Get Trial Status API request.

func (XPackLicenseGetTrialStatusRequest) Do ¶ added in v6.8.2 

func (r XPackLicenseGetTrialStatusRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackLicensePost ¶ added in v6.8.2 

type XPackLicensePost func(o ...func(*XPackLicensePostRequest)) (*Response, error)

XPackLicensePost - https://www.elastic.co/guide/en/elasticsearch/reference/6.7/update-license.html

func (XPackLicensePost) WithAcknowledge ¶ added in v6.8.2 

func (f XPackLicensePost) WithAcknowledge(v bool) func(*XPackLicensePostRequest)

WithAcknowledge - whether the user has acknowledged acknowledge messages (default: false).

func (XPackLicensePost) WithBody ¶ added in v6.8.2 

func (f XPackLicensePost) WithBody(v io.Reader) func(*XPackLicensePostRequest)

WithBody - licenses to be installed.

func (XPackLicensePost) WithContext ¶ added in v6.8.2 

func (f XPackLicensePost) WithContext(v context.Context) func(*XPackLicensePostRequest)

WithContext sets the request context.

func (XPackLicensePost) WithErrorTrace ¶ added in v6.8.2 

func (f XPackLicensePost) WithErrorTrace() func(*XPackLicensePostRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackLicensePost) WithFilterPath ¶ added in v6.8.2 

func (f XPackLicensePost) WithFilterPath(v ...string) func(*XPackLicensePostRequest)

WithFilterPath filters the properties of the response body.

func (XPackLicensePost) WithHeader ¶ added in v6.8.2 

func (f XPackLicensePost) WithHeader(h map[string]string) func(*XPackLicensePostRequest)

WithHeader adds the headers to the HTTP request.

func (XPackLicensePost) WithHuman ¶ added in v6.8.2 

func (f XPackLicensePost) WithHuman() func(*XPackLicensePostRequest)

WithHuman makes statistical values human-readable.

func (XPackLicensePost) WithOpaqueID ¶ added in v6.8.5 

func (f XPackLicensePost) WithOpaqueID(s string) func(*XPackLicensePostRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackLicensePost) WithPretty ¶ added in v6.8.2 

func (f XPackLicensePost) WithPretty() func(*XPackLicensePostRequest)

WithPretty makes the response body pretty-printed.

type XPackLicensePostRequest ¶ added in v6.8.2 

type XPackLicensePostRequest struct {
	Body io.Reader

	Acknowledge *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackLicensePostRequest configures the X Pack License Post API request.

func (XPackLicensePostRequest) Do ¶ added in v6.8.2 

func (r XPackLicensePostRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackLicensePostStartBasic ¶ added in v6.8.2 

type XPackLicensePostStartBasic func(o ...func(*XPackLicensePostStartBasicRequest)) (*Response, error)

XPackLicensePostStartBasic - https://www.elastic.co/guide/en/elasticsearch/reference/6.7/start-basic.html

func (XPackLicensePostStartBasic) WithAcknowledge ¶ added in v6.8.2 

func (f XPackLicensePostStartBasic) WithAcknowledge(v bool) func(*XPackLicensePostStartBasicRequest)

WithAcknowledge - whether the user has acknowledged acknowledge messages (default: false).

func (XPackLicensePostStartBasic) WithContext ¶ added in v6.8.2 

func (f XPackLicensePostStartBasic) WithContext(v context.Context) func(*XPackLicensePostStartBasicRequest)

WithContext sets the request context.

func (XPackLicensePostStartBasic) WithErrorTrace ¶ added in v6.8.2 

func (f XPackLicensePostStartBasic) WithErrorTrace() func(*XPackLicensePostStartBasicRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackLicensePostStartBasic) WithFilterPath ¶ added in v6.8.2 

func (f XPackLicensePostStartBasic) WithFilterPath(v ...string) func(*XPackLicensePostStartBasicRequest)

WithFilterPath filters the properties of the response body.

func (XPackLicensePostStartBasic) WithHeader ¶ added in v6.8.2 

func (f XPackLicensePostStartBasic) WithHeader(h map[string]string) func(*XPackLicensePostStartBasicRequest)

WithHeader adds the headers to the HTTP request.

func (XPackLicensePostStartBasic) WithHuman ¶ added in v6.8.2 

func (f XPackLicensePostStartBasic) WithHuman() func(*XPackLicensePostStartBasicRequest)

WithHuman makes statistical values human-readable.

func (XPackLicensePostStartBasic) WithOpaqueID ¶ added in v6.8.5 

func (f XPackLicensePostStartBasic) WithOpaqueID(s string) func(*XPackLicensePostStartBasicRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackLicensePostStartBasic) WithPretty ¶ added in v6.8.2 

func (f XPackLicensePostStartBasic) WithPretty() func(*XPackLicensePostStartBasicRequest)

WithPretty makes the response body pretty-printed.

type XPackLicensePostStartBasicRequest ¶ added in v6.8.2 

type XPackLicensePostStartBasicRequest struct {
	Acknowledge *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackLicensePostStartBasicRequest configures the X Pack License Post Start Basic API request.

func (XPackLicensePostStartBasicRequest) Do ¶ added in v6.8.2 

func (r XPackLicensePostStartBasicRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackLicensePostStartTrial ¶ added in v6.8.2 

type XPackLicensePostStartTrial func(o ...func(*XPackLicensePostStartTrialRequest)) (*Response, error)

XPackLicensePostStartTrial - https://www.elastic.co/guide/en/elasticsearch/reference/6.7/start-trial.html

func (XPackLicensePostStartTrial) WithAcknowledge ¶ added in v6.8.2 

func (f XPackLicensePostStartTrial) WithAcknowledge(v bool) func(*XPackLicensePostStartTrialRequest)

WithAcknowledge - whether the user has acknowledged acknowledge messages (default: false).

func (XPackLicensePostStartTrial) WithContext ¶ added in v6.8.2 

func (f XPackLicensePostStartTrial) WithContext(v context.Context) func(*XPackLicensePostStartTrialRequest)

WithContext sets the request context.

func (XPackLicensePostStartTrial) WithDocumentType ¶ added in v6.8.2 

func (f XPackLicensePostStartTrial) WithDocumentType(v string) func(*XPackLicensePostStartTrialRequest)

WithDocumentType - the type of trial license to generate (default: "trial").

func (XPackLicensePostStartTrial) WithErrorTrace ¶ added in v6.8.2 

func (f XPackLicensePostStartTrial) WithErrorTrace() func(*XPackLicensePostStartTrialRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackLicensePostStartTrial) WithFilterPath ¶ added in v6.8.2 

func (f XPackLicensePostStartTrial) WithFilterPath(v ...string) func(*XPackLicensePostStartTrialRequest)

WithFilterPath filters the properties of the response body.

func (XPackLicensePostStartTrial) WithHeader ¶ added in v6.8.2 

func (f XPackLicensePostStartTrial) WithHeader(h map[string]string) func(*XPackLicensePostStartTrialRequest)

WithHeader adds the headers to the HTTP request.

func (XPackLicensePostStartTrial) WithHuman ¶ added in v6.8.2 

func (f XPackLicensePostStartTrial) WithHuman() func(*XPackLicensePostStartTrialRequest)

WithHuman makes statistical values human-readable.

func (XPackLicensePostStartTrial) WithOpaqueID ¶ added in v6.8.5 

func (f XPackLicensePostStartTrial) WithOpaqueID(s string) func(*XPackLicensePostStartTrialRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackLicensePostStartTrial) WithPretty ¶ added in v6.8.2 

func (f XPackLicensePostStartTrial) WithPretty() func(*XPackLicensePostStartTrialRequest)

WithPretty makes the response body pretty-printed.

type XPackLicensePostStartTrialRequest ¶ added in v6.8.2 

type XPackLicensePostStartTrialRequest struct {
	Acknowledge  *bool
	DocumentType string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackLicensePostStartTrialRequest configures the X Pack License Post Start Trial API request.

func (XPackLicensePostStartTrialRequest) Do ¶ added in v6.8.2 

func (r XPackLicensePostStartTrialRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLCloseJob ¶ added in v6.8.2 

type XPackMLCloseJob func(job_id string, o ...func(*XPackMLCloseJobRequest)) (*Response, error)

XPackMLCloseJob - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html

func (XPackMLCloseJob) WithAllowNoJobs ¶ added in v6.8.2 

func (f XPackMLCloseJob) WithAllowNoJobs(v bool) func(*XPackMLCloseJobRequest)

WithAllowNoJobs - whether to ignore if a wildcard expression matches no jobs. (this includes `_all` string or when no jobs have been specified).

func (XPackMLCloseJob) WithBody ¶ added in v6.8.2 

func (f XPackMLCloseJob) WithBody(v io.Reader) func(*XPackMLCloseJobRequest)

WithBody - The URL params optionally sent in the body.

func (XPackMLCloseJob) WithContext ¶ added in v6.8.2 

func (f XPackMLCloseJob) WithContext(v context.Context) func(*XPackMLCloseJobRequest)

WithContext sets the request context.

func (XPackMLCloseJob) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLCloseJob) WithErrorTrace() func(*XPackMLCloseJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLCloseJob) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLCloseJob) WithFilterPath(v ...string) func(*XPackMLCloseJobRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLCloseJob) WithForce ¶ added in v6.8.2 

func (f XPackMLCloseJob) WithForce(v bool) func(*XPackMLCloseJobRequest)

WithForce - true if the job should be forcefully closed.

func (XPackMLCloseJob) WithHeader ¶ added in v6.8.2 

func (f XPackMLCloseJob) WithHeader(h map[string]string) func(*XPackMLCloseJobRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLCloseJob) WithHuman ¶ added in v6.8.2 

func (f XPackMLCloseJob) WithHuman() func(*XPackMLCloseJobRequest)

WithHuman makes statistical values human-readable.

func (XPackMLCloseJob) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLCloseJob) WithOpaqueID(s string) func(*XPackMLCloseJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLCloseJob) WithPretty ¶ added in v6.8.2 

func (f XPackMLCloseJob) WithPretty() func(*XPackMLCloseJobRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLCloseJob) WithTimeout ¶ added in v6.8.2 

func (f XPackMLCloseJob) WithTimeout(v time.Duration) func(*XPackMLCloseJobRequest)

WithTimeout - controls the time to wait until a job has closed. default to 30 minutes.

type XPackMLCloseJobRequest ¶ added in v6.8.2 

type XPackMLCloseJobRequest 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
}

XPackMLCloseJobRequest configures the X PackML Close Job API request.

func (XPackMLCloseJobRequest) Do ¶ added in v6.8.2 

func (r XPackMLCloseJobRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLDeleteCalendar ¶ added in v6.8.2 

type XPackMLDeleteCalendar func(calendar_id string, o ...func(*XPackMLDeleteCalendarRequest)) (*Response, error)

XPackMLDeleteCalendar -

func (XPackMLDeleteCalendar) WithContext ¶ added in v6.8.2 

func (f XPackMLDeleteCalendar) WithContext(v context.Context) func(*XPackMLDeleteCalendarRequest)

WithContext sets the request context.

func (XPackMLDeleteCalendar) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLDeleteCalendar) WithErrorTrace() func(*XPackMLDeleteCalendarRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLDeleteCalendar) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLDeleteCalendar) WithFilterPath(v ...string) func(*XPackMLDeleteCalendarRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLDeleteCalendar) WithHeader ¶ added in v6.8.2 

func (f XPackMLDeleteCalendar) WithHeader(h map[string]string) func(*XPackMLDeleteCalendarRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLDeleteCalendar) WithHuman ¶ added in v6.8.2 

func (f XPackMLDeleteCalendar) WithHuman() func(*XPackMLDeleteCalendarRequest)

WithHuman makes statistical values human-readable.

func (XPackMLDeleteCalendar) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLDeleteCalendar) WithOpaqueID(s string) func(*XPackMLDeleteCalendarRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLDeleteCalendar) WithPretty ¶ added in v6.8.2 

func (f XPackMLDeleteCalendar) WithPretty() func(*XPackMLDeleteCalendarRequest)

WithPretty makes the response body pretty-printed.

type XPackMLDeleteCalendarEvent ¶ added in v6.8.2 

type XPackMLDeleteCalendarEvent func(calendar_id string, event_id string, o ...func(*XPackMLDeleteCalendarEventRequest)) (*Response, error)

XPackMLDeleteCalendarEvent -

func (XPackMLDeleteCalendarEvent) WithContext ¶ added in v6.8.2 

func (f XPackMLDeleteCalendarEvent) WithContext(v context.Context) func(*XPackMLDeleteCalendarEventRequest)

WithContext sets the request context.

func (XPackMLDeleteCalendarEvent) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLDeleteCalendarEvent) WithErrorTrace() func(*XPackMLDeleteCalendarEventRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLDeleteCalendarEvent) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLDeleteCalendarEvent) WithFilterPath(v ...string) func(*XPackMLDeleteCalendarEventRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLDeleteCalendarEvent) WithHeader ¶ added in v6.8.2 

func (f XPackMLDeleteCalendarEvent) WithHeader(h map[string]string) func(*XPackMLDeleteCalendarEventRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLDeleteCalendarEvent) WithHuman ¶ added in v6.8.2 

func (f XPackMLDeleteCalendarEvent) WithHuman() func(*XPackMLDeleteCalendarEventRequest)

WithHuman makes statistical values human-readable.

func (XPackMLDeleteCalendarEvent) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLDeleteCalendarEvent) WithOpaqueID(s string) func(*XPackMLDeleteCalendarEventRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLDeleteCalendarEvent) WithPretty ¶ added in v6.8.2 

func (f XPackMLDeleteCalendarEvent) WithPretty() func(*XPackMLDeleteCalendarEventRequest)

WithPretty makes the response body pretty-printed.

type XPackMLDeleteCalendarEventRequest ¶ added in v6.8.2 

type XPackMLDeleteCalendarEventRequest struct {
	CalendarID string
	EventID    string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLDeleteCalendarEventRequest configures the X PackML Delete Calendar Event API request.

func (XPackMLDeleteCalendarEventRequest) Do ¶ added in v6.8.2 

func (r XPackMLDeleteCalendarEventRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLDeleteCalendarJob ¶ added in v6.8.2 

type XPackMLDeleteCalendarJob func(calendar_id string, job_id string, o ...func(*XPackMLDeleteCalendarJobRequest)) (*Response, error)

XPackMLDeleteCalendarJob -

func (XPackMLDeleteCalendarJob) WithContext ¶ added in v6.8.2 

func (f XPackMLDeleteCalendarJob) WithContext(v context.Context) func(*XPackMLDeleteCalendarJobRequest)

WithContext sets the request context.

func (XPackMLDeleteCalendarJob) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLDeleteCalendarJob) WithErrorTrace() func(*XPackMLDeleteCalendarJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLDeleteCalendarJob) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLDeleteCalendarJob) WithFilterPath(v ...string) func(*XPackMLDeleteCalendarJobRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLDeleteCalendarJob) WithHeader ¶ added in v6.8.2 

func (f XPackMLDeleteCalendarJob) WithHeader(h map[string]string) func(*XPackMLDeleteCalendarJobRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLDeleteCalendarJob) WithHuman ¶ added in v6.8.2 

func (f XPackMLDeleteCalendarJob) WithHuman() func(*XPackMLDeleteCalendarJobRequest)

WithHuman makes statistical values human-readable.

func (XPackMLDeleteCalendarJob) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLDeleteCalendarJob) WithOpaqueID(s string) func(*XPackMLDeleteCalendarJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLDeleteCalendarJob) WithPretty ¶ added in v6.8.2 

func (f XPackMLDeleteCalendarJob) WithPretty() func(*XPackMLDeleteCalendarJobRequest)

WithPretty makes the response body pretty-printed.

type XPackMLDeleteCalendarJobRequest ¶ added in v6.8.2 

type XPackMLDeleteCalendarJobRequest struct {
	CalendarID string
	JobID      string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLDeleteCalendarJobRequest configures the X PackML Delete Calendar Job API request.

func (XPackMLDeleteCalendarJobRequest) Do ¶ added in v6.8.2 

func (r XPackMLDeleteCalendarJobRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLDeleteCalendarRequest ¶ added in v6.8.2 

type XPackMLDeleteCalendarRequest struct {
	CalendarID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLDeleteCalendarRequest configures the X PackML Delete Calendar API request.

func (XPackMLDeleteCalendarRequest) Do ¶ added in v6.8.2 

func (r XPackMLDeleteCalendarRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLDeleteDatafeed ¶ added in v6.8.2 

type XPackMLDeleteDatafeed func(datafeed_id string, o ...func(*XPackMLDeleteDatafeedRequest)) (*Response, error)

XPackMLDeleteDatafeed - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html

func (XPackMLDeleteDatafeed) WithContext ¶ added in v6.8.2 

func (f XPackMLDeleteDatafeed) WithContext(v context.Context) func(*XPackMLDeleteDatafeedRequest)

WithContext sets the request context.

func (XPackMLDeleteDatafeed) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLDeleteDatafeed) WithErrorTrace() func(*XPackMLDeleteDatafeedRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLDeleteDatafeed) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLDeleteDatafeed) WithFilterPath(v ...string) func(*XPackMLDeleteDatafeedRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLDeleteDatafeed) WithForce ¶ added in v6.8.2 

func (f XPackMLDeleteDatafeed) WithForce(v bool) func(*XPackMLDeleteDatafeedRequest)

WithForce - true if the datafeed should be forcefully deleted.

func (XPackMLDeleteDatafeed) WithHeader ¶ added in v6.8.2 

func (f XPackMLDeleteDatafeed) WithHeader(h map[string]string) func(*XPackMLDeleteDatafeedRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLDeleteDatafeed) WithHuman ¶ added in v6.8.2 

func (f XPackMLDeleteDatafeed) WithHuman() func(*XPackMLDeleteDatafeedRequest)

WithHuman makes statistical values human-readable.

func (XPackMLDeleteDatafeed) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLDeleteDatafeed) WithOpaqueID(s string) func(*XPackMLDeleteDatafeedRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLDeleteDatafeed) WithPretty ¶ added in v6.8.2 

func (f XPackMLDeleteDatafeed) WithPretty() func(*XPackMLDeleteDatafeedRequest)

WithPretty makes the response body pretty-printed.

type XPackMLDeleteDatafeedRequest ¶ added in v6.8.2 

type XPackMLDeleteDatafeedRequest struct {
	DatafeedID string

	Force *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLDeleteDatafeedRequest configures the X PackML Delete Datafeed API request.

func (XPackMLDeleteDatafeedRequest) Do ¶ added in v6.8.2 

func (r XPackMLDeleteDatafeedRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLDeleteExpiredData ¶ added in v6.8.2 

type XPackMLDeleteExpiredData func(o ...func(*XPackMLDeleteExpiredDataRequest)) (*Response, error)

XPackMLDeleteExpiredData -

func (XPackMLDeleteExpiredData) WithContext ¶ added in v6.8.2 

func (f XPackMLDeleteExpiredData) WithContext(v context.Context) func(*XPackMLDeleteExpiredDataRequest)

WithContext sets the request context.

func (XPackMLDeleteExpiredData) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLDeleteExpiredData) WithErrorTrace() func(*XPackMLDeleteExpiredDataRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLDeleteExpiredData) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLDeleteExpiredData) WithFilterPath(v ...string) func(*XPackMLDeleteExpiredDataRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLDeleteExpiredData) WithHeader ¶ added in v6.8.2 

func (f XPackMLDeleteExpiredData) WithHeader(h map[string]string) func(*XPackMLDeleteExpiredDataRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLDeleteExpiredData) WithHuman ¶ added in v6.8.2 

func (f XPackMLDeleteExpiredData) WithHuman() func(*XPackMLDeleteExpiredDataRequest)

WithHuman makes statistical values human-readable.

func (XPackMLDeleteExpiredData) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLDeleteExpiredData) WithOpaqueID(s string) func(*XPackMLDeleteExpiredDataRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLDeleteExpiredData) WithPretty ¶ added in v6.8.2 

func (f XPackMLDeleteExpiredData) WithPretty() func(*XPackMLDeleteExpiredDataRequest)

WithPretty makes the response body pretty-printed.

type XPackMLDeleteExpiredDataRequest ¶ added in v6.8.2 

type XPackMLDeleteExpiredDataRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLDeleteExpiredDataRequest configures the X PackML Delete Expired Data API request.

func (XPackMLDeleteExpiredDataRequest) Do ¶ added in v6.8.2 

func (r XPackMLDeleteExpiredDataRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLDeleteFilter ¶ added in v6.8.2 

type XPackMLDeleteFilter func(filter_id string, o ...func(*XPackMLDeleteFilterRequest)) (*Response, error)

XPackMLDeleteFilter -

func (XPackMLDeleteFilter) WithContext ¶ added in v6.8.2 

func (f XPackMLDeleteFilter) WithContext(v context.Context) func(*XPackMLDeleteFilterRequest)

WithContext sets the request context.

func (XPackMLDeleteFilter) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLDeleteFilter) WithErrorTrace() func(*XPackMLDeleteFilterRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLDeleteFilter) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLDeleteFilter) WithFilterPath(v ...string) func(*XPackMLDeleteFilterRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLDeleteFilter) WithHeader ¶ added in v6.8.2 

func (f XPackMLDeleteFilter) WithHeader(h map[string]string) func(*XPackMLDeleteFilterRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLDeleteFilter) WithHuman ¶ added in v6.8.2 

func (f XPackMLDeleteFilter) WithHuman() func(*XPackMLDeleteFilterRequest)

WithHuman makes statistical values human-readable.

func (XPackMLDeleteFilter) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLDeleteFilter) WithOpaqueID(s string) func(*XPackMLDeleteFilterRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLDeleteFilter) WithPretty ¶ added in v6.8.2 

func (f XPackMLDeleteFilter) WithPretty() func(*XPackMLDeleteFilterRequest)

WithPretty makes the response body pretty-printed.

type XPackMLDeleteFilterRequest ¶ added in v6.8.2 

type XPackMLDeleteFilterRequest struct {
	FilterID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLDeleteFilterRequest configures the X PackML Delete Filter API request.

func (XPackMLDeleteFilterRequest) Do ¶ added in v6.8.2 

func (r XPackMLDeleteFilterRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLDeleteForecast ¶ added in v6.8.2 

type XPackMLDeleteForecast func(job_id string, o ...func(*XPackMLDeleteForecastRequest)) (*Response, error)

XPackMLDeleteForecast - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html

func (XPackMLDeleteForecast) WithAllowNoForecasts ¶ added in v6.8.2 

func (f XPackMLDeleteForecast) WithAllowNoForecasts(v bool) func(*XPackMLDeleteForecastRequest)

WithAllowNoForecasts - whether to ignore if `_all` matches no forecasts.

func (XPackMLDeleteForecast) WithContext ¶ added in v6.8.2 

func (f XPackMLDeleteForecast) WithContext(v context.Context) func(*XPackMLDeleteForecastRequest)

WithContext sets the request context.

func (XPackMLDeleteForecast) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLDeleteForecast) WithErrorTrace() func(*XPackMLDeleteForecastRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLDeleteForecast) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLDeleteForecast) WithFilterPath(v ...string) func(*XPackMLDeleteForecastRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLDeleteForecast) WithForecastID ¶ added in v6.8.2 

func (f XPackMLDeleteForecast) WithForecastID(v string) func(*XPackMLDeleteForecastRequest)

WithForecastID - the ID of the forecast to delete, can be comma delimited list. leaving blank implies `_all`.

func (XPackMLDeleteForecast) WithHeader ¶ added in v6.8.2 

func (f XPackMLDeleteForecast) WithHeader(h map[string]string) func(*XPackMLDeleteForecastRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLDeleteForecast) WithHuman ¶ added in v6.8.2 

func (f XPackMLDeleteForecast) WithHuman() func(*XPackMLDeleteForecastRequest)

WithHuman makes statistical values human-readable.

func (XPackMLDeleteForecast) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLDeleteForecast) WithOpaqueID(s string) func(*XPackMLDeleteForecastRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLDeleteForecast) WithPretty ¶ added in v6.8.2 

func (f XPackMLDeleteForecast) WithPretty() func(*XPackMLDeleteForecastRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLDeleteForecast) WithTimeout ¶ added in v6.8.2 

func (f XPackMLDeleteForecast) WithTimeout(v time.Duration) func(*XPackMLDeleteForecastRequest)

WithTimeout - controls the time to wait until the forecast(s) are deleted. default to 30 seconds.

type XPackMLDeleteForecastRequest ¶ added in v6.8.2 

type XPackMLDeleteForecastRequest 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
}

XPackMLDeleteForecastRequest configures the X PackML Delete Forecast API request.

func (XPackMLDeleteForecastRequest) Do ¶ added in v6.8.2 

func (r XPackMLDeleteForecastRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLDeleteJob ¶ added in v6.8.2 

type XPackMLDeleteJob func(job_id string, o ...func(*XPackMLDeleteJobRequest)) (*Response, error)

XPackMLDeleteJob - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html

func (XPackMLDeleteJob) WithContext ¶ added in v6.8.2 

func (f XPackMLDeleteJob) WithContext(v context.Context) func(*XPackMLDeleteJobRequest)

WithContext sets the request context.

func (XPackMLDeleteJob) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLDeleteJob) WithErrorTrace() func(*XPackMLDeleteJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLDeleteJob) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLDeleteJob) WithFilterPath(v ...string) func(*XPackMLDeleteJobRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLDeleteJob) WithForce ¶ added in v6.8.2 

func (f XPackMLDeleteJob) WithForce(v bool) func(*XPackMLDeleteJobRequest)

WithForce - true if the job should be forcefully deleted.

func (XPackMLDeleteJob) WithHeader ¶ added in v6.8.2 

func (f XPackMLDeleteJob) WithHeader(h map[string]string) func(*XPackMLDeleteJobRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLDeleteJob) WithHuman ¶ added in v6.8.2 

func (f XPackMLDeleteJob) WithHuman() func(*XPackMLDeleteJobRequest)

WithHuman makes statistical values human-readable.

func (XPackMLDeleteJob) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLDeleteJob) WithOpaqueID(s string) func(*XPackMLDeleteJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLDeleteJob) WithPretty ¶ added in v6.8.2 

func (f XPackMLDeleteJob) WithPretty() func(*XPackMLDeleteJobRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLDeleteJob) WithWaitForCompletion ¶ added in v6.8.2 

func (f XPackMLDeleteJob) WithWaitForCompletion(v bool) func(*XPackMLDeleteJobRequest)

WithWaitForCompletion - should this request wait until the operation has completed before returning.

type XPackMLDeleteJobRequest ¶ added in v6.8.2 

type XPackMLDeleteJobRequest struct {
	JobID string

	Force             *bool
	WaitForCompletion *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLDeleteJobRequest configures the X PackML Delete Job API request.

func (XPackMLDeleteJobRequest) Do ¶ added in v6.8.2 

func (r XPackMLDeleteJobRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLDeleteModelSnapshot ¶ added in v6.8.2 

type XPackMLDeleteModelSnapshot func(snapshot_id string, job_id string, o ...func(*XPackMLDeleteModelSnapshotRequest)) (*Response, error)

XPackMLDeleteModelSnapshot - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html

func (XPackMLDeleteModelSnapshot) WithContext ¶ added in v6.8.2 

func (f XPackMLDeleteModelSnapshot) WithContext(v context.Context) func(*XPackMLDeleteModelSnapshotRequest)

WithContext sets the request context.

func (XPackMLDeleteModelSnapshot) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLDeleteModelSnapshot) WithErrorTrace() func(*XPackMLDeleteModelSnapshotRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLDeleteModelSnapshot) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLDeleteModelSnapshot) WithFilterPath(v ...string) func(*XPackMLDeleteModelSnapshotRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLDeleteModelSnapshot) WithHeader ¶ added in v6.8.2 

func (f XPackMLDeleteModelSnapshot) WithHeader(h map[string]string) func(*XPackMLDeleteModelSnapshotRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLDeleteModelSnapshot) WithHuman ¶ added in v6.8.2 

func (f XPackMLDeleteModelSnapshot) WithHuman() func(*XPackMLDeleteModelSnapshotRequest)

WithHuman makes statistical values human-readable.

func (XPackMLDeleteModelSnapshot) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLDeleteModelSnapshot) WithOpaqueID(s string) func(*XPackMLDeleteModelSnapshotRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLDeleteModelSnapshot) WithPretty ¶ added in v6.8.2 

func (f XPackMLDeleteModelSnapshot) WithPretty() func(*XPackMLDeleteModelSnapshotRequest)

WithPretty makes the response body pretty-printed.

type XPackMLDeleteModelSnapshotRequest ¶ added in v6.8.2 

type XPackMLDeleteModelSnapshotRequest struct {
	JobID      string
	SnapshotID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLDeleteModelSnapshotRequest configures the X PackML Delete Model Snapshot API request.

func (XPackMLDeleteModelSnapshotRequest) Do ¶ added in v6.8.2 

func (r XPackMLDeleteModelSnapshotRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLFindFileStructure ¶ added in v6.8.2 

type XPackMLFindFileStructure func(body io.Reader, o ...func(*XPackMLFindFileStructureRequest)) (*Response, error)

XPackMLFindFileStructure - http://www.elastic.co/guide/en/elasticsearch/reference/6.7/ml-find-file-structure.html

func (XPackMLFindFileStructure) WithCharset ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithCharset(v string) func(*XPackMLFindFileStructureRequest)

WithCharset - optional parameter to specify the character set of the file.

func (XPackMLFindFileStructure) WithColumnNames ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithColumnNames(v ...string) func(*XPackMLFindFileStructureRequest)

WithColumnNames - optional parameter containing a comma separated list of the column names for a delimited file.

func (XPackMLFindFileStructure) WithContext ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithContext(v context.Context) func(*XPackMLFindFileStructureRequest)

WithContext sets the request context.

func (XPackMLFindFileStructure) WithDelimiter ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithDelimiter(v string) func(*XPackMLFindFileStructureRequest)

WithDelimiter - optional parameter to specify the delimiter character for a delimited file - must be a single character.

func (XPackMLFindFileStructure) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithErrorTrace() func(*XPackMLFindFileStructureRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLFindFileStructure) WithExplain ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithExplain(v bool) func(*XPackMLFindFileStructureRequest)

WithExplain - whether to include a commentary on how the structure was derived.

func (XPackMLFindFileStructure) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithFilterPath(v ...string) func(*XPackMLFindFileStructureRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLFindFileStructure) WithFormat ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithFormat(v string) func(*XPackMLFindFileStructureRequest)

WithFormat - optional parameter to specify the high level file format.

func (XPackMLFindFileStructure) WithGrokPattern ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithGrokPattern(v string) func(*XPackMLFindFileStructureRequest)

WithGrokPattern - optional parameter to specify the grok pattern that should be used to extract fields from messages in a semi-structured text file.

func (XPackMLFindFileStructure) WithHasHeaderRow ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithHasHeaderRow(v bool) func(*XPackMLFindFileStructureRequest)

WithHasHeaderRow - optional parameter to specify whether a delimited file includes the column names in its first row.

func (XPackMLFindFileStructure) WithHeader ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithHeader(h map[string]string) func(*XPackMLFindFileStructureRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLFindFileStructure) WithHuman ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithHuman() func(*XPackMLFindFileStructureRequest)

WithHuman makes statistical values human-readable.

func (XPackMLFindFileStructure) WithLinesToSample ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithLinesToSample(v int) func(*XPackMLFindFileStructureRequest)

WithLinesToSample - how many lines of the file should be included in the analysis.

func (XPackMLFindFileStructure) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLFindFileStructure) WithOpaqueID(s string) func(*XPackMLFindFileStructureRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLFindFileStructure) WithPretty ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithPretty() func(*XPackMLFindFileStructureRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLFindFileStructure) WithQuote ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithQuote(v string) func(*XPackMLFindFileStructureRequest)

WithQuote - optional parameter to specify the quote character for a delimited file - must be a single character.

func (XPackMLFindFileStructure) WithShouldTrimFields ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithShouldTrimFields(v bool) func(*XPackMLFindFileStructureRequest)

WithShouldTrimFields - optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them.

func (XPackMLFindFileStructure) WithTimeout ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithTimeout(v time.Duration) func(*XPackMLFindFileStructureRequest)

WithTimeout - timeout after which the analysis will be aborted.

func (XPackMLFindFileStructure) WithTimestampField ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithTimestampField(v string) func(*XPackMLFindFileStructureRequest)

WithTimestampField - optional parameter to specify the timestamp field in the file.

func (XPackMLFindFileStructure) WithTimestampFormat ¶ added in v6.8.2 

func (f XPackMLFindFileStructure) WithTimestampFormat(v string) func(*XPackMLFindFileStructureRequest)

WithTimestampFormat - optional parameter to specify the timestamp format in the file - may be either a joda or java time format.

type XPackMLFindFileStructureRequest ¶ added in v6.8.2 

type XPackMLFindFileStructureRequest struct {
	Body io.Reader

	Charset          string
	ColumnNames      []string
	Delimiter        string
	Explain          *bool
	Format           string
	GrokPattern      string
	HasHeaderRow     *bool
	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
}

XPackMLFindFileStructureRequest configures the X PackML Find File Structure API request.

func (XPackMLFindFileStructureRequest) Do ¶ added in v6.8.2 

func (r XPackMLFindFileStructureRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLFlushJob ¶ added in v6.8.2 

type XPackMLFlushJob func(job_id string, o ...func(*XPackMLFlushJobRequest)) (*Response, error)

XPackMLFlushJob - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html

func (XPackMLFlushJob) WithAdvanceTime ¶ added in v6.8.2 

func (f XPackMLFlushJob) WithAdvanceTime(v string) func(*XPackMLFlushJobRequest)

WithAdvanceTime - advances time to the given value generating results and updating the model for the advanced interval.

func (XPackMLFlushJob) WithBody ¶ added in v6.8.2 

func (f XPackMLFlushJob) WithBody(v io.Reader) func(*XPackMLFlushJobRequest)

WithBody - Flush parameters.

func (XPackMLFlushJob) WithCalcInterim ¶ added in v6.8.2 

func (f XPackMLFlushJob) WithCalcInterim(v bool) func(*XPackMLFlushJobRequest)

WithCalcInterim - calculates interim results for the most recent bucket or all buckets within the latency period.

func (XPackMLFlushJob) WithContext ¶ added in v6.8.2 

func (f XPackMLFlushJob) WithContext(v context.Context) func(*XPackMLFlushJobRequest)

WithContext sets the request context.

func (XPackMLFlushJob) WithEnd ¶ added in v6.8.2 

func (f XPackMLFlushJob) WithEnd(v string) func(*XPackMLFlushJobRequest)

WithEnd - when used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results.

func (XPackMLFlushJob) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLFlushJob) WithErrorTrace() func(*XPackMLFlushJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLFlushJob) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLFlushJob) WithFilterPath(v ...string) func(*XPackMLFlushJobRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLFlushJob) WithHeader ¶ added in v6.8.2 

func (f XPackMLFlushJob) WithHeader(h map[string]string) func(*XPackMLFlushJobRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLFlushJob) WithHuman ¶ added in v6.8.2 

func (f XPackMLFlushJob) WithHuman() func(*XPackMLFlushJobRequest)

WithHuman makes statistical values human-readable.

func (XPackMLFlushJob) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLFlushJob) WithOpaqueID(s string) func(*XPackMLFlushJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLFlushJob) WithPretty ¶ added in v6.8.2 

func (f XPackMLFlushJob) WithPretty() func(*XPackMLFlushJobRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLFlushJob) WithSkipTime ¶ added in v6.8.2 

func (f XPackMLFlushJob) WithSkipTime(v string) func(*XPackMLFlushJobRequest)

WithSkipTime - skips time to the given value without generating results or updating the model for the skipped interval.

func (XPackMLFlushJob) WithStart ¶ added in v6.8.2 

func (f XPackMLFlushJob) WithStart(v string) func(*XPackMLFlushJobRequest)

WithStart - when used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results.

type XPackMLFlushJobRequest ¶ added in v6.8.2 

type XPackMLFlushJobRequest 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
}

XPackMLFlushJobRequest configures the X PackML Flush Job API request.

func (XPackMLFlushJobRequest) Do ¶ added in v6.8.2 

func (r XPackMLFlushJobRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLForecast ¶ added in v6.8.2 

type XPackMLForecast func(job_id string, o ...func(*XPackMLForecastRequest)) (*Response, error)

XPackMLForecast -

func (XPackMLForecast) WithContext ¶ added in v6.8.2 

func (f XPackMLForecast) WithContext(v context.Context) func(*XPackMLForecastRequest)

WithContext sets the request context.

func (XPackMLForecast) WithDuration ¶ added in v6.8.2 

func (f XPackMLForecast) WithDuration(v time.Duration) func(*XPackMLForecastRequest)

WithDuration - the duration of the forecast.

func (XPackMLForecast) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLForecast) WithErrorTrace() func(*XPackMLForecastRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLForecast) WithExpiresIn ¶ added in v6.8.2 

func (f XPackMLForecast) WithExpiresIn(v time.Duration) func(*XPackMLForecastRequest)

WithExpiresIn - the time interval after which the forecast expires. expired forecasts will be deleted at the first opportunity..

func (XPackMLForecast) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLForecast) WithFilterPath(v ...string) func(*XPackMLForecastRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLForecast) WithHeader ¶ added in v6.8.2 

func (f XPackMLForecast) WithHeader(h map[string]string) func(*XPackMLForecastRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLForecast) WithHuman ¶ added in v6.8.2 

func (f XPackMLForecast) WithHuman() func(*XPackMLForecastRequest)

WithHuman makes statistical values human-readable.

func (XPackMLForecast) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLForecast) WithOpaqueID(s string) func(*XPackMLForecastRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLForecast) WithPretty ¶ added in v6.8.2 

func (f XPackMLForecast) WithPretty() func(*XPackMLForecastRequest)

WithPretty makes the response body pretty-printed.

type XPackMLForecastRequest ¶ added in v6.8.2 

type XPackMLForecastRequest 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
}

XPackMLForecastRequest configures the X PackML Forecast API request.

func (XPackMLForecastRequest) Do ¶ added in v6.8.2 

func (r XPackMLForecastRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLGetBuckets ¶ added in v6.8.2 

type XPackMLGetBuckets func(job_id string, o ...func(*XPackMLGetBucketsRequest)) (*Response, error)

XPackMLGetBuckets - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html

func (XPackMLGetBuckets) WithAnomalyScore ¶ added in v6.8.2 

func (f XPackMLGetBuckets) WithAnomalyScore(v interface{}) func(*XPackMLGetBucketsRequest)

WithAnomalyScore - filter for the most anomalous buckets.

func (XPackMLGetBuckets) WithBody ¶ added in v6.8.2 

func (f XPackMLGetBuckets) WithBody(v io.Reader) func(*XPackMLGetBucketsRequest)

WithBody - Bucket selection details if not provided in URI.

func (XPackMLGetBuckets) WithContext ¶ added in v6.8.2 

func (f XPackMLGetBuckets) WithContext(v context.Context) func(*XPackMLGetBucketsRequest)

WithContext sets the request context.

func (XPackMLGetBuckets) WithDesc ¶ added in v6.8.2 

func (f XPackMLGetBuckets) WithDesc(v bool) func(*XPackMLGetBucketsRequest)

WithDesc - set the sort direction.

func (XPackMLGetBuckets) WithEnd ¶ added in v6.8.2 

func (f XPackMLGetBuckets) WithEnd(v string) func(*XPackMLGetBucketsRequest)

WithEnd - end time filter for buckets.

func (XPackMLGetBuckets) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLGetBuckets) WithErrorTrace() func(*XPackMLGetBucketsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLGetBuckets) WithExcludeInterim ¶ added in v6.8.2 

func (f XPackMLGetBuckets) WithExcludeInterim(v bool) func(*XPackMLGetBucketsRequest)

WithExcludeInterim - exclude interim results.

func (XPackMLGetBuckets) WithExpand ¶ added in v6.8.2 

func (f XPackMLGetBuckets) WithExpand(v bool) func(*XPackMLGetBucketsRequest)

WithExpand - include anomaly records.

func (XPackMLGetBuckets) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLGetBuckets) WithFilterPath(v ...string) func(*XPackMLGetBucketsRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLGetBuckets) WithFrom ¶ added in v6.8.2 

func (f XPackMLGetBuckets) WithFrom(v int) func(*XPackMLGetBucketsRequest)

WithFrom - skips a number of buckets.

func (XPackMLGetBuckets) WithHeader ¶ added in v6.8.2 

func (f XPackMLGetBuckets) WithHeader(h map[string]string) func(*XPackMLGetBucketsRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLGetBuckets) WithHuman ¶ added in v6.8.2 

func (f XPackMLGetBuckets) WithHuman() func(*XPackMLGetBucketsRequest)

WithHuman makes statistical values human-readable.

func (XPackMLGetBuckets) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLGetBuckets) WithOpaqueID(s string) func(*XPackMLGetBucketsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLGetBuckets) WithPretty ¶ added in v6.8.2 

func (f XPackMLGetBuckets) WithPretty() func(*XPackMLGetBucketsRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLGetBuckets) WithSize ¶ added in v6.8.2 

func (f XPackMLGetBuckets) WithSize(v int) func(*XPackMLGetBucketsRequest)

WithSize - specifies a max number of buckets to get.

func (XPackMLGetBuckets) WithSort ¶ added in v6.8.2 

func (f XPackMLGetBuckets) WithSort(v string) func(*XPackMLGetBucketsRequest)

WithSort - sort buckets by a particular field.

func (XPackMLGetBuckets) WithStart ¶ added in v6.8.2 

func (f XPackMLGetBuckets) WithStart(v string) func(*XPackMLGetBucketsRequest)

WithStart - start time filter for buckets.

func (XPackMLGetBuckets) WithTimestamp ¶ added in v6.8.2 

func (f XPackMLGetBuckets) WithTimestamp(v string) func(*XPackMLGetBucketsRequest)

WithTimestamp - the timestamp of the desired single bucket result.

type XPackMLGetBucketsRequest ¶ added in v6.8.2 

type XPackMLGetBucketsRequest 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
}

XPackMLGetBucketsRequest configures the X PackML Get Buckets API request.

func (XPackMLGetBucketsRequest) Do ¶ added in v6.8.2 

func (r XPackMLGetBucketsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLGetCalendarEvents ¶ added in v6.8.2 

type XPackMLGetCalendarEvents func(calendar_id string, o ...func(*XPackMLGetCalendarEventsRequest)) (*Response, error)

XPackMLGetCalendarEvents -

func (XPackMLGetCalendarEvents) WithContext ¶ added in v6.8.2 

func (f XPackMLGetCalendarEvents) WithContext(v context.Context) func(*XPackMLGetCalendarEventsRequest)

WithContext sets the request context.

func (XPackMLGetCalendarEvents) WithEnd ¶ added in v6.8.2 

func (f XPackMLGetCalendarEvents) WithEnd(v interface{}) func(*XPackMLGetCalendarEventsRequest)

WithEnd - get events before this time.

func (XPackMLGetCalendarEvents) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLGetCalendarEvents) WithErrorTrace() func(*XPackMLGetCalendarEventsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLGetCalendarEvents) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLGetCalendarEvents) WithFilterPath(v ...string) func(*XPackMLGetCalendarEventsRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLGetCalendarEvents) WithFrom ¶ added in v6.8.2 

func (f XPackMLGetCalendarEvents) WithFrom(v int) func(*XPackMLGetCalendarEventsRequest)

WithFrom - skips a number of events.

func (XPackMLGetCalendarEvents) WithHeader ¶ added in v6.8.2 

func (f XPackMLGetCalendarEvents) WithHeader(h map[string]string) func(*XPackMLGetCalendarEventsRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLGetCalendarEvents) WithHuman ¶ added in v6.8.2 

func (f XPackMLGetCalendarEvents) WithHuman() func(*XPackMLGetCalendarEventsRequest)

WithHuman makes statistical values human-readable.

func (XPackMLGetCalendarEvents) WithJobID ¶ added in v6.8.2 

func (f XPackMLGetCalendarEvents) WithJobID(v string) func(*XPackMLGetCalendarEventsRequest)

WithJobID - get events for the job. when this option is used calendar_id must be '_all'.

func (XPackMLGetCalendarEvents) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLGetCalendarEvents) WithOpaqueID(s string) func(*XPackMLGetCalendarEventsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLGetCalendarEvents) WithPretty ¶ added in v6.8.2 

func (f XPackMLGetCalendarEvents) WithPretty() func(*XPackMLGetCalendarEventsRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLGetCalendarEvents) WithSize ¶ added in v6.8.2 

func (f XPackMLGetCalendarEvents) WithSize(v int) func(*XPackMLGetCalendarEventsRequest)

WithSize - specifies a max number of events to get.

func (XPackMLGetCalendarEvents) WithStart ¶ added in v6.8.2 

func (f XPackMLGetCalendarEvents) WithStart(v string) func(*XPackMLGetCalendarEventsRequest)

WithStart - get events after this time.

type XPackMLGetCalendarEventsRequest ¶ added in v6.8.2 

type XPackMLGetCalendarEventsRequest 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
}

XPackMLGetCalendarEventsRequest configures the X PackML Get Calendar Events API request.

func (XPackMLGetCalendarEventsRequest) Do ¶ added in v6.8.2 

func (r XPackMLGetCalendarEventsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLGetCalendars ¶ added in v6.8.2 

type XPackMLGetCalendars func(o ...func(*XPackMLGetCalendarsRequest)) (*Response, error)

XPackMLGetCalendars -

func (XPackMLGetCalendars) WithCalendarID ¶ added in v6.8.2 

func (f XPackMLGetCalendars) WithCalendarID(v string) func(*XPackMLGetCalendarsRequest)

WithCalendarID - the ID of the calendar to fetch.

func (XPackMLGetCalendars) WithContext ¶ added in v6.8.2 

func (f XPackMLGetCalendars) WithContext(v context.Context) func(*XPackMLGetCalendarsRequest)

WithContext sets the request context.

func (XPackMLGetCalendars) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLGetCalendars) WithErrorTrace() func(*XPackMLGetCalendarsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLGetCalendars) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLGetCalendars) WithFilterPath(v ...string) func(*XPackMLGetCalendarsRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLGetCalendars) WithFrom ¶ added in v6.8.2 

func (f XPackMLGetCalendars) WithFrom(v int) func(*XPackMLGetCalendarsRequest)

WithFrom - skips a number of calendars.

func (XPackMLGetCalendars) WithHeader ¶ added in v6.8.2 

func (f XPackMLGetCalendars) WithHeader(h map[string]string) func(*XPackMLGetCalendarsRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLGetCalendars) WithHuman ¶ added in v6.8.2 

func (f XPackMLGetCalendars) WithHuman() func(*XPackMLGetCalendarsRequest)

WithHuman makes statistical values human-readable.

func (XPackMLGetCalendars) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLGetCalendars) WithOpaqueID(s string) func(*XPackMLGetCalendarsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLGetCalendars) WithPretty ¶ added in v6.8.2 

func (f XPackMLGetCalendars) WithPretty() func(*XPackMLGetCalendarsRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLGetCalendars) WithSize ¶ added in v6.8.2 

func (f XPackMLGetCalendars) WithSize(v int) func(*XPackMLGetCalendarsRequest)

WithSize - specifies a max number of calendars to get.

type XPackMLGetCalendarsRequest ¶ added in v6.8.2 

type XPackMLGetCalendarsRequest struct {
	CalendarID string

	From *int
	Size *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLGetCalendarsRequest configures the X PackML Get Calendars API request.

func (XPackMLGetCalendarsRequest) Do ¶ added in v6.8.2 

func (r XPackMLGetCalendarsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLGetCategories ¶ added in v6.8.2 

type XPackMLGetCategories func(job_id string, o ...func(*XPackMLGetCategoriesRequest)) (*Response, error)

XPackMLGetCategories - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html

func (XPackMLGetCategories) WithBody ¶ added in v6.8.2 

func (f XPackMLGetCategories) WithBody(v io.Reader) func(*XPackMLGetCategoriesRequest)

WithBody - Category selection details if not provided in URI.

func (XPackMLGetCategories) WithCategoryID ¶ added in v6.8.2 

func (f XPackMLGetCategories) WithCategoryID(v int) func(*XPackMLGetCategoriesRequest)

WithCategoryID - the identifier of the category definition of interest.

func (XPackMLGetCategories) WithContext ¶ added in v6.8.2 

func (f XPackMLGetCategories) WithContext(v context.Context) func(*XPackMLGetCategoriesRequest)

WithContext sets the request context.

func (XPackMLGetCategories) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLGetCategories) WithErrorTrace() func(*XPackMLGetCategoriesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLGetCategories) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLGetCategories) WithFilterPath(v ...string) func(*XPackMLGetCategoriesRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLGetCategories) WithFrom ¶ added in v6.8.2 

func (f XPackMLGetCategories) WithFrom(v int) func(*XPackMLGetCategoriesRequest)

WithFrom - skips a number of categories.

func (XPackMLGetCategories) WithHeader ¶ added in v6.8.2 

func (f XPackMLGetCategories) WithHeader(h map[string]string) func(*XPackMLGetCategoriesRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLGetCategories) WithHuman ¶ added in v6.8.2 

func (f XPackMLGetCategories) WithHuman() func(*XPackMLGetCategoriesRequest)

WithHuman makes statistical values human-readable.

func (XPackMLGetCategories) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLGetCategories) WithOpaqueID(s string) func(*XPackMLGetCategoriesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLGetCategories) WithPretty ¶ added in v6.8.2 

func (f XPackMLGetCategories) WithPretty() func(*XPackMLGetCategoriesRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLGetCategories) WithSize ¶ added in v6.8.2 

func (f XPackMLGetCategories) WithSize(v int) func(*XPackMLGetCategoriesRequest)

WithSize - specifies a max number of categories to get.

type XPackMLGetCategoriesRequest ¶ added in v6.8.2 

type XPackMLGetCategoriesRequest 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
}

XPackMLGetCategoriesRequest configures the X PackML Get Categories API request.

func (XPackMLGetCategoriesRequest) Do ¶ added in v6.8.2 

func (r XPackMLGetCategoriesRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLGetDatafeedStats ¶ added in v6.8.2 

type XPackMLGetDatafeedStats func(o ...func(*XPackMLGetDatafeedStatsRequest)) (*Response, error)

XPackMLGetDatafeedStats - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html

func (XPackMLGetDatafeedStats) WithAllowNoDatafeeds ¶ added in v6.8.2 

func (f XPackMLGetDatafeedStats) WithAllowNoDatafeeds(v bool) func(*XPackMLGetDatafeedStatsRequest)

WithAllowNoDatafeeds - whether to ignore if a wildcard expression matches no datafeeds. (this includes `_all` string or when no datafeeds have been specified).

func (XPackMLGetDatafeedStats) WithContext ¶ added in v6.8.2 

func (f XPackMLGetDatafeedStats) WithContext(v context.Context) func(*XPackMLGetDatafeedStatsRequest)

WithContext sets the request context.

func (XPackMLGetDatafeedStats) WithDatafeedID ¶ added in v6.8.2 

func (f XPackMLGetDatafeedStats) WithDatafeedID(v string) func(*XPackMLGetDatafeedStatsRequest)

WithDatafeedID - the ID of the datafeeds stats to fetch.

func (XPackMLGetDatafeedStats) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLGetDatafeedStats) WithErrorTrace() func(*XPackMLGetDatafeedStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLGetDatafeedStats) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLGetDatafeedStats) WithFilterPath(v ...string) func(*XPackMLGetDatafeedStatsRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLGetDatafeedStats) WithHeader ¶ added in v6.8.2 

func (f XPackMLGetDatafeedStats) WithHeader(h map[string]string) func(*XPackMLGetDatafeedStatsRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLGetDatafeedStats) WithHuman ¶ added in v6.8.2 

func (f XPackMLGetDatafeedStats) WithHuman() func(*XPackMLGetDatafeedStatsRequest)

WithHuman makes statistical values human-readable.

func (XPackMLGetDatafeedStats) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLGetDatafeedStats) WithOpaqueID(s string) func(*XPackMLGetDatafeedStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLGetDatafeedStats) WithPretty ¶ added in v6.8.2 

func (f XPackMLGetDatafeedStats) WithPretty() func(*XPackMLGetDatafeedStatsRequest)

WithPretty makes the response body pretty-printed.

type XPackMLGetDatafeedStatsRequest ¶ added in v6.8.2 

type XPackMLGetDatafeedStatsRequest struct {
	DatafeedID string

	AllowNoDatafeeds *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLGetDatafeedStatsRequest configures the X PackML Get Datafeed Stats API request.

func (XPackMLGetDatafeedStatsRequest) Do ¶ added in v6.8.2 

func (r XPackMLGetDatafeedStatsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLGetDatafeeds ¶ added in v6.8.2 

type XPackMLGetDatafeeds func(o ...func(*XPackMLGetDatafeedsRequest)) (*Response, error)

XPackMLGetDatafeeds - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html

func (XPackMLGetDatafeeds) WithAllowNoDatafeeds ¶ added in v6.8.2 

func (f XPackMLGetDatafeeds) WithAllowNoDatafeeds(v bool) func(*XPackMLGetDatafeedsRequest)

WithAllowNoDatafeeds - whether to ignore if a wildcard expression matches no datafeeds. (this includes `_all` string or when no datafeeds have been specified).

func (XPackMLGetDatafeeds) WithContext ¶ added in v6.8.2 

func (f XPackMLGetDatafeeds) WithContext(v context.Context) func(*XPackMLGetDatafeedsRequest)

WithContext sets the request context.

func (XPackMLGetDatafeeds) WithDatafeedID ¶ added in v6.8.2 

func (f XPackMLGetDatafeeds) WithDatafeedID(v string) func(*XPackMLGetDatafeedsRequest)

WithDatafeedID - the ID of the datafeeds to fetch.

func (XPackMLGetDatafeeds) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLGetDatafeeds) WithErrorTrace() func(*XPackMLGetDatafeedsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLGetDatafeeds) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLGetDatafeeds) WithFilterPath(v ...string) func(*XPackMLGetDatafeedsRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLGetDatafeeds) WithHeader ¶ added in v6.8.2 

func (f XPackMLGetDatafeeds) WithHeader(h map[string]string) func(*XPackMLGetDatafeedsRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLGetDatafeeds) WithHuman ¶ added in v6.8.2 

func (f XPackMLGetDatafeeds) WithHuman() func(*XPackMLGetDatafeedsRequest)

WithHuman makes statistical values human-readable.

func (XPackMLGetDatafeeds) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLGetDatafeeds) WithOpaqueID(s string) func(*XPackMLGetDatafeedsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLGetDatafeeds) WithPretty ¶ added in v6.8.2 

func (f XPackMLGetDatafeeds) WithPretty() func(*XPackMLGetDatafeedsRequest)

WithPretty makes the response body pretty-printed.

type XPackMLGetDatafeedsRequest ¶ added in v6.8.2 

type XPackMLGetDatafeedsRequest struct {
	DatafeedID string

	AllowNoDatafeeds *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLGetDatafeedsRequest configures the X PackML Get Datafeeds API request.

func (XPackMLGetDatafeedsRequest) Do ¶ added in v6.8.2 

func (r XPackMLGetDatafeedsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLGetFilters ¶ added in v6.8.2 

type XPackMLGetFilters func(o ...func(*XPackMLGetFiltersRequest)) (*Response, error)

XPackMLGetFilters -

func (XPackMLGetFilters) WithContext ¶ added in v6.8.2 

func (f XPackMLGetFilters) WithContext(v context.Context) func(*XPackMLGetFiltersRequest)

WithContext sets the request context.

func (XPackMLGetFilters) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLGetFilters) WithErrorTrace() func(*XPackMLGetFiltersRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLGetFilters) WithFilterID ¶ added in v6.8.2 

func (f XPackMLGetFilters) WithFilterID(v string) func(*XPackMLGetFiltersRequest)

WithFilterID - the ID of the filter to fetch.

func (XPackMLGetFilters) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLGetFilters) WithFilterPath(v ...string) func(*XPackMLGetFiltersRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLGetFilters) WithFrom ¶ added in v6.8.2 

func (f XPackMLGetFilters) WithFrom(v int) func(*XPackMLGetFiltersRequest)

WithFrom - skips a number of filters.

func (XPackMLGetFilters) WithHeader ¶ added in v6.8.2 

func (f XPackMLGetFilters) WithHeader(h map[string]string) func(*XPackMLGetFiltersRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLGetFilters) WithHuman ¶ added in v6.8.2 

func (f XPackMLGetFilters) WithHuman() func(*XPackMLGetFiltersRequest)

WithHuman makes statistical values human-readable.

func (XPackMLGetFilters) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLGetFilters) WithOpaqueID(s string) func(*XPackMLGetFiltersRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLGetFilters) WithPretty ¶ added in v6.8.2 

func (f XPackMLGetFilters) WithPretty() func(*XPackMLGetFiltersRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLGetFilters) WithSize ¶ added in v6.8.2 

func (f XPackMLGetFilters) WithSize(v int) func(*XPackMLGetFiltersRequest)

WithSize - specifies a max number of filters to get.

type XPackMLGetFiltersRequest ¶ added in v6.8.2 

type XPackMLGetFiltersRequest struct {
	FilterID string

	From *int
	Size *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLGetFiltersRequest configures the X PackML Get Filters API request.

func (XPackMLGetFiltersRequest) Do ¶ added in v6.8.2 

func (r XPackMLGetFiltersRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLGetInfluencers ¶ added in v6.8.2 

type XPackMLGetInfluencers func(job_id string, o ...func(*XPackMLGetInfluencersRequest)) (*Response, error)

XPackMLGetInfluencers - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html

func (XPackMLGetInfluencers) WithBody ¶ added in v6.8.2 

func (f XPackMLGetInfluencers) WithBody(v io.Reader) func(*XPackMLGetInfluencersRequest)

WithBody - Influencer selection criteria.

func (XPackMLGetInfluencers) WithContext ¶ added in v6.8.2 

func (f XPackMLGetInfluencers) WithContext(v context.Context) func(*XPackMLGetInfluencersRequest)

WithContext sets the request context.

func (XPackMLGetInfluencers) WithDesc ¶ added in v6.8.2 

func (f XPackMLGetInfluencers) WithDesc(v bool) func(*XPackMLGetInfluencersRequest)

WithDesc - whether the results should be sorted in decending order.

func (XPackMLGetInfluencers) WithEnd ¶ added in v6.8.2 

func (f XPackMLGetInfluencers) WithEnd(v string) func(*XPackMLGetInfluencersRequest)

WithEnd - end timestamp for the requested influencers.

func (XPackMLGetInfluencers) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLGetInfluencers) WithErrorTrace() func(*XPackMLGetInfluencersRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLGetInfluencers) WithExcludeInterim ¶ added in v6.8.2 

func (f XPackMLGetInfluencers) WithExcludeInterim(v bool) func(*XPackMLGetInfluencersRequest)

WithExcludeInterim - exclude interim results.

func (XPackMLGetInfluencers) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLGetInfluencers) WithFilterPath(v ...string) func(*XPackMLGetInfluencersRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLGetInfluencers) WithFrom ¶ added in v6.8.2 

func (f XPackMLGetInfluencers) WithFrom(v int) func(*XPackMLGetInfluencersRequest)

WithFrom - skips a number of influencers.

func (XPackMLGetInfluencers) WithHeader ¶ added in v6.8.2 

func (f XPackMLGetInfluencers) WithHeader(h map[string]string) func(*XPackMLGetInfluencersRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLGetInfluencers) WithHuman ¶ added in v6.8.2 

func (f XPackMLGetInfluencers) WithHuman() func(*XPackMLGetInfluencersRequest)

WithHuman makes statistical values human-readable.

func (XPackMLGetInfluencers) WithInfluencerScore ¶ added in v6.8.2 

func (f XPackMLGetInfluencers) WithInfluencerScore(v interface{}) func(*XPackMLGetInfluencersRequest)

WithInfluencerScore - influencer score threshold for the requested influencers.

func (XPackMLGetInfluencers) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLGetInfluencers) WithOpaqueID(s string) func(*XPackMLGetInfluencersRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLGetInfluencers) WithPretty ¶ added in v6.8.2 

func (f XPackMLGetInfluencers) WithPretty() func(*XPackMLGetInfluencersRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLGetInfluencers) WithSize ¶ added in v6.8.2 

func (f XPackMLGetInfluencers) WithSize(v int) func(*XPackMLGetInfluencersRequest)

WithSize - specifies a max number of influencers to get.

func (XPackMLGetInfluencers) WithSort ¶ added in v6.8.2 

func (f XPackMLGetInfluencers) WithSort(v string) func(*XPackMLGetInfluencersRequest)

WithSort - sort field for the requested influencers.

func (XPackMLGetInfluencers) WithStart ¶ added in v6.8.2 

func (f XPackMLGetInfluencers) WithStart(v string) func(*XPackMLGetInfluencersRequest)

WithStart - start timestamp for the requested influencers.

type XPackMLGetInfluencersRequest ¶ added in v6.8.2 

type XPackMLGetInfluencersRequest 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
}

XPackMLGetInfluencersRequest configures the X PackML Get Influencers API request.

func (XPackMLGetInfluencersRequest) Do ¶ added in v6.8.2 

func (r XPackMLGetInfluencersRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLGetJobStats ¶ added in v6.8.2 

type XPackMLGetJobStats func(o ...func(*XPackMLGetJobStatsRequest)) (*Response, error)

XPackMLGetJobStats - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html

func (XPackMLGetJobStats) WithAllowNoJobs ¶ added in v6.8.2 

func (f XPackMLGetJobStats) WithAllowNoJobs(v bool) func(*XPackMLGetJobStatsRequest)

WithAllowNoJobs - whether to ignore if a wildcard expression matches no jobs. (this includes `_all` string or when no jobs have been specified).

func (XPackMLGetJobStats) WithContext ¶ added in v6.8.2 

func (f XPackMLGetJobStats) WithContext(v context.Context) func(*XPackMLGetJobStatsRequest)

WithContext sets the request context.

func (XPackMLGetJobStats) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLGetJobStats) WithErrorTrace() func(*XPackMLGetJobStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLGetJobStats) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLGetJobStats) WithFilterPath(v ...string) func(*XPackMLGetJobStatsRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLGetJobStats) WithHeader ¶ added in v6.8.2 

func (f XPackMLGetJobStats) WithHeader(h map[string]string) func(*XPackMLGetJobStatsRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLGetJobStats) WithHuman ¶ added in v6.8.2 

func (f XPackMLGetJobStats) WithHuman() func(*XPackMLGetJobStatsRequest)

WithHuman makes statistical values human-readable.

func (XPackMLGetJobStats) WithJobID ¶ added in v6.8.2 

func (f XPackMLGetJobStats) WithJobID(v string) func(*XPackMLGetJobStatsRequest)

WithJobID - the ID of the jobs stats to fetch.

func (XPackMLGetJobStats) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLGetJobStats) WithOpaqueID(s string) func(*XPackMLGetJobStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLGetJobStats) WithPretty ¶ added in v6.8.2 

func (f XPackMLGetJobStats) WithPretty() func(*XPackMLGetJobStatsRequest)

WithPretty makes the response body pretty-printed.

type XPackMLGetJobStatsRequest ¶ added in v6.8.2 

type XPackMLGetJobStatsRequest struct {
	JobID string

	AllowNoJobs *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLGetJobStatsRequest configures the X PackML Get Job Stats API request.

func (XPackMLGetJobStatsRequest) Do ¶ added in v6.8.2 

func (r XPackMLGetJobStatsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLGetJobs ¶ added in v6.8.2 

type XPackMLGetJobs func(o ...func(*XPackMLGetJobsRequest)) (*Response, error)

XPackMLGetJobs - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html

func (XPackMLGetJobs) WithAllowNoJobs ¶ added in v6.8.2 

func (f XPackMLGetJobs) WithAllowNoJobs(v bool) func(*XPackMLGetJobsRequest)

WithAllowNoJobs - whether to ignore if a wildcard expression matches no jobs. (this includes `_all` string or when no jobs have been specified).

func (XPackMLGetJobs) WithContext ¶ added in v6.8.2 

func (f XPackMLGetJobs) WithContext(v context.Context) func(*XPackMLGetJobsRequest)

WithContext sets the request context.

func (XPackMLGetJobs) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLGetJobs) WithErrorTrace() func(*XPackMLGetJobsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLGetJobs) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLGetJobs) WithFilterPath(v ...string) func(*XPackMLGetJobsRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLGetJobs) WithHeader ¶ added in v6.8.2 

func (f XPackMLGetJobs) WithHeader(h map[string]string) func(*XPackMLGetJobsRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLGetJobs) WithHuman ¶ added in v6.8.2 

func (f XPackMLGetJobs) WithHuman() func(*XPackMLGetJobsRequest)

WithHuman makes statistical values human-readable.

func (XPackMLGetJobs) WithJobID ¶ added in v6.8.2 

func (f XPackMLGetJobs) WithJobID(v string) func(*XPackMLGetJobsRequest)

WithJobID - the ID of the jobs to fetch.

func (XPackMLGetJobs) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLGetJobs) WithOpaqueID(s string) func(*XPackMLGetJobsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLGetJobs) WithPretty ¶ added in v6.8.2 

func (f XPackMLGetJobs) WithPretty() func(*XPackMLGetJobsRequest)

WithPretty makes the response body pretty-printed.

type XPackMLGetJobsRequest ¶ added in v6.8.2 

type XPackMLGetJobsRequest struct {
	JobID string

	AllowNoJobs *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLGetJobsRequest configures the X PackML Get Jobs API request.

func (XPackMLGetJobsRequest) Do ¶ added in v6.8.2 

func (r XPackMLGetJobsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLGetModelSnapshots ¶ added in v6.8.2 

type XPackMLGetModelSnapshots func(job_id string, o ...func(*XPackMLGetModelSnapshotsRequest)) (*Response, error)

XPackMLGetModelSnapshots - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html

func (XPackMLGetModelSnapshots) WithBody ¶ added in v6.8.2 

func (f XPackMLGetModelSnapshots) WithBody(v io.Reader) func(*XPackMLGetModelSnapshotsRequest)

WithBody - Model snapshot selection criteria.

func (XPackMLGetModelSnapshots) WithContext ¶ added in v6.8.2 

func (f XPackMLGetModelSnapshots) WithContext(v context.Context) func(*XPackMLGetModelSnapshotsRequest)

WithContext sets the request context.

func (XPackMLGetModelSnapshots) WithDesc ¶ added in v6.8.2 

func (f XPackMLGetModelSnapshots) WithDesc(v bool) func(*XPackMLGetModelSnapshotsRequest)

WithDesc - true if the results should be sorted in descending order.

func (XPackMLGetModelSnapshots) WithEnd ¶ added in v6.8.2 

func (f XPackMLGetModelSnapshots) WithEnd(v interface{}) func(*XPackMLGetModelSnapshotsRequest)

WithEnd - the filter 'end' query parameter.

func (XPackMLGetModelSnapshots) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLGetModelSnapshots) WithErrorTrace() func(*XPackMLGetModelSnapshotsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLGetModelSnapshots) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLGetModelSnapshots) WithFilterPath(v ...string) func(*XPackMLGetModelSnapshotsRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLGetModelSnapshots) WithFrom ¶ added in v6.8.2 

func (f XPackMLGetModelSnapshots) WithFrom(v int) func(*XPackMLGetModelSnapshotsRequest)

WithFrom - skips a number of documents.

func (XPackMLGetModelSnapshots) WithHeader ¶ added in v6.8.2 

func (f XPackMLGetModelSnapshots) WithHeader(h map[string]string) func(*XPackMLGetModelSnapshotsRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLGetModelSnapshots) WithHuman ¶ added in v6.8.2 

func (f XPackMLGetModelSnapshots) WithHuman() func(*XPackMLGetModelSnapshotsRequest)

WithHuman makes statistical values human-readable.

func (XPackMLGetModelSnapshots) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLGetModelSnapshots) WithOpaqueID(s string) func(*XPackMLGetModelSnapshotsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLGetModelSnapshots) WithPretty ¶ added in v6.8.2 

func (f XPackMLGetModelSnapshots) WithPretty() func(*XPackMLGetModelSnapshotsRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLGetModelSnapshots) WithSize ¶ added in v6.8.2 

func (f XPackMLGetModelSnapshots) WithSize(v int) func(*XPackMLGetModelSnapshotsRequest)

WithSize - the default number of documents returned in queries as a string..

func (XPackMLGetModelSnapshots) WithSnapshotID ¶ added in v6.8.2 

func (f XPackMLGetModelSnapshots) WithSnapshotID(v string) func(*XPackMLGetModelSnapshotsRequest)

WithSnapshotID - the ID of the snapshot to fetch.

func (XPackMLGetModelSnapshots) WithSort ¶ added in v6.8.2 

func (f XPackMLGetModelSnapshots) WithSort(v string) func(*XPackMLGetModelSnapshotsRequest)

WithSort - name of the field to sort on.

func (XPackMLGetModelSnapshots) WithStart ¶ added in v6.8.2 

func (f XPackMLGetModelSnapshots) WithStart(v interface{}) func(*XPackMLGetModelSnapshotsRequest)

WithStart - the filter 'start' query parameter.

type XPackMLGetModelSnapshotsRequest ¶ added in v6.8.2 

type XPackMLGetModelSnapshotsRequest 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
}

XPackMLGetModelSnapshotsRequest configures the X PackML Get Model Snapshots API request.

func (XPackMLGetModelSnapshotsRequest) Do ¶ added in v6.8.2 

func (r XPackMLGetModelSnapshotsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLGetOverallBuckets ¶ added in v6.8.2 

type XPackMLGetOverallBuckets func(job_id string, o ...func(*XPackMLGetOverallBucketsRequest)) (*Response, error)

XPackMLGetOverallBuckets - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html

func (XPackMLGetOverallBuckets) WithAllowNoJobs ¶ added in v6.8.2 

func (f XPackMLGetOverallBuckets) WithAllowNoJobs(v bool) func(*XPackMLGetOverallBucketsRequest)

WithAllowNoJobs - whether to ignore if a wildcard expression matches no jobs. (this includes `_all` string or when no jobs have been specified).

func (XPackMLGetOverallBuckets) WithBody ¶ added in v6.8.2 

func (f XPackMLGetOverallBuckets) WithBody(v io.Reader) func(*XPackMLGetOverallBucketsRequest)

WithBody - Overall bucket selection details if not provided in URI.

func (XPackMLGetOverallBuckets) WithBucketSpan ¶ added in v6.8.2 

func (f XPackMLGetOverallBuckets) WithBucketSpan(v string) func(*XPackMLGetOverallBucketsRequest)

WithBucketSpan - the span of the overall buckets. defaults to the longest job bucket_span.

func (XPackMLGetOverallBuckets) WithContext ¶ added in v6.8.2 

func (f XPackMLGetOverallBuckets) WithContext(v context.Context) func(*XPackMLGetOverallBucketsRequest)

WithContext sets the request context.

func (XPackMLGetOverallBuckets) WithEnd ¶ added in v6.8.2 

func (f XPackMLGetOverallBuckets) WithEnd(v string) func(*XPackMLGetOverallBucketsRequest)

WithEnd - returns overall buckets with timestamps earlier than this time.

func (XPackMLGetOverallBuckets) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLGetOverallBuckets) WithErrorTrace() func(*XPackMLGetOverallBucketsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLGetOverallBuckets) WithExcludeInterim ¶ added in v6.8.2 

func (f XPackMLGetOverallBuckets) WithExcludeInterim(v bool) func(*XPackMLGetOverallBucketsRequest)

WithExcludeInterim - if true overall buckets that include interim buckets will be excluded.

func (XPackMLGetOverallBuckets) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLGetOverallBuckets) WithFilterPath(v ...string) func(*XPackMLGetOverallBucketsRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLGetOverallBuckets) WithHeader ¶ added in v6.8.2 

func (f XPackMLGetOverallBuckets) WithHeader(h map[string]string) func(*XPackMLGetOverallBucketsRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLGetOverallBuckets) WithHuman ¶ added in v6.8.2 

func (f XPackMLGetOverallBuckets) WithHuman() func(*XPackMLGetOverallBucketsRequest)

WithHuman makes statistical values human-readable.

func (XPackMLGetOverallBuckets) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLGetOverallBuckets) WithOpaqueID(s string) func(*XPackMLGetOverallBucketsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLGetOverallBuckets) WithOverallScore ¶ added in v6.8.2 

func (f XPackMLGetOverallBuckets) WithOverallScore(v interface{}) func(*XPackMLGetOverallBucketsRequest)

WithOverallScore - returns overall buckets with overall scores higher than this value.

func (XPackMLGetOverallBuckets) WithPretty ¶ added in v6.8.2 

func (f XPackMLGetOverallBuckets) WithPretty() func(*XPackMLGetOverallBucketsRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLGetOverallBuckets) WithStart ¶ added in v6.8.2 

func (f XPackMLGetOverallBuckets) WithStart(v string) func(*XPackMLGetOverallBucketsRequest)

WithStart - returns overall buckets with timestamps after this time.

func (XPackMLGetOverallBuckets) WithTopN ¶ added in v6.8.2 

func (f XPackMLGetOverallBuckets) WithTopN(v int) func(*XPackMLGetOverallBucketsRequest)

WithTopN - the number of top job bucket scores to be used in the overall_score calculation.

type XPackMLGetOverallBucketsRequest ¶ added in v6.8.2 

type XPackMLGetOverallBucketsRequest 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
}

XPackMLGetOverallBucketsRequest configures the X PackML Get Overall Buckets API request.

func (XPackMLGetOverallBucketsRequest) Do ¶ added in v6.8.2 

func (r XPackMLGetOverallBucketsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLGetRecords ¶ added in v6.8.2 

type XPackMLGetRecords func(job_id string, o ...func(*XPackMLGetRecordsRequest)) (*Response, error)

XPackMLGetRecords - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html

func (XPackMLGetRecords) WithBody ¶ added in v6.8.2 

func (f XPackMLGetRecords) WithBody(v io.Reader) func(*XPackMLGetRecordsRequest)

WithBody - Record selection criteria.

func (XPackMLGetRecords) WithContext ¶ added in v6.8.2 

func (f XPackMLGetRecords) WithContext(v context.Context) func(*XPackMLGetRecordsRequest)

WithContext sets the request context.

func (XPackMLGetRecords) WithDesc ¶ added in v6.8.2 

func (f XPackMLGetRecords) WithDesc(v bool) func(*XPackMLGetRecordsRequest)

WithDesc - set the sort direction.

func (XPackMLGetRecords) WithEnd ¶ added in v6.8.2 

func (f XPackMLGetRecords) WithEnd(v string) func(*XPackMLGetRecordsRequest)

WithEnd - end time filter for records.

func (XPackMLGetRecords) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLGetRecords) WithErrorTrace() func(*XPackMLGetRecordsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLGetRecords) WithExcludeInterim ¶ added in v6.8.2 

func (f XPackMLGetRecords) WithExcludeInterim(v bool) func(*XPackMLGetRecordsRequest)

WithExcludeInterim - exclude interim results.

func (XPackMLGetRecords) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLGetRecords) WithFilterPath(v ...string) func(*XPackMLGetRecordsRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLGetRecords) WithFrom ¶ added in v6.8.2 

func (f XPackMLGetRecords) WithFrom(v int) func(*XPackMLGetRecordsRequest)

WithFrom - skips a number of records.

func (XPackMLGetRecords) WithHeader ¶ added in v6.8.2 

func (f XPackMLGetRecords) WithHeader(h map[string]string) func(*XPackMLGetRecordsRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLGetRecords) WithHuman ¶ added in v6.8.2 

func (f XPackMLGetRecords) WithHuman() func(*XPackMLGetRecordsRequest)

WithHuman makes statistical values human-readable.

func (XPackMLGetRecords) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLGetRecords) WithOpaqueID(s string) func(*XPackMLGetRecordsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLGetRecords) WithPretty ¶ added in v6.8.2 

func (f XPackMLGetRecords) WithPretty() func(*XPackMLGetRecordsRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLGetRecords) WithRecordScore ¶ added in v6.8.2 

func (f XPackMLGetRecords) WithRecordScore(v interface{}) func(*XPackMLGetRecordsRequest)

WithRecordScore - .

func (XPackMLGetRecords) WithSize ¶ added in v6.8.2 

func (f XPackMLGetRecords) WithSize(v int) func(*XPackMLGetRecordsRequest)

WithSize - specifies a max number of records to get.

func (XPackMLGetRecords) WithSort ¶ added in v6.8.2 

func (f XPackMLGetRecords) WithSort(v string) func(*XPackMLGetRecordsRequest)

WithSort - sort records by a particular field.

func (XPackMLGetRecords) WithStart ¶ added in v6.8.2 

func (f XPackMLGetRecords) WithStart(v string) func(*XPackMLGetRecordsRequest)

WithStart - start time filter for records.

type XPackMLGetRecordsRequest ¶ added in v6.8.2 

type XPackMLGetRecordsRequest 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
}

XPackMLGetRecordsRequest configures the X PackML Get Records API request.

func (XPackMLGetRecordsRequest) Do ¶ added in v6.8.2 

func (r XPackMLGetRecordsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLInfo ¶ added in v6.8.2 

type XPackMLInfo func(o ...func(*XPackMLInfoRequest)) (*Response, error)

XPackMLInfo -

func (XPackMLInfo) WithContext ¶ added in v6.8.2 

func (f XPackMLInfo) WithContext(v context.Context) func(*XPackMLInfoRequest)

WithContext sets the request context.

func (XPackMLInfo) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLInfo) WithErrorTrace() func(*XPackMLInfoRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLInfo) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLInfo) WithFilterPath(v ...string) func(*XPackMLInfoRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLInfo) WithHeader ¶ added in v6.8.2 

func (f XPackMLInfo) WithHeader(h map[string]string) func(*XPackMLInfoRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLInfo) WithHuman ¶ added in v6.8.2 

func (f XPackMLInfo) WithHuman() func(*XPackMLInfoRequest)

WithHuman makes statistical values human-readable.

func (XPackMLInfo) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLInfo) WithOpaqueID(s string) func(*XPackMLInfoRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLInfo) WithPretty ¶ added in v6.8.2 

func (f XPackMLInfo) WithPretty() func(*XPackMLInfoRequest)

WithPretty makes the response body pretty-printed.

type XPackMLInfoRequest ¶ added in v6.8.2 

type XPackMLInfoRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLInfoRequest configures the X PackML Info API request.

func (XPackMLInfoRequest) Do ¶ added in v6.8.2 

func (r XPackMLInfoRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLOpenJob ¶ added in v6.8.2 

type XPackMLOpenJob func(job_id string, o ...func(*XPackMLOpenJobRequest)) (*Response, error)

XPackMLOpenJob - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html

func (XPackMLOpenJob) WithContext ¶ added in v6.8.2 

func (f XPackMLOpenJob) WithContext(v context.Context) func(*XPackMLOpenJobRequest)

WithContext sets the request context.

func (XPackMLOpenJob) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLOpenJob) WithErrorTrace() func(*XPackMLOpenJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLOpenJob) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLOpenJob) WithFilterPath(v ...string) func(*XPackMLOpenJobRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLOpenJob) WithHeader ¶ added in v6.8.2 

func (f XPackMLOpenJob) WithHeader(h map[string]string) func(*XPackMLOpenJobRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLOpenJob) WithHuman ¶ added in v6.8.2 

func (f XPackMLOpenJob) WithHuman() func(*XPackMLOpenJobRequest)

WithHuman makes statistical values human-readable.

func (XPackMLOpenJob) WithIgnoreDowntime ¶ added in v6.8.2 

func (f XPackMLOpenJob) WithIgnoreDowntime(v bool) func(*XPackMLOpenJobRequest)

WithIgnoreDowntime - controls if gaps in data are treated as anomalous or as a maintenance window after a job re-start.

func (XPackMLOpenJob) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLOpenJob) WithOpaqueID(s string) func(*XPackMLOpenJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLOpenJob) WithPretty ¶ added in v6.8.2 

func (f XPackMLOpenJob) WithPretty() func(*XPackMLOpenJobRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLOpenJob) WithTimeout ¶ added in v6.8.2 

func (f XPackMLOpenJob) WithTimeout(v time.Duration) func(*XPackMLOpenJobRequest)

WithTimeout - controls the time to wait until a job has opened. default to 30 minutes.

type XPackMLOpenJobRequest ¶ added in v6.8.2 

type XPackMLOpenJobRequest struct {
	IgnoreDowntime *bool
	JobID          string
	Timeout        time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLOpenJobRequest configures the X PackML Open Job API request.

func (XPackMLOpenJobRequest) Do ¶ added in v6.8.2 

func (r XPackMLOpenJobRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLPostCalendarEvents ¶ added in v6.8.2 

type XPackMLPostCalendarEvents func(calendar_id string, body io.Reader, o ...func(*XPackMLPostCalendarEventsRequest)) (*Response, error)

XPackMLPostCalendarEvents -

func (XPackMLPostCalendarEvents) WithContext ¶ added in v6.8.2 

func (f XPackMLPostCalendarEvents) WithContext(v context.Context) func(*XPackMLPostCalendarEventsRequest)

WithContext sets the request context.

func (XPackMLPostCalendarEvents) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLPostCalendarEvents) WithErrorTrace() func(*XPackMLPostCalendarEventsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLPostCalendarEvents) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLPostCalendarEvents) WithFilterPath(v ...string) func(*XPackMLPostCalendarEventsRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLPostCalendarEvents) WithHeader ¶ added in v6.8.2 

func (f XPackMLPostCalendarEvents) WithHeader(h map[string]string) func(*XPackMLPostCalendarEventsRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLPostCalendarEvents) WithHuman ¶ added in v6.8.2 

func (f XPackMLPostCalendarEvents) WithHuman() func(*XPackMLPostCalendarEventsRequest)

WithHuman makes statistical values human-readable.

func (XPackMLPostCalendarEvents) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLPostCalendarEvents) WithOpaqueID(s string) func(*XPackMLPostCalendarEventsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLPostCalendarEvents) WithPretty ¶ added in v6.8.2 

func (f XPackMLPostCalendarEvents) WithPretty() func(*XPackMLPostCalendarEventsRequest)

WithPretty makes the response body pretty-printed.

type XPackMLPostCalendarEventsRequest ¶ added in v6.8.2 

type XPackMLPostCalendarEventsRequest struct {
	Body io.Reader

	CalendarID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLPostCalendarEventsRequest configures the X PackML Post Calendar Events API request.

func (XPackMLPostCalendarEventsRequest) Do ¶ added in v6.8.2 

func (r XPackMLPostCalendarEventsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLPostData ¶ added in v6.8.2 

type XPackMLPostData func(job_id string, body io.Reader, o ...func(*XPackMLPostDataRequest)) (*Response, error)

XPackMLPostData - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html

func (XPackMLPostData) WithContext ¶ added in v6.8.2 

func (f XPackMLPostData) WithContext(v context.Context) func(*XPackMLPostDataRequest)

WithContext sets the request context.

func (XPackMLPostData) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLPostData) WithErrorTrace() func(*XPackMLPostDataRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLPostData) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLPostData) WithFilterPath(v ...string) func(*XPackMLPostDataRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLPostData) WithHeader ¶ added in v6.8.2 

func (f XPackMLPostData) WithHeader(h map[string]string) func(*XPackMLPostDataRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLPostData) WithHuman ¶ added in v6.8.2 

func (f XPackMLPostData) WithHuman() func(*XPackMLPostDataRequest)

WithHuman makes statistical values human-readable.

func (XPackMLPostData) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLPostData) WithOpaqueID(s string) func(*XPackMLPostDataRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLPostData) WithPretty ¶ added in v6.8.2 

func (f XPackMLPostData) WithPretty() func(*XPackMLPostDataRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLPostData) WithResetEnd ¶ added in v6.8.2 

func (f XPackMLPostData) WithResetEnd(v string) func(*XPackMLPostDataRequest)

WithResetEnd - optional parameter to specify the end of the bucket resetting range.

func (XPackMLPostData) WithResetStart ¶ added in v6.8.2 

func (f XPackMLPostData) WithResetStart(v string) func(*XPackMLPostDataRequest)

WithResetStart - optional parameter to specify the start of the bucket resetting range.

type XPackMLPostDataRequest ¶ added in v6.8.2 

type XPackMLPostDataRequest 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
}

XPackMLPostDataRequest configures the X PackML Post Data API request.

func (XPackMLPostDataRequest) Do ¶ added in v6.8.2 

func (r XPackMLPostDataRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLPreviewDatafeed ¶ added in v6.8.2 

type XPackMLPreviewDatafeed func(datafeed_id string, o ...func(*XPackMLPreviewDatafeedRequest)) (*Response, error)

XPackMLPreviewDatafeed - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html

func (XPackMLPreviewDatafeed) WithContext ¶ added in v6.8.2 

func (f XPackMLPreviewDatafeed) WithContext(v context.Context) func(*XPackMLPreviewDatafeedRequest)

WithContext sets the request context.

func (XPackMLPreviewDatafeed) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLPreviewDatafeed) WithErrorTrace() func(*XPackMLPreviewDatafeedRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLPreviewDatafeed) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLPreviewDatafeed) WithFilterPath(v ...string) func(*XPackMLPreviewDatafeedRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLPreviewDatafeed) WithHeader ¶ added in v6.8.2 

func (f XPackMLPreviewDatafeed) WithHeader(h map[string]string) func(*XPackMLPreviewDatafeedRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLPreviewDatafeed) WithHuman ¶ added in v6.8.2 

func (f XPackMLPreviewDatafeed) WithHuman() func(*XPackMLPreviewDatafeedRequest)

WithHuman makes statistical values human-readable.

func (XPackMLPreviewDatafeed) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLPreviewDatafeed) WithOpaqueID(s string) func(*XPackMLPreviewDatafeedRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLPreviewDatafeed) WithPretty ¶ added in v6.8.2 

func (f XPackMLPreviewDatafeed) WithPretty() func(*XPackMLPreviewDatafeedRequest)

WithPretty makes the response body pretty-printed.

type XPackMLPreviewDatafeedRequest ¶ added in v6.8.2 

type XPackMLPreviewDatafeedRequest struct {
	DatafeedID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLPreviewDatafeedRequest configures the X PackML Preview Datafeed API request.

func (XPackMLPreviewDatafeedRequest) Do ¶ added in v6.8.2 

func (r XPackMLPreviewDatafeedRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLPutCalendar ¶ added in v6.8.2 

type XPackMLPutCalendar func(calendar_id string, o ...func(*XPackMLPutCalendarRequest)) (*Response, error)

XPackMLPutCalendar -

func (XPackMLPutCalendar) WithBody ¶ added in v6.8.2 

func (f XPackMLPutCalendar) WithBody(v io.Reader) func(*XPackMLPutCalendarRequest)

WithBody - The calendar details.

func (XPackMLPutCalendar) WithContext ¶ added in v6.8.2 

func (f XPackMLPutCalendar) WithContext(v context.Context) func(*XPackMLPutCalendarRequest)

WithContext sets the request context.

func (XPackMLPutCalendar) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLPutCalendar) WithErrorTrace() func(*XPackMLPutCalendarRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLPutCalendar) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLPutCalendar) WithFilterPath(v ...string) func(*XPackMLPutCalendarRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLPutCalendar) WithHeader ¶ added in v6.8.2 

func (f XPackMLPutCalendar) WithHeader(h map[string]string) func(*XPackMLPutCalendarRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLPutCalendar) WithHuman ¶ added in v6.8.2 

func (f XPackMLPutCalendar) WithHuman() func(*XPackMLPutCalendarRequest)

WithHuman makes statistical values human-readable.

func (XPackMLPutCalendar) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLPutCalendar) WithOpaqueID(s string) func(*XPackMLPutCalendarRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLPutCalendar) WithPretty ¶ added in v6.8.2 

func (f XPackMLPutCalendar) WithPretty() func(*XPackMLPutCalendarRequest)

WithPretty makes the response body pretty-printed.

type XPackMLPutCalendarJob ¶ added in v6.8.2 

type XPackMLPutCalendarJob func(calendar_id string, job_id string, o ...func(*XPackMLPutCalendarJobRequest)) (*Response, error)

XPackMLPutCalendarJob -

func (XPackMLPutCalendarJob) WithContext ¶ added in v6.8.2 

func (f XPackMLPutCalendarJob) WithContext(v context.Context) func(*XPackMLPutCalendarJobRequest)

WithContext sets the request context.

func (XPackMLPutCalendarJob) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLPutCalendarJob) WithErrorTrace() func(*XPackMLPutCalendarJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLPutCalendarJob) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLPutCalendarJob) WithFilterPath(v ...string) func(*XPackMLPutCalendarJobRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLPutCalendarJob) WithHeader ¶ added in v6.8.2 

func (f XPackMLPutCalendarJob) WithHeader(h map[string]string) func(*XPackMLPutCalendarJobRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLPutCalendarJob) WithHuman ¶ added in v6.8.2 

func (f XPackMLPutCalendarJob) WithHuman() func(*XPackMLPutCalendarJobRequest)

WithHuman makes statistical values human-readable.

func (XPackMLPutCalendarJob) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLPutCalendarJob) WithOpaqueID(s string) func(*XPackMLPutCalendarJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLPutCalendarJob) WithPretty ¶ added in v6.8.2 

func (f XPackMLPutCalendarJob) WithPretty() func(*XPackMLPutCalendarJobRequest)

WithPretty makes the response body pretty-printed.

type XPackMLPutCalendarJobRequest ¶ added in v6.8.2 

type XPackMLPutCalendarJobRequest struct {
	CalendarID string
	JobID      string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLPutCalendarJobRequest configures the X PackML Put Calendar Job API request.

func (XPackMLPutCalendarJobRequest) Do ¶ added in v6.8.2 

func (r XPackMLPutCalendarJobRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLPutCalendarRequest ¶ added in v6.8.2 

type XPackMLPutCalendarRequest struct {
	Body io.Reader

	CalendarID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLPutCalendarRequest configures the X PackML Put Calendar API request.

func (XPackMLPutCalendarRequest) Do ¶ added in v6.8.2 

func (r XPackMLPutCalendarRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLPutDatafeed ¶ added in v6.8.2 

type XPackMLPutDatafeed func(body io.Reader, datafeed_id string, o ...func(*XPackMLPutDatafeedRequest)) (*Response, error)

XPackMLPutDatafeed - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html

func (XPackMLPutDatafeed) WithContext ¶ added in v6.8.2 

func (f XPackMLPutDatafeed) WithContext(v context.Context) func(*XPackMLPutDatafeedRequest)

WithContext sets the request context.

func (XPackMLPutDatafeed) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLPutDatafeed) WithErrorTrace() func(*XPackMLPutDatafeedRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLPutDatafeed) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLPutDatafeed) WithFilterPath(v ...string) func(*XPackMLPutDatafeedRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLPutDatafeed) WithHeader ¶ added in v6.8.2 

func (f XPackMLPutDatafeed) WithHeader(h map[string]string) func(*XPackMLPutDatafeedRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLPutDatafeed) WithHuman ¶ added in v6.8.2 

func (f XPackMLPutDatafeed) WithHuman() func(*XPackMLPutDatafeedRequest)

WithHuman makes statistical values human-readable.

func (XPackMLPutDatafeed) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLPutDatafeed) WithOpaqueID(s string) func(*XPackMLPutDatafeedRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLPutDatafeed) WithPretty ¶ added in v6.8.2 

func (f XPackMLPutDatafeed) WithPretty() func(*XPackMLPutDatafeedRequest)

WithPretty makes the response body pretty-printed.

type XPackMLPutDatafeedRequest ¶ added in v6.8.2 

type XPackMLPutDatafeedRequest struct {
	Body io.Reader

	DatafeedID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLPutDatafeedRequest configures the X PackML Put Datafeed API request.

func (XPackMLPutDatafeedRequest) Do ¶ added in v6.8.2 

func (r XPackMLPutDatafeedRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLPutFilter ¶ added in v6.8.2 

type XPackMLPutFilter func(body io.Reader, filter_id string, o ...func(*XPackMLPutFilterRequest)) (*Response, error)

XPackMLPutFilter -

func (XPackMLPutFilter) WithContext ¶ added in v6.8.2 

func (f XPackMLPutFilter) WithContext(v context.Context) func(*XPackMLPutFilterRequest)

WithContext sets the request context.

func (XPackMLPutFilter) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLPutFilter) WithErrorTrace() func(*XPackMLPutFilterRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLPutFilter) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLPutFilter) WithFilterPath(v ...string) func(*XPackMLPutFilterRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLPutFilter) WithHeader ¶ added in v6.8.2 

func (f XPackMLPutFilter) WithHeader(h map[string]string) func(*XPackMLPutFilterRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLPutFilter) WithHuman ¶ added in v6.8.2 

func (f XPackMLPutFilter) WithHuman() func(*XPackMLPutFilterRequest)

WithHuman makes statistical values human-readable.

func (XPackMLPutFilter) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLPutFilter) WithOpaqueID(s string) func(*XPackMLPutFilterRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLPutFilter) WithPretty ¶ added in v6.8.2 

func (f XPackMLPutFilter) WithPretty() func(*XPackMLPutFilterRequest)

WithPretty makes the response body pretty-printed.

type XPackMLPutFilterRequest ¶ added in v6.8.2 

type XPackMLPutFilterRequest struct {
	Body io.Reader

	FilterID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLPutFilterRequest configures the X PackML Put Filter API request.

func (XPackMLPutFilterRequest) Do ¶ added in v6.8.2 

func (r XPackMLPutFilterRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLPutJob ¶ added in v6.8.2 

type XPackMLPutJob func(job_id string, body io.Reader, o ...func(*XPackMLPutJobRequest)) (*Response, error)

XPackMLPutJob - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html

func (XPackMLPutJob) WithContext ¶ added in v6.8.2 

func (f XPackMLPutJob) WithContext(v context.Context) func(*XPackMLPutJobRequest)

WithContext sets the request context.

func (XPackMLPutJob) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLPutJob) WithErrorTrace() func(*XPackMLPutJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLPutJob) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLPutJob) WithFilterPath(v ...string) func(*XPackMLPutJobRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLPutJob) WithHeader ¶ added in v6.8.2 

func (f XPackMLPutJob) WithHeader(h map[string]string) func(*XPackMLPutJobRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLPutJob) WithHuman ¶ added in v6.8.2 

func (f XPackMLPutJob) WithHuman() func(*XPackMLPutJobRequest)

WithHuman makes statistical values human-readable.

func (XPackMLPutJob) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLPutJob) WithOpaqueID(s string) func(*XPackMLPutJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLPutJob) WithPretty ¶ added in v6.8.2 

func (f XPackMLPutJob) WithPretty() func(*XPackMLPutJobRequest)

WithPretty makes the response body pretty-printed.

type XPackMLPutJobRequest ¶ added in v6.8.2 

type XPackMLPutJobRequest struct {
	Body io.Reader

	JobID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLPutJobRequest configures the X PackML Put Job API request.

func (XPackMLPutJobRequest) Do ¶ added in v6.8.2 

func (r XPackMLPutJobRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLRevertModelSnapshot ¶ added in v6.8.2 

type XPackMLRevertModelSnapshot func(snapshot_id string, job_id string, o ...func(*XPackMLRevertModelSnapshotRequest)) (*Response, error)

XPackMLRevertModelSnapshot - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html

func (XPackMLRevertModelSnapshot) WithBody ¶ added in v6.8.2 

func (f XPackMLRevertModelSnapshot) WithBody(v io.Reader) func(*XPackMLRevertModelSnapshotRequest)

WithBody - Reversion options.

func (XPackMLRevertModelSnapshot) WithContext ¶ added in v6.8.2 

func (f XPackMLRevertModelSnapshot) WithContext(v context.Context) func(*XPackMLRevertModelSnapshotRequest)

WithContext sets the request context.

func (XPackMLRevertModelSnapshot) WithDeleteInterveningResults ¶ added in v6.8.2 

func (f XPackMLRevertModelSnapshot) WithDeleteInterveningResults(v bool) func(*XPackMLRevertModelSnapshotRequest)

WithDeleteInterveningResults - should we reset the results back to the time of the snapshot?.

func (XPackMLRevertModelSnapshot) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLRevertModelSnapshot) WithErrorTrace() func(*XPackMLRevertModelSnapshotRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLRevertModelSnapshot) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLRevertModelSnapshot) WithFilterPath(v ...string) func(*XPackMLRevertModelSnapshotRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLRevertModelSnapshot) WithHeader ¶ added in v6.8.2 

func (f XPackMLRevertModelSnapshot) WithHeader(h map[string]string) func(*XPackMLRevertModelSnapshotRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLRevertModelSnapshot) WithHuman ¶ added in v6.8.2 

func (f XPackMLRevertModelSnapshot) WithHuman() func(*XPackMLRevertModelSnapshotRequest)

WithHuman makes statistical values human-readable.

func (XPackMLRevertModelSnapshot) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLRevertModelSnapshot) WithOpaqueID(s string) func(*XPackMLRevertModelSnapshotRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLRevertModelSnapshot) WithPretty ¶ added in v6.8.2 

func (f XPackMLRevertModelSnapshot) WithPretty() func(*XPackMLRevertModelSnapshotRequest)

WithPretty makes the response body pretty-printed.

type XPackMLRevertModelSnapshotRequest ¶ added in v6.8.2 

type XPackMLRevertModelSnapshotRequest 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
}

XPackMLRevertModelSnapshotRequest configures the X PackML Revert Model Snapshot API request.

func (XPackMLRevertModelSnapshotRequest) Do ¶ added in v6.8.2 

func (r XPackMLRevertModelSnapshotRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLSetUpgradeMode ¶ added in v6.8.2 

type XPackMLSetUpgradeMode func(o ...func(*XPackMLSetUpgradeModeRequest)) (*Response, error)

XPackMLSetUpgradeMode - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html

func (XPackMLSetUpgradeMode) WithContext ¶ added in v6.8.2 

func (f XPackMLSetUpgradeMode) WithContext(v context.Context) func(*XPackMLSetUpgradeModeRequest)

WithContext sets the request context.

func (XPackMLSetUpgradeMode) WithEnabled ¶ added in v6.8.2 

func (f XPackMLSetUpgradeMode) WithEnabled(v bool) func(*XPackMLSetUpgradeModeRequest)

WithEnabled - whether to enable upgrade_mode ml setting or not. defaults to false..

func (XPackMLSetUpgradeMode) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLSetUpgradeMode) WithErrorTrace() func(*XPackMLSetUpgradeModeRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLSetUpgradeMode) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLSetUpgradeMode) WithFilterPath(v ...string) func(*XPackMLSetUpgradeModeRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLSetUpgradeMode) WithHeader ¶ added in v6.8.2 

func (f XPackMLSetUpgradeMode) WithHeader(h map[string]string) func(*XPackMLSetUpgradeModeRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLSetUpgradeMode) WithHuman ¶ added in v6.8.2 

func (f XPackMLSetUpgradeMode) WithHuman() func(*XPackMLSetUpgradeModeRequest)

WithHuman makes statistical values human-readable.

func (XPackMLSetUpgradeMode) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLSetUpgradeMode) WithOpaqueID(s string) func(*XPackMLSetUpgradeModeRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLSetUpgradeMode) WithPretty ¶ added in v6.8.2 

func (f XPackMLSetUpgradeMode) WithPretty() func(*XPackMLSetUpgradeModeRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLSetUpgradeMode) WithTimeout ¶ added in v6.8.2 

func (f XPackMLSetUpgradeMode) WithTimeout(v time.Duration) func(*XPackMLSetUpgradeModeRequest)

WithTimeout - controls the time to wait before action times out. defaults to 30 seconds.

type XPackMLSetUpgradeModeRequest ¶ added in v6.8.2 

type XPackMLSetUpgradeModeRequest struct {
	Enabled *bool
	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLSetUpgradeModeRequest configures the X PackML Set Upgrade Mode API request.

func (XPackMLSetUpgradeModeRequest) Do ¶ added in v6.8.2 

func (r XPackMLSetUpgradeModeRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLStartDatafeed ¶ added in v6.8.2 

type XPackMLStartDatafeed func(datafeed_id string, o ...func(*XPackMLStartDatafeedRequest)) (*Response, error)

XPackMLStartDatafeed - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html

func (XPackMLStartDatafeed) WithBody ¶ added in v6.8.2 

func (f XPackMLStartDatafeed) WithBody(v io.Reader) func(*XPackMLStartDatafeedRequest)

WithBody - The start datafeed parameters.

func (XPackMLStartDatafeed) WithContext ¶ added in v6.8.2 

func (f XPackMLStartDatafeed) WithContext(v context.Context) func(*XPackMLStartDatafeedRequest)

WithContext sets the request context.

func (XPackMLStartDatafeed) WithEnd ¶ added in v6.8.2 

func (f XPackMLStartDatafeed) WithEnd(v string) func(*XPackMLStartDatafeedRequest)

WithEnd - the end time when the datafeed should stop. when not set, the datafeed continues in real time.

func (XPackMLStartDatafeed) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLStartDatafeed) WithErrorTrace() func(*XPackMLStartDatafeedRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLStartDatafeed) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLStartDatafeed) WithFilterPath(v ...string) func(*XPackMLStartDatafeedRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLStartDatafeed) WithHeader ¶ added in v6.8.2 

func (f XPackMLStartDatafeed) WithHeader(h map[string]string) func(*XPackMLStartDatafeedRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLStartDatafeed) WithHuman ¶ added in v6.8.2 

func (f XPackMLStartDatafeed) WithHuman() func(*XPackMLStartDatafeedRequest)

WithHuman makes statistical values human-readable.

func (XPackMLStartDatafeed) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLStartDatafeed) WithOpaqueID(s string) func(*XPackMLStartDatafeedRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLStartDatafeed) WithPretty ¶ added in v6.8.2 

func (f XPackMLStartDatafeed) WithPretty() func(*XPackMLStartDatafeedRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLStartDatafeed) WithStart ¶ added in v6.8.2 

func (f XPackMLStartDatafeed) WithStart(v string) func(*XPackMLStartDatafeedRequest)

WithStart - the start time from where the datafeed should begin.

func (XPackMLStartDatafeed) WithTimeout ¶ added in v6.8.2 

func (f XPackMLStartDatafeed) WithTimeout(v time.Duration) func(*XPackMLStartDatafeedRequest)

WithTimeout - controls the time to wait until a datafeed has started. default to 20 seconds.

type XPackMLStartDatafeedRequest ¶ added in v6.8.2 

type XPackMLStartDatafeedRequest 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
}

XPackMLStartDatafeedRequest configures the X PackML Start Datafeed API request.

func (XPackMLStartDatafeedRequest) Do ¶ added in v6.8.2 

func (r XPackMLStartDatafeedRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLStopDatafeed ¶ added in v6.8.2 

type XPackMLStopDatafeed func(datafeed_id string, o ...func(*XPackMLStopDatafeedRequest)) (*Response, error)

XPackMLStopDatafeed - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html

func (XPackMLStopDatafeed) WithAllowNoDatafeeds ¶ added in v6.8.2 

func (f XPackMLStopDatafeed) WithAllowNoDatafeeds(v bool) func(*XPackMLStopDatafeedRequest)

WithAllowNoDatafeeds - whether to ignore if a wildcard expression matches no datafeeds. (this includes `_all` string or when no datafeeds have been specified).

func (XPackMLStopDatafeed) WithContext ¶ added in v6.8.2 

func (f XPackMLStopDatafeed) WithContext(v context.Context) func(*XPackMLStopDatafeedRequest)

WithContext sets the request context.

func (XPackMLStopDatafeed) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLStopDatafeed) WithErrorTrace() func(*XPackMLStopDatafeedRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLStopDatafeed) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLStopDatafeed) WithFilterPath(v ...string) func(*XPackMLStopDatafeedRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLStopDatafeed) WithForce ¶ added in v6.8.2 

func (f XPackMLStopDatafeed) WithForce(v bool) func(*XPackMLStopDatafeedRequest)

WithForce - true if the datafeed should be forcefully stopped..

func (XPackMLStopDatafeed) WithHeader ¶ added in v6.8.2 

func (f XPackMLStopDatafeed) WithHeader(h map[string]string) func(*XPackMLStopDatafeedRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLStopDatafeed) WithHuman ¶ added in v6.8.2 

func (f XPackMLStopDatafeed) WithHuman() func(*XPackMLStopDatafeedRequest)

WithHuman makes statistical values human-readable.

func (XPackMLStopDatafeed) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLStopDatafeed) WithOpaqueID(s string) func(*XPackMLStopDatafeedRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLStopDatafeed) WithPretty ¶ added in v6.8.2 

func (f XPackMLStopDatafeed) WithPretty() func(*XPackMLStopDatafeedRequest)

WithPretty makes the response body pretty-printed.

func (XPackMLStopDatafeed) WithTimeout ¶ added in v6.8.2 

func (f XPackMLStopDatafeed) WithTimeout(v time.Duration) func(*XPackMLStopDatafeedRequest)

WithTimeout - controls the time to wait until a datafeed has stopped. default to 20 seconds.

type XPackMLStopDatafeedRequest ¶ added in v6.8.2 

type XPackMLStopDatafeedRequest 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
}

XPackMLStopDatafeedRequest configures the X PackML Stop Datafeed API request.

func (XPackMLStopDatafeedRequest) Do ¶ added in v6.8.2 

func (r XPackMLStopDatafeedRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLUpdateDatafeed ¶ added in v6.8.2 

type XPackMLUpdateDatafeed func(body io.Reader, datafeed_id string, o ...func(*XPackMLUpdateDatafeedRequest)) (*Response, error)

XPackMLUpdateDatafeed - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html

func (XPackMLUpdateDatafeed) WithContext ¶ added in v6.8.2 

func (f XPackMLUpdateDatafeed) WithContext(v context.Context) func(*XPackMLUpdateDatafeedRequest)

WithContext sets the request context.

func (XPackMLUpdateDatafeed) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLUpdateDatafeed) WithErrorTrace() func(*XPackMLUpdateDatafeedRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLUpdateDatafeed) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLUpdateDatafeed) WithFilterPath(v ...string) func(*XPackMLUpdateDatafeedRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLUpdateDatafeed) WithHeader ¶ added in v6.8.2 

func (f XPackMLUpdateDatafeed) WithHeader(h map[string]string) func(*XPackMLUpdateDatafeedRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLUpdateDatafeed) WithHuman ¶ added in v6.8.2 

func (f XPackMLUpdateDatafeed) WithHuman() func(*XPackMLUpdateDatafeedRequest)

WithHuman makes statistical values human-readable.

func (XPackMLUpdateDatafeed) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLUpdateDatafeed) WithOpaqueID(s string) func(*XPackMLUpdateDatafeedRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLUpdateDatafeed) WithPretty ¶ added in v6.8.2 

func (f XPackMLUpdateDatafeed) WithPretty() func(*XPackMLUpdateDatafeedRequest)

WithPretty makes the response body pretty-printed.

type XPackMLUpdateDatafeedRequest ¶ added in v6.8.2 

type XPackMLUpdateDatafeedRequest struct {
	Body io.Reader

	DatafeedID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLUpdateDatafeedRequest configures the X PackML Update Datafeed API request.

func (XPackMLUpdateDatafeedRequest) Do ¶ added in v6.8.2 

func (r XPackMLUpdateDatafeedRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLUpdateFilter ¶ added in v6.8.2 

type XPackMLUpdateFilter func(body io.Reader, filter_id string, o ...func(*XPackMLUpdateFilterRequest)) (*Response, error)

XPackMLUpdateFilter -

func (XPackMLUpdateFilter) WithContext ¶ added in v6.8.2 

func (f XPackMLUpdateFilter) WithContext(v context.Context) func(*XPackMLUpdateFilterRequest)

WithContext sets the request context.

func (XPackMLUpdateFilter) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLUpdateFilter) WithErrorTrace() func(*XPackMLUpdateFilterRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLUpdateFilter) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLUpdateFilter) WithFilterPath(v ...string) func(*XPackMLUpdateFilterRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLUpdateFilter) WithHeader ¶ added in v6.8.2 

func (f XPackMLUpdateFilter) WithHeader(h map[string]string) func(*XPackMLUpdateFilterRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLUpdateFilter) WithHuman ¶ added in v6.8.2 

func (f XPackMLUpdateFilter) WithHuman() func(*XPackMLUpdateFilterRequest)

WithHuman makes statistical values human-readable.

func (XPackMLUpdateFilter) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLUpdateFilter) WithOpaqueID(s string) func(*XPackMLUpdateFilterRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLUpdateFilter) WithPretty ¶ added in v6.8.2 

func (f XPackMLUpdateFilter) WithPretty() func(*XPackMLUpdateFilterRequest)

WithPretty makes the response body pretty-printed.

type XPackMLUpdateFilterRequest ¶ added in v6.8.2 

type XPackMLUpdateFilterRequest struct {
	Body io.Reader

	FilterID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLUpdateFilterRequest configures the X PackML Update Filter API request.

func (XPackMLUpdateFilterRequest) Do ¶ added in v6.8.2 

func (r XPackMLUpdateFilterRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLUpdateJob ¶ added in v6.8.2 

type XPackMLUpdateJob func(job_id string, body io.Reader, o ...func(*XPackMLUpdateJobRequest)) (*Response, error)

XPackMLUpdateJob - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html

func (XPackMLUpdateJob) WithContext ¶ added in v6.8.2 

func (f XPackMLUpdateJob) WithContext(v context.Context) func(*XPackMLUpdateJobRequest)

WithContext sets the request context.

func (XPackMLUpdateJob) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLUpdateJob) WithErrorTrace() func(*XPackMLUpdateJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLUpdateJob) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLUpdateJob) WithFilterPath(v ...string) func(*XPackMLUpdateJobRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLUpdateJob) WithHeader ¶ added in v6.8.2 

func (f XPackMLUpdateJob) WithHeader(h map[string]string) func(*XPackMLUpdateJobRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLUpdateJob) WithHuman ¶ added in v6.8.2 

func (f XPackMLUpdateJob) WithHuman() func(*XPackMLUpdateJobRequest)

WithHuman makes statistical values human-readable.

func (XPackMLUpdateJob) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLUpdateJob) WithOpaqueID(s string) func(*XPackMLUpdateJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLUpdateJob) WithPretty ¶ added in v6.8.2 

func (f XPackMLUpdateJob) WithPretty() func(*XPackMLUpdateJobRequest)

WithPretty makes the response body pretty-printed.

type XPackMLUpdateJobRequest ¶ added in v6.8.2 

type XPackMLUpdateJobRequest struct {
	Body io.Reader

	JobID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLUpdateJobRequest configures the X PackML Update Job API request.

func (XPackMLUpdateJobRequest) Do ¶ added in v6.8.2 

func (r XPackMLUpdateJobRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLUpdateModelSnapshot ¶ added in v6.8.2 

type XPackMLUpdateModelSnapshot func(snapshot_id string, job_id string, body io.Reader, o ...func(*XPackMLUpdateModelSnapshotRequest)) (*Response, error)

XPackMLUpdateModelSnapshot - http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html

func (XPackMLUpdateModelSnapshot) WithContext ¶ added in v6.8.2 

func (f XPackMLUpdateModelSnapshot) WithContext(v context.Context) func(*XPackMLUpdateModelSnapshotRequest)

WithContext sets the request context.

func (XPackMLUpdateModelSnapshot) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLUpdateModelSnapshot) WithErrorTrace() func(*XPackMLUpdateModelSnapshotRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLUpdateModelSnapshot) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLUpdateModelSnapshot) WithFilterPath(v ...string) func(*XPackMLUpdateModelSnapshotRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLUpdateModelSnapshot) WithHeader ¶ added in v6.8.2 

func (f XPackMLUpdateModelSnapshot) WithHeader(h map[string]string) func(*XPackMLUpdateModelSnapshotRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLUpdateModelSnapshot) WithHuman ¶ added in v6.8.2 

func (f XPackMLUpdateModelSnapshot) WithHuman() func(*XPackMLUpdateModelSnapshotRequest)

WithHuman makes statistical values human-readable.

func (XPackMLUpdateModelSnapshot) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLUpdateModelSnapshot) WithOpaqueID(s string) func(*XPackMLUpdateModelSnapshotRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLUpdateModelSnapshot) WithPretty ¶ added in v6.8.2 

func (f XPackMLUpdateModelSnapshot) WithPretty() func(*XPackMLUpdateModelSnapshotRequest)

WithPretty makes the response body pretty-printed.

type XPackMLUpdateModelSnapshotRequest ¶ added in v6.8.2 

type XPackMLUpdateModelSnapshotRequest struct {
	Body io.Reader

	JobID      string
	SnapshotID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLUpdateModelSnapshotRequest configures the X PackML Update Model Snapshot API request.

func (XPackMLUpdateModelSnapshotRequest) Do ¶ added in v6.8.2 

func (r XPackMLUpdateModelSnapshotRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLValidate ¶ added in v6.8.2 

type XPackMLValidate func(body io.Reader, o ...func(*XPackMLValidateRequest)) (*Response, error)

XPackMLValidate -

func (XPackMLValidate) WithContext ¶ added in v6.8.2 

func (f XPackMLValidate) WithContext(v context.Context) func(*XPackMLValidateRequest)

WithContext sets the request context.

func (XPackMLValidate) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLValidate) WithErrorTrace() func(*XPackMLValidateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLValidate) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLValidate) WithFilterPath(v ...string) func(*XPackMLValidateRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLValidate) WithHeader ¶ added in v6.8.2 

func (f XPackMLValidate) WithHeader(h map[string]string) func(*XPackMLValidateRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLValidate) WithHuman ¶ added in v6.8.2 

func (f XPackMLValidate) WithHuman() func(*XPackMLValidateRequest)

WithHuman makes statistical values human-readable.

func (XPackMLValidate) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLValidate) WithOpaqueID(s string) func(*XPackMLValidateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLValidate) WithPretty ¶ added in v6.8.2 

func (f XPackMLValidate) WithPretty() func(*XPackMLValidateRequest)

WithPretty makes the response body pretty-printed.

type XPackMLValidateDetector ¶ added in v6.8.2 

type XPackMLValidateDetector func(body io.Reader, o ...func(*XPackMLValidateDetectorRequest)) (*Response, error)

XPackMLValidateDetector -

func (XPackMLValidateDetector) WithContext ¶ added in v6.8.2 

func (f XPackMLValidateDetector) WithContext(v context.Context) func(*XPackMLValidateDetectorRequest)

WithContext sets the request context.

func (XPackMLValidateDetector) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMLValidateDetector) WithErrorTrace() func(*XPackMLValidateDetectorRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMLValidateDetector) WithFilterPath ¶ added in v6.8.2 

func (f XPackMLValidateDetector) WithFilterPath(v ...string) func(*XPackMLValidateDetectorRequest)

WithFilterPath filters the properties of the response body.

func (XPackMLValidateDetector) WithHeader ¶ added in v6.8.2 

func (f XPackMLValidateDetector) WithHeader(h map[string]string) func(*XPackMLValidateDetectorRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMLValidateDetector) WithHuman ¶ added in v6.8.2 

func (f XPackMLValidateDetector) WithHuman() func(*XPackMLValidateDetectorRequest)

WithHuman makes statistical values human-readable.

func (XPackMLValidateDetector) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMLValidateDetector) WithOpaqueID(s string) func(*XPackMLValidateDetectorRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMLValidateDetector) WithPretty ¶ added in v6.8.2 

func (f XPackMLValidateDetector) WithPretty() func(*XPackMLValidateDetectorRequest)

WithPretty makes the response body pretty-printed.

type XPackMLValidateDetectorRequest ¶ added in v6.8.2 

type XPackMLValidateDetectorRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLValidateDetectorRequest configures the X PackML Validate Detector API request.

func (XPackMLValidateDetectorRequest) Do ¶ added in v6.8.2 

func (r XPackMLValidateDetectorRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMLValidateRequest ¶ added in v6.8.2 

type XPackMLValidateRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMLValidateRequest configures the X PackML Validate API request.

func (XPackMLValidateRequest) Do ¶ added in v6.8.2 

func (r XPackMLValidateRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMigrationDeprecations ¶ added in v6.8.2 

type XPackMigrationDeprecations func(o ...func(*XPackMigrationDeprecationsRequest)) (*Response, error)

XPackMigrationDeprecations - http://www.elastic.co/guide/en/elasticsearch/reference/6.7/migration-api-deprecation.html

func (XPackMigrationDeprecations) WithContext ¶ added in v6.8.2 

func (f XPackMigrationDeprecations) WithContext(v context.Context) func(*XPackMigrationDeprecationsRequest)

WithContext sets the request context.

func (XPackMigrationDeprecations) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMigrationDeprecations) WithErrorTrace() func(*XPackMigrationDeprecationsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMigrationDeprecations) WithFilterPath ¶ added in v6.8.2 

func (f XPackMigrationDeprecations) WithFilterPath(v ...string) func(*XPackMigrationDeprecationsRequest)

WithFilterPath filters the properties of the response body.

func (XPackMigrationDeprecations) WithHeader ¶ added in v6.8.2 

func (f XPackMigrationDeprecations) WithHeader(h map[string]string) func(*XPackMigrationDeprecationsRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMigrationDeprecations) WithHuman ¶ added in v6.8.2 

func (f XPackMigrationDeprecations) WithHuman() func(*XPackMigrationDeprecationsRequest)

WithHuman makes statistical values human-readable.

func (XPackMigrationDeprecations) WithIndex ¶ added in v6.8.2 

func (f XPackMigrationDeprecations) WithIndex(v string) func(*XPackMigrationDeprecationsRequest)

WithIndex - index pattern.

func (XPackMigrationDeprecations) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMigrationDeprecations) WithOpaqueID(s string) func(*XPackMigrationDeprecationsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMigrationDeprecations) WithPretty ¶ added in v6.8.2 

func (f XPackMigrationDeprecations) WithPretty() func(*XPackMigrationDeprecationsRequest)

WithPretty makes the response body pretty-printed.

type XPackMigrationDeprecationsRequest ¶ added in v6.8.2 

type XPackMigrationDeprecationsRequest struct {
	Index string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMigrationDeprecationsRequest configures the X Pack Migration Deprecations API request.

func (XPackMigrationDeprecationsRequest) Do ¶ added in v6.8.2 

func (r XPackMigrationDeprecationsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMigrationGetAssistance ¶ added in v6.8.2 

type XPackMigrationGetAssistance func(o ...func(*XPackMigrationGetAssistanceRequest)) (*Response, error)

XPackMigrationGetAssistance - https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-assistance.html

func (XPackMigrationGetAssistance) WithAllowNoIndices ¶ added in v6.8.2 

func (f XPackMigrationGetAssistance) WithAllowNoIndices(v bool) func(*XPackMigrationGetAssistanceRequest)

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 (XPackMigrationGetAssistance) WithContext ¶ added in v6.8.2 

func (f XPackMigrationGetAssistance) WithContext(v context.Context) func(*XPackMigrationGetAssistanceRequest)

WithContext sets the request context.

func (XPackMigrationGetAssistance) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMigrationGetAssistance) WithErrorTrace() func(*XPackMigrationGetAssistanceRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMigrationGetAssistance) WithExpandWildcards ¶ added in v6.8.2 

func (f XPackMigrationGetAssistance) WithExpandWildcards(v string) func(*XPackMigrationGetAssistanceRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (XPackMigrationGetAssistance) WithFilterPath ¶ added in v6.8.2 

func (f XPackMigrationGetAssistance) WithFilterPath(v ...string) func(*XPackMigrationGetAssistanceRequest)

WithFilterPath filters the properties of the response body.

func (XPackMigrationGetAssistance) WithHeader ¶ added in v6.8.2 

func (f XPackMigrationGetAssistance) WithHeader(h map[string]string) func(*XPackMigrationGetAssistanceRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMigrationGetAssistance) WithHuman ¶ added in v6.8.2 

func (f XPackMigrationGetAssistance) WithHuman() func(*XPackMigrationGetAssistanceRequest)

WithHuman makes statistical values human-readable.

func (XPackMigrationGetAssistance) WithIgnoreUnavailable ¶ added in v6.8.2 

func (f XPackMigrationGetAssistance) WithIgnoreUnavailable(v bool) func(*XPackMigrationGetAssistanceRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (XPackMigrationGetAssistance) WithIndex ¶ added in v6.8.2 

func (f XPackMigrationGetAssistance) WithIndex(v ...string) func(*XPackMigrationGetAssistanceRequest)

WithIndex - a list of index names; use _all to perform the operation on all indices.

func (XPackMigrationGetAssistance) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMigrationGetAssistance) WithOpaqueID(s string) func(*XPackMigrationGetAssistanceRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMigrationGetAssistance) WithPretty ¶ added in v6.8.2 

func (f XPackMigrationGetAssistance) WithPretty() func(*XPackMigrationGetAssistanceRequest)

WithPretty makes the response body pretty-printed.

type XPackMigrationGetAssistanceRequest ¶ added in v6.8.2 

type XPackMigrationGetAssistanceRequest struct {
	Index []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMigrationGetAssistanceRequest configures the X Pack Migration Get Assistance API request.

func (XPackMigrationGetAssistanceRequest) Do ¶ added in v6.8.2 

func (r XPackMigrationGetAssistanceRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMigrationUpgrade ¶ added in v6.8.2 

type XPackMigrationUpgrade func(index string, o ...func(*XPackMigrationUpgradeRequest)) (*Response, error)

XPackMigrationUpgrade - https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-upgrade.html

func (XPackMigrationUpgrade) WithContext ¶ added in v6.8.2 

func (f XPackMigrationUpgrade) WithContext(v context.Context) func(*XPackMigrationUpgradeRequest)

WithContext sets the request context.

func (XPackMigrationUpgrade) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMigrationUpgrade) WithErrorTrace() func(*XPackMigrationUpgradeRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMigrationUpgrade) WithFilterPath ¶ added in v6.8.2 

func (f XPackMigrationUpgrade) WithFilterPath(v ...string) func(*XPackMigrationUpgradeRequest)

WithFilterPath filters the properties of the response body.

func (XPackMigrationUpgrade) WithHeader ¶ added in v6.8.2 

func (f XPackMigrationUpgrade) WithHeader(h map[string]string) func(*XPackMigrationUpgradeRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMigrationUpgrade) WithHuman ¶ added in v6.8.2 

func (f XPackMigrationUpgrade) WithHuman() func(*XPackMigrationUpgradeRequest)

WithHuman makes statistical values human-readable.

func (XPackMigrationUpgrade) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMigrationUpgrade) WithOpaqueID(s string) func(*XPackMigrationUpgradeRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMigrationUpgrade) WithPretty ¶ added in v6.8.2 

func (f XPackMigrationUpgrade) WithPretty() func(*XPackMigrationUpgradeRequest)

WithPretty makes the response body pretty-printed.

func (XPackMigrationUpgrade) WithWaitForCompletion ¶ added in v6.8.2 

func (f XPackMigrationUpgrade) WithWaitForCompletion(v bool) func(*XPackMigrationUpgradeRequest)

WithWaitForCompletion - should the request block until the upgrade operation is completed.

type XPackMigrationUpgradeRequest ¶ added in v6.8.2 

type XPackMigrationUpgradeRequest struct {
	Index string

	WaitForCompletion *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackMigrationUpgradeRequest configures the X Pack Migration Upgrade API request.

func (XPackMigrationUpgradeRequest) Do ¶ added in v6.8.2 

func (r XPackMigrationUpgradeRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackMonitoringBulk ¶ added in v6.8.2 

type XPackMonitoringBulk func(body io.Reader, o ...func(*XPackMonitoringBulkRequest)) (*Response, error)

XPackMonitoringBulk - https://www.elastic.co/guide/en/elasticsearch/reference/6.7/es-monitoring.html

func (XPackMonitoringBulk) WithContext ¶ added in v6.8.2 

func (f XPackMonitoringBulk) WithContext(v context.Context) func(*XPackMonitoringBulkRequest)

WithContext sets the request context.

func (XPackMonitoringBulk) WithDocumentType ¶ added in v6.8.2 

func (f XPackMonitoringBulk) WithDocumentType(v string) func(*XPackMonitoringBulkRequest)

WithDocumentType - default document type for items which don't provide one.

func (XPackMonitoringBulk) WithErrorTrace ¶ added in v6.8.2 

func (f XPackMonitoringBulk) WithErrorTrace() func(*XPackMonitoringBulkRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackMonitoringBulk) WithFilterPath ¶ added in v6.8.2 

func (f XPackMonitoringBulk) WithFilterPath(v ...string) func(*XPackMonitoringBulkRequest)

WithFilterPath filters the properties of the response body.

func (XPackMonitoringBulk) WithHeader ¶ added in v6.8.2 

func (f XPackMonitoringBulk) WithHeader(h map[string]string) func(*XPackMonitoringBulkRequest)

WithHeader adds the headers to the HTTP request.

func (XPackMonitoringBulk) WithHuman ¶ added in v6.8.2 

func (f XPackMonitoringBulk) WithHuman() func(*XPackMonitoringBulkRequest)

WithHuman makes statistical values human-readable.

func (XPackMonitoringBulk) WithInterval ¶ added in v6.8.2 

func (f XPackMonitoringBulk) WithInterval(v string) func(*XPackMonitoringBulkRequest)

WithInterval - collection interval (e.g., '10s' or '10000ms') of the payload.

func (XPackMonitoringBulk) WithOpaqueID ¶ added in v6.8.5 

func (f XPackMonitoringBulk) WithOpaqueID(s string) func(*XPackMonitoringBulkRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackMonitoringBulk) WithPretty ¶ added in v6.8.2 

func (f XPackMonitoringBulk) WithPretty() func(*XPackMonitoringBulkRequest)

WithPretty makes the response body pretty-printed.

func (XPackMonitoringBulk) WithSystemAPIVersion ¶ added in v6.8.2 

func (f XPackMonitoringBulk) WithSystemAPIVersion(v string) func(*XPackMonitoringBulkRequest)

WithSystemAPIVersion - api version of the monitored system.

func (XPackMonitoringBulk) WithSystemID ¶ added in v6.8.2 

func (f XPackMonitoringBulk) WithSystemID(v string) func(*XPackMonitoringBulkRequest)

WithSystemID - identifier of the monitored system.

type XPackMonitoringBulkRequest ¶ added in v6.8.2 

type XPackMonitoringBulkRequest 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
}

XPackMonitoringBulkRequest configures the X Pack Monitoring Bulk API request.

func (XPackMonitoringBulkRequest) Do ¶ added in v6.8.2 

func (r XPackMonitoringBulkRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackRollupDeleteJob ¶ added in v6.8.2 

type XPackRollupDeleteJob func(id string, o ...func(*XPackRollupDeleteJobRequest)) (*Response, error)

XPackRollupDeleteJob -

func (XPackRollupDeleteJob) WithContext ¶ added in v6.8.2 

func (f XPackRollupDeleteJob) WithContext(v context.Context) func(*XPackRollupDeleteJobRequest)

WithContext sets the request context.

func (XPackRollupDeleteJob) WithErrorTrace ¶ added in v6.8.2 

func (f XPackRollupDeleteJob) WithErrorTrace() func(*XPackRollupDeleteJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackRollupDeleteJob) WithFilterPath ¶ added in v6.8.2 

func (f XPackRollupDeleteJob) WithFilterPath(v ...string) func(*XPackRollupDeleteJobRequest)

WithFilterPath filters the properties of the response body.

func (XPackRollupDeleteJob) WithHeader ¶ added in v6.8.2 

func (f XPackRollupDeleteJob) WithHeader(h map[string]string) func(*XPackRollupDeleteJobRequest)

WithHeader adds the headers to the HTTP request.

func (XPackRollupDeleteJob) WithHuman ¶ added in v6.8.2 

func (f XPackRollupDeleteJob) WithHuman() func(*XPackRollupDeleteJobRequest)

WithHuman makes statistical values human-readable.

func (XPackRollupDeleteJob) WithOpaqueID ¶ added in v6.8.5 

func (f XPackRollupDeleteJob) WithOpaqueID(s string) func(*XPackRollupDeleteJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackRollupDeleteJob) WithPretty ¶ added in v6.8.2 

func (f XPackRollupDeleteJob) WithPretty() func(*XPackRollupDeleteJobRequest)

WithPretty makes the response body pretty-printed.

type XPackRollupDeleteJobRequest ¶ added in v6.8.2 

type XPackRollupDeleteJobRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackRollupDeleteJobRequest configures the X Pack Rollup Delete Job API request.

func (XPackRollupDeleteJobRequest) Do ¶ added in v6.8.2 

func (r XPackRollupDeleteJobRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackRollupGetJobs ¶ added in v6.8.2 

type XPackRollupGetJobs func(o ...func(*XPackRollupGetJobsRequest)) (*Response, error)

XPackRollupGetJobs -

func (XPackRollupGetJobs) WithContext ¶ added in v6.8.2 

func (f XPackRollupGetJobs) WithContext(v context.Context) func(*XPackRollupGetJobsRequest)

WithContext sets the request context.

func (XPackRollupGetJobs) WithDocumentID ¶ added in v6.8.2 

func (f XPackRollupGetJobs) WithDocumentID(v string) func(*XPackRollupGetJobsRequest)

WithDocumentID - the ID of the job(s) to fetch. accepts glob patterns, or left blank for all jobs.

func (XPackRollupGetJobs) WithErrorTrace ¶ added in v6.8.2 

func (f XPackRollupGetJobs) WithErrorTrace() func(*XPackRollupGetJobsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackRollupGetJobs) WithFilterPath ¶ added in v6.8.2 

func (f XPackRollupGetJobs) WithFilterPath(v ...string) func(*XPackRollupGetJobsRequest)

WithFilterPath filters the properties of the response body.

func (XPackRollupGetJobs) WithHeader ¶ added in v6.8.2 

func (f XPackRollupGetJobs) WithHeader(h map[string]string) func(*XPackRollupGetJobsRequest)

WithHeader adds the headers to the HTTP request.

func (XPackRollupGetJobs) WithHuman ¶ added in v6.8.2 

func (f XPackRollupGetJobs) WithHuman() func(*XPackRollupGetJobsRequest)

WithHuman makes statistical values human-readable.

func (XPackRollupGetJobs) WithOpaqueID ¶ added in v6.8.5 

func (f XPackRollupGetJobs) WithOpaqueID(s string) func(*XPackRollupGetJobsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackRollupGetJobs) WithPretty ¶ added in v6.8.2 

func (f XPackRollupGetJobs) WithPretty() func(*XPackRollupGetJobsRequest)

WithPretty makes the response body pretty-printed.

type XPackRollupGetJobsRequest ¶ added in v6.8.2 

type XPackRollupGetJobsRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackRollupGetJobsRequest configures the X Pack Rollup Get Jobs API request.

func (XPackRollupGetJobsRequest) Do ¶ added in v6.8.2 

func (r XPackRollupGetJobsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackRollupGetRollupCaps ¶ added in v6.8.2 

type XPackRollupGetRollupCaps func(o ...func(*XPackRollupGetRollupCapsRequest)) (*Response, error)

XPackRollupGetRollupCaps -

func (XPackRollupGetRollupCaps) WithContext ¶ added in v6.8.2 

func (f XPackRollupGetRollupCaps) WithContext(v context.Context) func(*XPackRollupGetRollupCapsRequest)

WithContext sets the request context.

func (XPackRollupGetRollupCaps) WithDocumentID ¶ added in v6.8.2 

func (f XPackRollupGetRollupCaps) WithDocumentID(v string) func(*XPackRollupGetRollupCapsRequest)

WithDocumentID - the ID of the index to check rollup capabilities on, or left blank for all jobs.

func (XPackRollupGetRollupCaps) WithErrorTrace ¶ added in v6.8.2 

func (f XPackRollupGetRollupCaps) WithErrorTrace() func(*XPackRollupGetRollupCapsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackRollupGetRollupCaps) WithFilterPath ¶ added in v6.8.2 

func (f XPackRollupGetRollupCaps) WithFilterPath(v ...string) func(*XPackRollupGetRollupCapsRequest)

WithFilterPath filters the properties of the response body.

func (XPackRollupGetRollupCaps) WithHeader ¶ added in v6.8.2 

func (f XPackRollupGetRollupCaps) WithHeader(h map[string]string) func(*XPackRollupGetRollupCapsRequest)

WithHeader adds the headers to the HTTP request.

func (XPackRollupGetRollupCaps) WithHuman ¶ added in v6.8.2 

func (f XPackRollupGetRollupCaps) WithHuman() func(*XPackRollupGetRollupCapsRequest)

WithHuman makes statistical values human-readable.

func (XPackRollupGetRollupCaps) WithOpaqueID ¶ added in v6.8.5 

func (f XPackRollupGetRollupCaps) WithOpaqueID(s string) func(*XPackRollupGetRollupCapsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackRollupGetRollupCaps) WithPretty ¶ added in v6.8.2 

func (f XPackRollupGetRollupCaps) WithPretty() func(*XPackRollupGetRollupCapsRequest)

WithPretty makes the response body pretty-printed.

type XPackRollupGetRollupCapsRequest ¶ added in v6.8.2 

type XPackRollupGetRollupCapsRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackRollupGetRollupCapsRequest configures the X Pack Rollup Get Rollup Caps API request.

func (XPackRollupGetRollupCapsRequest) Do ¶ added in v6.8.2 

func (r XPackRollupGetRollupCapsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackRollupGetRollupIndexCaps ¶ added in v6.8.2 

type XPackRollupGetRollupIndexCaps func(index string, o ...func(*XPackRollupGetRollupIndexCapsRequest)) (*Response, error)

XPackRollupGetRollupIndexCaps -

func (XPackRollupGetRollupIndexCaps) WithContext ¶ added in v6.8.2 

func (f XPackRollupGetRollupIndexCaps) WithContext(v context.Context) func(*XPackRollupGetRollupIndexCapsRequest)

WithContext sets the request context.

func (XPackRollupGetRollupIndexCaps) WithErrorTrace ¶ added in v6.8.2 

func (f XPackRollupGetRollupIndexCaps) WithErrorTrace() func(*XPackRollupGetRollupIndexCapsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackRollupGetRollupIndexCaps) WithFilterPath ¶ added in v6.8.2 

func (f XPackRollupGetRollupIndexCaps) WithFilterPath(v ...string) func(*XPackRollupGetRollupIndexCapsRequest)

WithFilterPath filters the properties of the response body.

func (XPackRollupGetRollupIndexCaps) WithHeader ¶ added in v6.8.2 

func (f XPackRollupGetRollupIndexCaps) WithHeader(h map[string]string) func(*XPackRollupGetRollupIndexCapsRequest)

WithHeader adds the headers to the HTTP request.

func (XPackRollupGetRollupIndexCaps) WithHuman ¶ added in v6.8.2 

func (f XPackRollupGetRollupIndexCaps) WithHuman() func(*XPackRollupGetRollupIndexCapsRequest)

WithHuman makes statistical values human-readable.

func (XPackRollupGetRollupIndexCaps) WithOpaqueID ¶ added in v6.8.5 

func (f XPackRollupGetRollupIndexCaps) WithOpaqueID(s string) func(*XPackRollupGetRollupIndexCapsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackRollupGetRollupIndexCaps) WithPretty ¶ added in v6.8.2 

func (f XPackRollupGetRollupIndexCaps) WithPretty() func(*XPackRollupGetRollupIndexCapsRequest)

WithPretty makes the response body pretty-printed.

type XPackRollupGetRollupIndexCapsRequest ¶ added in v6.8.2 

type XPackRollupGetRollupIndexCapsRequest struct {
	Index string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackRollupGetRollupIndexCapsRequest configures the X Pack Rollup Get Rollup Index Caps API request.

func (XPackRollupGetRollupIndexCapsRequest) Do ¶ added in v6.8.2 

func (r XPackRollupGetRollupIndexCapsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackRollupPutJob ¶ added in v6.8.2 

type XPackRollupPutJob func(id string, body io.Reader, o ...func(*XPackRollupPutJobRequest)) (*Response, error)

XPackRollupPutJob -

func (XPackRollupPutJob) WithContext ¶ added in v6.8.2 

func (f XPackRollupPutJob) WithContext(v context.Context) func(*XPackRollupPutJobRequest)

WithContext sets the request context.

func (XPackRollupPutJob) WithErrorTrace ¶ added in v6.8.2 

func (f XPackRollupPutJob) WithErrorTrace() func(*XPackRollupPutJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackRollupPutJob) WithFilterPath ¶ added in v6.8.2 

func (f XPackRollupPutJob) WithFilterPath(v ...string) func(*XPackRollupPutJobRequest)

WithFilterPath filters the properties of the response body.

func (XPackRollupPutJob) WithHeader ¶ added in v6.8.2 

func (f XPackRollupPutJob) WithHeader(h map[string]string) func(*XPackRollupPutJobRequest)

WithHeader adds the headers to the HTTP request.

func (XPackRollupPutJob) WithHuman ¶ added in v6.8.2 

func (f XPackRollupPutJob) WithHuman() func(*XPackRollupPutJobRequest)

WithHuman makes statistical values human-readable.

func (XPackRollupPutJob) WithOpaqueID ¶ added in v6.8.5 

func (f XPackRollupPutJob) WithOpaqueID(s string) func(*XPackRollupPutJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackRollupPutJob) WithPretty ¶ added in v6.8.2 

func (f XPackRollupPutJob) WithPretty() func(*XPackRollupPutJobRequest)

WithPretty makes the response body pretty-printed.

type XPackRollupPutJobRequest ¶ added in v6.8.2 

type XPackRollupPutJobRequest struct {
	DocumentID string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackRollupPutJobRequest configures the X Pack Rollup Put Job API request.

func (XPackRollupPutJobRequest) Do ¶ added in v6.8.2 

func (r XPackRollupPutJobRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackRollupRollupSearch ¶ added in v6.8.2 

type XPackRollupRollupSearch func(index string, body io.Reader, o ...func(*XPackRollupRollupSearchRequest)) (*Response, error)

XPackRollupRollupSearch -

func (XPackRollupRollupSearch) WithContext ¶ added in v6.8.2 

func (f XPackRollupRollupSearch) WithContext(v context.Context) func(*XPackRollupRollupSearchRequest)

WithContext sets the request context.

func (XPackRollupRollupSearch) WithDocumentType ¶ added in v6.8.2 

func (f XPackRollupRollupSearch) WithDocumentType(v string) func(*XPackRollupRollupSearchRequest)

WithDocumentType - the doc type inside the index.

func (XPackRollupRollupSearch) WithErrorTrace ¶ added in v6.8.2 

func (f XPackRollupRollupSearch) WithErrorTrace() func(*XPackRollupRollupSearchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackRollupRollupSearch) WithFilterPath ¶ added in v6.8.2 

func (f XPackRollupRollupSearch) WithFilterPath(v ...string) func(*XPackRollupRollupSearchRequest)

WithFilterPath filters the properties of the response body.

func (XPackRollupRollupSearch) WithHeader ¶ added in v6.8.2 

func (f XPackRollupRollupSearch) WithHeader(h map[string]string) func(*XPackRollupRollupSearchRequest)

WithHeader adds the headers to the HTTP request.

func (XPackRollupRollupSearch) WithHuman ¶ added in v6.8.2 

func (f XPackRollupRollupSearch) WithHuman() func(*XPackRollupRollupSearchRequest)

WithHuman makes statistical values human-readable.

func (XPackRollupRollupSearch) WithOpaqueID ¶ added in v6.8.5 

func (f XPackRollupRollupSearch) WithOpaqueID(s string) func(*XPackRollupRollupSearchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackRollupRollupSearch) WithPretty ¶ added in v6.8.2 

func (f XPackRollupRollupSearch) WithPretty() func(*XPackRollupRollupSearchRequest)

WithPretty makes the response body pretty-printed.

func (XPackRollupRollupSearch) WithTypedKeys ¶ added in v6.8.2 

func (f XPackRollupRollupSearch) WithTypedKeys(v bool) func(*XPackRollupRollupSearchRequest)

WithTypedKeys - specify whether aggregation and suggester names should be prefixed by their respective types in the response.

type XPackRollupRollupSearchRequest ¶ added in v6.8.2 

type XPackRollupRollupSearchRequest struct {
	Index        string
	DocumentType string

	Body io.Reader

	TypedKeys *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackRollupRollupSearchRequest configures the X Pack Rollup Rollup Search API request.

func (XPackRollupRollupSearchRequest) Do ¶ added in v6.8.2 

func (r XPackRollupRollupSearchRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackRollupStartJob ¶ added in v6.8.2 

type XPackRollupStartJob func(id string, o ...func(*XPackRollupStartJobRequest)) (*Response, error)

XPackRollupStartJob -

func (XPackRollupStartJob) WithContext ¶ added in v6.8.2 

func (f XPackRollupStartJob) WithContext(v context.Context) func(*XPackRollupStartJobRequest)

WithContext sets the request context.

func (XPackRollupStartJob) WithErrorTrace ¶ added in v6.8.2 

func (f XPackRollupStartJob) WithErrorTrace() func(*XPackRollupStartJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackRollupStartJob) WithFilterPath ¶ added in v6.8.2 

func (f XPackRollupStartJob) WithFilterPath(v ...string) func(*XPackRollupStartJobRequest)

WithFilterPath filters the properties of the response body.

func (XPackRollupStartJob) WithHeader ¶ added in v6.8.2 

func (f XPackRollupStartJob) WithHeader(h map[string]string) func(*XPackRollupStartJobRequest)

WithHeader adds the headers to the HTTP request.

func (XPackRollupStartJob) WithHuman ¶ added in v6.8.2 

func (f XPackRollupStartJob) WithHuman() func(*XPackRollupStartJobRequest)

WithHuman makes statistical values human-readable.

func (XPackRollupStartJob) WithOpaqueID ¶ added in v6.8.5 

func (f XPackRollupStartJob) WithOpaqueID(s string) func(*XPackRollupStartJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackRollupStartJob) WithPretty ¶ added in v6.8.2 

func (f XPackRollupStartJob) WithPretty() func(*XPackRollupStartJobRequest)

WithPretty makes the response body pretty-printed.

type XPackRollupStartJobRequest ¶ added in v6.8.2 

type XPackRollupStartJobRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackRollupStartJobRequest configures the X Pack Rollup Start Job API request.

func (XPackRollupStartJobRequest) Do ¶ added in v6.8.2 

func (r XPackRollupStartJobRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackRollupStopJob ¶ added in v6.8.2 

type XPackRollupStopJob func(id string, o ...func(*XPackRollupStopJobRequest)) (*Response, error)

XPackRollupStopJob -

func (XPackRollupStopJob) WithContext ¶ added in v6.8.2 

func (f XPackRollupStopJob) WithContext(v context.Context) func(*XPackRollupStopJobRequest)

WithContext sets the request context.

func (XPackRollupStopJob) WithErrorTrace ¶ added in v6.8.2 

func (f XPackRollupStopJob) WithErrorTrace() func(*XPackRollupStopJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackRollupStopJob) WithFilterPath ¶ added in v6.8.2 

func (f XPackRollupStopJob) WithFilterPath(v ...string) func(*XPackRollupStopJobRequest)

WithFilterPath filters the properties of the response body.

func (XPackRollupStopJob) WithHeader ¶ added in v6.8.2 

func (f XPackRollupStopJob) WithHeader(h map[string]string) func(*XPackRollupStopJobRequest)

WithHeader adds the headers to the HTTP request.

func (XPackRollupStopJob) WithHuman ¶ added in v6.8.2 

func (f XPackRollupStopJob) WithHuman() func(*XPackRollupStopJobRequest)

WithHuman makes statistical values human-readable.

func (XPackRollupStopJob) WithOpaqueID ¶ added in v6.8.5 

func (f XPackRollupStopJob) WithOpaqueID(s string) func(*XPackRollupStopJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackRollupStopJob) WithPretty ¶ added in v6.8.2 

func (f XPackRollupStopJob) WithPretty() func(*XPackRollupStopJobRequest)

WithPretty makes the response body pretty-printed.

func (XPackRollupStopJob) WithTimeout ¶ added in v6.8.2 

func (f XPackRollupStopJob) WithTimeout(v time.Duration) func(*XPackRollupStopJobRequest)

WithTimeout - block for (at maximum) the specified duration while waiting for the job to stop. defaults to 30s..

func (XPackRollupStopJob) WithWaitForCompletion ¶ added in v6.8.2 

func (f XPackRollupStopJob) WithWaitForCompletion(v bool) func(*XPackRollupStopJobRequest)

WithWaitForCompletion - true if the api should block until the job has fully stopped, false if should be executed async. defaults to false..

type XPackRollupStopJobRequest ¶ added in v6.8.2 

type XPackRollupStopJobRequest struct {
	DocumentID string

	Timeout           time.Duration
	WaitForCompletion *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackRollupStopJobRequest configures the X Pack Rollup Stop Job API request.

func (XPackRollupStopJobRequest) Do ¶ added in v6.8.2 

func (r XPackRollupStopJobRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSQLClearCursor ¶ added in v6.8.2 

type XPackSQLClearCursor func(body io.Reader, o ...func(*XPackSQLClearCursorRequest)) (*Response, error)

XPackSQLClearCursor - Clear SQL cursor

func (XPackSQLClearCursor) WithContext ¶ added in v6.8.2 

func (f XPackSQLClearCursor) WithContext(v context.Context) func(*XPackSQLClearCursorRequest)

WithContext sets the request context.

func (XPackSQLClearCursor) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSQLClearCursor) WithErrorTrace() func(*XPackSQLClearCursorRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSQLClearCursor) WithFilterPath ¶ added in v6.8.2 

func (f XPackSQLClearCursor) WithFilterPath(v ...string) func(*XPackSQLClearCursorRequest)

WithFilterPath filters the properties of the response body.

func (XPackSQLClearCursor) WithHeader ¶ added in v6.8.2 

func (f XPackSQLClearCursor) WithHeader(h map[string]string) func(*XPackSQLClearCursorRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSQLClearCursor) WithHuman ¶ added in v6.8.2 

func (f XPackSQLClearCursor) WithHuman() func(*XPackSQLClearCursorRequest)

WithHuman makes statistical values human-readable.

func (XPackSQLClearCursor) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSQLClearCursor) WithOpaqueID(s string) func(*XPackSQLClearCursorRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSQLClearCursor) WithPretty ¶ added in v6.8.2 

func (f XPackSQLClearCursor) WithPretty() func(*XPackSQLClearCursorRequest)

WithPretty makes the response body pretty-printed.

type XPackSQLClearCursorRequest ¶ added in v6.8.2 

type XPackSQLClearCursorRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSQLClearCursorRequest configures the X PackSQL Clear Cursor API request.

func (XPackSQLClearCursorRequest) Do ¶ added in v6.8.2 

func (r XPackSQLClearCursorRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSQLQuery ¶ added in v6.8.2 

type XPackSQLQuery func(body io.Reader, o ...func(*XPackSQLQueryRequest)) (*Response, error)

XPackSQLQuery - Execute SQL

func (XPackSQLQuery) WithContext ¶ added in v6.8.2 

func (f XPackSQLQuery) WithContext(v context.Context) func(*XPackSQLQueryRequest)

WithContext sets the request context.

func (XPackSQLQuery) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSQLQuery) WithErrorTrace() func(*XPackSQLQueryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSQLQuery) WithFilterPath ¶ added in v6.8.2 

func (f XPackSQLQuery) WithFilterPath(v ...string) func(*XPackSQLQueryRequest)

WithFilterPath filters the properties of the response body.

func (XPackSQLQuery) WithFormat ¶ added in v6.8.2 

func (f XPackSQLQuery) WithFormat(v string) func(*XPackSQLQueryRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (XPackSQLQuery) WithHeader ¶ added in v6.8.2 

func (f XPackSQLQuery) WithHeader(h map[string]string) func(*XPackSQLQueryRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSQLQuery) WithHuman ¶ added in v6.8.2 

func (f XPackSQLQuery) WithHuman() func(*XPackSQLQueryRequest)

WithHuman makes statistical values human-readable.

func (XPackSQLQuery) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSQLQuery) WithOpaqueID(s string) func(*XPackSQLQueryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSQLQuery) WithPretty ¶ added in v6.8.2 

func (f XPackSQLQuery) WithPretty() func(*XPackSQLQueryRequest)

WithPretty makes the response body pretty-printed.

type XPackSQLQueryRequest ¶ added in v6.8.2 

type XPackSQLQueryRequest struct {
	Body io.Reader

	Format string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSQLQueryRequest configures the X PackSQL Query API request.

func (XPackSQLQueryRequest) Do ¶ added in v6.8.2 

func (r XPackSQLQueryRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSQLTranslate ¶ added in v6.8.2 

type XPackSQLTranslate func(body io.Reader, o ...func(*XPackSQLTranslateRequest)) (*Response, error)

XPackSQLTranslate - Translate SQL into Elasticsearch queries

func (XPackSQLTranslate) WithContext ¶ added in v6.8.2 

func (f XPackSQLTranslate) WithContext(v context.Context) func(*XPackSQLTranslateRequest)

WithContext sets the request context.

func (XPackSQLTranslate) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSQLTranslate) WithErrorTrace() func(*XPackSQLTranslateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSQLTranslate) WithFilterPath ¶ added in v6.8.2 

func (f XPackSQLTranslate) WithFilterPath(v ...string) func(*XPackSQLTranslateRequest)

WithFilterPath filters the properties of the response body.

func (XPackSQLTranslate) WithHeader ¶ added in v6.8.2 

func (f XPackSQLTranslate) WithHeader(h map[string]string) func(*XPackSQLTranslateRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSQLTranslate) WithHuman ¶ added in v6.8.2 

func (f XPackSQLTranslate) WithHuman() func(*XPackSQLTranslateRequest)

WithHuman makes statistical values human-readable.

func (XPackSQLTranslate) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSQLTranslate) WithOpaqueID(s string) func(*XPackSQLTranslateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSQLTranslate) WithPretty ¶ added in v6.8.2 

func (f XPackSQLTranslate) WithPretty() func(*XPackSQLTranslateRequest)

WithPretty makes the response body pretty-printed.

type XPackSQLTranslateRequest ¶ added in v6.8.2 

type XPackSQLTranslateRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSQLTranslateRequest configures the X PackSQL Translate API request.

func (XPackSQLTranslateRequest) Do ¶ added in v6.8.2 

func (r XPackSQLTranslateRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSSLCertificates ¶ added in v6.8.2 

type XPackSSLCertificates func(o ...func(*XPackSSLCertificatesRequest)) (*Response, error)

XPackSSLCertificates - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html

func (XPackSSLCertificates) WithContext ¶ added in v6.8.2 

func (f XPackSSLCertificates) WithContext(v context.Context) func(*XPackSSLCertificatesRequest)

WithContext sets the request context.

func (XPackSSLCertificates) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSSLCertificates) WithErrorTrace() func(*XPackSSLCertificatesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSSLCertificates) WithFilterPath ¶ added in v6.8.2 

func (f XPackSSLCertificates) WithFilterPath(v ...string) func(*XPackSSLCertificatesRequest)

WithFilterPath filters the properties of the response body.

func (XPackSSLCertificates) WithHeader ¶ added in v6.8.2 

func (f XPackSSLCertificates) WithHeader(h map[string]string) func(*XPackSSLCertificatesRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSSLCertificates) WithHuman ¶ added in v6.8.2 

func (f XPackSSLCertificates) WithHuman() func(*XPackSSLCertificatesRequest)

WithHuman makes statistical values human-readable.

func (XPackSSLCertificates) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSSLCertificates) WithOpaqueID(s string) func(*XPackSSLCertificatesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSSLCertificates) WithPretty ¶ added in v6.8.2 

func (f XPackSSLCertificates) WithPretty() func(*XPackSSLCertificatesRequest)

WithPretty makes the response body pretty-printed.

type XPackSSLCertificatesRequest ¶ added in v6.8.2 

type XPackSSLCertificatesRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSSLCertificatesRequest configures the X PackSSL Certificates API request.

func (XPackSSLCertificatesRequest) Do ¶ added in v6.8.2 

func (r XPackSSLCertificatesRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityAuthenticate ¶ added in v6.8.2 

type XPackSecurityAuthenticate func(o ...func(*XPackSecurityAuthenticateRequest)) (*Response, error)

XPackSecurityAuthenticate - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html

func (XPackSecurityAuthenticate) WithContext ¶ added in v6.8.2 

func (f XPackSecurityAuthenticate) WithContext(v context.Context) func(*XPackSecurityAuthenticateRequest)

WithContext sets the request context.

func (XPackSecurityAuthenticate) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityAuthenticate) WithErrorTrace() func(*XPackSecurityAuthenticateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityAuthenticate) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityAuthenticate) WithFilterPath(v ...string) func(*XPackSecurityAuthenticateRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityAuthenticate) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityAuthenticate) WithHeader(h map[string]string) func(*XPackSecurityAuthenticateRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityAuthenticate) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityAuthenticate) WithHuman() func(*XPackSecurityAuthenticateRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityAuthenticate) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityAuthenticate) WithOpaqueID(s string) func(*XPackSecurityAuthenticateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityAuthenticate) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityAuthenticate) WithPretty() func(*XPackSecurityAuthenticateRequest)

WithPretty makes the response body pretty-printed.

type XPackSecurityAuthenticateRequest ¶ added in v6.8.2 

type XPackSecurityAuthenticateRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityAuthenticateRequest configures the X Pack Security Authenticate API request.

func (XPackSecurityAuthenticateRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityAuthenticateRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityChangePassword ¶ added in v6.8.2 

type XPackSecurityChangePassword func(body io.Reader, o ...func(*XPackSecurityChangePasswordRequest)) (*Response, error)

XPackSecurityChangePassword - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html

func (XPackSecurityChangePassword) WithContext ¶ added in v6.8.2 

func (f XPackSecurityChangePassword) WithContext(v context.Context) func(*XPackSecurityChangePasswordRequest)

WithContext sets the request context.

func (XPackSecurityChangePassword) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityChangePassword) WithErrorTrace() func(*XPackSecurityChangePasswordRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityChangePassword) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityChangePassword) WithFilterPath(v ...string) func(*XPackSecurityChangePasswordRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityChangePassword) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityChangePassword) WithHeader(h map[string]string) func(*XPackSecurityChangePasswordRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityChangePassword) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityChangePassword) WithHuman() func(*XPackSecurityChangePasswordRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityChangePassword) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityChangePassword) WithOpaqueID(s string) func(*XPackSecurityChangePasswordRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityChangePassword) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityChangePassword) WithPretty() func(*XPackSecurityChangePasswordRequest)

WithPretty makes the response body pretty-printed.

func (XPackSecurityChangePassword) WithRefresh ¶ added in v6.8.2 

func (f XPackSecurityChangePassword) WithRefresh(v string) func(*XPackSecurityChangePasswordRequest)

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 (XPackSecurityChangePassword) WithUsername ¶ added in v6.8.2 

func (f XPackSecurityChangePassword) WithUsername(v string) func(*XPackSecurityChangePasswordRequest)

WithUsername - the username of the user to change the password for.

type XPackSecurityChangePasswordRequest ¶ added in v6.8.2 

type XPackSecurityChangePasswordRequest struct {
	Body io.Reader

	Username string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityChangePasswordRequest configures the X Pack Security Change Password API request.

func (XPackSecurityChangePasswordRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityChangePasswordRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityClearCachedRealms ¶ added in v6.8.2 

type XPackSecurityClearCachedRealms func(realms []string, o ...func(*XPackSecurityClearCachedRealmsRequest)) (*Response, error)

XPackSecurityClearCachedRealms - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html

func (XPackSecurityClearCachedRealms) WithContext ¶ added in v6.8.2 

func (f XPackSecurityClearCachedRealms) WithContext(v context.Context) func(*XPackSecurityClearCachedRealmsRequest)

WithContext sets the request context.

func (XPackSecurityClearCachedRealms) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityClearCachedRealms) WithErrorTrace() func(*XPackSecurityClearCachedRealmsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityClearCachedRealms) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityClearCachedRealms) WithFilterPath(v ...string) func(*XPackSecurityClearCachedRealmsRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityClearCachedRealms) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityClearCachedRealms) WithHeader(h map[string]string) func(*XPackSecurityClearCachedRealmsRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityClearCachedRealms) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityClearCachedRealms) WithHuman() func(*XPackSecurityClearCachedRealmsRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityClearCachedRealms) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityClearCachedRealms) WithOpaqueID(s string) func(*XPackSecurityClearCachedRealmsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityClearCachedRealms) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityClearCachedRealms) WithPretty() func(*XPackSecurityClearCachedRealmsRequest)

WithPretty makes the response body pretty-printed.

func (XPackSecurityClearCachedRealms) WithUsernames ¶ added in v6.8.2 

func (f XPackSecurityClearCachedRealms) WithUsernames(v ...string) func(*XPackSecurityClearCachedRealmsRequest)

WithUsernames - comma-separated list of usernames to clear from the cache.

type XPackSecurityClearCachedRealmsRequest ¶ added in v6.8.2 

type XPackSecurityClearCachedRealmsRequest struct {
	Realms []string

	Usernames []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityClearCachedRealmsRequest configures the X Pack Security Clear Cached Realms API request.

func (XPackSecurityClearCachedRealmsRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityClearCachedRealmsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityClearCachedRoles ¶ added in v6.8.2 

type XPackSecurityClearCachedRoles func(name []string, o ...func(*XPackSecurityClearCachedRolesRequest)) (*Response, error)

XPackSecurityClearCachedRoles - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html

func (XPackSecurityClearCachedRoles) WithContext ¶ added in v6.8.2 

func (f XPackSecurityClearCachedRoles) WithContext(v context.Context) func(*XPackSecurityClearCachedRolesRequest)

WithContext sets the request context.

func (XPackSecurityClearCachedRoles) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityClearCachedRoles) WithErrorTrace() func(*XPackSecurityClearCachedRolesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityClearCachedRoles) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityClearCachedRoles) WithFilterPath(v ...string) func(*XPackSecurityClearCachedRolesRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityClearCachedRoles) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityClearCachedRoles) WithHeader(h map[string]string) func(*XPackSecurityClearCachedRolesRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityClearCachedRoles) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityClearCachedRoles) WithHuman() func(*XPackSecurityClearCachedRolesRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityClearCachedRoles) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityClearCachedRoles) WithOpaqueID(s string) func(*XPackSecurityClearCachedRolesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityClearCachedRoles) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityClearCachedRoles) WithPretty() func(*XPackSecurityClearCachedRolesRequest)

WithPretty makes the response body pretty-printed.

type XPackSecurityClearCachedRolesRequest ¶ added in v6.8.2 

type XPackSecurityClearCachedRolesRequest struct {
	Name []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityClearCachedRolesRequest configures the X Pack Security Clear Cached Roles API request.

func (XPackSecurityClearCachedRolesRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityClearCachedRolesRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityDeletePrivileges ¶ added in v6.8.2 

type XPackSecurityDeletePrivileges func(name string, application string, o ...func(*XPackSecurityDeletePrivilegesRequest)) (*Response, error)

XPackSecurityDeletePrivileges - TODO

func (XPackSecurityDeletePrivileges) WithContext ¶ added in v6.8.2 

func (f XPackSecurityDeletePrivileges) WithContext(v context.Context) func(*XPackSecurityDeletePrivilegesRequest)

WithContext sets the request context.

func (XPackSecurityDeletePrivileges) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityDeletePrivileges) WithErrorTrace() func(*XPackSecurityDeletePrivilegesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityDeletePrivileges) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityDeletePrivileges) WithFilterPath(v ...string) func(*XPackSecurityDeletePrivilegesRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityDeletePrivileges) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityDeletePrivileges) WithHeader(h map[string]string) func(*XPackSecurityDeletePrivilegesRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityDeletePrivileges) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityDeletePrivileges) WithHuman() func(*XPackSecurityDeletePrivilegesRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityDeletePrivileges) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityDeletePrivileges) WithOpaqueID(s string) func(*XPackSecurityDeletePrivilegesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityDeletePrivileges) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityDeletePrivileges) WithPretty() func(*XPackSecurityDeletePrivilegesRequest)

WithPretty makes the response body pretty-printed.

func (XPackSecurityDeletePrivileges) WithRefresh ¶ added in v6.8.2 

func (f XPackSecurityDeletePrivileges) WithRefresh(v string) func(*XPackSecurityDeletePrivilegesRequest)

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 XPackSecurityDeletePrivilegesRequest ¶ added in v6.8.2 

type XPackSecurityDeletePrivilegesRequest struct {
	Application string
	Name        string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityDeletePrivilegesRequest configures the X Pack Security Delete Privileges API request.

func (XPackSecurityDeletePrivilegesRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityDeletePrivilegesRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityDeleteRole ¶ added in v6.8.2 

type XPackSecurityDeleteRole func(name string, o ...func(*XPackSecurityDeleteRoleRequest)) (*Response, error)

XPackSecurityDeleteRole - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html

func (XPackSecurityDeleteRole) WithContext ¶ added in v6.8.2 

func (f XPackSecurityDeleteRole) WithContext(v context.Context) func(*XPackSecurityDeleteRoleRequest)

WithContext sets the request context.

func (XPackSecurityDeleteRole) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityDeleteRole) WithErrorTrace() func(*XPackSecurityDeleteRoleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityDeleteRole) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityDeleteRole) WithFilterPath(v ...string) func(*XPackSecurityDeleteRoleRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityDeleteRole) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityDeleteRole) WithHeader(h map[string]string) func(*XPackSecurityDeleteRoleRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityDeleteRole) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityDeleteRole) WithHuman() func(*XPackSecurityDeleteRoleRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityDeleteRole) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityDeleteRole) WithOpaqueID(s string) func(*XPackSecurityDeleteRoleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityDeleteRole) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityDeleteRole) WithPretty() func(*XPackSecurityDeleteRoleRequest)

WithPretty makes the response body pretty-printed.

func (XPackSecurityDeleteRole) WithRefresh ¶ added in v6.8.2 

func (f XPackSecurityDeleteRole) WithRefresh(v string) func(*XPackSecurityDeleteRoleRequest)

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 XPackSecurityDeleteRoleMapping ¶ added in v6.8.2 

type XPackSecurityDeleteRoleMapping func(name string, o ...func(*XPackSecurityDeleteRoleMappingRequest)) (*Response, error)

XPackSecurityDeleteRoleMapping - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html

func (XPackSecurityDeleteRoleMapping) WithContext ¶ added in v6.8.2 

func (f XPackSecurityDeleteRoleMapping) WithContext(v context.Context) func(*XPackSecurityDeleteRoleMappingRequest)

WithContext sets the request context.

func (XPackSecurityDeleteRoleMapping) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityDeleteRoleMapping) WithErrorTrace() func(*XPackSecurityDeleteRoleMappingRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityDeleteRoleMapping) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityDeleteRoleMapping) WithFilterPath(v ...string) func(*XPackSecurityDeleteRoleMappingRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityDeleteRoleMapping) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityDeleteRoleMapping) WithHeader(h map[string]string) func(*XPackSecurityDeleteRoleMappingRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityDeleteRoleMapping) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityDeleteRoleMapping) WithHuman() func(*XPackSecurityDeleteRoleMappingRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityDeleteRoleMapping) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityDeleteRoleMapping) WithOpaqueID(s string) func(*XPackSecurityDeleteRoleMappingRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityDeleteRoleMapping) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityDeleteRoleMapping) WithPretty() func(*XPackSecurityDeleteRoleMappingRequest)

WithPretty makes the response body pretty-printed.

func (XPackSecurityDeleteRoleMapping) WithRefresh ¶ added in v6.8.2 

func (f XPackSecurityDeleteRoleMapping) WithRefresh(v string) func(*XPackSecurityDeleteRoleMappingRequest)

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 XPackSecurityDeleteRoleMappingRequest ¶ added in v6.8.2 

type XPackSecurityDeleteRoleMappingRequest struct {
	Name string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityDeleteRoleMappingRequest configures the X Pack Security Delete Role Mapping API request.

func (XPackSecurityDeleteRoleMappingRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityDeleteRoleMappingRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityDeleteRoleRequest ¶ added in v6.8.2 

type XPackSecurityDeleteRoleRequest struct {
	Name string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityDeleteRoleRequest configures the X Pack Security Delete Role API request.

func (XPackSecurityDeleteRoleRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityDeleteRoleRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityDeleteUser ¶ added in v6.8.2 

type XPackSecurityDeleteUser func(username string, o ...func(*XPackSecurityDeleteUserRequest)) (*Response, error)

XPackSecurityDeleteUser - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html

func (XPackSecurityDeleteUser) WithContext ¶ added in v6.8.2 

func (f XPackSecurityDeleteUser) WithContext(v context.Context) func(*XPackSecurityDeleteUserRequest)

WithContext sets the request context.

func (XPackSecurityDeleteUser) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityDeleteUser) WithErrorTrace() func(*XPackSecurityDeleteUserRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityDeleteUser) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityDeleteUser) WithFilterPath(v ...string) func(*XPackSecurityDeleteUserRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityDeleteUser) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityDeleteUser) WithHeader(h map[string]string) func(*XPackSecurityDeleteUserRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityDeleteUser) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityDeleteUser) WithHuman() func(*XPackSecurityDeleteUserRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityDeleteUser) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityDeleteUser) WithOpaqueID(s string) func(*XPackSecurityDeleteUserRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityDeleteUser) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityDeleteUser) WithPretty() func(*XPackSecurityDeleteUserRequest)

WithPretty makes the response body pretty-printed.

func (XPackSecurityDeleteUser) WithRefresh ¶ added in v6.8.2 

func (f XPackSecurityDeleteUser) WithRefresh(v string) func(*XPackSecurityDeleteUserRequest)

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 XPackSecurityDeleteUserRequest ¶ added in v6.8.2 

type XPackSecurityDeleteUserRequest struct {
	Username string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityDeleteUserRequest configures the X Pack Security Delete User API request.

func (XPackSecurityDeleteUserRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityDeleteUserRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityDisableUser ¶ added in v6.8.2 

type XPackSecurityDisableUser func(username string, o ...func(*XPackSecurityDisableUserRequest)) (*Response, error)

XPackSecurityDisableUser - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html

func (XPackSecurityDisableUser) WithContext ¶ added in v6.8.2 

func (f XPackSecurityDisableUser) WithContext(v context.Context) func(*XPackSecurityDisableUserRequest)

WithContext sets the request context.

func (XPackSecurityDisableUser) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityDisableUser) WithErrorTrace() func(*XPackSecurityDisableUserRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityDisableUser) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityDisableUser) WithFilterPath(v ...string) func(*XPackSecurityDisableUserRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityDisableUser) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityDisableUser) WithHeader(h map[string]string) func(*XPackSecurityDisableUserRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityDisableUser) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityDisableUser) WithHuman() func(*XPackSecurityDisableUserRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityDisableUser) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityDisableUser) WithOpaqueID(s string) func(*XPackSecurityDisableUserRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityDisableUser) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityDisableUser) WithPretty() func(*XPackSecurityDisableUserRequest)

WithPretty makes the response body pretty-printed.

func (XPackSecurityDisableUser) WithRefresh ¶ added in v6.8.2 

func (f XPackSecurityDisableUser) WithRefresh(v string) func(*XPackSecurityDisableUserRequest)

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 XPackSecurityDisableUserRequest ¶ added in v6.8.2 

type XPackSecurityDisableUserRequest struct {
	Username string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityDisableUserRequest configures the X Pack Security Disable User API request.

func (XPackSecurityDisableUserRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityDisableUserRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityEnableUser ¶ added in v6.8.2 

type XPackSecurityEnableUser func(username string, o ...func(*XPackSecurityEnableUserRequest)) (*Response, error)

XPackSecurityEnableUser - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html

func (XPackSecurityEnableUser) WithContext ¶ added in v6.8.2 

func (f XPackSecurityEnableUser) WithContext(v context.Context) func(*XPackSecurityEnableUserRequest)

WithContext sets the request context.

func (XPackSecurityEnableUser) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityEnableUser) WithErrorTrace() func(*XPackSecurityEnableUserRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityEnableUser) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityEnableUser) WithFilterPath(v ...string) func(*XPackSecurityEnableUserRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityEnableUser) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityEnableUser) WithHeader(h map[string]string) func(*XPackSecurityEnableUserRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityEnableUser) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityEnableUser) WithHuman() func(*XPackSecurityEnableUserRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityEnableUser) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityEnableUser) WithOpaqueID(s string) func(*XPackSecurityEnableUserRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityEnableUser) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityEnableUser) WithPretty() func(*XPackSecurityEnableUserRequest)

WithPretty makes the response body pretty-printed.

func (XPackSecurityEnableUser) WithRefresh ¶ added in v6.8.2 

func (f XPackSecurityEnableUser) WithRefresh(v string) func(*XPackSecurityEnableUserRequest)

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 XPackSecurityEnableUserRequest ¶ added in v6.8.2 

type XPackSecurityEnableUserRequest struct {
	Username string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityEnableUserRequest configures the X Pack Security Enable User API request.

func (XPackSecurityEnableUserRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityEnableUserRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityGetPrivileges ¶ added in v6.8.2 

type XPackSecurityGetPrivileges func(o ...func(*XPackSecurityGetPrivilegesRequest)) (*Response, error)

XPackSecurityGetPrivileges - TODO

func (XPackSecurityGetPrivileges) WithApplication ¶ added in v6.8.2 

func (f XPackSecurityGetPrivileges) WithApplication(v string) func(*XPackSecurityGetPrivilegesRequest)

WithApplication - application name.

func (XPackSecurityGetPrivileges) WithContext ¶ added in v6.8.2 

func (f XPackSecurityGetPrivileges) WithContext(v context.Context) func(*XPackSecurityGetPrivilegesRequest)

WithContext sets the request context.

func (XPackSecurityGetPrivileges) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityGetPrivileges) WithErrorTrace() func(*XPackSecurityGetPrivilegesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityGetPrivileges) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityGetPrivileges) WithFilterPath(v ...string) func(*XPackSecurityGetPrivilegesRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityGetPrivileges) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityGetPrivileges) WithHeader(h map[string]string) func(*XPackSecurityGetPrivilegesRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityGetPrivileges) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityGetPrivileges) WithHuman() func(*XPackSecurityGetPrivilegesRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityGetPrivileges) WithName ¶ added in v6.8.2 

func (f XPackSecurityGetPrivileges) WithName(v string) func(*XPackSecurityGetPrivilegesRequest)

WithName - privilege name.

func (XPackSecurityGetPrivileges) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityGetPrivileges) WithOpaqueID(s string) func(*XPackSecurityGetPrivilegesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityGetPrivileges) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityGetPrivileges) WithPretty() func(*XPackSecurityGetPrivilegesRequest)

WithPretty makes the response body pretty-printed.

type XPackSecurityGetPrivilegesRequest ¶ added in v6.8.2 

type XPackSecurityGetPrivilegesRequest struct {
	Application string
	Name        string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityGetPrivilegesRequest configures the X Pack Security Get Privileges API request.

func (XPackSecurityGetPrivilegesRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityGetPrivilegesRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityGetRole ¶ added in v6.8.2 

type XPackSecurityGetRole func(o ...func(*XPackSecurityGetRoleRequest)) (*Response, error)

XPackSecurityGetRole - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html

func (XPackSecurityGetRole) WithContext ¶ added in v6.8.2 

func (f XPackSecurityGetRole) WithContext(v context.Context) func(*XPackSecurityGetRoleRequest)

WithContext sets the request context.

func (XPackSecurityGetRole) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityGetRole) WithErrorTrace() func(*XPackSecurityGetRoleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityGetRole) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityGetRole) WithFilterPath(v ...string) func(*XPackSecurityGetRoleRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityGetRole) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityGetRole) WithHeader(h map[string]string) func(*XPackSecurityGetRoleRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityGetRole) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityGetRole) WithHuman() func(*XPackSecurityGetRoleRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityGetRole) WithName ¶ added in v6.8.2 

func (f XPackSecurityGetRole) WithName(v string) func(*XPackSecurityGetRoleRequest)

WithName - role name.

func (XPackSecurityGetRole) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityGetRole) WithOpaqueID(s string) func(*XPackSecurityGetRoleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityGetRole) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityGetRole) WithPretty() func(*XPackSecurityGetRoleRequest)

WithPretty makes the response body pretty-printed.

type XPackSecurityGetRoleMapping ¶ added in v6.8.2 

type XPackSecurityGetRoleMapping func(o ...func(*XPackSecurityGetRoleMappingRequest)) (*Response, error)

XPackSecurityGetRoleMapping - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html

func (XPackSecurityGetRoleMapping) WithContext ¶ added in v6.8.2 

func (f XPackSecurityGetRoleMapping) WithContext(v context.Context) func(*XPackSecurityGetRoleMappingRequest)

WithContext sets the request context.

func (XPackSecurityGetRoleMapping) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityGetRoleMapping) WithErrorTrace() func(*XPackSecurityGetRoleMappingRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityGetRoleMapping) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityGetRoleMapping) WithFilterPath(v ...string) func(*XPackSecurityGetRoleMappingRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityGetRoleMapping) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityGetRoleMapping) WithHeader(h map[string]string) func(*XPackSecurityGetRoleMappingRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityGetRoleMapping) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityGetRoleMapping) WithHuman() func(*XPackSecurityGetRoleMappingRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityGetRoleMapping) WithName ¶ added in v6.8.2 

func (f XPackSecurityGetRoleMapping) WithName(v string) func(*XPackSecurityGetRoleMappingRequest)

WithName - role-mapping name.

func (XPackSecurityGetRoleMapping) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityGetRoleMapping) WithOpaqueID(s string) func(*XPackSecurityGetRoleMappingRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityGetRoleMapping) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityGetRoleMapping) WithPretty() func(*XPackSecurityGetRoleMappingRequest)

WithPretty makes the response body pretty-printed.

type XPackSecurityGetRoleMappingRequest ¶ added in v6.8.2 

type XPackSecurityGetRoleMappingRequest struct {
	Name string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityGetRoleMappingRequest configures the X Pack Security Get Role Mapping API request.

func (XPackSecurityGetRoleMappingRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityGetRoleMappingRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityGetRoleRequest ¶ added in v6.8.2 

type XPackSecurityGetRoleRequest struct {
	Name string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityGetRoleRequest configures the X Pack Security Get Role API request.

func (XPackSecurityGetRoleRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityGetRoleRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityGetToken ¶ added in v6.8.2 

type XPackSecurityGetToken func(body io.Reader, o ...func(*XPackSecurityGetTokenRequest)) (*Response, error)

XPackSecurityGetToken - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html

func (XPackSecurityGetToken) WithContext ¶ added in v6.8.2 

func (f XPackSecurityGetToken) WithContext(v context.Context) func(*XPackSecurityGetTokenRequest)

WithContext sets the request context.

func (XPackSecurityGetToken) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityGetToken) WithErrorTrace() func(*XPackSecurityGetTokenRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityGetToken) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityGetToken) WithFilterPath(v ...string) func(*XPackSecurityGetTokenRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityGetToken) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityGetToken) WithHeader(h map[string]string) func(*XPackSecurityGetTokenRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityGetToken) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityGetToken) WithHuman() func(*XPackSecurityGetTokenRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityGetToken) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityGetToken) WithOpaqueID(s string) func(*XPackSecurityGetTokenRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityGetToken) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityGetToken) WithPretty() func(*XPackSecurityGetTokenRequest)

WithPretty makes the response body pretty-printed.

type XPackSecurityGetTokenRequest ¶ added in v6.8.2 

type XPackSecurityGetTokenRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityGetTokenRequest configures the X Pack Security Get Token API request.

func (XPackSecurityGetTokenRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityGetTokenRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityGetUser ¶ added in v6.8.2 

type XPackSecurityGetUser func(o ...func(*XPackSecurityGetUserRequest)) (*Response, error)

XPackSecurityGetUser - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html

func (XPackSecurityGetUser) WithContext ¶ added in v6.8.2 

func (f XPackSecurityGetUser) WithContext(v context.Context) func(*XPackSecurityGetUserRequest)

WithContext sets the request context.

func (XPackSecurityGetUser) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityGetUser) WithErrorTrace() func(*XPackSecurityGetUserRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityGetUser) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityGetUser) WithFilterPath(v ...string) func(*XPackSecurityGetUserRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityGetUser) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityGetUser) WithHeader(h map[string]string) func(*XPackSecurityGetUserRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityGetUser) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityGetUser) WithHuman() func(*XPackSecurityGetUserRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityGetUser) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityGetUser) WithOpaqueID(s string) func(*XPackSecurityGetUserRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityGetUser) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityGetUser) WithPretty() func(*XPackSecurityGetUserRequest)

WithPretty makes the response body pretty-printed.

func (XPackSecurityGetUser) WithUsername ¶ added in v6.8.2 

func (f XPackSecurityGetUser) WithUsername(v ...string) func(*XPackSecurityGetUserRequest)

WithUsername - a list of usernames.

type XPackSecurityGetUserPrivileges ¶ added in v6.8.2 

type XPackSecurityGetUserPrivileges func(o ...func(*XPackSecurityGetUserPrivilegesRequest)) (*Response, error)

XPackSecurityGetUserPrivileges - https://www.elastic.co/guide/en/elasticsearch/reference/6.7/security-api-get-privileges.html

func (XPackSecurityGetUserPrivileges) WithContext ¶ added in v6.8.2 

func (f XPackSecurityGetUserPrivileges) WithContext(v context.Context) func(*XPackSecurityGetUserPrivilegesRequest)

WithContext sets the request context.

func (XPackSecurityGetUserPrivileges) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityGetUserPrivileges) WithErrorTrace() func(*XPackSecurityGetUserPrivilegesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityGetUserPrivileges) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityGetUserPrivileges) WithFilterPath(v ...string) func(*XPackSecurityGetUserPrivilegesRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityGetUserPrivileges) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityGetUserPrivileges) WithHeader(h map[string]string) func(*XPackSecurityGetUserPrivilegesRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityGetUserPrivileges) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityGetUserPrivileges) WithHuman() func(*XPackSecurityGetUserPrivilegesRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityGetUserPrivileges) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityGetUserPrivileges) WithOpaqueID(s string) func(*XPackSecurityGetUserPrivilegesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityGetUserPrivileges) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityGetUserPrivileges) WithPretty() func(*XPackSecurityGetUserPrivilegesRequest)

WithPretty makes the response body pretty-printed.

type XPackSecurityGetUserPrivilegesRequest ¶ added in v6.8.2 

type XPackSecurityGetUserPrivilegesRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityGetUserPrivilegesRequest configures the X Pack Security Get User Privileges API request.

func (XPackSecurityGetUserPrivilegesRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityGetUserPrivilegesRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityGetUserRequest ¶ added in v6.8.2 

type XPackSecurityGetUserRequest struct {
	Username []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityGetUserRequest configures the X Pack Security Get User API request.

func (XPackSecurityGetUserRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityGetUserRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityHasPrivileges ¶ added in v6.8.2 

type XPackSecurityHasPrivileges func(body io.Reader, o ...func(*XPackSecurityHasPrivilegesRequest)) (*Response, error)

XPackSecurityHasPrivileges - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html

func (XPackSecurityHasPrivileges) WithContext ¶ added in v6.8.2 

func (f XPackSecurityHasPrivileges) WithContext(v context.Context) func(*XPackSecurityHasPrivilegesRequest)

WithContext sets the request context.

func (XPackSecurityHasPrivileges) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityHasPrivileges) WithErrorTrace() func(*XPackSecurityHasPrivilegesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityHasPrivileges) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityHasPrivileges) WithFilterPath(v ...string) func(*XPackSecurityHasPrivilegesRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityHasPrivileges) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityHasPrivileges) WithHeader(h map[string]string) func(*XPackSecurityHasPrivilegesRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityHasPrivileges) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityHasPrivileges) WithHuman() func(*XPackSecurityHasPrivilegesRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityHasPrivileges) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityHasPrivileges) WithOpaqueID(s string) func(*XPackSecurityHasPrivilegesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityHasPrivileges) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityHasPrivileges) WithPretty() func(*XPackSecurityHasPrivilegesRequest)

WithPretty makes the response body pretty-printed.

func (XPackSecurityHasPrivileges) WithUser ¶ added in v6.8.2 

func (f XPackSecurityHasPrivileges) WithUser(v string) func(*XPackSecurityHasPrivilegesRequest)

WithUser - username.

type XPackSecurityHasPrivilegesRequest ¶ added in v6.8.2 

type XPackSecurityHasPrivilegesRequest struct {
	Body io.Reader

	User string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityHasPrivilegesRequest configures the X Pack Security Has Privileges API request.

func (XPackSecurityHasPrivilegesRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityHasPrivilegesRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityInvalidateToken ¶ added in v6.8.2 

type XPackSecurityInvalidateToken func(body io.Reader, o ...func(*XPackSecurityInvalidateTokenRequest)) (*Response, error)

XPackSecurityInvalidateToken - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html

func (XPackSecurityInvalidateToken) WithContext ¶ added in v6.8.2 

func (f XPackSecurityInvalidateToken) WithContext(v context.Context) func(*XPackSecurityInvalidateTokenRequest)

WithContext sets the request context.

func (XPackSecurityInvalidateToken) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityInvalidateToken) WithErrorTrace() func(*XPackSecurityInvalidateTokenRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityInvalidateToken) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityInvalidateToken) WithFilterPath(v ...string) func(*XPackSecurityInvalidateTokenRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityInvalidateToken) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityInvalidateToken) WithHeader(h map[string]string) func(*XPackSecurityInvalidateTokenRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityInvalidateToken) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityInvalidateToken) WithHuman() func(*XPackSecurityInvalidateTokenRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityInvalidateToken) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityInvalidateToken) WithOpaqueID(s string) func(*XPackSecurityInvalidateTokenRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityInvalidateToken) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityInvalidateToken) WithPretty() func(*XPackSecurityInvalidateTokenRequest)

WithPretty makes the response body pretty-printed.

type XPackSecurityInvalidateTokenRequest ¶ added in v6.8.2 

type XPackSecurityInvalidateTokenRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityInvalidateTokenRequest configures the X Pack Security Invalidate Token API request.

func (XPackSecurityInvalidateTokenRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityInvalidateTokenRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityPutPrivileges ¶ added in v6.8.2 

type XPackSecurityPutPrivileges func(body io.Reader, o ...func(*XPackSecurityPutPrivilegesRequest)) (*Response, error)

XPackSecurityPutPrivileges - TODO

func (XPackSecurityPutPrivileges) WithContext ¶ added in v6.8.2 

func (f XPackSecurityPutPrivileges) WithContext(v context.Context) func(*XPackSecurityPutPrivilegesRequest)

WithContext sets the request context.

func (XPackSecurityPutPrivileges) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityPutPrivileges) WithErrorTrace() func(*XPackSecurityPutPrivilegesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityPutPrivileges) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityPutPrivileges) WithFilterPath(v ...string) func(*XPackSecurityPutPrivilegesRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityPutPrivileges) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityPutPrivileges) WithHeader(h map[string]string) func(*XPackSecurityPutPrivilegesRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityPutPrivileges) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityPutPrivileges) WithHuman() func(*XPackSecurityPutPrivilegesRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityPutPrivileges) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityPutPrivileges) WithOpaqueID(s string) func(*XPackSecurityPutPrivilegesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityPutPrivileges) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityPutPrivileges) WithPretty() func(*XPackSecurityPutPrivilegesRequest)

WithPretty makes the response body pretty-printed.

func (XPackSecurityPutPrivileges) WithRefresh ¶ added in v6.8.2 

func (f XPackSecurityPutPrivileges) WithRefresh(v string) func(*XPackSecurityPutPrivilegesRequest)

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 XPackSecurityPutPrivilegesRequest ¶ added in v6.8.2 

type XPackSecurityPutPrivilegesRequest struct {
	Body io.Reader

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityPutPrivilegesRequest configures the X Pack Security Put Privileges API request.

func (XPackSecurityPutPrivilegesRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityPutPrivilegesRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityPutRole ¶ added in v6.8.2 

type XPackSecurityPutRole func(name string, body io.Reader, o ...func(*XPackSecurityPutRoleRequest)) (*Response, error)

XPackSecurityPutRole - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html

func (XPackSecurityPutRole) WithContext ¶ added in v6.8.2 

func (f XPackSecurityPutRole) WithContext(v context.Context) func(*XPackSecurityPutRoleRequest)

WithContext sets the request context.

func (XPackSecurityPutRole) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityPutRole) WithErrorTrace() func(*XPackSecurityPutRoleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityPutRole) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityPutRole) WithFilterPath(v ...string) func(*XPackSecurityPutRoleRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityPutRole) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityPutRole) WithHeader(h map[string]string) func(*XPackSecurityPutRoleRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityPutRole) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityPutRole) WithHuman() func(*XPackSecurityPutRoleRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityPutRole) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityPutRole) WithOpaqueID(s string) func(*XPackSecurityPutRoleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityPutRole) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityPutRole) WithPretty() func(*XPackSecurityPutRoleRequest)

WithPretty makes the response body pretty-printed.

func (XPackSecurityPutRole) WithRefresh ¶ added in v6.8.2 

func (f XPackSecurityPutRole) WithRefresh(v string) func(*XPackSecurityPutRoleRequest)

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 XPackSecurityPutRoleMapping ¶ added in v6.8.2 

type XPackSecurityPutRoleMapping func(name string, body io.Reader, o ...func(*XPackSecurityPutRoleMappingRequest)) (*Response, error)

XPackSecurityPutRoleMapping - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html

func (XPackSecurityPutRoleMapping) WithContext ¶ added in v6.8.2 

func (f XPackSecurityPutRoleMapping) WithContext(v context.Context) func(*XPackSecurityPutRoleMappingRequest)

WithContext sets the request context.

func (XPackSecurityPutRoleMapping) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityPutRoleMapping) WithErrorTrace() func(*XPackSecurityPutRoleMappingRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityPutRoleMapping) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityPutRoleMapping) WithFilterPath(v ...string) func(*XPackSecurityPutRoleMappingRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityPutRoleMapping) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityPutRoleMapping) WithHeader(h map[string]string) func(*XPackSecurityPutRoleMappingRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityPutRoleMapping) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityPutRoleMapping) WithHuman() func(*XPackSecurityPutRoleMappingRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityPutRoleMapping) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityPutRoleMapping) WithOpaqueID(s string) func(*XPackSecurityPutRoleMappingRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityPutRoleMapping) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityPutRoleMapping) WithPretty() func(*XPackSecurityPutRoleMappingRequest)

WithPretty makes the response body pretty-printed.

func (XPackSecurityPutRoleMapping) WithRefresh ¶ added in v6.8.2 

func (f XPackSecurityPutRoleMapping) WithRefresh(v string) func(*XPackSecurityPutRoleMappingRequest)

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 XPackSecurityPutRoleMappingRequest ¶ added in v6.8.2 

type XPackSecurityPutRoleMappingRequest struct {
	Body io.Reader

	Name string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityPutRoleMappingRequest configures the X Pack Security Put Role Mapping API request.

func (XPackSecurityPutRoleMappingRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityPutRoleMappingRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityPutRoleRequest ¶ added in v6.8.2 

type XPackSecurityPutRoleRequest struct {
	Body io.Reader

	Name string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityPutRoleRequest configures the X Pack Security Put Role API request.

func (XPackSecurityPutRoleRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityPutRoleRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackSecurityPutUser ¶ added in v6.8.2 

type XPackSecurityPutUser func(username string, body io.Reader, o ...func(*XPackSecurityPutUserRequest)) (*Response, error)

XPackSecurityPutUser - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html

func (XPackSecurityPutUser) WithContext ¶ added in v6.8.2 

func (f XPackSecurityPutUser) WithContext(v context.Context) func(*XPackSecurityPutUserRequest)

WithContext sets the request context.

func (XPackSecurityPutUser) WithErrorTrace ¶ added in v6.8.2 

func (f XPackSecurityPutUser) WithErrorTrace() func(*XPackSecurityPutUserRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackSecurityPutUser) WithFilterPath ¶ added in v6.8.2 

func (f XPackSecurityPutUser) WithFilterPath(v ...string) func(*XPackSecurityPutUserRequest)

WithFilterPath filters the properties of the response body.

func (XPackSecurityPutUser) WithHeader ¶ added in v6.8.2 

func (f XPackSecurityPutUser) WithHeader(h map[string]string) func(*XPackSecurityPutUserRequest)

WithHeader adds the headers to the HTTP request.

func (XPackSecurityPutUser) WithHuman ¶ added in v6.8.2 

func (f XPackSecurityPutUser) WithHuman() func(*XPackSecurityPutUserRequest)

WithHuman makes statistical values human-readable.

func (XPackSecurityPutUser) WithOpaqueID ¶ added in v6.8.5 

func (f XPackSecurityPutUser) WithOpaqueID(s string) func(*XPackSecurityPutUserRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackSecurityPutUser) WithPretty ¶ added in v6.8.2 

func (f XPackSecurityPutUser) WithPretty() func(*XPackSecurityPutUserRequest)

WithPretty makes the response body pretty-printed.

func (XPackSecurityPutUser) WithRefresh ¶ added in v6.8.2 

func (f XPackSecurityPutUser) WithRefresh(v string) func(*XPackSecurityPutUserRequest)

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 XPackSecurityPutUserRequest ¶ added in v6.8.2 

type XPackSecurityPutUserRequest struct {
	Body io.Reader

	Username string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackSecurityPutUserRequest configures the X Pack Security Put User API request.

func (XPackSecurityPutUserRequest) Do ¶ added in v6.8.2 

func (r XPackSecurityPutUserRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackUsage ¶ added in v6.8.2 

type XPackUsage func(o ...func(*XPackUsageRequest)) (*Response, error)

XPackUsage - Retrieve information about xpack features usage

func (XPackUsage) WithContext ¶ added in v6.8.2 

func (f XPackUsage) WithContext(v context.Context) func(*XPackUsageRequest)

WithContext sets the request context.

func (XPackUsage) WithErrorTrace ¶ added in v6.8.2 

func (f XPackUsage) WithErrorTrace() func(*XPackUsageRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackUsage) WithFilterPath ¶ added in v6.8.2 

func (f XPackUsage) WithFilterPath(v ...string) func(*XPackUsageRequest)

WithFilterPath filters the properties of the response body.

func (XPackUsage) WithHeader ¶ added in v6.8.2 

func (f XPackUsage) WithHeader(h map[string]string) func(*XPackUsageRequest)

WithHeader adds the headers to the HTTP request.

func (XPackUsage) WithHuman ¶ added in v6.8.2 

func (f XPackUsage) WithHuman() func(*XPackUsageRequest)

WithHuman makes statistical values human-readable.

func (XPackUsage) WithMasterTimeout ¶ added in v6.8.2 

func (f XPackUsage) WithMasterTimeout(v time.Duration) func(*XPackUsageRequest)

WithMasterTimeout - specify timeout for watch write operation.

func (XPackUsage) WithOpaqueID ¶ added in v6.8.5 

func (f XPackUsage) WithOpaqueID(s string) func(*XPackUsageRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackUsage) WithPretty ¶ added in v6.8.2 

func (f XPackUsage) WithPretty() func(*XPackUsageRequest)

WithPretty makes the response body pretty-printed.

type XPackUsageRequest ¶ added in v6.8.2 

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.

func (XPackUsageRequest) Do ¶ added in v6.8.2 

func (r XPackUsageRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackWatcherAckWatch ¶ added in v6.8.2 

type XPackWatcherAckWatch func(watch_id string, o ...func(*XPackWatcherAckWatchRequest)) (*Response, error)

XPackWatcherAckWatch - http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html

func (XPackWatcherAckWatch) WithActionID ¶ added in v6.8.2 

func (f XPackWatcherAckWatch) WithActionID(v ...string) func(*XPackWatcherAckWatchRequest)

WithActionID - a list of the action ids to be acked.

func (XPackWatcherAckWatch) WithContext ¶ added in v6.8.2 

func (f XPackWatcherAckWatch) WithContext(v context.Context) func(*XPackWatcherAckWatchRequest)

WithContext sets the request context.

func (XPackWatcherAckWatch) WithErrorTrace ¶ added in v6.8.2 

func (f XPackWatcherAckWatch) WithErrorTrace() func(*XPackWatcherAckWatchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackWatcherAckWatch) WithFilterPath ¶ added in v6.8.2 

func (f XPackWatcherAckWatch) WithFilterPath(v ...string) func(*XPackWatcherAckWatchRequest)

WithFilterPath filters the properties of the response body.

func (XPackWatcherAckWatch) WithHeader ¶ added in v6.8.2 

func (f XPackWatcherAckWatch) WithHeader(h map[string]string) func(*XPackWatcherAckWatchRequest)

WithHeader adds the headers to the HTTP request.

func (XPackWatcherAckWatch) WithHuman ¶ added in v6.8.2 

func (f XPackWatcherAckWatch) WithHuman() func(*XPackWatcherAckWatchRequest)

WithHuman makes statistical values human-readable.

func (XPackWatcherAckWatch) WithMasterTimeout ¶ added in v6.8.2 

func (f XPackWatcherAckWatch) WithMasterTimeout(v time.Duration) func(*XPackWatcherAckWatchRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (XPackWatcherAckWatch) WithOpaqueID ¶ added in v6.8.5 

func (f XPackWatcherAckWatch) WithOpaqueID(s string) func(*XPackWatcherAckWatchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackWatcherAckWatch) WithPretty ¶ added in v6.8.2 

func (f XPackWatcherAckWatch) WithPretty() func(*XPackWatcherAckWatchRequest)

WithPretty makes the response body pretty-printed.

type XPackWatcherAckWatchRequest ¶ added in v6.8.2 

type XPackWatcherAckWatchRequest struct {
	ActionID []string
	WatchID  string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackWatcherAckWatchRequest configures the X Pack Watcher Ack Watch API request.

func (XPackWatcherAckWatchRequest) Do ¶ added in v6.8.2 

func (r XPackWatcherAckWatchRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackWatcherActivateWatch ¶ added in v6.8.2 

type XPackWatcherActivateWatch func(watch_id string, o ...func(*XPackWatcherActivateWatchRequest)) (*Response, error)

XPackWatcherActivateWatch - https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html

func (XPackWatcherActivateWatch) WithContext ¶ added in v6.8.2 

func (f XPackWatcherActivateWatch) WithContext(v context.Context) func(*XPackWatcherActivateWatchRequest)

WithContext sets the request context.

func (XPackWatcherActivateWatch) WithErrorTrace ¶ added in v6.8.2 

func (f XPackWatcherActivateWatch) WithErrorTrace() func(*XPackWatcherActivateWatchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackWatcherActivateWatch) WithFilterPath ¶ added in v6.8.2 

func (f XPackWatcherActivateWatch) WithFilterPath(v ...string) func(*XPackWatcherActivateWatchRequest)

WithFilterPath filters the properties of the response body.

func (XPackWatcherActivateWatch) WithHeader ¶ added in v6.8.2 

func (f XPackWatcherActivateWatch) WithHeader(h map[string]string) func(*XPackWatcherActivateWatchRequest)

WithHeader adds the headers to the HTTP request.

func (XPackWatcherActivateWatch) WithHuman ¶ added in v6.8.2 

func (f XPackWatcherActivateWatch) WithHuman() func(*XPackWatcherActivateWatchRequest)

WithHuman makes statistical values human-readable.

func (XPackWatcherActivateWatch) WithMasterTimeout ¶ added in v6.8.2 

func (f XPackWatcherActivateWatch) WithMasterTimeout(v time.Duration) func(*XPackWatcherActivateWatchRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (XPackWatcherActivateWatch) WithOpaqueID ¶ added in v6.8.5 

func (f XPackWatcherActivateWatch) WithOpaqueID(s string) func(*XPackWatcherActivateWatchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackWatcherActivateWatch) WithPretty ¶ added in v6.8.2 

func (f XPackWatcherActivateWatch) WithPretty() func(*XPackWatcherActivateWatchRequest)

WithPretty makes the response body pretty-printed.

type XPackWatcherActivateWatchRequest ¶ added in v6.8.2 

type XPackWatcherActivateWatchRequest struct {
	WatchID string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackWatcherActivateWatchRequest configures the X Pack Watcher Activate Watch API request.

func (XPackWatcherActivateWatchRequest) Do ¶ added in v6.8.2 

func (r XPackWatcherActivateWatchRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackWatcherDeactivateWatch ¶ added in v6.8.2 

type XPackWatcherDeactivateWatch func(watch_id string, o ...func(*XPackWatcherDeactivateWatchRequest)) (*Response, error)

XPackWatcherDeactivateWatch - https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html

func (XPackWatcherDeactivateWatch) WithContext ¶ added in v6.8.2 

func (f XPackWatcherDeactivateWatch) WithContext(v context.Context) func(*XPackWatcherDeactivateWatchRequest)

WithContext sets the request context.

func (XPackWatcherDeactivateWatch) WithErrorTrace ¶ added in v6.8.2 

func (f XPackWatcherDeactivateWatch) WithErrorTrace() func(*XPackWatcherDeactivateWatchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackWatcherDeactivateWatch) WithFilterPath ¶ added in v6.8.2 

func (f XPackWatcherDeactivateWatch) WithFilterPath(v ...string) func(*XPackWatcherDeactivateWatchRequest)

WithFilterPath filters the properties of the response body.

func (XPackWatcherDeactivateWatch) WithHeader ¶ added in v6.8.2 

func (f XPackWatcherDeactivateWatch) WithHeader(h map[string]string) func(*XPackWatcherDeactivateWatchRequest)

WithHeader adds the headers to the HTTP request.

func (XPackWatcherDeactivateWatch) WithHuman ¶ added in v6.8.2 

func (f XPackWatcherDeactivateWatch) WithHuman() func(*XPackWatcherDeactivateWatchRequest)

WithHuman makes statistical values human-readable.

func (XPackWatcherDeactivateWatch) WithMasterTimeout ¶ added in v6.8.2 

func (f XPackWatcherDeactivateWatch) WithMasterTimeout(v time.Duration) func(*XPackWatcherDeactivateWatchRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (XPackWatcherDeactivateWatch) WithOpaqueID ¶ added in v6.8.5 

func (f XPackWatcherDeactivateWatch) WithOpaqueID(s string) func(*XPackWatcherDeactivateWatchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackWatcherDeactivateWatch) WithPretty ¶ added in v6.8.2 

func (f XPackWatcherDeactivateWatch) WithPretty() func(*XPackWatcherDeactivateWatchRequest)

WithPretty makes the response body pretty-printed.

type XPackWatcherDeactivateWatchRequest ¶ added in v6.8.2 

type XPackWatcherDeactivateWatchRequest struct {
	WatchID string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackWatcherDeactivateWatchRequest configures the X Pack Watcher Deactivate Watch API request.

func (XPackWatcherDeactivateWatchRequest) Do ¶ added in v6.8.2 

func (r XPackWatcherDeactivateWatchRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackWatcherDeleteWatch ¶ added in v6.8.2 

type XPackWatcherDeleteWatch func(id string, o ...func(*XPackWatcherDeleteWatchRequest)) (*Response, error)

XPackWatcherDeleteWatch - http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html

func (XPackWatcherDeleteWatch) WithContext ¶ added in v6.8.2 

func (f XPackWatcherDeleteWatch) WithContext(v context.Context) func(*XPackWatcherDeleteWatchRequest)

WithContext sets the request context.

func (XPackWatcherDeleteWatch) WithErrorTrace ¶ added in v6.8.2 

func (f XPackWatcherDeleteWatch) WithErrorTrace() func(*XPackWatcherDeleteWatchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackWatcherDeleteWatch) WithFilterPath ¶ added in v6.8.2 

func (f XPackWatcherDeleteWatch) WithFilterPath(v ...string) func(*XPackWatcherDeleteWatchRequest)

WithFilterPath filters the properties of the response body.

func (XPackWatcherDeleteWatch) WithHeader ¶ added in v6.8.2 

func (f XPackWatcherDeleteWatch) WithHeader(h map[string]string) func(*XPackWatcherDeleteWatchRequest)

WithHeader adds the headers to the HTTP request.

func (XPackWatcherDeleteWatch) WithHuman ¶ added in v6.8.2 

func (f XPackWatcherDeleteWatch) WithHuman() func(*XPackWatcherDeleteWatchRequest)

WithHuman makes statistical values human-readable.

func (XPackWatcherDeleteWatch) WithMasterTimeout ¶ added in v6.8.2 

func (f XPackWatcherDeleteWatch) WithMasterTimeout(v time.Duration) func(*XPackWatcherDeleteWatchRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (XPackWatcherDeleteWatch) WithOpaqueID ¶ added in v6.8.5 

func (f XPackWatcherDeleteWatch) WithOpaqueID(s string) func(*XPackWatcherDeleteWatchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackWatcherDeleteWatch) WithPretty ¶ added in v6.8.2 

func (f XPackWatcherDeleteWatch) WithPretty() func(*XPackWatcherDeleteWatchRequest)

WithPretty makes the response body pretty-printed.

type XPackWatcherDeleteWatchRequest ¶ added in v6.8.2 

type XPackWatcherDeleteWatchRequest struct {
	DocumentID string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackWatcherDeleteWatchRequest configures the X Pack Watcher Delete Watch API request.

func (XPackWatcherDeleteWatchRequest) Do ¶ added in v6.8.2 

func (r XPackWatcherDeleteWatchRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackWatcherExecuteWatch ¶ added in v6.8.2 

type XPackWatcherExecuteWatch func(o ...func(*XPackWatcherExecuteWatchRequest)) (*Response, error)

XPackWatcherExecuteWatch - http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html

func (XPackWatcherExecuteWatch) WithBody ¶ added in v6.8.2 

func (f XPackWatcherExecuteWatch) WithBody(v io.Reader) func(*XPackWatcherExecuteWatchRequest)

WithBody - Execution control.

func (XPackWatcherExecuteWatch) WithContext ¶ added in v6.8.2 

func (f XPackWatcherExecuteWatch) WithContext(v context.Context) func(*XPackWatcherExecuteWatchRequest)

WithContext sets the request context.

func (XPackWatcherExecuteWatch) WithDebug ¶ added in v6.8.2 

func (f XPackWatcherExecuteWatch) WithDebug(v bool) func(*XPackWatcherExecuteWatchRequest)

WithDebug - indicates whether the watch should execute in debug mode.

func (XPackWatcherExecuteWatch) WithDocumentID ¶ added in v6.8.2 

func (f XPackWatcherExecuteWatch) WithDocumentID(v string) func(*XPackWatcherExecuteWatchRequest)

WithDocumentID - watch ID.

func (XPackWatcherExecuteWatch) WithErrorTrace ¶ added in v6.8.2 

func (f XPackWatcherExecuteWatch) WithErrorTrace() func(*XPackWatcherExecuteWatchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackWatcherExecuteWatch) WithFilterPath ¶ added in v6.8.2 

func (f XPackWatcherExecuteWatch) WithFilterPath(v ...string) func(*XPackWatcherExecuteWatchRequest)

WithFilterPath filters the properties of the response body.

func (XPackWatcherExecuteWatch) WithHeader ¶ added in v6.8.2 

func (f XPackWatcherExecuteWatch) WithHeader(h map[string]string) func(*XPackWatcherExecuteWatchRequest)

WithHeader adds the headers to the HTTP request.

func (XPackWatcherExecuteWatch) WithHuman ¶ added in v6.8.2 

func (f XPackWatcherExecuteWatch) WithHuman() func(*XPackWatcherExecuteWatchRequest)

WithHuman makes statistical values human-readable.

func (XPackWatcherExecuteWatch) WithOpaqueID ¶ added in v6.8.5 

func (f XPackWatcherExecuteWatch) WithOpaqueID(s string) func(*XPackWatcherExecuteWatchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackWatcherExecuteWatch) WithPretty ¶ added in v6.8.2 

func (f XPackWatcherExecuteWatch) WithPretty() func(*XPackWatcherExecuteWatchRequest)

WithPretty makes the response body pretty-printed.

type XPackWatcherExecuteWatchRequest ¶ added in v6.8.2 

type XPackWatcherExecuteWatchRequest struct {
	DocumentID string

	Body io.Reader

	Debug *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackWatcherExecuteWatchRequest configures the X Pack Watcher Execute Watch API request.

func (XPackWatcherExecuteWatchRequest) Do ¶ added in v6.8.2 

func (r XPackWatcherExecuteWatchRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackWatcherGetWatch ¶ added in v6.8.2 

type XPackWatcherGetWatch func(id string, o ...func(*XPackWatcherGetWatchRequest)) (*Response, error)

XPackWatcherGetWatch - http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html

func (XPackWatcherGetWatch) WithContext ¶ added in v6.8.2 

func (f XPackWatcherGetWatch) WithContext(v context.Context) func(*XPackWatcherGetWatchRequest)

WithContext sets the request context.

func (XPackWatcherGetWatch) WithErrorTrace ¶ added in v6.8.2 

func (f XPackWatcherGetWatch) WithErrorTrace() func(*XPackWatcherGetWatchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackWatcherGetWatch) WithFilterPath ¶ added in v6.8.2 

func (f XPackWatcherGetWatch) WithFilterPath(v ...string) func(*XPackWatcherGetWatchRequest)

WithFilterPath filters the properties of the response body.

func (XPackWatcherGetWatch) WithHeader ¶ added in v6.8.2 

func (f XPackWatcherGetWatch) WithHeader(h map[string]string) func(*XPackWatcherGetWatchRequest)

WithHeader adds the headers to the HTTP request.

func (XPackWatcherGetWatch) WithHuman ¶ added in v6.8.2 

func (f XPackWatcherGetWatch) WithHuman() func(*XPackWatcherGetWatchRequest)

WithHuman makes statistical values human-readable.

func (XPackWatcherGetWatch) WithOpaqueID ¶ added in v6.8.5 

func (f XPackWatcherGetWatch) WithOpaqueID(s string) func(*XPackWatcherGetWatchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackWatcherGetWatch) WithPretty ¶ added in v6.8.2 

func (f XPackWatcherGetWatch) WithPretty() func(*XPackWatcherGetWatchRequest)

WithPretty makes the response body pretty-printed.

type XPackWatcherGetWatchRequest ¶ added in v6.8.2 

type XPackWatcherGetWatchRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackWatcherGetWatchRequest configures the X Pack Watcher Get Watch API request.

func (XPackWatcherGetWatchRequest) Do ¶ added in v6.8.2 

func (r XPackWatcherGetWatchRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackWatcherPutWatch ¶ added in v6.8.2 

type XPackWatcherPutWatch func(id string, o ...func(*XPackWatcherPutWatchRequest)) (*Response, error)

XPackWatcherPutWatch - http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html

func (XPackWatcherPutWatch) WithActive ¶ added in v6.8.2 

func (f XPackWatcherPutWatch) WithActive(v bool) func(*XPackWatcherPutWatchRequest)

WithActive - specify whether the watch is in/active by default.

func (XPackWatcherPutWatch) WithBody ¶ added in v6.8.2 

func (f XPackWatcherPutWatch) WithBody(v io.Reader) func(*XPackWatcherPutWatchRequest)

WithBody - The watch.

func (XPackWatcherPutWatch) WithContext ¶ added in v6.8.2 

func (f XPackWatcherPutWatch) WithContext(v context.Context) func(*XPackWatcherPutWatchRequest)

WithContext sets the request context.

func (XPackWatcherPutWatch) WithErrorTrace ¶ added in v6.8.2 

func (f XPackWatcherPutWatch) WithErrorTrace() func(*XPackWatcherPutWatchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackWatcherPutWatch) WithFilterPath ¶ added in v6.8.2 

func (f XPackWatcherPutWatch) WithFilterPath(v ...string) func(*XPackWatcherPutWatchRequest)

WithFilterPath filters the properties of the response body.

func (XPackWatcherPutWatch) WithHeader ¶ added in v6.8.2 

func (f XPackWatcherPutWatch) WithHeader(h map[string]string) func(*XPackWatcherPutWatchRequest)

WithHeader adds the headers to the HTTP request.

func (XPackWatcherPutWatch) WithHuman ¶ added in v6.8.2 

func (f XPackWatcherPutWatch) WithHuman() func(*XPackWatcherPutWatchRequest)

WithHuman makes statistical values human-readable.

func (XPackWatcherPutWatch) WithIfPrimaryTerm ¶ added in v6.8.2 

func (f XPackWatcherPutWatch) WithIfPrimaryTerm(v int) func(*XPackWatcherPutWatchRequest)

WithIfPrimaryTerm - only update the watch if the last operation that has changed the watch has the specified primary term.

func (XPackWatcherPutWatch) WithIfSeqNo ¶ added in v6.8.2 

func (f XPackWatcherPutWatch) WithIfSeqNo(v int) func(*XPackWatcherPutWatchRequest)

WithIfSeqNo - only update the watch if the last operation that has changed the watch has the specified sequence number.

func (XPackWatcherPutWatch) WithMasterTimeout ¶ added in v6.8.2 

func (f XPackWatcherPutWatch) WithMasterTimeout(v time.Duration) func(*XPackWatcherPutWatchRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (XPackWatcherPutWatch) WithOpaqueID ¶ added in v6.8.5 

func (f XPackWatcherPutWatch) WithOpaqueID(s string) func(*XPackWatcherPutWatchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackWatcherPutWatch) WithPretty ¶ added in v6.8.2 

func (f XPackWatcherPutWatch) WithPretty() func(*XPackWatcherPutWatchRequest)

WithPretty makes the response body pretty-printed.

func (XPackWatcherPutWatch) WithVersion ¶ added in v6.8.2 

func (f XPackWatcherPutWatch) WithVersion(v int) func(*XPackWatcherPutWatchRequest)

WithVersion - explicit version number for concurrency control.

type XPackWatcherPutWatchRequest ¶ added in v6.8.2 

type XPackWatcherPutWatchRequest struct {
	DocumentID string

	Body io.Reader

	Active        *bool
	IfPrimaryTerm *int
	IfSeqNo       *int
	MasterTimeout time.Duration
	Version       *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackWatcherPutWatchRequest configures the X Pack Watcher Put Watch API request.

func (XPackWatcherPutWatchRequest) Do ¶ added in v6.8.2 

func (r XPackWatcherPutWatchRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackWatcherRestart ¶ added in v6.8.2 

type XPackWatcherRestart func(o ...func(*XPackWatcherRestartRequest)) (*Response, error)

XPackWatcherRestart - http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-restart.html

func (XPackWatcherRestart) WithContext ¶ added in v6.8.2 

func (f XPackWatcherRestart) WithContext(v context.Context) func(*XPackWatcherRestartRequest)

WithContext sets the request context.

func (XPackWatcherRestart) WithErrorTrace ¶ added in v6.8.2 

func (f XPackWatcherRestart) WithErrorTrace() func(*XPackWatcherRestartRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackWatcherRestart) WithFilterPath ¶ added in v6.8.2 

func (f XPackWatcherRestart) WithFilterPath(v ...string) func(*XPackWatcherRestartRequest)

WithFilterPath filters the properties of the response body.

func (XPackWatcherRestart) WithHeader ¶ added in v6.8.2 

func (f XPackWatcherRestart) WithHeader(h map[string]string) func(*XPackWatcherRestartRequest)

WithHeader adds the headers to the HTTP request.

func (XPackWatcherRestart) WithHuman ¶ added in v6.8.2 

func (f XPackWatcherRestart) WithHuman() func(*XPackWatcherRestartRequest)

WithHuman makes statistical values human-readable.

func (XPackWatcherRestart) WithOpaqueID ¶ added in v6.8.5 

func (f XPackWatcherRestart) WithOpaqueID(s string) func(*XPackWatcherRestartRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackWatcherRestart) WithPretty ¶ added in v6.8.2 

func (f XPackWatcherRestart) WithPretty() func(*XPackWatcherRestartRequest)

WithPretty makes the response body pretty-printed.

type XPackWatcherRestartRequest ¶ added in v6.8.2 

type XPackWatcherRestartRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackWatcherRestartRequest configures the X Pack Watcher Restart API request.

func (XPackWatcherRestartRequest) Do ¶ added in v6.8.2 

func (r XPackWatcherRestartRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackWatcherStart ¶ added in v6.8.2 

type XPackWatcherStart func(o ...func(*XPackWatcherStartRequest)) (*Response, error)

XPackWatcherStart - http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html

func (XPackWatcherStart) WithContext ¶ added in v6.8.2 

func (f XPackWatcherStart) WithContext(v context.Context) func(*XPackWatcherStartRequest)

WithContext sets the request context.

func (XPackWatcherStart) WithErrorTrace ¶ added in v6.8.2 

func (f XPackWatcherStart) WithErrorTrace() func(*XPackWatcherStartRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackWatcherStart) WithFilterPath ¶ added in v6.8.2 

func (f XPackWatcherStart) WithFilterPath(v ...string) func(*XPackWatcherStartRequest)

WithFilterPath filters the properties of the response body.

func (XPackWatcherStart) WithHeader ¶ added in v6.8.2 

func (f XPackWatcherStart) WithHeader(h map[string]string) func(*XPackWatcherStartRequest)

WithHeader adds the headers to the HTTP request.

func (XPackWatcherStart) WithHuman ¶ added in v6.8.2 

func (f XPackWatcherStart) WithHuman() func(*XPackWatcherStartRequest)

WithHuman makes statistical values human-readable.

func (XPackWatcherStart) WithOpaqueID ¶ added in v6.8.5 

func (f XPackWatcherStart) WithOpaqueID(s string) func(*XPackWatcherStartRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackWatcherStart) WithPretty ¶ added in v6.8.2 

func (f XPackWatcherStart) WithPretty() func(*XPackWatcherStartRequest)

WithPretty makes the response body pretty-printed.

type XPackWatcherStartRequest ¶ added in v6.8.2 

type XPackWatcherStartRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackWatcherStartRequest configures the X Pack Watcher Start API request.

func (XPackWatcherStartRequest) Do ¶ added in v6.8.2 

func (r XPackWatcherStartRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackWatcherStats ¶ added in v6.8.2 

type XPackWatcherStats func(o ...func(*XPackWatcherStatsRequest)) (*Response, error)

XPackWatcherStats - http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html

func (XPackWatcherStats) WithContext ¶ added in v6.8.2 

func (f XPackWatcherStats) WithContext(v context.Context) func(*XPackWatcherStatsRequest)

WithContext sets the request context.

func (XPackWatcherStats) WithEmitStacktraces ¶ added in v6.8.2 

func (f XPackWatcherStats) WithEmitStacktraces(v bool) func(*XPackWatcherStatsRequest)

WithEmitStacktraces - emits stack traces of currently running watches.

func (XPackWatcherStats) WithErrorTrace ¶ added in v6.8.2 

func (f XPackWatcherStats) WithErrorTrace() func(*XPackWatcherStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackWatcherStats) WithFilterPath ¶ added in v6.8.2 

func (f XPackWatcherStats) WithFilterPath(v ...string) func(*XPackWatcherStatsRequest)

WithFilterPath filters the properties of the response body.

func (XPackWatcherStats) WithHeader ¶ added in v6.8.2 

func (f XPackWatcherStats) WithHeader(h map[string]string) func(*XPackWatcherStatsRequest)

WithHeader adds the headers to the HTTP request.

func (XPackWatcherStats) WithHuman ¶ added in v6.8.2 

func (f XPackWatcherStats) WithHuman() func(*XPackWatcherStatsRequest)

WithHuman makes statistical values human-readable.

func (XPackWatcherStats) WithMetric ¶ added in v6.8.2 

func (f XPackWatcherStats) WithMetric(v string) func(*XPackWatcherStatsRequest)

WithMetric - controls what additional stat metrics should be include in the response.

func (XPackWatcherStats) WithOpaqueID ¶ added in v6.8.5 

func (f XPackWatcherStats) WithOpaqueID(s string) func(*XPackWatcherStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackWatcherStats) WithPretty ¶ added in v6.8.2 

func (f XPackWatcherStats) WithPretty() func(*XPackWatcherStatsRequest)

WithPretty makes the response body pretty-printed.

type XPackWatcherStatsRequest ¶ added in v6.8.2 

type XPackWatcherStatsRequest struct {
	Metric string

	EmitStacktraces *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackWatcherStatsRequest configures the X Pack Watcher Stats API request.

func (XPackWatcherStatsRequest) Do ¶ added in v6.8.2 

func (r XPackWatcherStatsRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackWatcherStop ¶ added in v6.8.2 

type XPackWatcherStop func(o ...func(*XPackWatcherStopRequest)) (*Response, error)

XPackWatcherStop - http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html

func (XPackWatcherStop) WithContext ¶ added in v6.8.2 

func (f XPackWatcherStop) WithContext(v context.Context) func(*XPackWatcherStopRequest)

WithContext sets the request context.

func (XPackWatcherStop) WithErrorTrace ¶ added in v6.8.2 

func (f XPackWatcherStop) WithErrorTrace() func(*XPackWatcherStopRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackWatcherStop) WithFilterPath ¶ added in v6.8.2 

func (f XPackWatcherStop) WithFilterPath(v ...string) func(*XPackWatcherStopRequest)

WithFilterPath filters the properties of the response body.

func (XPackWatcherStop) WithHeader ¶ added in v6.8.2 

func (f XPackWatcherStop) WithHeader(h map[string]string) func(*XPackWatcherStopRequest)

WithHeader adds the headers to the HTTP request.

func (XPackWatcherStop) WithHuman ¶ added in v6.8.2 

func (f XPackWatcherStop) WithHuman() func(*XPackWatcherStopRequest)

WithHuman makes statistical values human-readable.

func (XPackWatcherStop) WithOpaqueID ¶ added in v6.8.5 

func (f XPackWatcherStop) WithOpaqueID(s string) func(*XPackWatcherStopRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackWatcherStop) WithPretty ¶ added in v6.8.2 

func (f XPackWatcherStop) WithPretty() func(*XPackWatcherStopRequest)

WithPretty makes the response body pretty-printed.

type XPackWatcherStopRequest ¶ added in v6.8.2 

type XPackWatcherStopRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

XPackWatcherStopRequest configures the X Pack Watcher Stop API request.

func (XPackWatcherStopRequest) Do ¶ added in v6.8.2 

func (r XPackWatcherStopRequest) Do(ctx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

Source Files ¶

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.