esapi

package
v7.17.10 Latest Latest
Warning

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

 Go to latest Published: May 3, 2023 License: Apache-2.0 Imports: 11 Imported by: 459

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/v7/esapi Index
go doc github.com/elastic/go-elasticsearch/v7/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
	AsyncSearch *AsyncSearch
	CCR         *CCR
	ILM         *ILM
	License     *License
	Migration   *Migration
	ML          *ML
	Monitoring  *Monitoring
	Rollup      *Rollup
	Security    *Security
	SQL         *SQL
	SSL         *SSL
	Watcher     *Watcher
	XPack       *XPack

	AutoscalingDeleteAutoscalingPolicy            AutoscalingDeleteAutoscalingPolicy
	AutoscalingGetAutoscalingCapacity             AutoscalingGetAutoscalingCapacity
	AutoscalingGetAutoscalingDecision             AutoscalingGetAutoscalingDecision
	AutoscalingGetAutoscalingPolicy               AutoscalingGetAutoscalingPolicy
	AutoscalingPutAutoscalingPolicy               AutoscalingPutAutoscalingPolicy
	Bulk                                          Bulk
	ClearScroll                                   ClearScroll
	ClosePointInTime                              ClosePointInTime
	Count                                         Count
	Create                                        Create
	DanglingIndicesDeleteDanglingIndex            DanglingIndicesDeleteDanglingIndex
	DanglingIndicesImportDanglingIndex            DanglingIndicesImportDanglingIndex
	DanglingIndicesListDanglingIndices            DanglingIndicesListDanglingIndices
	DataFrameTransformDeprecatedDeleteTransform   DataFrameTransformDeprecatedDeleteTransform
	DataFrameTransformDeprecatedGetTransform      DataFrameTransformDeprecatedGetTransform
	DataFrameTransformDeprecatedGetTransformStats DataFrameTransformDeprecatedGetTransformStats
	DataFrameTransformDeprecatedPreviewTransform  DataFrameTransformDeprecatedPreviewTransform
	DataFrameTransformDeprecatedPutTransform      DataFrameTransformDeprecatedPutTransform
	DataFrameTransformDeprecatedStartTransform    DataFrameTransformDeprecatedStartTransform
	DataFrameTransformDeprecatedStopTransform     DataFrameTransformDeprecatedStopTransform
	DataFrameTransformDeprecatedUpdateTransform   DataFrameTransformDeprecatedUpdateTransform
	DeleteByQuery                                 DeleteByQuery
	DeleteByQueryRethrottle                       DeleteByQueryRethrottle
	Delete                                        Delete
	DeleteScript                                  DeleteScript
	EnrichDeletePolicy                            EnrichDeletePolicy
	EnrichExecutePolicy                           EnrichExecutePolicy
	EnrichGetPolicy                               EnrichGetPolicy
	EnrichPutPolicy                               EnrichPutPolicy
	EnrichStats                                   EnrichStats
	EqlDelete                                     EqlDelete
	EqlGet                                        EqlGet
	EqlGetStatus                                  EqlGetStatus
	EqlSearch                                     EqlSearch
	Exists                                        Exists
	ExistsSource                                  ExistsSource
	Explain                                       Explain
	FeaturesGetFeatures                           FeaturesGetFeatures
	FeaturesResetFeatures                         FeaturesResetFeatures
	FieldCaps                                     FieldCaps
	FleetGlobalCheckpoints                        FleetGlobalCheckpoints
	FleetMsearch                                  FleetMsearch
	FleetSearch                                   FleetSearch
	Get                                           Get
	GetScriptContext                              GetScriptContext
	GetScriptLanguages                            GetScriptLanguages
	GetScript                                     GetScript
	GetSource                                     GetSource
	GraphExplore                                  GraphExplore
	Index                                         Index
	Info                                          Info
	LogstashDeletePipeline                        LogstashDeletePipeline
	LogstashGetPipeline                           LogstashGetPipeline
	LogstashPutPipeline                           LogstashPutPipeline
	Mget                                          Mget
	Msearch                                       Msearch
	MsearchTemplate                               MsearchTemplate
	Mtermvectors                                  Mtermvectors
	OpenPointInTime                               OpenPointInTime
	Ping                                          Ping
	PutScript                                     PutScript
	RankEval                                      RankEval
	Reindex                                       Reindex
	ReindexRethrottle                             ReindexRethrottle
	RenderSearchTemplate                          RenderSearchTemplate
	ScriptsPainlessExecute                        ScriptsPainlessExecute
	Scroll                                        Scroll
	SearchMvt                                     SearchMvt
	Search                                        Search
	SearchShards                                  SearchShards
	SearchTemplate                                SearchTemplate
	SearchableSnapshotsCacheStats                 SearchableSnapshotsCacheStats
	SearchableSnapshotsClearCache                 SearchableSnapshotsClearCache
	SearchableSnapshotsMount                      SearchableSnapshotsMount
	SearchableSnapshotsRepositoryStats            SearchableSnapshotsRepositoryStats
	SearchableSnapshotsStats                      SearchableSnapshotsStats
	ShutdownDeleteNode                            ShutdownDeleteNode
	ShutdownGetNode                               ShutdownGetNode
	ShutdownPutNode                               ShutdownPutNode
	SlmDeleteLifecycle                            SlmDeleteLifecycle
	SlmExecuteLifecycle                           SlmExecuteLifecycle
	SlmExecuteRetention                           SlmExecuteRetention
	SlmGetLifecycle                               SlmGetLifecycle
	SlmGetStats                                   SlmGetStats
	SlmGetStatus                                  SlmGetStatus
	SlmPutLifecycle                               SlmPutLifecycle
	SlmStart                                      SlmStart
	SlmStop                                       SlmStop
	TermsEnum                                     TermsEnum
	Termvectors                                   Termvectors
	TextStructureFindStructure                    TextStructureFindStructure
	TransformDeleteTransform                      TransformDeleteTransform
	TransformGetTransform                         TransformGetTransform
	TransformGetTransformStats                    TransformGetTransformStats
	TransformPreviewTransform                     TransformPreviewTransform
	TransformPutTransform                         TransformPutTransform
	TransformStartTransform                       TransformStartTransform
	TransformStopTransform                        TransformStopTransform
	TransformUpdateTransform                      TransformUpdateTransform
	TransformUpgradeTransforms                    TransformUpgradeTransforms
	UpdateByQuery                                 UpdateByQuery
	UpdateByQueryRethrottle                       UpdateByQueryRethrottle
	Update                                        Update
}

API contains the Elasticsearch APIs

func New 

func New(t Transport) *API

New creates new API

type AsyncSearch added in v7.7.0 

type AsyncSearch struct {
	Delete AsyncSearchDelete
	Get    AsyncSearchGet
	Status AsyncSearchStatus
	Submit AsyncSearchSubmit
}

AsyncSearch contains the AsyncSearch APIs

type AsyncSearchDelete added in v7.7.0 

type AsyncSearchDelete func(id string, o ...func(*AsyncSearchDeleteRequest)) (*Response, error)

AsyncSearchDelete - Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html.

func (AsyncSearchDelete) WithContext added in v7.7.0 

func (f AsyncSearchDelete) WithContext(v context.Context) func(*AsyncSearchDeleteRequest)

WithContext sets the request context.

func (AsyncSearchDelete) WithErrorTrace added in v7.7.0 

func (f AsyncSearchDelete) WithErrorTrace() func(*AsyncSearchDeleteRequest)

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

func (AsyncSearchDelete) WithFilterPath added in v7.7.0 

func (f AsyncSearchDelete) WithFilterPath(v ...string) func(*AsyncSearchDeleteRequest)

WithFilterPath filters the properties of the response body.

func (AsyncSearchDelete) WithHeader added in v7.7.0 

func (f AsyncSearchDelete) WithHeader(h map[string]string) func(*AsyncSearchDeleteRequest)

WithHeader adds the headers to the HTTP request.

func (AsyncSearchDelete) WithHuman added in v7.7.0 

func (f AsyncSearchDelete) WithHuman() func(*AsyncSearchDeleteRequest)

WithHuman makes statistical values human-readable.

func (AsyncSearchDelete) WithOpaqueID added in v7.7.0 

func (f AsyncSearchDelete) WithOpaqueID(s string) func(*AsyncSearchDeleteRequest)

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

func (AsyncSearchDelete) WithPretty added in v7.7.0 

func (f AsyncSearchDelete) WithPretty() func(*AsyncSearchDeleteRequest)

WithPretty makes the response body pretty-printed.

type AsyncSearchDeleteRequest added in v7.7.0 

type AsyncSearchDeleteRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

AsyncSearchDeleteRequest configures the Async Search Delete API request.

func (AsyncSearchDeleteRequest) Do added in v7.7.0 

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

Do executes the request and returns response or error.

type AsyncSearchGet added in v7.7.0 

type AsyncSearchGet func(id string, o ...func(*AsyncSearchGetRequest)) (*Response, error)

AsyncSearchGet - Retrieves the results of a previously submitted async search request given its ID.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html.

func (AsyncSearchGet) WithContext added in v7.7.0 

func (f AsyncSearchGet) WithContext(v context.Context) func(*AsyncSearchGetRequest)

WithContext sets the request context.

func (AsyncSearchGet) WithErrorTrace added in v7.7.0 

func (f AsyncSearchGet) WithErrorTrace() func(*AsyncSearchGetRequest)

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

func (AsyncSearchGet) WithFilterPath added in v7.7.0 

func (f AsyncSearchGet) WithFilterPath(v ...string) func(*AsyncSearchGetRequest)

WithFilterPath filters the properties of the response body.

func (AsyncSearchGet) WithHeader added in v7.7.0 

func (f AsyncSearchGet) WithHeader(h map[string]string) func(*AsyncSearchGetRequest)

WithHeader adds the headers to the HTTP request.

func (AsyncSearchGet) WithHuman added in v7.7.0 

func (f AsyncSearchGet) WithHuman() func(*AsyncSearchGetRequest)

WithHuman makes statistical values human-readable.

func (AsyncSearchGet) WithKeepAlive added in v7.7.0 

func (f AsyncSearchGet) WithKeepAlive(v time.Duration) func(*AsyncSearchGetRequest)

WithKeepAlive - specify the time interval in which the results (partial or final) for this search will be available.

func (AsyncSearchGet) WithOpaqueID added in v7.7.0 

func (f AsyncSearchGet) WithOpaqueID(s string) func(*AsyncSearchGetRequest)

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

func (AsyncSearchGet) WithPretty added in v7.7.0 

func (f AsyncSearchGet) WithPretty() func(*AsyncSearchGetRequest)

WithPretty makes the response body pretty-printed.

func (AsyncSearchGet) WithTypedKeys added in v7.7.0 

func (f AsyncSearchGet) WithTypedKeys(v bool) func(*AsyncSearchGetRequest)

WithTypedKeys - specify whether aggregation and suggester names should be prefixed by their respective types in the response.

func (AsyncSearchGet) WithWaitForCompletionTimeout added in v7.7.0 

func (f AsyncSearchGet) WithWaitForCompletionTimeout(v time.Duration) func(*AsyncSearchGetRequest)

WithWaitForCompletionTimeout - specify the time that the request should block waiting for the final response.

type AsyncSearchGetRequest added in v7.7.0 

type AsyncSearchGetRequest struct {
	DocumentID string

	KeepAlive                time.Duration
	TypedKeys                *bool
	WaitForCompletionTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

AsyncSearchGetRequest configures the Async Search Get API request.

func (AsyncSearchGetRequest) Do added in v7.7.0 

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

Do executes the request and returns response or error.

type AsyncSearchStatus added in v7.10.0 

type AsyncSearchStatus func(id string, o ...func(*AsyncSearchStatusRequest)) (*Response, error)

AsyncSearchStatus - Retrieves the status of a previously submitted async search request given its ID.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html.

func (AsyncSearchStatus) WithContext added in v7.10.0 

func (f AsyncSearchStatus) WithContext(v context.Context) func(*AsyncSearchStatusRequest)

WithContext sets the request context.

func (AsyncSearchStatus) WithErrorTrace added in v7.10.0 

func (f AsyncSearchStatus) WithErrorTrace() func(*AsyncSearchStatusRequest)

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

func (AsyncSearchStatus) WithFilterPath added in v7.10.0 

func (f AsyncSearchStatus) WithFilterPath(v ...string) func(*AsyncSearchStatusRequest)

WithFilterPath filters the properties of the response body.

func (AsyncSearchStatus) WithHeader added in v7.10.0 

func (f AsyncSearchStatus) WithHeader(h map[string]string) func(*AsyncSearchStatusRequest)

WithHeader adds the headers to the HTTP request.

func (AsyncSearchStatus) WithHuman added in v7.10.0 

func (f AsyncSearchStatus) WithHuman() func(*AsyncSearchStatusRequest)

WithHuman makes statistical values human-readable.

func (AsyncSearchStatus) WithOpaqueID added in v7.10.0 

func (f AsyncSearchStatus) WithOpaqueID(s string) func(*AsyncSearchStatusRequest)

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

func (AsyncSearchStatus) WithPretty added in v7.10.0 

func (f AsyncSearchStatus) WithPretty() func(*AsyncSearchStatusRequest)

WithPretty makes the response body pretty-printed.

type AsyncSearchStatusRequest added in v7.10.0 

type AsyncSearchStatusRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

AsyncSearchStatusRequest configures the Async Search Status API request.

func (AsyncSearchStatusRequest) Do added in v7.10.0 

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

Do executes the request and returns response or error.

type AsyncSearchSubmit added in v7.7.0 

type AsyncSearchSubmit func(o ...func(*AsyncSearchSubmitRequest)) (*Response, error)

AsyncSearchSubmit - Executes a search request asynchronously.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html.

func (AsyncSearchSubmit) WithAllowNoIndices added in v7.7.0 

func (f AsyncSearchSubmit) WithAllowNoIndices(v bool) func(*AsyncSearchSubmitRequest)

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 (AsyncSearchSubmit) WithAllowPartialSearchResults added in v7.7.0 

func (f AsyncSearchSubmit) WithAllowPartialSearchResults(v bool) func(*AsyncSearchSubmitRequest)

WithAllowPartialSearchResults - indicate if an error should be returned if there is a partial search failure or timeout.

func (AsyncSearchSubmit) WithAnalyzeWildcard added in v7.7.0 

func (f AsyncSearchSubmit) WithAnalyzeWildcard(v bool) func(*AsyncSearchSubmitRequest)

WithAnalyzeWildcard - specify whether wildcard and prefix queries should be analyzed (default: false).

func (AsyncSearchSubmit) WithAnalyzer added in v7.7.0 

func (f AsyncSearchSubmit) WithAnalyzer(v string) func(*AsyncSearchSubmitRequest)

WithAnalyzer - the analyzer to use for the query string.

func (AsyncSearchSubmit) WithBatchedReduceSize added in v7.7.0 

func (f AsyncSearchSubmit) WithBatchedReduceSize(v int) func(*AsyncSearchSubmitRequest)

WithBatchedReduceSize - the number of shard results that should be reduced at once on the coordinating node. this value should be used as the granularity at which progress results will be made available..

func (AsyncSearchSubmit) WithBody added in v7.7.0 

func (f AsyncSearchSubmit) WithBody(v io.Reader) func(*AsyncSearchSubmitRequest)

WithBody - The search definition using the Query DSL.

func (AsyncSearchSubmit) WithContext added in v7.7.0 

func (f AsyncSearchSubmit) WithContext(v context.Context) func(*AsyncSearchSubmitRequest)

WithContext sets the request context.

func (AsyncSearchSubmit) WithDefaultOperator added in v7.7.0 

func (f AsyncSearchSubmit) WithDefaultOperator(v string) func(*AsyncSearchSubmitRequest)

WithDefaultOperator - the default operator for query string query (and or or).

func (AsyncSearchSubmit) WithDf added in v7.7.0 

func (f AsyncSearchSubmit) WithDf(v string) func(*AsyncSearchSubmitRequest)

WithDf - the field to use as default where no field prefix is given in the query string.

func (AsyncSearchSubmit) WithDocvalueFields added in v7.7.0 

func (f AsyncSearchSubmit) WithDocvalueFields(v ...string) func(*AsyncSearchSubmitRequest)

WithDocvalueFields - a list of fields to return as the docvalue representation of a field for each hit.

func (AsyncSearchSubmit) WithErrorTrace added in v7.7.0 

func (f AsyncSearchSubmit) WithErrorTrace() func(*AsyncSearchSubmitRequest)

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

func (AsyncSearchSubmit) WithExpandWildcards added in v7.7.0 

func (f AsyncSearchSubmit) WithExpandWildcards(v string) func(*AsyncSearchSubmitRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (AsyncSearchSubmit) WithExplain added in v7.7.0 

func (f AsyncSearchSubmit) WithExplain(v bool) func(*AsyncSearchSubmitRequest)

WithExplain - specify whether to return detailed information about score computation as part of a hit.

func (AsyncSearchSubmit) WithFilterPath added in v7.7.0 

func (f AsyncSearchSubmit) WithFilterPath(v ...string) func(*AsyncSearchSubmitRequest)

WithFilterPath filters the properties of the response body.

func (AsyncSearchSubmit) WithFrom added in v7.7.0 

func (f AsyncSearchSubmit) WithFrom(v int) func(*AsyncSearchSubmitRequest)

WithFrom - starting offset (default: 0).

func (AsyncSearchSubmit) WithHeader added in v7.7.0 

func (f AsyncSearchSubmit) WithHeader(h map[string]string) func(*AsyncSearchSubmitRequest)

WithHeader adds the headers to the HTTP request.

func (AsyncSearchSubmit) WithHuman added in v7.7.0 

func (f AsyncSearchSubmit) WithHuman() func(*AsyncSearchSubmitRequest)

WithHuman makes statistical values human-readable.

func (AsyncSearchSubmit) WithIgnoreThrottled added in v7.7.0 

func (f AsyncSearchSubmit) WithIgnoreThrottled(v bool) func(*AsyncSearchSubmitRequest)

WithIgnoreThrottled - whether specified concrete, expanded or aliased indices should be ignored when throttled.

func (AsyncSearchSubmit) WithIgnoreUnavailable added in v7.7.0 

func (f AsyncSearchSubmit) WithIgnoreUnavailable(v bool) func(*AsyncSearchSubmitRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (AsyncSearchSubmit) WithIndex added in v7.7.0 

func (f AsyncSearchSubmit) WithIndex(v ...string) func(*AsyncSearchSubmitRequest)

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

func (AsyncSearchSubmit) WithKeepAlive added in v7.7.0 

func (f AsyncSearchSubmit) WithKeepAlive(v time.Duration) func(*AsyncSearchSubmitRequest)

WithKeepAlive - update the time interval in which the results (partial or final) for this search will be available.

func (AsyncSearchSubmit) WithKeepOnCompletion added in v7.7.0 

func (f AsyncSearchSubmit) WithKeepOnCompletion(v bool) func(*AsyncSearchSubmitRequest)

WithKeepOnCompletion - control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false).

func (AsyncSearchSubmit) WithLenient added in v7.7.0 

func (f AsyncSearchSubmit) WithLenient(v bool) func(*AsyncSearchSubmitRequest)

WithLenient - specify whether format-based query failures (such as providing text to a numeric field) should be ignored.

func (AsyncSearchSubmit) WithMaxConcurrentShardRequests added in v7.7.0 

func (f AsyncSearchSubmit) WithMaxConcurrentShardRequests(v int) func(*AsyncSearchSubmitRequest)

WithMaxConcurrentShardRequests - the number of concurrent shard requests per node this search executes concurrently. this value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.

func (AsyncSearchSubmit) WithOpaqueID added in v7.7.0 

func (f AsyncSearchSubmit) WithOpaqueID(s string) func(*AsyncSearchSubmitRequest)

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

func (AsyncSearchSubmit) WithPreference added in v7.7.0 

func (f AsyncSearchSubmit) WithPreference(v string) func(*AsyncSearchSubmitRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (AsyncSearchSubmit) WithPretty added in v7.7.0 

func (f AsyncSearchSubmit) WithPretty() func(*AsyncSearchSubmitRequest)

WithPretty makes the response body pretty-printed.

func (AsyncSearchSubmit) WithQuery added in v7.7.0 

func (f AsyncSearchSubmit) WithQuery(v string) func(*AsyncSearchSubmitRequest)

WithQuery - query in the lucene query string syntax.

func (AsyncSearchSubmit) WithRequestCache added in v7.7.0 

func (f AsyncSearchSubmit) WithRequestCache(v bool) func(*AsyncSearchSubmitRequest)

WithRequestCache - specify if request cache should be used for this request or not, defaults to true.

func (AsyncSearchSubmit) WithRouting added in v7.7.0 

func (f AsyncSearchSubmit) WithRouting(v ...string) func(*AsyncSearchSubmitRequest)

WithRouting - a list of specific routing values.

func (AsyncSearchSubmit) WithSearchType added in v7.7.0 

func (f AsyncSearchSubmit) WithSearchType(v string) func(*AsyncSearchSubmitRequest)

WithSearchType - search operation type.

func (AsyncSearchSubmit) WithSeqNoPrimaryTerm added in v7.7.0 

func (f AsyncSearchSubmit) WithSeqNoPrimaryTerm(v bool) func(*AsyncSearchSubmitRequest)

WithSeqNoPrimaryTerm - specify whether to return sequence number and primary term of the last modification of each hit.

func (AsyncSearchSubmit) WithSize added in v7.7.0 

func (f AsyncSearchSubmit) WithSize(v int) func(*AsyncSearchSubmitRequest)

WithSize - number of hits to return (default: 10).

func (AsyncSearchSubmit) WithSort added in v7.7.0 

func (f AsyncSearchSubmit) WithSort(v ...string) func(*AsyncSearchSubmitRequest)

WithSort - a list of <field>:<direction> pairs.

func (AsyncSearchSubmit) WithSource added in v7.7.0 

func (f AsyncSearchSubmit) WithSource(v ...string) func(*AsyncSearchSubmitRequest)

WithSource - true or false to return the _source field or not, or a list of fields to return.

func (AsyncSearchSubmit) WithSourceExcludes added in v7.7.0 

func (f AsyncSearchSubmit) WithSourceExcludes(v ...string) func(*AsyncSearchSubmitRequest)

WithSourceExcludes - a list of fields to exclude from the returned _source field.

func (AsyncSearchSubmit) WithSourceIncludes added in v7.7.0 

func (f AsyncSearchSubmit) WithSourceIncludes(v ...string) func(*AsyncSearchSubmitRequest)

WithSourceIncludes - a list of fields to extract and return from the _source field.

func (AsyncSearchSubmit) WithStats added in v7.7.0 

func (f AsyncSearchSubmit) WithStats(v ...string) func(*AsyncSearchSubmitRequest)

WithStats - specific 'tag' of the request for logging and statistical purposes.

func (AsyncSearchSubmit) WithStoredFields added in v7.7.0 

func (f AsyncSearchSubmit) WithStoredFields(v ...string) func(*AsyncSearchSubmitRequest)

WithStoredFields - a list of stored fields to return as part of a hit.

func (AsyncSearchSubmit) WithSuggestField added in v7.7.0 

func (f AsyncSearchSubmit) WithSuggestField(v string) func(*AsyncSearchSubmitRequest)

WithSuggestField - specify which field to use for suggestions.

func (AsyncSearchSubmit) WithSuggestMode added in v7.7.0 

func (f AsyncSearchSubmit) WithSuggestMode(v string) func(*AsyncSearchSubmitRequest)

WithSuggestMode - specify suggest mode.

func (AsyncSearchSubmit) WithSuggestSize added in v7.7.0 

func (f AsyncSearchSubmit) WithSuggestSize(v int) func(*AsyncSearchSubmitRequest)

WithSuggestSize - how many suggestions to return in response.

func (AsyncSearchSubmit) WithSuggestText added in v7.7.0 

func (f AsyncSearchSubmit) WithSuggestText(v string) func(*AsyncSearchSubmitRequest)

WithSuggestText - the source text for which the suggestions should be returned.

func (AsyncSearchSubmit) WithTerminateAfter added in v7.7.0 

func (f AsyncSearchSubmit) WithTerminateAfter(v int) func(*AsyncSearchSubmitRequest)

WithTerminateAfter - the maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early..

func (AsyncSearchSubmit) WithTimeout added in v7.7.0 

func (f AsyncSearchSubmit) WithTimeout(v time.Duration) func(*AsyncSearchSubmitRequest)

WithTimeout - explicit operation timeout.

func (AsyncSearchSubmit) WithTrackScores added in v7.7.0 

func (f AsyncSearchSubmit) WithTrackScores(v bool) func(*AsyncSearchSubmitRequest)

WithTrackScores - whether to calculate and return scores even if they are not used for sorting.

func (AsyncSearchSubmit) WithTrackTotalHits added in v7.7.0 

func (f AsyncSearchSubmit) WithTrackTotalHits(v bool) func(*AsyncSearchSubmitRequest)

WithTrackTotalHits - indicate if the number of documents that match the query should be tracked.

func (AsyncSearchSubmit) WithTypedKeys added in v7.7.0 

func (f AsyncSearchSubmit) WithTypedKeys(v bool) func(*AsyncSearchSubmitRequest)

WithTypedKeys - specify whether aggregation and suggester names should be prefixed by their respective types in the response.

func (AsyncSearchSubmit) WithVersion added in v7.7.0 

func (f AsyncSearchSubmit) WithVersion(v bool) func(*AsyncSearchSubmitRequest)

WithVersion - specify whether to return document version as part of a hit.

func (AsyncSearchSubmit) WithWaitForCompletionTimeout added in v7.7.0 

func (f AsyncSearchSubmit) WithWaitForCompletionTimeout(v time.Duration) func(*AsyncSearchSubmitRequest)

WithWaitForCompletionTimeout - specify the time that the request should block waiting for the final response.

type AsyncSearchSubmitRequest added in v7.7.0 

type AsyncSearchSubmitRequest struct {
	Index []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
	KeepAlive                  time.Duration
	KeepOnCompletion           *bool
	Lenient                    *bool
	MaxConcurrentShardRequests *int
	Preference                 string
	Query                      string
	RequestCache               *bool
	Routing                    []string
	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             *bool
	TypedKeys                  *bool
	Version                    *bool
	WaitForCompletionTimeout   time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

AsyncSearchSubmitRequest configures the Async Search Submit API request.

func (AsyncSearchSubmitRequest) Do added in v7.7.0 

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

Do executes the request and returns response or error.

type AutoscalingDeleteAutoscalingPolicy added in v7.7.0 

type AutoscalingDeleteAutoscalingPolicy func(name string, o ...func(*AutoscalingDeleteAutoscalingPolicyRequest)) (*Response, error)

AutoscalingDeleteAutoscalingPolicy - Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html.

func (AutoscalingDeleteAutoscalingPolicy) WithContext added in v7.7.0 

func (f AutoscalingDeleteAutoscalingPolicy) WithContext(v context.Context) func(*AutoscalingDeleteAutoscalingPolicyRequest)

WithContext sets the request context.

func (AutoscalingDeleteAutoscalingPolicy) WithErrorTrace added in v7.7.0 

func (f AutoscalingDeleteAutoscalingPolicy) WithErrorTrace() func(*AutoscalingDeleteAutoscalingPolicyRequest)

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

func (AutoscalingDeleteAutoscalingPolicy) WithFilterPath added in v7.7.0 

func (f AutoscalingDeleteAutoscalingPolicy) WithFilterPath(v ...string) func(*AutoscalingDeleteAutoscalingPolicyRequest)

WithFilterPath filters the properties of the response body.

func (AutoscalingDeleteAutoscalingPolicy) WithHeader added in v7.7.0 

func (f AutoscalingDeleteAutoscalingPolicy) WithHeader(h map[string]string) func(*AutoscalingDeleteAutoscalingPolicyRequest)

WithHeader adds the headers to the HTTP request.

func (AutoscalingDeleteAutoscalingPolicy) WithHuman added in v7.7.0 

func (f AutoscalingDeleteAutoscalingPolicy) WithHuman() func(*AutoscalingDeleteAutoscalingPolicyRequest)

WithHuman makes statistical values human-readable.

func (AutoscalingDeleteAutoscalingPolicy) WithOpaqueID added in v7.7.0 

func (f AutoscalingDeleteAutoscalingPolicy) WithOpaqueID(s string) func(*AutoscalingDeleteAutoscalingPolicyRequest)

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

func (AutoscalingDeleteAutoscalingPolicy) WithPretty added in v7.7.0 

func (f AutoscalingDeleteAutoscalingPolicy) WithPretty() func(*AutoscalingDeleteAutoscalingPolicyRequest)

WithPretty makes the response body pretty-printed.

type AutoscalingDeleteAutoscalingPolicyRequest added in v7.7.0 

type AutoscalingDeleteAutoscalingPolicyRequest struct {
	Name string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

AutoscalingDeleteAutoscalingPolicyRequest configures the Autoscaling Delete Autoscaling Policy API request.

func (AutoscalingDeleteAutoscalingPolicyRequest) Do added in v7.7.0 

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

Do executes the request and returns response or error.

type AutoscalingGetAutoscalingCapacity added in v7.10.0 

type AutoscalingGetAutoscalingCapacity func(o ...func(*AutoscalingGetAutoscalingCapacityRequest)) (*Response, error)

AutoscalingGetAutoscalingCapacity - Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html.

func (AutoscalingGetAutoscalingCapacity) WithContext added in v7.10.0 

func (f AutoscalingGetAutoscalingCapacity) WithContext(v context.Context) func(*AutoscalingGetAutoscalingCapacityRequest)

WithContext sets the request context.

func (AutoscalingGetAutoscalingCapacity) WithErrorTrace added in v7.10.0 

func (f AutoscalingGetAutoscalingCapacity) WithErrorTrace() func(*AutoscalingGetAutoscalingCapacityRequest)

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

func (AutoscalingGetAutoscalingCapacity) WithFilterPath added in v7.10.0 

func (f AutoscalingGetAutoscalingCapacity) WithFilterPath(v ...string) func(*AutoscalingGetAutoscalingCapacityRequest)

WithFilterPath filters the properties of the response body.

func (AutoscalingGetAutoscalingCapacity) WithHeader added in v7.10.0 

func (f AutoscalingGetAutoscalingCapacity) WithHeader(h map[string]string) func(*AutoscalingGetAutoscalingCapacityRequest)

WithHeader adds the headers to the HTTP request.

func (AutoscalingGetAutoscalingCapacity) WithHuman added in v7.10.0 

func (f AutoscalingGetAutoscalingCapacity) WithHuman() func(*AutoscalingGetAutoscalingCapacityRequest)

WithHuman makes statistical values human-readable.

func (AutoscalingGetAutoscalingCapacity) WithOpaqueID added in v7.10.0 

func (f AutoscalingGetAutoscalingCapacity) WithOpaqueID(s string) func(*AutoscalingGetAutoscalingCapacityRequest)

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

func (AutoscalingGetAutoscalingCapacity) WithPretty added in v7.10.0 

func (f AutoscalingGetAutoscalingCapacity) WithPretty() func(*AutoscalingGetAutoscalingCapacityRequest)

WithPretty makes the response body pretty-printed.

type AutoscalingGetAutoscalingCapacityRequest added in v7.10.0 

type AutoscalingGetAutoscalingCapacityRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

AutoscalingGetAutoscalingCapacityRequest configures the Autoscaling Get Autoscaling Capacity API request.

func (AutoscalingGetAutoscalingCapacityRequest) Do added in v7.10.0 

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

Do executes the request and returns response or error.

type AutoscalingGetAutoscalingDecision added in v7.7.0 

type AutoscalingGetAutoscalingDecision func(o ...func(*AutoscalingGetAutoscalingDecisionRequest)) (*Response, error)

AutoscalingGetAutoscalingDecision - Gets the current autoscaling decision based on the configured autoscaling policy, indicating whether or not autoscaling is needed.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-decision.html.

func (AutoscalingGetAutoscalingDecision) WithContext added in v7.7.0 

func (f AutoscalingGetAutoscalingDecision) WithContext(v context.Context) func(*AutoscalingGetAutoscalingDecisionRequest)

WithContext sets the request context.

func (AutoscalingGetAutoscalingDecision) WithErrorTrace added in v7.7.0 

func (f AutoscalingGetAutoscalingDecision) WithErrorTrace() func(*AutoscalingGetAutoscalingDecisionRequest)

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

func (AutoscalingGetAutoscalingDecision) WithFilterPath added in v7.7.0 

func (f AutoscalingGetAutoscalingDecision) WithFilterPath(v ...string) func(*AutoscalingGetAutoscalingDecisionRequest)

WithFilterPath filters the properties of the response body.

func (AutoscalingGetAutoscalingDecision) WithHeader added in v7.7.0 

func (f AutoscalingGetAutoscalingDecision) WithHeader(h map[string]string) func(*AutoscalingGetAutoscalingDecisionRequest)

WithHeader adds the headers to the HTTP request.

func (AutoscalingGetAutoscalingDecision) WithHuman added in v7.7.0 

func (f AutoscalingGetAutoscalingDecision) WithHuman() func(*AutoscalingGetAutoscalingDecisionRequest)

WithHuman makes statistical values human-readable.

func (AutoscalingGetAutoscalingDecision) WithOpaqueID added in v7.7.0 

func (f AutoscalingGetAutoscalingDecision) WithOpaqueID(s string) func(*AutoscalingGetAutoscalingDecisionRequest)

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

func (AutoscalingGetAutoscalingDecision) WithPretty added in v7.7.0 

func (f AutoscalingGetAutoscalingDecision) WithPretty() func(*AutoscalingGetAutoscalingDecisionRequest)

WithPretty makes the response body pretty-printed.

type AutoscalingGetAutoscalingDecisionRequest added in v7.7.0 

type AutoscalingGetAutoscalingDecisionRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

AutoscalingGetAutoscalingDecisionRequest configures the Autoscaling Get Autoscaling Decision API request.

func (AutoscalingGetAutoscalingDecisionRequest) Do added in v7.7.0 

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

Do executes the request and returns response or error.

type AutoscalingGetAutoscalingPolicy added in v7.7.0 

type AutoscalingGetAutoscalingPolicy func(name string, o ...func(*AutoscalingGetAutoscalingPolicyRequest)) (*Response, error)

AutoscalingGetAutoscalingPolicy - Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html.

func (AutoscalingGetAutoscalingPolicy) WithContext added in v7.7.0 

func (f AutoscalingGetAutoscalingPolicy) WithContext(v context.Context) func(*AutoscalingGetAutoscalingPolicyRequest)

WithContext sets the request context.

func (AutoscalingGetAutoscalingPolicy) WithErrorTrace added in v7.7.0 

func (f AutoscalingGetAutoscalingPolicy) WithErrorTrace() func(*AutoscalingGetAutoscalingPolicyRequest)

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

func (AutoscalingGetAutoscalingPolicy) WithFilterPath added in v7.7.0 

func (f AutoscalingGetAutoscalingPolicy) WithFilterPath(v ...string) func(*AutoscalingGetAutoscalingPolicyRequest)

WithFilterPath filters the properties of the response body.

func (AutoscalingGetAutoscalingPolicy) WithHeader added in v7.7.0 

func (f AutoscalingGetAutoscalingPolicy) WithHeader(h map[string]string) func(*AutoscalingGetAutoscalingPolicyRequest)

WithHeader adds the headers to the HTTP request.

func (AutoscalingGetAutoscalingPolicy) WithHuman added in v7.7.0 

func (f AutoscalingGetAutoscalingPolicy) WithHuman() func(*AutoscalingGetAutoscalingPolicyRequest)

WithHuman makes statistical values human-readable.

func (AutoscalingGetAutoscalingPolicy) WithOpaqueID added in v7.7.0 

func (f AutoscalingGetAutoscalingPolicy) WithOpaqueID(s string) func(*AutoscalingGetAutoscalingPolicyRequest)

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

func (AutoscalingGetAutoscalingPolicy) WithPretty added in v7.7.0 

func (f AutoscalingGetAutoscalingPolicy) WithPretty() func(*AutoscalingGetAutoscalingPolicyRequest)

WithPretty makes the response body pretty-printed.

type AutoscalingGetAutoscalingPolicyRequest added in v7.7.0 

type AutoscalingGetAutoscalingPolicyRequest struct {
	Name string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

AutoscalingGetAutoscalingPolicyRequest configures the Autoscaling Get Autoscaling Policy API request.

func (AutoscalingGetAutoscalingPolicyRequest) Do added in v7.7.0 

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

Do executes the request and returns response or error.

type AutoscalingPutAutoscalingPolicy added in v7.7.0 

type AutoscalingPutAutoscalingPolicy func(name string, body io.Reader, o ...func(*AutoscalingPutAutoscalingPolicyRequest)) (*Response, error)

AutoscalingPutAutoscalingPolicy - Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html.

func (AutoscalingPutAutoscalingPolicy) WithContext added in v7.7.0 

func (f AutoscalingPutAutoscalingPolicy) WithContext(v context.Context) func(*AutoscalingPutAutoscalingPolicyRequest)

WithContext sets the request context.

func (AutoscalingPutAutoscalingPolicy) WithErrorTrace added in v7.7.0 

func (f AutoscalingPutAutoscalingPolicy) WithErrorTrace() func(*AutoscalingPutAutoscalingPolicyRequest)

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

func (AutoscalingPutAutoscalingPolicy) WithFilterPath added in v7.7.0 

func (f AutoscalingPutAutoscalingPolicy) WithFilterPath(v ...string) func(*AutoscalingPutAutoscalingPolicyRequest)

WithFilterPath filters the properties of the response body.

func (AutoscalingPutAutoscalingPolicy) WithHeader added in v7.7.0 

func (f AutoscalingPutAutoscalingPolicy) WithHeader(h map[string]string) func(*AutoscalingPutAutoscalingPolicyRequest)

WithHeader adds the headers to the HTTP request.

func (AutoscalingPutAutoscalingPolicy) WithHuman added in v7.7.0 

func (f AutoscalingPutAutoscalingPolicy) WithHuman() func(*AutoscalingPutAutoscalingPolicyRequest)

WithHuman makes statistical values human-readable.

func (AutoscalingPutAutoscalingPolicy) WithOpaqueID added in v7.7.0 

func (f AutoscalingPutAutoscalingPolicy) WithOpaqueID(s string) func(*AutoscalingPutAutoscalingPolicyRequest)

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

func (AutoscalingPutAutoscalingPolicy) WithPretty added in v7.7.0 

func (f AutoscalingPutAutoscalingPolicy) WithPretty() func(*AutoscalingPutAutoscalingPolicyRequest)

WithPretty makes the response body pretty-printed.

type AutoscalingPutAutoscalingPolicyRequest added in v7.7.0 

type AutoscalingPutAutoscalingPolicyRequest struct {
	Body io.Reader

	Name string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

AutoscalingPutAutoscalingPolicyRequest configures the Autoscaling Put Autoscaling Policy API request.

func (AutoscalingPutAutoscalingPolicyRequest) Do added in v7.7.0 

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

Do executes the request and returns response or error.

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 https://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) WithFilterPath 

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

WithFilterPath filters the properties of the response body.

func (Bulk) WithHeader added in v7.2.0 

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 v7.5.0 

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 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 (Bulk) WithRequireAlias added in v7.10.0 

func (f Bulk) WithRequireAlias(v bool) func(*BulkRequest)

WithRequireAlias - sets require_alias for all incoming documents. defaults to unset (false).

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

	Pipeline            string
	Refresh             string
	RequireAlias        *bool
	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 v7.2.0 

type CCR struct {
	DeleteAutoFollowPattern CCRDeleteAutoFollowPattern
	FollowInfo              CCRFollowInfo
	Follow                  CCRFollow
	FollowStats             CCRFollowStats
	ForgetFollower          CCRForgetFollower
	GetAutoFollowPattern    CCRGetAutoFollowPattern
	PauseAutoFollowPattern  CCRPauseAutoFollowPattern
	PauseFollow             CCRPauseFollow
	PutAutoFollowPattern    CCRPutAutoFollowPattern
	ResumeAutoFollowPattern CCRResumeAutoFollowPattern
	ResumeFollow            CCRResumeFollow
	Stats                   CCRStats
	Unfollow                CCRUnfollow
}

CCR contains the CCR APIs

type CCRDeleteAutoFollowPattern added in v7.2.0 

type CCRDeleteAutoFollowPattern func(name string, o ...func(*CCRDeleteAutoFollowPatternRequest)) (*Response, error)

CCRDeleteAutoFollowPattern - Deletes auto-follow patterns.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html.

func (CCRDeleteAutoFollowPattern) WithContext added in v7.2.0 

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

WithContext sets the request context.

func (CCRDeleteAutoFollowPattern) WithErrorTrace added in v7.2.0 

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

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

func (CCRDeleteAutoFollowPattern) WithFilterPath added in v7.2.0 

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

WithFilterPath filters the properties of the response body.

func (CCRDeleteAutoFollowPattern) WithHeader added in v7.2.0 

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

WithHeader adds the headers to the HTTP request.

func (CCRDeleteAutoFollowPattern) WithHuman added in v7.2.0 

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

WithHuman makes statistical values human-readable.

func (CCRDeleteAutoFollowPattern) WithOpaqueID added in v7.5.0 

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

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

func (CCRDeleteAutoFollowPattern) WithPretty added in v7.2.0 

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

WithPretty makes the response body pretty-printed.

type CCRDeleteAutoFollowPatternRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type CCRFollow added in v7.2.0 

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

CCRFollow - Creates a new follower index configured to follow the referenced leader index.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html.

func (CCRFollow) WithContext added in v7.2.0 

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

WithContext sets the request context.

func (CCRFollow) WithErrorTrace added in v7.2.0 

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

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

func (CCRFollow) WithFilterPath added in v7.2.0 

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

WithFilterPath filters the properties of the response body.

func (CCRFollow) WithHeader added in v7.2.0 

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

WithHeader adds the headers to the HTTP request.

func (CCRFollow) WithHuman added in v7.2.0 

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

WithHuman makes statistical values human-readable.

func (CCRFollow) WithOpaqueID added in v7.5.0 

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

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

func (CCRFollow) WithPretty added in v7.2.0 

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

WithPretty makes the response body pretty-printed.

func (CCRFollow) WithWaitForActiveShards added in v7.2.0 

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 v7.2.0 

type CCRFollowInfo func(index []string, o ...func(*CCRFollowInfoRequest)) (*Response, error)

CCRFollowInfo - Retrieves information about all follower indices, including parameters and status for each follower index

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html.

func (CCRFollowInfo) WithContext added in v7.2.0 

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

WithContext sets the request context.

func (CCRFollowInfo) WithErrorTrace added in v7.2.0 

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

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

func (CCRFollowInfo) WithFilterPath added in v7.2.0 

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

WithFilterPath filters the properties of the response body.

func (CCRFollowInfo) WithHeader added in v7.2.0 

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

WithHeader adds the headers to the HTTP request.

func (CCRFollowInfo) WithHuman added in v7.2.0 

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

WithHuman makes statistical values human-readable.

func (CCRFollowInfo) WithOpaqueID added in v7.5.0 

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

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

func (CCRFollowInfo) WithPretty added in v7.2.0 

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

WithPretty makes the response body pretty-printed.

type CCRFollowInfoRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type CCRFollowRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type CCRFollowStats added in v7.2.0 

type CCRFollowStats func(index []string, o ...func(*CCRFollowStatsRequest)) (*Response, error)

CCRFollowStats - Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html.

func (CCRFollowStats) WithContext added in v7.2.0 

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

WithContext sets the request context.

func (CCRFollowStats) WithErrorTrace added in v7.2.0 

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

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

func (CCRFollowStats) WithFilterPath added in v7.2.0 

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

WithFilterPath filters the properties of the response body.

func (CCRFollowStats) WithHeader added in v7.2.0 

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

WithHeader adds the headers to the HTTP request.

func (CCRFollowStats) WithHuman added in v7.2.0 

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

WithHuman makes statistical values human-readable.

func (CCRFollowStats) WithOpaqueID added in v7.5.0 

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

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

func (CCRFollowStats) WithPretty added in v7.2.0 

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

WithPretty makes the response body pretty-printed.

type CCRFollowStatsRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type CCRForgetFollower added in v7.2.0 

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

CCRForgetFollower - Removes the follower retention leases from the leader.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-forget-follower.html.

func (CCRForgetFollower) WithContext added in v7.2.0 

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

WithContext sets the request context.

func (CCRForgetFollower) WithErrorTrace added in v7.2.0 

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

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

func (CCRForgetFollower) WithFilterPath added in v7.2.0 

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

WithFilterPath filters the properties of the response body.

func (CCRForgetFollower) WithHeader added in v7.2.0 

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

WithHeader adds the headers to the HTTP request.

func (CCRForgetFollower) WithHuman added in v7.2.0 

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

WithHuman makes statistical values human-readable.

func (CCRForgetFollower) WithOpaqueID added in v7.5.0 

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

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

func (CCRForgetFollower) WithPretty added in v7.2.0 

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

WithPretty makes the response body pretty-printed.

type CCRForgetFollowerRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type CCRGetAutoFollowPattern added in v7.2.0 

type CCRGetAutoFollowPattern func(o ...func(*CCRGetAutoFollowPatternRequest)) (*Response, error)

CCRGetAutoFollowPattern - Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html.

func (CCRGetAutoFollowPattern) WithContext added in v7.2.0 

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

WithContext sets the request context.

func (CCRGetAutoFollowPattern) WithErrorTrace added in v7.2.0 

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

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

func (CCRGetAutoFollowPattern) WithFilterPath added in v7.2.0 

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

WithFilterPath filters the properties of the response body.

func (CCRGetAutoFollowPattern) WithHeader added in v7.2.0 

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

WithHeader adds the headers to the HTTP request.

func (CCRGetAutoFollowPattern) WithHuman added in v7.2.0 

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

WithHuman makes statistical values human-readable.

func (CCRGetAutoFollowPattern) WithName added in v7.2.0 

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

WithName - the name of the auto follow pattern..

func (CCRGetAutoFollowPattern) WithOpaqueID added in v7.5.0 

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

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

func (CCRGetAutoFollowPattern) WithPretty added in v7.2.0 

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

WithPretty makes the response body pretty-printed.

type CCRGetAutoFollowPatternRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type CCRPauseAutoFollowPattern added in v7.5.0 

type CCRPauseAutoFollowPattern func(name string, o ...func(*CCRPauseAutoFollowPatternRequest)) (*Response, error)

CCRPauseAutoFollowPattern - Pauses an auto-follow pattern

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-pause-auto-follow-pattern.html.

func (CCRPauseAutoFollowPattern) WithContext added in v7.5.0 

func (f CCRPauseAutoFollowPattern) WithContext(v context.Context) func(*CCRPauseAutoFollowPatternRequest)

WithContext sets the request context.

func (CCRPauseAutoFollowPattern) WithErrorTrace added in v7.5.0 

func (f CCRPauseAutoFollowPattern) WithErrorTrace() func(*CCRPauseAutoFollowPatternRequest)

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

func (CCRPauseAutoFollowPattern) WithFilterPath added in v7.5.0 

func (f CCRPauseAutoFollowPattern) WithFilterPath(v ...string) func(*CCRPauseAutoFollowPatternRequest)

WithFilterPath filters the properties of the response body.

func (CCRPauseAutoFollowPattern) WithHeader added in v7.5.0 

func (f CCRPauseAutoFollowPattern) WithHeader(h map[string]string) func(*CCRPauseAutoFollowPatternRequest)

WithHeader adds the headers to the HTTP request.

func (CCRPauseAutoFollowPattern) WithHuman added in v7.5.0 

func (f CCRPauseAutoFollowPattern) WithHuman() func(*CCRPauseAutoFollowPatternRequest)

WithHuman makes statistical values human-readable.

func (CCRPauseAutoFollowPattern) WithOpaqueID added in v7.5.0 

func (f CCRPauseAutoFollowPattern) WithOpaqueID(s string) func(*CCRPauseAutoFollowPatternRequest)

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

func (CCRPauseAutoFollowPattern) WithPretty added in v7.5.0 

func (f CCRPauseAutoFollowPattern) WithPretty() func(*CCRPauseAutoFollowPatternRequest)

WithPretty makes the response body pretty-printed.

type CCRPauseAutoFollowPatternRequest added in v7.5.0 

type CCRPauseAutoFollowPatternRequest struct {
	Name string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

CCRPauseAutoFollowPatternRequest configures the CCR Pause Auto Follow Pattern API request.

func (CCRPauseAutoFollowPatternRequest) Do added in v7.5.0 

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

Do executes the request and returns response or error.

type CCRPauseFollow added in v7.2.0 

type CCRPauseFollow func(index string, o ...func(*CCRPauseFollowRequest)) (*Response, error)

CCRPauseFollow - Pauses a follower index. The follower index will not fetch any additional operations from the leader index.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-follow.html.

func (CCRPauseFollow) WithContext added in v7.2.0 

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

WithContext sets the request context.

func (CCRPauseFollow) WithErrorTrace added in v7.2.0 

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

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

func (CCRPauseFollow) WithFilterPath added in v7.2.0 

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

WithFilterPath filters the properties of the response body.

func (CCRPauseFollow) WithHeader added in v7.2.0 

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

WithHeader adds the headers to the HTTP request.

func (CCRPauseFollow) WithHuman added in v7.2.0 

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

WithHuman makes statistical values human-readable.

func (CCRPauseFollow) WithOpaqueID added in v7.5.0 

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

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

func (CCRPauseFollow) WithPretty added in v7.2.0 

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

WithPretty makes the response body pretty-printed.

type CCRPauseFollowRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type CCRPutAutoFollowPattern added in v7.2.0 

type CCRPutAutoFollowPattern func(name string, body io.Reader, o ...func(*CCRPutAutoFollowPatternRequest)) (*Response, error)

CCRPutAutoFollowPattern - Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-follow-pattern.html.

func (CCRPutAutoFollowPattern) WithContext added in v7.2.0 

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

WithContext sets the request context.

func (CCRPutAutoFollowPattern) WithErrorTrace added in v7.2.0 

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

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

func (CCRPutAutoFollowPattern) WithFilterPath added in v7.2.0 

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

WithFilterPath filters the properties of the response body.

func (CCRPutAutoFollowPattern) WithHeader added in v7.2.0 

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

WithHeader adds the headers to the HTTP request.

func (CCRPutAutoFollowPattern) WithHuman added in v7.2.0 

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

WithHuman makes statistical values human-readable.

func (CCRPutAutoFollowPattern) WithOpaqueID added in v7.5.0 

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

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

func (CCRPutAutoFollowPattern) WithPretty added in v7.2.0 

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

WithPretty makes the response body pretty-printed.

type CCRPutAutoFollowPatternRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type CCRResumeAutoFollowPattern added in v7.5.0 

type CCRResumeAutoFollowPattern func(name string, o ...func(*CCRResumeAutoFollowPatternRequest)) (*Response, error)

CCRResumeAutoFollowPattern - Resumes an auto-follow pattern that has been paused

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-resume-auto-follow-pattern.html.

func (CCRResumeAutoFollowPattern) WithContext added in v7.5.0 

func (f CCRResumeAutoFollowPattern) WithContext(v context.Context) func(*CCRResumeAutoFollowPatternRequest)

WithContext sets the request context.

func (CCRResumeAutoFollowPattern) WithErrorTrace added in v7.5.0 

func (f CCRResumeAutoFollowPattern) WithErrorTrace() func(*CCRResumeAutoFollowPatternRequest)

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

func (CCRResumeAutoFollowPattern) WithFilterPath added in v7.5.0 

func (f CCRResumeAutoFollowPattern) WithFilterPath(v ...string) func(*CCRResumeAutoFollowPatternRequest)

WithFilterPath filters the properties of the response body.

func (CCRResumeAutoFollowPattern) WithHeader added in v7.5.0 

func (f CCRResumeAutoFollowPattern) WithHeader(h map[string]string) func(*CCRResumeAutoFollowPatternRequest)

WithHeader adds the headers to the HTTP request.

func (CCRResumeAutoFollowPattern) WithHuman added in v7.5.0 

func (f CCRResumeAutoFollowPattern) WithHuman() func(*CCRResumeAutoFollowPatternRequest)

WithHuman makes statistical values human-readable.

func (CCRResumeAutoFollowPattern) WithOpaqueID added in v7.5.0 

func (f CCRResumeAutoFollowPattern) WithOpaqueID(s string) func(*CCRResumeAutoFollowPatternRequest)

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

func (CCRResumeAutoFollowPattern) WithPretty added in v7.5.0 

func (f CCRResumeAutoFollowPattern) WithPretty() func(*CCRResumeAutoFollowPatternRequest)

WithPretty makes the response body pretty-printed.

type CCRResumeAutoFollowPatternRequest added in v7.5.0 

type CCRResumeAutoFollowPatternRequest struct {
	Name string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

CCRResumeAutoFollowPatternRequest configures the CCR Resume Auto Follow Pattern API request.

func (CCRResumeAutoFollowPatternRequest) Do added in v7.5.0 

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

Do executes the request and returns response or error.

type CCRResumeFollow added in v7.2.0 

type CCRResumeFollow func(index string, o ...func(*CCRResumeFollowRequest)) (*Response, error)

CCRResumeFollow - Resumes a follower index that has been paused

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html.

func (CCRResumeFollow) WithBody added in v7.2.0 

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 v7.2.0 

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

WithContext sets the request context.

func (CCRResumeFollow) WithErrorTrace added in v7.2.0 

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

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

func (CCRResumeFollow) WithFilterPath added in v7.2.0 

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

WithFilterPath filters the properties of the response body.

func (CCRResumeFollow) WithHeader added in v7.2.0 

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

WithHeader adds the headers to the HTTP request.

func (CCRResumeFollow) WithHuman added in v7.2.0 

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

WithHuman makes statistical values human-readable.

func (CCRResumeFollow) WithOpaqueID added in v7.5.0 

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

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

func (CCRResumeFollow) WithPretty added in v7.2.0 

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

WithPretty makes the response body pretty-printed.

type CCRResumeFollowRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type CCRStats added in v7.2.0 

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

CCRStats - Gets all stats related to cross-cluster replication.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html.

func (CCRStats) WithContext added in v7.2.0 

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

WithContext sets the request context.

func (CCRStats) WithErrorTrace added in v7.2.0 

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

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

func (CCRStats) WithFilterPath added in v7.2.0 

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

WithFilterPath filters the properties of the response body.

func (CCRStats) WithHeader added in v7.2.0 

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

WithHeader adds the headers to the HTTP request.

func (CCRStats) WithHuman added in v7.2.0 

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

WithHuman makes statistical values human-readable.

func (CCRStats) WithOpaqueID added in v7.5.0 

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

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

func (CCRStats) WithPretty added in v7.2.0 

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

WithPretty makes the response body pretty-printed.

type CCRStatsRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type CCRUnfollow added in v7.2.0 

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

CCRUnfollow - Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-unfollow.html.

func (CCRUnfollow) WithContext added in v7.2.0 

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

WithContext sets the request context.

func (CCRUnfollow) WithErrorTrace added in v7.2.0 

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

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

func (CCRUnfollow) WithFilterPath added in v7.2.0 

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

WithFilterPath filters the properties of the response body.

func (CCRUnfollow) WithHeader added in v7.2.0 

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

WithHeader adds the headers to the HTTP request.

func (CCRUnfollow) WithHuman added in v7.2.0 

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

WithHuman makes statistical values human-readable.

func (CCRUnfollow) WithOpaqueID added in v7.5.0 

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

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

func (CCRUnfollow) WithPretty added in v7.2.0 

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

WithPretty makes the response body pretty-printed.

type CCRUnfollowRequest added in v7.2.0 

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 v7.2.0 

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
	MLDataFrameAnalytics CatMLDataFrameAnalytics
	MLDatafeeds          CatMLDatafeeds
	MLJobs               CatMLJobs
	MLTrainedModels      CatMLTrainedModels
	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
	Transforms           CatTransforms
}

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 https://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) WithExpandWildcards added in v7.7.0 

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

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

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 v7.2.0 

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) WithName 

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

WithName - a list of alias names to return.

func (CatAliases) WithOpaqueID added in v7.5.0 

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

	ExpandWildcards string
	Format          string
	H               []string
	Help            *bool
	Local           *bool
	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 https://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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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) WithOpaqueID added in v7.5.0 

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
	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 https://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 v7.2.0 

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) WithOpaqueID added in v7.5.0 

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
	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 https://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 v7.2.0 

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) WithOpaqueID added in v7.5.0 

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) WithTime added in v7.4.1 

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

WithTime - the unit in which to display time values.

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
	S      []string
	Time   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 https://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 v7.2.0 

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 v7.5.0 

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 https://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) WithExpandWildcards added in v7.7.0 

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

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

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 v7.2.0 

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) WithIncludeUnloadedSegments added in v7.2.0 

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

WithIncludeUnloadedSegments - if set to true segment stats will include stats for segments that are not currently loaded into memory.

func (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 v7.5.0 

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) WithTime added in v7.4.1 

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

WithTime - the unit in which to display time values.

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
	ExpandWildcards         string
	Format                  string
	H                       []string
	Health                  string
	Help                    *bool
	IncludeUnloadedSegments *bool
	Local                   *bool
	MasterTimeout           time.Duration
	Pri                     *bool
	S                       []string
	Time                    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 CatMLDataFrameAnalytics added in v7.7.0 

type CatMLDataFrameAnalytics func(o ...func(*CatMLDataFrameAnalyticsRequest)) (*Response, error)

CatMLDataFrameAnalytics - Gets configuration and usage information about data frame analytics jobs.

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

func (CatMLDataFrameAnalytics) WithAllowNoMatch added in v7.7.0 

func (f CatMLDataFrameAnalytics) WithAllowNoMatch(v bool) func(*CatMLDataFrameAnalyticsRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no configs. (this includes `_all` string or when no configs have been specified).

func (CatMLDataFrameAnalytics) WithBytes added in v7.7.0 

func (f CatMLDataFrameAnalytics) WithBytes(v string) func(*CatMLDataFrameAnalyticsRequest)

WithBytes - the unit in which to display byte values.

func (CatMLDataFrameAnalytics) WithContext added in v7.7.0 

func (f CatMLDataFrameAnalytics) WithContext(v context.Context) func(*CatMLDataFrameAnalyticsRequest)

WithContext sets the request context.

func (CatMLDataFrameAnalytics) WithDocumentID added in v7.7.0 

func (f CatMLDataFrameAnalytics) WithDocumentID(v string) func(*CatMLDataFrameAnalyticsRequest)

WithDocumentID - the ID of the data frame analytics to fetch.

func (CatMLDataFrameAnalytics) WithErrorTrace added in v7.7.0 

func (f CatMLDataFrameAnalytics) WithErrorTrace() func(*CatMLDataFrameAnalyticsRequest)

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

func (CatMLDataFrameAnalytics) WithFilterPath added in v7.7.0 

func (f CatMLDataFrameAnalytics) WithFilterPath(v ...string) func(*CatMLDataFrameAnalyticsRequest)

WithFilterPath filters the properties of the response body.

func (CatMLDataFrameAnalytics) WithFormat added in v7.7.0 

func (f CatMLDataFrameAnalytics) WithFormat(v string) func(*CatMLDataFrameAnalyticsRequest)

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

func (CatMLDataFrameAnalytics) WithH added in v7.7.0 

func (f CatMLDataFrameAnalytics) WithH(v ...string) func(*CatMLDataFrameAnalyticsRequest)

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

func (CatMLDataFrameAnalytics) WithHeader added in v7.7.0 

func (f CatMLDataFrameAnalytics) WithHeader(h map[string]string) func(*CatMLDataFrameAnalyticsRequest)

WithHeader adds the headers to the HTTP request.

func (CatMLDataFrameAnalytics) WithHelp added in v7.7.0 

func (f CatMLDataFrameAnalytics) WithHelp(v bool) func(*CatMLDataFrameAnalyticsRequest)

WithHelp - return help information.

func (CatMLDataFrameAnalytics) WithHuman added in v7.7.0 

func (f CatMLDataFrameAnalytics) WithHuman() func(*CatMLDataFrameAnalyticsRequest)

WithHuman makes statistical values human-readable.

func (CatMLDataFrameAnalytics) WithOpaqueID added in v7.7.0 

func (f CatMLDataFrameAnalytics) WithOpaqueID(s string) func(*CatMLDataFrameAnalyticsRequest)

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

func (CatMLDataFrameAnalytics) WithPretty added in v7.7.0 

func (f CatMLDataFrameAnalytics) WithPretty() func(*CatMLDataFrameAnalyticsRequest)

WithPretty makes the response body pretty-printed.

func (CatMLDataFrameAnalytics) WithS added in v7.7.0 

func (f CatMLDataFrameAnalytics) WithS(v ...string) func(*CatMLDataFrameAnalyticsRequest)

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

func (CatMLDataFrameAnalytics) WithTime added in v7.7.0 

func (f CatMLDataFrameAnalytics) WithTime(v string) func(*CatMLDataFrameAnalyticsRequest)

WithTime - the unit in which to display time values.

func (CatMLDataFrameAnalytics) WithV added in v7.7.0 

func (f CatMLDataFrameAnalytics) WithV(v bool) func(*CatMLDataFrameAnalyticsRequest)

WithV - verbose mode. display column headers.

type CatMLDataFrameAnalyticsRequest added in v7.7.0 

type CatMLDataFrameAnalyticsRequest struct {
	DocumentID string

	AllowNoMatch *bool
	Bytes        string
	Format       string
	H            []string
	Help         *bool
	S            []string
	Time         string
	V            *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

CatMLDataFrameAnalyticsRequest configures the CatML Data Frame Analytics API request.

func (CatMLDataFrameAnalyticsRequest) Do added in v7.7.0 

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

Do executes the request and returns response or error.

type CatMLDatafeeds added in v7.7.0 

type CatMLDatafeeds func(o ...func(*CatMLDatafeedsRequest)) (*Response, error)

CatMLDatafeeds - Gets configuration and usage information about datafeeds.

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

func (CatMLDatafeeds) WithAllowNoDatafeeds added in v7.7.0 

func (f CatMLDatafeeds) WithAllowNoDatafeeds(v bool) func(*CatMLDatafeedsRequest)

WithAllowNoDatafeeds - whether to ignore if a wildcard expression matches no datafeeds. (this includes `_all` string or when no datafeeds have been specified).

func (CatMLDatafeeds) WithAllowNoMatch added in v7.10.0 

func (f CatMLDatafeeds) WithAllowNoMatch(v bool) func(*CatMLDatafeedsRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no datafeeds. (this includes `_all` string or when no datafeeds have been specified).

func (CatMLDatafeeds) WithContext added in v7.7.0 

func (f CatMLDatafeeds) WithContext(v context.Context) func(*CatMLDatafeedsRequest)

WithContext sets the request context.

func (CatMLDatafeeds) WithDatafeedID added in v7.7.0 

func (f CatMLDatafeeds) WithDatafeedID(v string) func(*CatMLDatafeedsRequest)

WithDatafeedID - the ID of the datafeeds stats to fetch.

func (CatMLDatafeeds) WithErrorTrace added in v7.7.0 

func (f CatMLDatafeeds) WithErrorTrace() func(*CatMLDatafeedsRequest)

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

func (CatMLDatafeeds) WithFilterPath added in v7.7.0 

func (f CatMLDatafeeds) WithFilterPath(v ...string) func(*CatMLDatafeedsRequest)

WithFilterPath filters the properties of the response body.

func (CatMLDatafeeds) WithFormat added in v7.7.0 

func (f CatMLDatafeeds) WithFormat(v string) func(*CatMLDatafeedsRequest)

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

func (CatMLDatafeeds) WithH added in v7.7.0 

func (f CatMLDatafeeds) WithH(v ...string) func(*CatMLDatafeedsRequest)

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

func (CatMLDatafeeds) WithHeader added in v7.7.0 

func (f CatMLDatafeeds) WithHeader(h map[string]string) func(*CatMLDatafeedsRequest)

WithHeader adds the headers to the HTTP request.

func (CatMLDatafeeds) WithHelp added in v7.7.0 

func (f CatMLDatafeeds) WithHelp(v bool) func(*CatMLDatafeedsRequest)

WithHelp - return help information.

func (CatMLDatafeeds) WithHuman added in v7.7.0 

func (f CatMLDatafeeds) WithHuman() func(*CatMLDatafeedsRequest)

WithHuman makes statistical values human-readable.

func (CatMLDatafeeds) WithOpaqueID added in v7.7.0 

func (f CatMLDatafeeds) WithOpaqueID(s string) func(*CatMLDatafeedsRequest)

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

func (CatMLDatafeeds) WithPretty added in v7.7.0 

func (f CatMLDatafeeds) WithPretty() func(*CatMLDatafeedsRequest)

WithPretty makes the response body pretty-printed.

func (CatMLDatafeeds) WithS added in v7.7.0 

func (f CatMLDatafeeds) WithS(v ...string) func(*CatMLDatafeedsRequest)

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

func (CatMLDatafeeds) WithTime added in v7.7.0 

func (f CatMLDatafeeds) WithTime(v string) func(*CatMLDatafeedsRequest)

WithTime - the unit in which to display time values.

func (CatMLDatafeeds) WithV added in v7.7.0 

func (f CatMLDatafeeds) WithV(v bool) func(*CatMLDatafeedsRequest)

WithV - verbose mode. display column headers.

type CatMLDatafeedsRequest added in v7.7.0 

type CatMLDatafeedsRequest struct {
	DatafeedID string

	AllowNoDatafeeds *bool
	AllowNoMatch     *bool
	Format           string
	H                []string
	Help             *bool
	S                []string
	Time             string
	V                *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

CatMLDatafeedsRequest configures the CatML Datafeeds API request.

func (CatMLDatafeedsRequest) Do added in v7.7.0 

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

Do executes the request and returns response or error.

type CatMLJobs added in v7.7.0 

type CatMLJobs func(o ...func(*CatMLJobsRequest)) (*Response, error)

CatMLJobs - Gets configuration and usage information about anomaly detection jobs.

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

func (CatMLJobs) WithAllowNoJobs added in v7.7.0 

func (f CatMLJobs) WithAllowNoJobs(v bool) func(*CatMLJobsRequest)

WithAllowNoJobs - whether to ignore if a wildcard expression matches no jobs. (this includes `_all` string or when no jobs have been specified).

func (CatMLJobs) WithAllowNoMatch added in v7.10.0 

func (f CatMLJobs) WithAllowNoMatch(v bool) func(*CatMLJobsRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no jobs. (this includes `_all` string or when no jobs have been specified).

func (CatMLJobs) WithBytes added in v7.7.0 

func (f CatMLJobs) WithBytes(v string) func(*CatMLJobsRequest)

WithBytes - the unit in which to display byte values.

func (CatMLJobs) WithContext added in v7.7.0 

func (f CatMLJobs) WithContext(v context.Context) func(*CatMLJobsRequest)

WithContext sets the request context.

func (CatMLJobs) WithErrorTrace added in v7.7.0 

func (f CatMLJobs) WithErrorTrace() func(*CatMLJobsRequest)

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

func (CatMLJobs) WithFilterPath added in v7.7.0 

func (f CatMLJobs) WithFilterPath(v ...string) func(*CatMLJobsRequest)

WithFilterPath filters the properties of the response body.

func (CatMLJobs) WithFormat added in v7.7.0 

func (f CatMLJobs) WithFormat(v string) func(*CatMLJobsRequest)

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

func (CatMLJobs) WithH added in v7.7.0 

func (f CatMLJobs) WithH(v ...string) func(*CatMLJobsRequest)

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

func (CatMLJobs) WithHeader added in v7.7.0 

func (f CatMLJobs) WithHeader(h map[string]string) func(*CatMLJobsRequest)

WithHeader adds the headers to the HTTP request.

func (CatMLJobs) WithHelp added in v7.7.0 

func (f CatMLJobs) WithHelp(v bool) func(*CatMLJobsRequest)

WithHelp - return help information.

func (CatMLJobs) WithHuman added in v7.7.0 

func (f CatMLJobs) WithHuman() func(*CatMLJobsRequest)

WithHuman makes statistical values human-readable.

func (CatMLJobs) WithJobID added in v7.7.0 

func (f CatMLJobs) WithJobID(v string) func(*CatMLJobsRequest)

WithJobID - the ID of the jobs stats to fetch.

func (CatMLJobs) WithOpaqueID added in v7.7.0 

func (f CatMLJobs) WithOpaqueID(s string) func(*CatMLJobsRequest)

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

func (CatMLJobs) WithPretty added in v7.7.0 

func (f CatMLJobs) WithPretty() func(*CatMLJobsRequest)

WithPretty makes the response body pretty-printed.

func (CatMLJobs) WithS added in v7.7.0 

func (f CatMLJobs) WithS(v ...string) func(*CatMLJobsRequest)

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

func (CatMLJobs) WithTime added in v7.7.0 

func (f CatMLJobs) WithTime(v string) func(*CatMLJobsRequest)

WithTime - the unit in which to display time values.

func (CatMLJobs) WithV added in v7.7.0 

func (f CatMLJobs) WithV(v bool) func(*CatMLJobsRequest)

WithV - verbose mode. display column headers.

type CatMLJobsRequest added in v7.7.0 

type CatMLJobsRequest struct {
	JobID string

	AllowNoJobs  *bool
	AllowNoMatch *bool
	Bytes        string
	Format       string
	H            []string
	Help         *bool
	S            []string
	Time         string
	V            *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

CatMLJobsRequest configures the CatML Jobs API request.

func (CatMLJobsRequest) Do added in v7.7.0 

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

Do executes the request and returns response or error.

type CatMLTrainedModels added in v7.7.0 

type CatMLTrainedModels func(o ...func(*CatMLTrainedModelsRequest)) (*Response, error)

CatMLTrainedModels - Gets configuration and usage information about inference trained models.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html.

func (CatMLTrainedModels) WithAllowNoMatch added in v7.7.0 

func (f CatMLTrainedModels) WithAllowNoMatch(v bool) func(*CatMLTrainedModelsRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no trained models. (this includes `_all` string or when no trained models have been specified).

func (CatMLTrainedModels) WithBytes added in v7.7.0 

func (f CatMLTrainedModels) WithBytes(v string) func(*CatMLTrainedModelsRequest)

WithBytes - the unit in which to display byte values.

func (CatMLTrainedModels) WithContext added in v7.7.0 

func (f CatMLTrainedModels) WithContext(v context.Context) func(*CatMLTrainedModelsRequest)

WithContext sets the request context.

func (CatMLTrainedModels) WithErrorTrace added in v7.7.0 

func (f CatMLTrainedModels) WithErrorTrace() func(*CatMLTrainedModelsRequest)

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

func (CatMLTrainedModels) WithFilterPath added in v7.7.0 

func (f CatMLTrainedModels) WithFilterPath(v ...string) func(*CatMLTrainedModelsRequest)

WithFilterPath filters the properties of the response body.

func (CatMLTrainedModels) WithFormat added in v7.7.0 

func (f CatMLTrainedModels) WithFormat(v string) func(*CatMLTrainedModelsRequest)

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

func (CatMLTrainedModels) WithFrom added in v7.7.0 

func (f CatMLTrainedModels) WithFrom(v int) func(*CatMLTrainedModelsRequest)

WithFrom - skips a number of trained models.

func (CatMLTrainedModels) WithH added in v7.7.0 

func (f CatMLTrainedModels) WithH(v ...string) func(*CatMLTrainedModelsRequest)

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

func (CatMLTrainedModels) WithHeader added in v7.7.0 

func (f CatMLTrainedModels) WithHeader(h map[string]string) func(*CatMLTrainedModelsRequest)

WithHeader adds the headers to the HTTP request.

func (CatMLTrainedModels) WithHelp added in v7.7.0 

func (f CatMLTrainedModels) WithHelp(v bool) func(*CatMLTrainedModelsRequest)

WithHelp - return help information.

func (CatMLTrainedModels) WithHuman added in v7.7.0 

func (f CatMLTrainedModels) WithHuman() func(*CatMLTrainedModelsRequest)

WithHuman makes statistical values human-readable.

func (CatMLTrainedModels) WithModelID added in v7.7.0 

func (f CatMLTrainedModels) WithModelID(v string) func(*CatMLTrainedModelsRequest)

WithModelID - the ID of the trained models stats to fetch.

func (CatMLTrainedModels) WithOpaqueID added in v7.7.0 

func (f CatMLTrainedModels) WithOpaqueID(s string) func(*CatMLTrainedModelsRequest)

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

func (CatMLTrainedModels) WithPretty added in v7.7.0 

func (f CatMLTrainedModels) WithPretty() func(*CatMLTrainedModelsRequest)

WithPretty makes the response body pretty-printed.

func (CatMLTrainedModels) WithS added in v7.7.0 

func (f CatMLTrainedModels) WithS(v ...string) func(*CatMLTrainedModelsRequest)

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

func (CatMLTrainedModels) WithSize added in v7.7.0 

func (f CatMLTrainedModels) WithSize(v int) func(*CatMLTrainedModelsRequest)

WithSize - specifies a max number of trained models to get.

func (CatMLTrainedModels) WithTime added in v7.7.0 

func (f CatMLTrainedModels) WithTime(v string) func(*CatMLTrainedModelsRequest)

WithTime - the unit in which to display time values.

func (CatMLTrainedModels) WithV added in v7.7.0 

func (f CatMLTrainedModels) WithV(v bool) func(*CatMLTrainedModelsRequest)

WithV - verbose mode. display column headers.

type CatMLTrainedModelsRequest added in v7.7.0 

type CatMLTrainedModelsRequest struct {
	ModelID string

	AllowNoMatch *bool
	Bytes        string
	Format       string
	From         *int
	H            []string
	Help         *bool
	S            []string
	Size         *int
	Time         string
	V            *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

CatMLTrainedModelsRequest configures the CatML Trained Models API request.

func (CatMLTrainedModelsRequest) Do added in v7.7.0 

func (r CatMLTrainedModelsRequest) 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 https://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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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

func (CatNodes) WithBytes added in v7.4.1 

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

WithBytes - the unit in which to display byte values.

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 v7.2.0 

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) WithIncludeUnloadedSegments added in v7.13.0 

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

WithIncludeUnloadedSegments - if set to true segment stats will include stats for segments that are not currently loaded into memory.

func (CatNodes) WithLocal 

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

WithLocal - calculate the selected nodes using the local cluster state rather than 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 v7.5.0 

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) WithTime added in v7.4.1 

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

WithTime - the unit in which to display time values.

func (CatNodes) WithV 

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

WithV - verbose mode. display column headers.

type CatNodesRequest 

type CatNodesRequest struct {
	Bytes                   string
	Format                  string
	FullID                  *bool
	H                       []string
	Help                    *bool
	IncludeUnloadedSegments *bool
	Local                   *bool
	MasterTimeout           time.Duration
	S                       []string
	Time                    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 https://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 v7.2.0 

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 v7.5.0 

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) WithTime added in v7.4.1 

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

WithTime - the unit in which to display time values.

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
	Time          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 https://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 v7.2.0 

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) WithIncludeBootstrap added in v7.12.0 

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

WithIncludeBootstrap - include bootstrap plugins in the response.

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 v7.5.0 

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
	IncludeBootstrap *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 https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html.

func (CatRecovery) WithActiveOnly added in v7.4.0 

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

WithActiveOnly - if `true`, the response only includes ongoing shard recoveries.

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) WithDetailed added in v7.4.0 

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

WithDetailed - if `true`, the response includes detailed information about shard recoveries.

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 v7.2.0 

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 - comma-separated list or wildcard expression of index names to limit the returned information.

func (CatRecovery) WithOpaqueID added in v7.5.0 

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) WithTime added in v7.4.1 

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

WithTime - the unit in which to display time values.

func (CatRecovery) WithV 

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

WithV - verbose mode. display column headers.

type CatRecoveryRequest 

type CatRecoveryRequest struct {
	Index []string

	ActiveOnly *bool
	Bytes      string
	Detailed   *bool
	Format     string
	H          []string
	Help       *bool
	S          []string
	Time       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 https://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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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) WithTime added in v7.4.1 

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

WithTime - the unit in which to display time values.

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
	Time          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 https://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 v7.2.0 

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 v7.5.0 

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) WithTime added in v7.4.1 

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

WithTime - the unit in which to display time values.

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
	Time              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 https://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 v7.2.0 

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) WithNodes added in v7.11.0 

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

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 (CatTasks) WithOpaqueID added in v7.5.0 

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

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

func (CatTasks) WithParentTaskID added in v7.11.0 

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

WithParentTaskID - return tasks with specified parent task ID (node_id:task_number). 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) WithTime added in v7.4.1 

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

WithTime - the unit in which to display time values.

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
	Nodes        []string
	ParentTaskID string
	S            []string
	Time         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 https://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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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 CatTransforms added in v7.7.0 

type CatTransforms func(o ...func(*CatTransformsRequest)) (*Response, error)

CatTransforms - Gets configuration and usage information about transforms.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html.

func (CatTransforms) WithAllowNoMatch added in v7.7.0 

func (f CatTransforms) WithAllowNoMatch(v bool) func(*CatTransformsRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no transforms. (this includes `_all` string or when no transforms have been specified).

func (CatTransforms) WithContext added in v7.7.0 

func (f CatTransforms) WithContext(v context.Context) func(*CatTransformsRequest)

WithContext sets the request context.

func (CatTransforms) WithErrorTrace added in v7.7.0 

func (f CatTransforms) WithErrorTrace() func(*CatTransformsRequest)

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

func (CatTransforms) WithFilterPath added in v7.7.0 

func (f CatTransforms) WithFilterPath(v ...string) func(*CatTransformsRequest)

WithFilterPath filters the properties of the response body.

func (CatTransforms) WithFormat added in v7.7.0 

func (f CatTransforms) WithFormat(v string) func(*CatTransformsRequest)

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

func (CatTransforms) WithFrom added in v7.7.0 

func (f CatTransforms) WithFrom(v int) func(*CatTransformsRequest)

WithFrom - skips a number of transform configs, defaults to 0.

func (CatTransforms) WithH added in v7.7.0 

func (f CatTransforms) WithH(v ...string) func(*CatTransformsRequest)

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

func (CatTransforms) WithHeader added in v7.7.0 

func (f CatTransforms) WithHeader(h map[string]string) func(*CatTransformsRequest)

WithHeader adds the headers to the HTTP request.

func (CatTransforms) WithHelp added in v7.7.0 

func (f CatTransforms) WithHelp(v bool) func(*CatTransformsRequest)

WithHelp - return help information.

func (CatTransforms) WithHuman added in v7.7.0 

func (f CatTransforms) WithHuman() func(*CatTransformsRequest)

WithHuman makes statistical values human-readable.

func (CatTransforms) WithOpaqueID added in v7.7.0 

func (f CatTransforms) WithOpaqueID(s string) func(*CatTransformsRequest)

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

func (CatTransforms) WithPretty added in v7.7.0 

func (f CatTransforms) WithPretty() func(*CatTransformsRequest)

WithPretty makes the response body pretty-printed.

func (CatTransforms) WithS added in v7.7.0 

func (f CatTransforms) WithS(v ...string) func(*CatTransformsRequest)

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

func (CatTransforms) WithSize added in v7.7.0 

func (f CatTransforms) WithSize(v int) func(*CatTransformsRequest)

WithSize - specifies a max number of transforms to get, defaults to 100.

func (CatTransforms) WithTime added in v7.7.0 

func (f CatTransforms) WithTime(v string) func(*CatTransformsRequest)

WithTime - the unit in which to display time values.

func (CatTransforms) WithTransformID added in v7.7.0 

func (f CatTransforms) WithTransformID(v string) func(*CatTransformsRequest)

WithTransformID - the ID of the transform for which to get stats. '_all' or '*' implies all transforms.

func (CatTransforms) WithV added in v7.7.0 

func (f CatTransforms) WithV(v bool) func(*CatTransformsRequest)

WithV - verbose mode. display column headers.

type CatTransformsRequest added in v7.7.0 

type CatTransformsRequest struct {
	TransformID string

	AllowNoMatch *bool
	Format       string
	From         *int
	H            []string
	Help         *bool
	S            []string
	Size         *int
	Time         string
	V            *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

CatTransformsRequest configures the Cat Transforms API request.

func (CatTransformsRequest) Do added in v7.7.0 

func (r CatTransformsRequest) 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 https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.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 v7.2.0 

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 v7.5.0 

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 ClosePointInTime added in v7.10.0 

type ClosePointInTime func(o ...func(*ClosePointInTimeRequest)) (*Response, error)

ClosePointInTime - Close a point in time

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html.

func (ClosePointInTime) WithBody added in v7.10.0 

func (f ClosePointInTime) WithBody(v io.Reader) func(*ClosePointInTimeRequest)

WithBody - a point-in-time id to close.

func (ClosePointInTime) WithContext added in v7.10.0 

func (f ClosePointInTime) WithContext(v context.Context) func(*ClosePointInTimeRequest)

WithContext sets the request context.

func (ClosePointInTime) WithErrorTrace added in v7.10.0 

func (f ClosePointInTime) WithErrorTrace() func(*ClosePointInTimeRequest)

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

func (ClosePointInTime) WithFilterPath added in v7.10.0 

func (f ClosePointInTime) WithFilterPath(v ...string) func(*ClosePointInTimeRequest)

WithFilterPath filters the properties of the response body.

func (ClosePointInTime) WithHeader added in v7.10.0 

func (f ClosePointInTime) WithHeader(h map[string]string) func(*ClosePointInTimeRequest)

WithHeader adds the headers to the HTTP request.

func (ClosePointInTime) WithHuman added in v7.10.0 

func (f ClosePointInTime) WithHuman() func(*ClosePointInTimeRequest)

WithHuman makes statistical values human-readable.

func (ClosePointInTime) WithOpaqueID added in v7.10.0 

func (f ClosePointInTime) WithOpaqueID(s string) func(*ClosePointInTimeRequest)

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

func (ClosePointInTime) WithPretty added in v7.10.0 

func (f ClosePointInTime) WithPretty() func(*ClosePointInTimeRequest)

WithPretty makes the response body pretty-printed.

type ClosePointInTimeRequest added in v7.10.0 

type ClosePointInTimeRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

ClosePointInTimeRequest configures the Close Point In Time API request.

func (ClosePointInTimeRequest) Do added in v7.10.0 

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

Do executes the request and returns response or error.

type Cluster 

type Cluster struct {
	AllocationExplain            ClusterAllocationExplain
	DeleteComponentTemplate      ClusterDeleteComponentTemplate
	DeleteVotingConfigExclusions ClusterDeleteVotingConfigExclusions
	ExistsComponentTemplate      ClusterExistsComponentTemplate
	GetComponentTemplate         ClusterGetComponentTemplate
	GetSettings                  ClusterGetSettings
	Health                       ClusterHealth
	PendingTasks                 ClusterPendingTasks
	PostVotingConfigExclusions   ClusterPostVotingConfigExclusions
	PutComponentTemplate         ClusterPutComponentTemplate
	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 https://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 a randomly-chosen 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 v7.2.0 

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 v7.5.0 

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 ClusterDeleteComponentTemplate added in v7.7.0 

type ClusterDeleteComponentTemplate func(name string, o ...func(*ClusterDeleteComponentTemplateRequest)) (*Response, error)

ClusterDeleteComponentTemplate deletes a component template

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html.

func (ClusterDeleteComponentTemplate) WithContext added in v7.7.0 

func (f ClusterDeleteComponentTemplate) WithContext(v context.Context) func(*ClusterDeleteComponentTemplateRequest)

WithContext sets the request context.

func (ClusterDeleteComponentTemplate) WithErrorTrace added in v7.7.0 

func (f ClusterDeleteComponentTemplate) WithErrorTrace() func(*ClusterDeleteComponentTemplateRequest)

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

func (ClusterDeleteComponentTemplate) WithFilterPath added in v7.7.0 

func (f ClusterDeleteComponentTemplate) WithFilterPath(v ...string) func(*ClusterDeleteComponentTemplateRequest)

WithFilterPath filters the properties of the response body.

func (ClusterDeleteComponentTemplate) WithHeader added in v7.7.0 

func (f ClusterDeleteComponentTemplate) WithHeader(h map[string]string) func(*ClusterDeleteComponentTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (ClusterDeleteComponentTemplate) WithHuman added in v7.7.0 

func (f ClusterDeleteComponentTemplate) WithHuman() func(*ClusterDeleteComponentTemplateRequest)

WithHuman makes statistical values human-readable.

func (ClusterDeleteComponentTemplate) WithMasterTimeout added in v7.7.0 

func (f ClusterDeleteComponentTemplate) WithMasterTimeout(v time.Duration) func(*ClusterDeleteComponentTemplateRequest)

WithMasterTimeout - specify timeout for connection to master.

func (ClusterDeleteComponentTemplate) WithOpaqueID added in v7.7.0 

func (f ClusterDeleteComponentTemplate) WithOpaqueID(s string) func(*ClusterDeleteComponentTemplateRequest)

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

func (ClusterDeleteComponentTemplate) WithPretty added in v7.7.0 

func (f ClusterDeleteComponentTemplate) WithPretty() func(*ClusterDeleteComponentTemplateRequest)

WithPretty makes the response body pretty-printed.

func (ClusterDeleteComponentTemplate) WithTimeout added in v7.7.0 

func (f ClusterDeleteComponentTemplate) WithTimeout(v time.Duration) func(*ClusterDeleteComponentTemplateRequest)

WithTimeout - explicit operation timeout.

type ClusterDeleteComponentTemplateRequest added in v7.7.0 

type ClusterDeleteComponentTemplateRequest 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
}

ClusterDeleteComponentTemplateRequest configures the Cluster Delete Component Template API request.

func (ClusterDeleteComponentTemplateRequest) Do added in v7.7.0 

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

Do executes the request and returns response or error.

type ClusterDeleteVotingConfigExclusions added in v7.8.0 

type ClusterDeleteVotingConfigExclusions func(o ...func(*ClusterDeleteVotingConfigExclusionsRequest)) (*Response, error)

ClusterDeleteVotingConfigExclusions clears cluster voting config exclusions.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html.

func (ClusterDeleteVotingConfigExclusions) WithContext added in v7.8.0 

func (f ClusterDeleteVotingConfigExclusions) WithContext(v context.Context) func(*ClusterDeleteVotingConfigExclusionsRequest)

WithContext sets the request context.

func (ClusterDeleteVotingConfigExclusions) WithErrorTrace added in v7.8.0 

func (f ClusterDeleteVotingConfigExclusions) WithErrorTrace() func(*ClusterDeleteVotingConfigExclusionsRequest)

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

func (ClusterDeleteVotingConfigExclusions) WithFilterPath added in v7.8.0 

func (f ClusterDeleteVotingConfigExclusions) WithFilterPath(v ...string) func(*ClusterDeleteVotingConfigExclusionsRequest)

WithFilterPath filters the properties of the response body.

func (ClusterDeleteVotingConfigExclusions) WithHeader added in v7.8.0 

func (f ClusterDeleteVotingConfigExclusions) WithHeader(h map[string]string) func(*ClusterDeleteVotingConfigExclusionsRequest)

WithHeader adds the headers to the HTTP request.

func (ClusterDeleteVotingConfigExclusions) WithHuman added in v7.8.0 

func (f ClusterDeleteVotingConfigExclusions) WithHuman() func(*ClusterDeleteVotingConfigExclusionsRequest)

WithHuman makes statistical values human-readable.

func (ClusterDeleteVotingConfigExclusions) WithOpaqueID added in v7.8.0 

func (f ClusterDeleteVotingConfigExclusions) WithOpaqueID(s string) func(*ClusterDeleteVotingConfigExclusionsRequest)

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

func (ClusterDeleteVotingConfigExclusions) WithPretty added in v7.8.0 

func (f ClusterDeleteVotingConfigExclusions) WithPretty() func(*ClusterDeleteVotingConfigExclusionsRequest)

WithPretty makes the response body pretty-printed.

func (ClusterDeleteVotingConfigExclusions) WithWaitForRemoval added in v7.8.0 

func (f ClusterDeleteVotingConfigExclusions) WithWaitForRemoval(v bool) func(*ClusterDeleteVotingConfigExclusionsRequest)

WithWaitForRemoval - specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list..

type ClusterDeleteVotingConfigExclusionsRequest added in v7.8.0 

type ClusterDeleteVotingConfigExclusionsRequest struct {
	WaitForRemoval *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

ClusterDeleteVotingConfigExclusionsRequest configures the Cluster Delete Voting Config Exclusions API request.

func (ClusterDeleteVotingConfigExclusionsRequest) Do added in v7.8.0 

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

Do executes the request and returns response or error.

type ClusterExistsComponentTemplate added in v7.7.0 

type ClusterExistsComponentTemplate func(name string, o ...func(*ClusterExistsComponentTemplateRequest)) (*Response, error)

ClusterExistsComponentTemplate returns information about whether a particular component template exist

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html.

func (ClusterExistsComponentTemplate) WithContext added in v7.7.0 

func (f ClusterExistsComponentTemplate) WithContext(v context.Context) func(*ClusterExistsComponentTemplateRequest)

WithContext sets the request context.

func (ClusterExistsComponentTemplate) WithErrorTrace added in v7.7.0 

func (f ClusterExistsComponentTemplate) WithErrorTrace() func(*ClusterExistsComponentTemplateRequest)

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

func (ClusterExistsComponentTemplate) WithFilterPath added in v7.7.0 

func (f ClusterExistsComponentTemplate) WithFilterPath(v ...string) func(*ClusterExistsComponentTemplateRequest)

WithFilterPath filters the properties of the response body.

func (ClusterExistsComponentTemplate) WithHeader added in v7.7.0 

func (f ClusterExistsComponentTemplate) WithHeader(h map[string]string) func(*ClusterExistsComponentTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (ClusterExistsComponentTemplate) WithHuman added in v7.7.0 

func (f ClusterExistsComponentTemplate) WithHuman() func(*ClusterExistsComponentTemplateRequest)

WithHuman makes statistical values human-readable.

func (ClusterExistsComponentTemplate) WithLocal added in v7.7.0 

func (f ClusterExistsComponentTemplate) WithLocal(v bool) func(*ClusterExistsComponentTemplateRequest)

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

func (ClusterExistsComponentTemplate) WithMasterTimeout added in v7.7.0 

func (f ClusterExistsComponentTemplate) WithMasterTimeout(v time.Duration) func(*ClusterExistsComponentTemplateRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (ClusterExistsComponentTemplate) WithOpaqueID added in v7.7.0 

func (f ClusterExistsComponentTemplate) WithOpaqueID(s string) func(*ClusterExistsComponentTemplateRequest)

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

func (ClusterExistsComponentTemplate) WithPretty added in v7.7.0 

func (f ClusterExistsComponentTemplate) WithPretty() func(*ClusterExistsComponentTemplateRequest)

WithPretty makes the response body pretty-printed.

type ClusterExistsComponentTemplateRequest added in v7.7.0 

type ClusterExistsComponentTemplateRequest struct {
	Name string

	Local         *bool
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

ClusterExistsComponentTemplateRequest configures the Cluster Exists Component Template API request.

func (ClusterExistsComponentTemplateRequest) Do added in v7.7.0 

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

Do executes the request and returns response or error.

type ClusterGetComponentTemplate added in v7.7.0 

type ClusterGetComponentTemplate func(o ...func(*ClusterGetComponentTemplateRequest)) (*Response, error)

ClusterGetComponentTemplate returns one or more component templates

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html.

func (ClusterGetComponentTemplate) WithContext added in v7.7.0 

func (f ClusterGetComponentTemplate) WithContext(v context.Context) func(*ClusterGetComponentTemplateRequest)

WithContext sets the request context.

func (ClusterGetComponentTemplate) WithErrorTrace added in v7.7.0 

func (f ClusterGetComponentTemplate) WithErrorTrace() func(*ClusterGetComponentTemplateRequest)

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

func (ClusterGetComponentTemplate) WithFilterPath added in v7.7.0 

func (f ClusterGetComponentTemplate) WithFilterPath(v ...string) func(*ClusterGetComponentTemplateRequest)

WithFilterPath filters the properties of the response body.

func (ClusterGetComponentTemplate) WithHeader added in v7.7.0 

func (f ClusterGetComponentTemplate) WithHeader(h map[string]string) func(*ClusterGetComponentTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (ClusterGetComponentTemplate) WithHuman added in v7.7.0 

func (f ClusterGetComponentTemplate) WithHuman() func(*ClusterGetComponentTemplateRequest)

WithHuman makes statistical values human-readable.

func (ClusterGetComponentTemplate) WithLocal added in v7.7.0 

func (f ClusterGetComponentTemplate) WithLocal(v bool) func(*ClusterGetComponentTemplateRequest)

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

func (ClusterGetComponentTemplate) WithMasterTimeout added in v7.7.0 

func (f ClusterGetComponentTemplate) WithMasterTimeout(v time.Duration) func(*ClusterGetComponentTemplateRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (ClusterGetComponentTemplate) WithName added in v7.7.0 

func (f ClusterGetComponentTemplate) WithName(v ...string) func(*ClusterGetComponentTemplateRequest)

WithName - the comma separated names of the component templates.

func (ClusterGetComponentTemplate) WithOpaqueID added in v7.7.0 

func (f ClusterGetComponentTemplate) WithOpaqueID(s string) func(*ClusterGetComponentTemplateRequest)

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

func (ClusterGetComponentTemplate) WithPretty added in v7.7.0 

func (f ClusterGetComponentTemplate) WithPretty() func(*ClusterGetComponentTemplateRequest)

WithPretty makes the response body pretty-printed.

type ClusterGetComponentTemplateRequest added in v7.7.0 

type ClusterGetComponentTemplateRequest struct {
	Name []string

	Local         *bool
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

ClusterGetComponentTemplateRequest configures the Cluster Get Component Template API request.

func (ClusterGetComponentTemplateRequest) Do added in v7.7.0 

func (r ClusterGetComponentTemplateRequest) 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 https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-get-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 v7.2.0 

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 v7.5.0 

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 https://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) WithExpandWildcards added in v7.2.0 

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

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (ClusterHealth) WithFilterPath 

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

WithFilterPath filters the properties of the response body.

func (ClusterHealth) WithHeader added in v7.2.0 

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 v7.5.0 

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

	ExpandWildcards             string
	Level                       string
	Local                       *bool
	MasterTimeout               time.Duration
	Timeout                     time.Duration
	WaitForActiveShards         string
	WaitForEvents               string
	WaitForNoInitializingShards *bool
	WaitForNoRelocatingShards   *bool
	WaitForNodes                string
	WaitForStatus               string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

ClusterHealthRequest configures the Cluster Health API request.

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 https://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 v7.2.0 

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 v7.5.0 

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 ClusterPostVotingConfigExclusions added in v7.8.0 

type ClusterPostVotingConfigExclusions func(o ...func(*ClusterPostVotingConfigExclusionsRequest)) (*Response, error)

ClusterPostVotingConfigExclusions updates the cluster voting config exclusions by node ids or node names.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html.

func (ClusterPostVotingConfigExclusions) WithContext added in v7.8.0 

func (f ClusterPostVotingConfigExclusions) WithContext(v context.Context) func(*ClusterPostVotingConfigExclusionsRequest)

WithContext sets the request context.

func (ClusterPostVotingConfigExclusions) WithErrorTrace added in v7.8.0 

func (f ClusterPostVotingConfigExclusions) WithErrorTrace() func(*ClusterPostVotingConfigExclusionsRequest)

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

func (ClusterPostVotingConfigExclusions) WithFilterPath added in v7.8.0 

func (f ClusterPostVotingConfigExclusions) WithFilterPath(v ...string) func(*ClusterPostVotingConfigExclusionsRequest)

WithFilterPath filters the properties of the response body.

func (ClusterPostVotingConfigExclusions) WithHeader added in v7.8.0 

func (f ClusterPostVotingConfigExclusions) WithHeader(h map[string]string) func(*ClusterPostVotingConfigExclusionsRequest)

WithHeader adds the headers to the HTTP request.

func (ClusterPostVotingConfigExclusions) WithHuman added in v7.8.0 

func (f ClusterPostVotingConfigExclusions) WithHuman() func(*ClusterPostVotingConfigExclusionsRequest)

WithHuman makes statistical values human-readable.

func (ClusterPostVotingConfigExclusions) WithNodeIds added in v7.8.0 

func (f ClusterPostVotingConfigExclusions) WithNodeIds(v string) func(*ClusterPostVotingConfigExclusionsRequest)

WithNodeIds - a list of the persistent ids of the nodes to exclude from the voting configuration. if specified, you may not also specify ?node_names..

func (ClusterPostVotingConfigExclusions) WithNodeNames added in v7.8.0 

func (f ClusterPostVotingConfigExclusions) WithNodeNames(v string) func(*ClusterPostVotingConfigExclusionsRequest)

WithNodeNames - a list of the names of the nodes to exclude from the voting configuration. if specified, you may not also specify ?node_ids..

func (ClusterPostVotingConfigExclusions) WithOpaqueID added in v7.8.0 

func (f ClusterPostVotingConfigExclusions) WithOpaqueID(s string) func(*ClusterPostVotingConfigExclusionsRequest)

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

func (ClusterPostVotingConfigExclusions) WithPretty added in v7.8.0 

func (f ClusterPostVotingConfigExclusions) WithPretty() func(*ClusterPostVotingConfigExclusionsRequest)

WithPretty makes the response body pretty-printed.

func (ClusterPostVotingConfigExclusions) WithTimeout added in v7.8.0 

func (f ClusterPostVotingConfigExclusions) WithTimeout(v time.Duration) func(*ClusterPostVotingConfigExclusionsRequest)

WithTimeout - explicit operation timeout.

type ClusterPostVotingConfigExclusionsRequest added in v7.8.0 

type ClusterPostVotingConfigExclusionsRequest struct {
	NodeIds   string
	NodeNames string
	Timeout   time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

ClusterPostVotingConfigExclusionsRequest configures the Cluster Post Voting Config Exclusions API request.

func (ClusterPostVotingConfigExclusionsRequest) Do added in v7.8.0 

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

Do executes the request and returns response or error.

type ClusterPutComponentTemplate added in v7.7.0 

type ClusterPutComponentTemplate func(name string, body io.Reader, o ...func(*ClusterPutComponentTemplateRequest)) (*Response, error)

ClusterPutComponentTemplate creates or updates a component template

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html.

func (ClusterPutComponentTemplate) WithContext added in v7.7.0 

func (f ClusterPutComponentTemplate) WithContext(v context.Context) func(*ClusterPutComponentTemplateRequest)

WithContext sets the request context.

func (ClusterPutComponentTemplate) WithCreate added in v7.7.0 

func (f ClusterPutComponentTemplate) WithCreate(v bool) func(*ClusterPutComponentTemplateRequest)

WithCreate - whether the index template should only be added if new or can also replace an existing one.

func (ClusterPutComponentTemplate) WithErrorTrace added in v7.7.0 

func (f ClusterPutComponentTemplate) WithErrorTrace() func(*ClusterPutComponentTemplateRequest)

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

func (ClusterPutComponentTemplate) WithFilterPath added in v7.7.0 

func (f ClusterPutComponentTemplate) WithFilterPath(v ...string) func(*ClusterPutComponentTemplateRequest)

WithFilterPath filters the properties of the response body.

func (ClusterPutComponentTemplate) WithHeader added in v7.7.0 

func (f ClusterPutComponentTemplate) WithHeader(h map[string]string) func(*ClusterPutComponentTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (ClusterPutComponentTemplate) WithHuman added in v7.7.0 

func (f ClusterPutComponentTemplate) WithHuman() func(*ClusterPutComponentTemplateRequest)

WithHuman makes statistical values human-readable.

func (ClusterPutComponentTemplate) WithMasterTimeout added in v7.7.0 

func (f ClusterPutComponentTemplate) WithMasterTimeout(v time.Duration) func(*ClusterPutComponentTemplateRequest)

WithMasterTimeout - specify timeout for connection to master.

func (ClusterPutComponentTemplate) WithOpaqueID added in v7.7.0 

func (f ClusterPutComponentTemplate) WithOpaqueID(s string) func(*ClusterPutComponentTemplateRequest)

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

func (ClusterPutComponentTemplate) WithPretty added in v7.7.0 

func (f ClusterPutComponentTemplate) WithPretty() func(*ClusterPutComponentTemplateRequest)

WithPretty makes the response body pretty-printed.

func (ClusterPutComponentTemplate) WithTimeout added in v7.7.0 

func (f ClusterPutComponentTemplate) WithTimeout(v time.Duration) func(*ClusterPutComponentTemplateRequest)

WithTimeout - explicit operation timeout.

type ClusterPutComponentTemplateRequest added in v7.7.0 

type ClusterPutComponentTemplateRequest struct {
	Body io.Reader

	Name string

	Create        *bool
	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

ClusterPutComponentTemplateRequest configures the Cluster Put Component Template API request.

func (ClusterPutComponentTemplateRequest) Do added in v7.7.0 

func (r ClusterPutComponentTemplateRequest) 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 https://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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

func (f Create) WithOpaqueID(s string) func(*CreateRequest)

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

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

	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 DanglingIndicesDeleteDanglingIndex added in v7.9.0 

type DanglingIndicesDeleteDanglingIndex func(index_uuid string, o ...func(*DanglingIndicesDeleteDanglingIndexRequest)) (*Response, error)

DanglingIndicesDeleteDanglingIndex deletes the specified dangling index

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html.

func (DanglingIndicesDeleteDanglingIndex) WithAcceptDataLoss added in v7.9.0 

func (f DanglingIndicesDeleteDanglingIndex) WithAcceptDataLoss(v bool) func(*DanglingIndicesDeleteDanglingIndexRequest)

WithAcceptDataLoss - must be set to true in order to delete the dangling index.

func (DanglingIndicesDeleteDanglingIndex) WithContext added in v7.9.0 

func (f DanglingIndicesDeleteDanglingIndex) WithContext(v context.Context) func(*DanglingIndicesDeleteDanglingIndexRequest)

WithContext sets the request context.

func (DanglingIndicesDeleteDanglingIndex) WithErrorTrace added in v7.9.0 

func (f DanglingIndicesDeleteDanglingIndex) WithErrorTrace() func(*DanglingIndicesDeleteDanglingIndexRequest)

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

func (DanglingIndicesDeleteDanglingIndex) WithFilterPath added in v7.9.0 

func (f DanglingIndicesDeleteDanglingIndex) WithFilterPath(v ...string) func(*DanglingIndicesDeleteDanglingIndexRequest)

WithFilterPath filters the properties of the response body.

func (DanglingIndicesDeleteDanglingIndex) WithHeader added in v7.9.0 

func (f DanglingIndicesDeleteDanglingIndex) WithHeader(h map[string]string) func(*DanglingIndicesDeleteDanglingIndexRequest)

WithHeader adds the headers to the HTTP request.

func (DanglingIndicesDeleteDanglingIndex) WithHuman added in v7.9.0 

func (f DanglingIndicesDeleteDanglingIndex) WithHuman() func(*DanglingIndicesDeleteDanglingIndexRequest)

WithHuman makes statistical values human-readable.

func (DanglingIndicesDeleteDanglingIndex) WithMasterTimeout added in v7.9.0 

func (f DanglingIndicesDeleteDanglingIndex) WithMasterTimeout(v time.Duration) func(*DanglingIndicesDeleteDanglingIndexRequest)

WithMasterTimeout - specify timeout for connection to master.

func (DanglingIndicesDeleteDanglingIndex) WithOpaqueID added in v7.9.0 

func (f DanglingIndicesDeleteDanglingIndex) WithOpaqueID(s string) func(*DanglingIndicesDeleteDanglingIndexRequest)

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

func (DanglingIndicesDeleteDanglingIndex) WithPretty added in v7.9.0 

func (f DanglingIndicesDeleteDanglingIndex) WithPretty() func(*DanglingIndicesDeleteDanglingIndexRequest)

WithPretty makes the response body pretty-printed.

func (DanglingIndicesDeleteDanglingIndex) WithTimeout added in v7.9.0 

func (f DanglingIndicesDeleteDanglingIndex) WithTimeout(v time.Duration) func(*DanglingIndicesDeleteDanglingIndexRequest)

WithTimeout - explicit operation timeout.

type DanglingIndicesDeleteDanglingIndexRequest added in v7.9.0 

type DanglingIndicesDeleteDanglingIndexRequest struct {
	IndexUUID string

	AcceptDataLoss *bool
	MasterTimeout  time.Duration
	Timeout        time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

DanglingIndicesDeleteDanglingIndexRequest configures the Dangling Indices Delete Dangling Index API request.

func (DanglingIndicesDeleteDanglingIndexRequest) Do added in v7.9.0 

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

Do executes the request and returns response or error.

type DanglingIndicesImportDanglingIndex added in v7.9.0 

type DanglingIndicesImportDanglingIndex func(index_uuid string, o ...func(*DanglingIndicesImportDanglingIndexRequest)) (*Response, error)

DanglingIndicesImportDanglingIndex imports the specified dangling index

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html.

func (DanglingIndicesImportDanglingIndex) WithAcceptDataLoss added in v7.9.0 

func (f DanglingIndicesImportDanglingIndex) WithAcceptDataLoss(v bool) func(*DanglingIndicesImportDanglingIndexRequest)

WithAcceptDataLoss - must be set to true in order to import the dangling index.

func (DanglingIndicesImportDanglingIndex) WithContext added in v7.9.0 

func (f DanglingIndicesImportDanglingIndex) WithContext(v context.Context) func(*DanglingIndicesImportDanglingIndexRequest)

WithContext sets the request context.

func (DanglingIndicesImportDanglingIndex) WithErrorTrace added in v7.9.0 

func (f DanglingIndicesImportDanglingIndex) WithErrorTrace() func(*DanglingIndicesImportDanglingIndexRequest)

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

func (DanglingIndicesImportDanglingIndex) WithFilterPath added in v7.9.0 

func (f DanglingIndicesImportDanglingIndex) WithFilterPath(v ...string) func(*DanglingIndicesImportDanglingIndexRequest)

WithFilterPath filters the properties of the response body.

func (DanglingIndicesImportDanglingIndex) WithHeader added in v7.9.0 

func (f DanglingIndicesImportDanglingIndex) WithHeader(h map[string]string) func(*DanglingIndicesImportDanglingIndexRequest)

WithHeader adds the headers to the HTTP request.

func (DanglingIndicesImportDanglingIndex) WithHuman added in v7.9.0 

func (f DanglingIndicesImportDanglingIndex) WithHuman() func(*DanglingIndicesImportDanglingIndexRequest)

WithHuman makes statistical values human-readable.

func (DanglingIndicesImportDanglingIndex) WithMasterTimeout added in v7.9.0 

func (f DanglingIndicesImportDanglingIndex) WithMasterTimeout(v time.Duration) func(*DanglingIndicesImportDanglingIndexRequest)

WithMasterTimeout - specify timeout for connection to master.

func (DanglingIndicesImportDanglingIndex) WithOpaqueID added in v7.9.0 

func (f DanglingIndicesImportDanglingIndex) WithOpaqueID(s string) func(*DanglingIndicesImportDanglingIndexRequest)

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

func (DanglingIndicesImportDanglingIndex) WithPretty added in v7.9.0 

func (f DanglingIndicesImportDanglingIndex) WithPretty() func(*DanglingIndicesImportDanglingIndexRequest)

WithPretty makes the response body pretty-printed.

func (DanglingIndicesImportDanglingIndex) WithTimeout added in v7.9.0 

func (f DanglingIndicesImportDanglingIndex) WithTimeout(v time.Duration) func(*DanglingIndicesImportDanglingIndexRequest)

WithTimeout - explicit operation timeout.

type DanglingIndicesImportDanglingIndexRequest added in v7.9.0 

type DanglingIndicesImportDanglingIndexRequest struct {
	IndexUUID string

	AcceptDataLoss *bool
	MasterTimeout  time.Duration
	Timeout        time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

DanglingIndicesImportDanglingIndexRequest configures the Dangling Indices Import Dangling Index API request.

func (DanglingIndicesImportDanglingIndexRequest) Do added in v7.9.0 

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

Do executes the request and returns response or error.

type DanglingIndicesListDanglingIndices added in v7.9.0 

type DanglingIndicesListDanglingIndices func(o ...func(*DanglingIndicesListDanglingIndicesRequest)) (*Response, error)

DanglingIndicesListDanglingIndices returns all dangling indices.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html.

func (DanglingIndicesListDanglingIndices) WithContext added in v7.9.0 

func (f DanglingIndicesListDanglingIndices) WithContext(v context.Context) func(*DanglingIndicesListDanglingIndicesRequest)

WithContext sets the request context.

func (DanglingIndicesListDanglingIndices) WithErrorTrace added in v7.9.0 

func (f DanglingIndicesListDanglingIndices) WithErrorTrace() func(*DanglingIndicesListDanglingIndicesRequest)

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

func (DanglingIndicesListDanglingIndices) WithFilterPath added in v7.9.0 

func (f DanglingIndicesListDanglingIndices) WithFilterPath(v ...string) func(*DanglingIndicesListDanglingIndicesRequest)

WithFilterPath filters the properties of the response body.

func (DanglingIndicesListDanglingIndices) WithHeader added in v7.9.0 

func (f DanglingIndicesListDanglingIndices) WithHeader(h map[string]string) func(*DanglingIndicesListDanglingIndicesRequest)

WithHeader adds the headers to the HTTP request.

func (DanglingIndicesListDanglingIndices) WithHuman added in v7.9.0 

func (f DanglingIndicesListDanglingIndices) WithHuman() func(*DanglingIndicesListDanglingIndicesRequest)

WithHuman makes statistical values human-readable.

func (DanglingIndicesListDanglingIndices) WithOpaqueID added in v7.9.0 

func (f DanglingIndicesListDanglingIndices) WithOpaqueID(s string) func(*DanglingIndicesListDanglingIndicesRequest)

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

func (DanglingIndicesListDanglingIndices) WithPretty added in v7.9.0 

func (f DanglingIndicesListDanglingIndices) WithPretty() func(*DanglingIndicesListDanglingIndicesRequest)

WithPretty makes the response body pretty-printed.

type DanglingIndicesListDanglingIndicesRequest added in v7.9.0 

type DanglingIndicesListDanglingIndicesRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

DanglingIndicesListDanglingIndicesRequest configures the Dangling Indices List Dangling Indices API request.

func (DanglingIndicesListDanglingIndicesRequest) Do added in v7.9.0 

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

Do executes the request and returns response or error.

type DataFrameTransformDeprecatedDeleteTransform added in v7.5.0 

type DataFrameTransformDeprecatedDeleteTransform func(transform_id string, o ...func(*DataFrameTransformDeprecatedDeleteTransformRequest)) (*Response, error)

DataFrameTransformDeprecatedDeleteTransform - Deletes an existing transform.

This API is beta.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html.

func (DataFrameTransformDeprecatedDeleteTransform) WithContext added in v7.5.0 

func (f DataFrameTransformDeprecatedDeleteTransform) WithContext(v context.Context) func(*DataFrameTransformDeprecatedDeleteTransformRequest)

WithContext sets the request context.

func (DataFrameTransformDeprecatedDeleteTransform) WithErrorTrace added in v7.5.0 

func (f DataFrameTransformDeprecatedDeleteTransform) WithErrorTrace() func(*DataFrameTransformDeprecatedDeleteTransformRequest)

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

func (DataFrameTransformDeprecatedDeleteTransform) WithFilterPath added in v7.5.0 

func (f DataFrameTransformDeprecatedDeleteTransform) WithFilterPath(v ...string) func(*DataFrameTransformDeprecatedDeleteTransformRequest)

WithFilterPath filters the properties of the response body.

func (DataFrameTransformDeprecatedDeleteTransform) WithForce added in v7.5.0 

func (f DataFrameTransformDeprecatedDeleteTransform) WithForce(v bool) func(*DataFrameTransformDeprecatedDeleteTransformRequest)

WithForce - when `true`, the transform is deleted regardless of its current state. the default value is `false`, meaning that the transform must be `stopped` before it can be deleted..

func (DataFrameTransformDeprecatedDeleteTransform) WithHeader added in v7.5.0 

func (f DataFrameTransformDeprecatedDeleteTransform) WithHeader(h map[string]string) func(*DataFrameTransformDeprecatedDeleteTransformRequest)

WithHeader adds the headers to the HTTP request.

func (DataFrameTransformDeprecatedDeleteTransform) WithHuman added in v7.5.0 

func (f DataFrameTransformDeprecatedDeleteTransform) WithHuman() func(*DataFrameTransformDeprecatedDeleteTransformRequest)

WithHuman makes statistical values human-readable.

func (DataFrameTransformDeprecatedDeleteTransform) WithOpaqueID added in v7.5.0 

func (f DataFrameTransformDeprecatedDeleteTransform) WithOpaqueID(s string) func(*DataFrameTransformDeprecatedDeleteTransformRequest)

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

func (DataFrameTransformDeprecatedDeleteTransform) WithPretty added in v7.5.0 

func (f DataFrameTransformDeprecatedDeleteTransform) WithPretty() func(*DataFrameTransformDeprecatedDeleteTransformRequest)

WithPretty makes the response body pretty-printed.

type DataFrameTransformDeprecatedDeleteTransformRequest added in v7.5.0 

type DataFrameTransformDeprecatedDeleteTransformRequest struct {
	TransformID string

	Force *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

DataFrameTransformDeprecatedDeleteTransformRequest configures the Data Frame Transform Deprecated Delete Transform API request.

func (DataFrameTransformDeprecatedDeleteTransformRequest) Do added in v7.5.0 

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

Do executes the request and returns response or error.

type DataFrameTransformDeprecatedGetTransform added in v7.5.0 

type DataFrameTransformDeprecatedGetTransform func(o ...func(*DataFrameTransformDeprecatedGetTransformRequest)) (*Response, error)

DataFrameTransformDeprecatedGetTransform - Retrieves configuration information for transforms.

This API is beta.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html.

func (DataFrameTransformDeprecatedGetTransform) WithAllowNoMatch added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransform) WithAllowNoMatch(v bool) func(*DataFrameTransformDeprecatedGetTransformRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no transforms. (this includes `_all` string or when no transforms have been specified).

func (DataFrameTransformDeprecatedGetTransform) WithContext added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransform) WithContext(v context.Context) func(*DataFrameTransformDeprecatedGetTransformRequest)

WithContext sets the request context.

func (DataFrameTransformDeprecatedGetTransform) WithErrorTrace added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransform) WithErrorTrace() func(*DataFrameTransformDeprecatedGetTransformRequest)

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

func (DataFrameTransformDeprecatedGetTransform) WithExcludeGenerated added in v7.11.0 

func (f DataFrameTransformDeprecatedGetTransform) WithExcludeGenerated(v bool) func(*DataFrameTransformDeprecatedGetTransformRequest)

WithExcludeGenerated - omits generated fields. allows transform configurations to be easily copied between clusters and within the same cluster.

func (DataFrameTransformDeprecatedGetTransform) WithFilterPath added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransform) WithFilterPath(v ...string) func(*DataFrameTransformDeprecatedGetTransformRequest)

WithFilterPath filters the properties of the response body.

func (DataFrameTransformDeprecatedGetTransform) WithFrom added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransform) WithFrom(v int) func(*DataFrameTransformDeprecatedGetTransformRequest)

WithFrom - skips a number of transform configs, defaults to 0.

func (DataFrameTransformDeprecatedGetTransform) WithHeader added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransform) WithHeader(h map[string]string) func(*DataFrameTransformDeprecatedGetTransformRequest)

WithHeader adds the headers to the HTTP request.

func (DataFrameTransformDeprecatedGetTransform) WithHuman added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransform) WithHuman() func(*DataFrameTransformDeprecatedGetTransformRequest)

WithHuman makes statistical values human-readable.

func (DataFrameTransformDeprecatedGetTransform) WithOpaqueID added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransform) WithOpaqueID(s string) func(*DataFrameTransformDeprecatedGetTransformRequest)

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

func (DataFrameTransformDeprecatedGetTransform) WithPretty added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransform) WithPretty() func(*DataFrameTransformDeprecatedGetTransformRequest)

WithPretty makes the response body pretty-printed.

func (DataFrameTransformDeprecatedGetTransform) WithSize added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransform) WithSize(v int) func(*DataFrameTransformDeprecatedGetTransformRequest)

WithSize - specifies a max number of transforms to get, defaults to 100.

func (DataFrameTransformDeprecatedGetTransform) WithTransformID added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransform) WithTransformID(v string) func(*DataFrameTransformDeprecatedGetTransformRequest)

WithTransformID - the ID or comma delimited list of ID expressions of the transforms to get, '_all' or '*' implies get all transforms.

type DataFrameTransformDeprecatedGetTransformRequest added in v7.5.0 

type DataFrameTransformDeprecatedGetTransformRequest struct {
	TransformID string

	AllowNoMatch     *bool
	ExcludeGenerated *bool
	From             *int
	Size             *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

DataFrameTransformDeprecatedGetTransformRequest configures the Data Frame Transform Deprecated Get Transform API request.

func (DataFrameTransformDeprecatedGetTransformRequest) Do added in v7.5.0 

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

Do executes the request and returns response or error.

type DataFrameTransformDeprecatedGetTransformStats added in v7.5.0 

type DataFrameTransformDeprecatedGetTransformStats func(transform_id string, o ...func(*DataFrameTransformDeprecatedGetTransformStatsRequest)) (*Response, error)

DataFrameTransformDeprecatedGetTransformStats - Retrieves usage information for transforms.

This API is beta.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html.

func (DataFrameTransformDeprecatedGetTransformStats) WithAllowNoMatch added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransformStats) WithAllowNoMatch(v bool) func(*DataFrameTransformDeprecatedGetTransformStatsRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no transforms. (this includes `_all` string or when no transforms have been specified).

func (DataFrameTransformDeprecatedGetTransformStats) WithContext added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransformStats) WithContext(v context.Context) func(*DataFrameTransformDeprecatedGetTransformStatsRequest)

WithContext sets the request context.

func (DataFrameTransformDeprecatedGetTransformStats) WithErrorTrace added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransformStats) WithErrorTrace() func(*DataFrameTransformDeprecatedGetTransformStatsRequest)

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

func (DataFrameTransformDeprecatedGetTransformStats) WithFilterPath added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransformStats) WithFilterPath(v ...string) func(*DataFrameTransformDeprecatedGetTransformStatsRequest)

WithFilterPath filters the properties of the response body.

func (DataFrameTransformDeprecatedGetTransformStats) WithFrom added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransformStats) WithFrom(v int) func(*DataFrameTransformDeprecatedGetTransformStatsRequest)

WithFrom - skips a number of transform stats, defaults to 0.

func (DataFrameTransformDeprecatedGetTransformStats) WithHeader added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransformStats) WithHeader(h map[string]string) func(*DataFrameTransformDeprecatedGetTransformStatsRequest)

WithHeader adds the headers to the HTTP request.

func (DataFrameTransformDeprecatedGetTransformStats) WithHuman added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransformStats) WithHuman() func(*DataFrameTransformDeprecatedGetTransformStatsRequest)

WithHuman makes statistical values human-readable.

func (DataFrameTransformDeprecatedGetTransformStats) WithOpaqueID added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransformStats) WithOpaqueID(s string) func(*DataFrameTransformDeprecatedGetTransformStatsRequest)

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

func (DataFrameTransformDeprecatedGetTransformStats) WithPretty added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransformStats) WithPretty() func(*DataFrameTransformDeprecatedGetTransformStatsRequest)

WithPretty makes the response body pretty-printed.

func (DataFrameTransformDeprecatedGetTransformStats) WithSize added in v7.5.0 

func (f DataFrameTransformDeprecatedGetTransformStats) WithSize(v int) func(*DataFrameTransformDeprecatedGetTransformStatsRequest)

WithSize - specifies a max number of transform stats to get, defaults to 100.

type DataFrameTransformDeprecatedGetTransformStatsRequest added in v7.5.0 

type DataFrameTransformDeprecatedGetTransformStatsRequest struct {
	TransformID string

	AllowNoMatch *bool
	From         *int
	Size         *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

DataFrameTransformDeprecatedGetTransformStatsRequest configures the Data Frame Transform Deprecated Get Transform Stats API request.

func (DataFrameTransformDeprecatedGetTransformStatsRequest) Do added in v7.5.0 

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

Do executes the request and returns response or error.

type DataFrameTransformDeprecatedPreviewTransform added in v7.5.0 

type DataFrameTransformDeprecatedPreviewTransform func(body io.Reader, o ...func(*DataFrameTransformDeprecatedPreviewTransformRequest)) (*Response, error)

DataFrameTransformDeprecatedPreviewTransform - Previews a transform.

This API is beta.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html.

func (DataFrameTransformDeprecatedPreviewTransform) WithContext added in v7.5.0 

func (f DataFrameTransformDeprecatedPreviewTransform) WithContext(v context.Context) func(*DataFrameTransformDeprecatedPreviewTransformRequest)

WithContext sets the request context.

func (DataFrameTransformDeprecatedPreviewTransform) WithErrorTrace added in v7.5.0 

func (f DataFrameTransformDeprecatedPreviewTransform) WithErrorTrace() func(*DataFrameTransformDeprecatedPreviewTransformRequest)

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

func (DataFrameTransformDeprecatedPreviewTransform) WithFilterPath added in v7.5.0 

func (f DataFrameTransformDeprecatedPreviewTransform) WithFilterPath(v ...string) func(*DataFrameTransformDeprecatedPreviewTransformRequest)

WithFilterPath filters the properties of the response body.

func (DataFrameTransformDeprecatedPreviewTransform) WithHeader added in v7.5.0 

func (f DataFrameTransformDeprecatedPreviewTransform) WithHeader(h map[string]string) func(*DataFrameTransformDeprecatedPreviewTransformRequest)

WithHeader adds the headers to the HTTP request.

func (DataFrameTransformDeprecatedPreviewTransform) WithHuman added in v7.5.0 

func (f DataFrameTransformDeprecatedPreviewTransform) WithHuman() func(*DataFrameTransformDeprecatedPreviewTransformRequest)

WithHuman makes statistical values human-readable.

func (DataFrameTransformDeprecatedPreviewTransform) WithOpaqueID added in v7.5.0 

func (f DataFrameTransformDeprecatedPreviewTransform) WithOpaqueID(s string) func(*DataFrameTransformDeprecatedPreviewTransformRequest)

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

func (DataFrameTransformDeprecatedPreviewTransform) WithPretty added in v7.5.0 

func (f DataFrameTransformDeprecatedPreviewTransform) WithPretty() func(*DataFrameTransformDeprecatedPreviewTransformRequest)

WithPretty makes the response body pretty-printed.

type DataFrameTransformDeprecatedPreviewTransformRequest added in v7.5.0 

type DataFrameTransformDeprecatedPreviewTransformRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

DataFrameTransformDeprecatedPreviewTransformRequest configures the Data Frame Transform Deprecated Preview Transform API request.

func (DataFrameTransformDeprecatedPreviewTransformRequest) Do added in v7.5.0 

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

Do executes the request and returns response or error.

type DataFrameTransformDeprecatedPutTransform added in v7.5.0 

type DataFrameTransformDeprecatedPutTransform func(body io.Reader, transform_id string, o ...func(*DataFrameTransformDeprecatedPutTransformRequest)) (*Response, error)

DataFrameTransformDeprecatedPutTransform - Instantiates a transform.

This API is beta.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html.

func (DataFrameTransformDeprecatedPutTransform) WithContext added in v7.5.0 

func (f DataFrameTransformDeprecatedPutTransform) WithContext(v context.Context) func(*DataFrameTransformDeprecatedPutTransformRequest)

WithContext sets the request context.

func (DataFrameTransformDeprecatedPutTransform) WithDeferValidation added in v7.5.0 

func (f DataFrameTransformDeprecatedPutTransform) WithDeferValidation(v bool) func(*DataFrameTransformDeprecatedPutTransformRequest)

WithDeferValidation - if validations should be deferred until transform starts, defaults to false..

func (DataFrameTransformDeprecatedPutTransform) WithErrorTrace added in v7.5.0 

func (f DataFrameTransformDeprecatedPutTransform) WithErrorTrace() func(*DataFrameTransformDeprecatedPutTransformRequest)

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

func (DataFrameTransformDeprecatedPutTransform) WithFilterPath added in v7.5.0 

func (f DataFrameTransformDeprecatedPutTransform) WithFilterPath(v ...string) func(*DataFrameTransformDeprecatedPutTransformRequest)

WithFilterPath filters the properties of the response body.

func (DataFrameTransformDeprecatedPutTransform) WithHeader added in v7.5.0 

func (f DataFrameTransformDeprecatedPutTransform) WithHeader(h map[string]string) func(*DataFrameTransformDeprecatedPutTransformRequest)

WithHeader adds the headers to the HTTP request.

func (DataFrameTransformDeprecatedPutTransform) WithHuman added in v7.5.0 

func (f DataFrameTransformDeprecatedPutTransform) WithHuman() func(*DataFrameTransformDeprecatedPutTransformRequest)

WithHuman makes statistical values human-readable.

func (DataFrameTransformDeprecatedPutTransform) WithOpaqueID added in v7.5.0 

func (f DataFrameTransformDeprecatedPutTransform) WithOpaqueID(s string) func(*DataFrameTransformDeprecatedPutTransformRequest)

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

func (DataFrameTransformDeprecatedPutTransform) WithPretty added in v7.5.0 

func (f DataFrameTransformDeprecatedPutTransform) WithPretty() func(*DataFrameTransformDeprecatedPutTransformRequest)

WithPretty makes the response body pretty-printed.

type DataFrameTransformDeprecatedPutTransformRequest added in v7.5.0 

type DataFrameTransformDeprecatedPutTransformRequest struct {
	Body io.Reader

	TransformID string

	DeferValidation *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

DataFrameTransformDeprecatedPutTransformRequest configures the Data Frame Transform Deprecated Put Transform API request.

func (DataFrameTransformDeprecatedPutTransformRequest) Do added in v7.5.0 

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

Do executes the request and returns response or error.

type DataFrameTransformDeprecatedStartTransform added in v7.5.0 

type DataFrameTransformDeprecatedStartTransform func(transform_id string, o ...func(*DataFrameTransformDeprecatedStartTransformRequest)) (*Response, error)

DataFrameTransformDeprecatedStartTransform - Starts one or more transforms.

This API is beta.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html.

func (DataFrameTransformDeprecatedStartTransform) WithContext added in v7.5.0 

func (f DataFrameTransformDeprecatedStartTransform) WithContext(v context.Context) func(*DataFrameTransformDeprecatedStartTransformRequest)

WithContext sets the request context.

func (DataFrameTransformDeprecatedStartTransform) WithErrorTrace added in v7.5.0 

func (f DataFrameTransformDeprecatedStartTransform) WithErrorTrace() func(*DataFrameTransformDeprecatedStartTransformRequest)

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

func (DataFrameTransformDeprecatedStartTransform) WithFilterPath added in v7.5.0 

func (f DataFrameTransformDeprecatedStartTransform) WithFilterPath(v ...string) func(*DataFrameTransformDeprecatedStartTransformRequest)

WithFilterPath filters the properties of the response body.

func (DataFrameTransformDeprecatedStartTransform) WithHeader added in v7.5.0 

func (f DataFrameTransformDeprecatedStartTransform) WithHeader(h map[string]string) func(*DataFrameTransformDeprecatedStartTransformRequest)

WithHeader adds the headers to the HTTP request.

func (DataFrameTransformDeprecatedStartTransform) WithHuman added in v7.5.0 

func (f DataFrameTransformDeprecatedStartTransform) WithHuman() func(*DataFrameTransformDeprecatedStartTransformRequest)

WithHuman makes statistical values human-readable.

func (DataFrameTransformDeprecatedStartTransform) WithOpaqueID added in v7.5.0 

func (f DataFrameTransformDeprecatedStartTransform) WithOpaqueID(s string) func(*DataFrameTransformDeprecatedStartTransformRequest)

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

func (DataFrameTransformDeprecatedStartTransform) WithPretty added in v7.5.0 

func (f DataFrameTransformDeprecatedStartTransform) WithPretty() func(*DataFrameTransformDeprecatedStartTransformRequest)

WithPretty makes the response body pretty-printed.

func (DataFrameTransformDeprecatedStartTransform) WithTimeout added in v7.5.0 

func (f DataFrameTransformDeprecatedStartTransform) WithTimeout(v time.Duration) func(*DataFrameTransformDeprecatedStartTransformRequest)

WithTimeout - controls the time to wait for the transform to start.

type DataFrameTransformDeprecatedStartTransformRequest added in v7.5.0 

type DataFrameTransformDeprecatedStartTransformRequest struct {
	TransformID string

	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

DataFrameTransformDeprecatedStartTransformRequest configures the Data Frame Transform Deprecated Start Transform API request.

func (DataFrameTransformDeprecatedStartTransformRequest) Do added in v7.5.0 

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

Do executes the request and returns response or error.

type DataFrameTransformDeprecatedStopTransform added in v7.5.0 

type DataFrameTransformDeprecatedStopTransform func(transform_id string, o ...func(*DataFrameTransformDeprecatedStopTransformRequest)) (*Response, error)

DataFrameTransformDeprecatedStopTransform - Stops one or more transforms.

This API is beta.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html.

func (DataFrameTransformDeprecatedStopTransform) WithAllowNoMatch added in v7.5.0 

func (f DataFrameTransformDeprecatedStopTransform) WithAllowNoMatch(v bool) func(*DataFrameTransformDeprecatedStopTransformRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no transforms. (this includes `_all` string or when no transforms have been specified).

func (DataFrameTransformDeprecatedStopTransform) WithContext added in v7.5.0 

func (f DataFrameTransformDeprecatedStopTransform) WithContext(v context.Context) func(*DataFrameTransformDeprecatedStopTransformRequest)

WithContext sets the request context.

func (DataFrameTransformDeprecatedStopTransform) WithErrorTrace added in v7.5.0 

func (f DataFrameTransformDeprecatedStopTransform) WithErrorTrace() func(*DataFrameTransformDeprecatedStopTransformRequest)

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

func (DataFrameTransformDeprecatedStopTransform) WithFilterPath added in v7.5.0 

func (f DataFrameTransformDeprecatedStopTransform) WithFilterPath(v ...string) func(*DataFrameTransformDeprecatedStopTransformRequest)

WithFilterPath filters the properties of the response body.

func (DataFrameTransformDeprecatedStopTransform) WithHeader added in v7.5.0 

func (f DataFrameTransformDeprecatedStopTransform) WithHeader(h map[string]string) func(*DataFrameTransformDeprecatedStopTransformRequest)

WithHeader adds the headers to the HTTP request.

func (DataFrameTransformDeprecatedStopTransform) WithHuman added in v7.5.0 

func (f DataFrameTransformDeprecatedStopTransform) WithHuman() func(*DataFrameTransformDeprecatedStopTransformRequest)

WithHuman makes statistical values human-readable.

func (DataFrameTransformDeprecatedStopTransform) WithOpaqueID added in v7.5.0 

func (f DataFrameTransformDeprecatedStopTransform) WithOpaqueID(s string) func(*DataFrameTransformDeprecatedStopTransformRequest)

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

func (DataFrameTransformDeprecatedStopTransform) WithPretty added in v7.5.0 

func (f DataFrameTransformDeprecatedStopTransform) WithPretty() func(*DataFrameTransformDeprecatedStopTransformRequest)

WithPretty makes the response body pretty-printed.

func (DataFrameTransformDeprecatedStopTransform) WithTimeout added in v7.5.0 

func (f DataFrameTransformDeprecatedStopTransform) WithTimeout(v time.Duration) func(*DataFrameTransformDeprecatedStopTransformRequest)

WithTimeout - controls the time to wait until the transform has stopped. default to 30 seconds.

func (DataFrameTransformDeprecatedStopTransform) WithWaitForCompletion added in v7.5.0 

func (f DataFrameTransformDeprecatedStopTransform) WithWaitForCompletion(v bool) func(*DataFrameTransformDeprecatedStopTransformRequest)

WithWaitForCompletion - whether to wait for the transform to fully stop before returning or not. default to false.

type DataFrameTransformDeprecatedStopTransformRequest added in v7.5.0 

type DataFrameTransformDeprecatedStopTransformRequest struct {
	TransformID string

	AllowNoMatch      *bool
	Timeout           time.Duration
	WaitForCompletion *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

DataFrameTransformDeprecatedStopTransformRequest configures the Data Frame Transform Deprecated Stop Transform API request.

func (DataFrameTransformDeprecatedStopTransformRequest) Do added in v7.5.0 

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

Do executes the request and returns response or error.

type DataFrameTransformDeprecatedUpdateTransform added in v7.5.0 

type DataFrameTransformDeprecatedUpdateTransform func(body io.Reader, transform_id string, o ...func(*DataFrameTransformDeprecatedUpdateTransformRequest)) (*Response, error)

DataFrameTransformDeprecatedUpdateTransform - Updates certain properties of a transform.

This API is beta.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html.

func (DataFrameTransformDeprecatedUpdateTransform) WithContext added in v7.5.0 

func (f DataFrameTransformDeprecatedUpdateTransform) WithContext(v context.Context) func(*DataFrameTransformDeprecatedUpdateTransformRequest)

WithContext sets the request context.

func (DataFrameTransformDeprecatedUpdateTransform) WithDeferValidation added in v7.5.0 

func (f DataFrameTransformDeprecatedUpdateTransform) WithDeferValidation(v bool) func(*DataFrameTransformDeprecatedUpdateTransformRequest)

WithDeferValidation - if validations should be deferred until transform starts, defaults to false..

func (DataFrameTransformDeprecatedUpdateTransform) WithErrorTrace added in v7.5.0 

func (f DataFrameTransformDeprecatedUpdateTransform) WithErrorTrace() func(*DataFrameTransformDeprecatedUpdateTransformRequest)

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

func (DataFrameTransformDeprecatedUpdateTransform) WithFilterPath added in v7.5.0 

func (f DataFrameTransformDeprecatedUpdateTransform) WithFilterPath(v ...string) func(*DataFrameTransformDeprecatedUpdateTransformRequest)

WithFilterPath filters the properties of the response body.

func (DataFrameTransformDeprecatedUpdateTransform) WithHeader added in v7.5.0 

func (f DataFrameTransformDeprecatedUpdateTransform) WithHeader(h map[string]string) func(*DataFrameTransformDeprecatedUpdateTransformRequest)

WithHeader adds the headers to the HTTP request.

func (DataFrameTransformDeprecatedUpdateTransform) WithHuman added in v7.5.0 

func (f DataFrameTransformDeprecatedUpdateTransform) WithHuman() func(*DataFrameTransformDeprecatedUpdateTransformRequest)

WithHuman makes statistical values human-readable.

func (DataFrameTransformDeprecatedUpdateTransform) WithOpaqueID added in v7.5.0 

func (f DataFrameTransformDeprecatedUpdateTransform) WithOpaqueID(s string) func(*DataFrameTransformDeprecatedUpdateTransformRequest)

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

func (DataFrameTransformDeprecatedUpdateTransform) WithPretty added in v7.5.0 

func (f DataFrameTransformDeprecatedUpdateTransform) WithPretty() func(*DataFrameTransformDeprecatedUpdateTransformRequest)

WithPretty makes the response body pretty-printed.

type DataFrameTransformDeprecatedUpdateTransformRequest added in v7.5.0 

type DataFrameTransformDeprecatedUpdateTransformRequest struct {
	Body io.Reader

	TransformID string

	DeferValidation *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

DataFrameTransformDeprecatedUpdateTransformRequest configures the Data Frame Transform Deprecated Update Transform API request.

func (DataFrameTransformDeprecatedUpdateTransformRequest) Do added in v7.5.0 

func (r DataFrameTransformDeprecatedUpdateTransformRequest) 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 https://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 v7.2.0 

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 v7.5.0 

func (f Delete) WithOpaqueID(s string) func(*DeleteRequest)

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

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 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 (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 v7.2.0 

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) WithMaxDocs added in v7.2.0 

func (f DeleteByQuery) WithMaxDocs(v int) func(*DeleteByQueryRequest)

WithMaxDocs - maximum number of documents to process (default: all documents).

func (DeleteByQuery) WithOpaqueID added in v7.5.0 

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 - deprecated, please use `max_docs` instead.

func (DeleteByQuery) WithSlices 

func (f DeleteByQuery) WithSlices(v interface{}) func(*DeleteByQueryRequest)

WithSlices - the number of slices this task should be divided into. defaults to 1, meaning the task isn't sliced into subtasks. can be set to `auto`..

func (DeleteByQuery) WithSort 

func (f DeleteByQuery) WithSort(v ...string) func(*DeleteByQueryRequest)

WithSort - a list of <field>:<direction> pairs.

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
	MaxDocs             *int
	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              interface{}
	Sort                []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 v7.2.0 

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 v7.5.0 

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
	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 https://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 v7.2.0 

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 v7.5.0 

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 EnrichDeletePolicy added in v7.5.0 

type EnrichDeletePolicy func(name string, o ...func(*EnrichDeletePolicyRequest)) (*Response, error)

EnrichDeletePolicy - Deletes an existing enrich policy and its enrich index.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html.

func (EnrichDeletePolicy) WithContext added in v7.5.0 

func (f EnrichDeletePolicy) WithContext(v context.Context) func(*EnrichDeletePolicyRequest)

WithContext sets the request context.

func (EnrichDeletePolicy) WithErrorTrace added in v7.5.0 

func (f EnrichDeletePolicy) WithErrorTrace() func(*EnrichDeletePolicyRequest)

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

func (EnrichDeletePolicy) WithFilterPath added in v7.5.0 

func (f EnrichDeletePolicy) WithFilterPath(v ...string) func(*EnrichDeletePolicyRequest)

WithFilterPath filters the properties of the response body.

func (EnrichDeletePolicy) WithHeader added in v7.5.0 

func (f EnrichDeletePolicy) WithHeader(h map[string]string) func(*EnrichDeletePolicyRequest)

WithHeader adds the headers to the HTTP request.

func (EnrichDeletePolicy) WithHuman added in v7.5.0 

func (f EnrichDeletePolicy) WithHuman() func(*EnrichDeletePolicyRequest)

WithHuman makes statistical values human-readable.

func (EnrichDeletePolicy) WithOpaqueID added in v7.5.0 

func (f EnrichDeletePolicy) WithOpaqueID(s string) func(*EnrichDeletePolicyRequest)

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

func (EnrichDeletePolicy) WithPretty added in v7.5.0 

func (f EnrichDeletePolicy) WithPretty() func(*EnrichDeletePolicyRequest)

WithPretty makes the response body pretty-printed.

type EnrichDeletePolicyRequest added in v7.5.0 

type EnrichDeletePolicyRequest struct {
	Name string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

EnrichDeletePolicyRequest configures the Enrich Delete Policy API request.

func (EnrichDeletePolicyRequest) Do added in v7.5.0 

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

Do executes the request and returns response or error.

type EnrichExecutePolicy added in v7.5.0 

type EnrichExecutePolicy func(name string, o ...func(*EnrichExecutePolicyRequest)) (*Response, error)

EnrichExecutePolicy - Creates the enrich index for an existing enrich policy.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/execute-enrich-policy-api.html.

func (EnrichExecutePolicy) WithContext added in v7.5.0 

func (f EnrichExecutePolicy) WithContext(v context.Context) func(*EnrichExecutePolicyRequest)

WithContext sets the request context.

func (EnrichExecutePolicy) WithErrorTrace added in v7.5.0 

func (f EnrichExecutePolicy) WithErrorTrace() func(*EnrichExecutePolicyRequest)

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

func (EnrichExecutePolicy) WithFilterPath added in v7.5.0 

func (f EnrichExecutePolicy) WithFilterPath(v ...string) func(*EnrichExecutePolicyRequest)

WithFilterPath filters the properties of the response body.

func (EnrichExecutePolicy) WithHeader added in v7.5.0 

func (f EnrichExecutePolicy) WithHeader(h map[string]string) func(*EnrichExecutePolicyRequest)

WithHeader adds the headers to the HTTP request.

func (EnrichExecutePolicy) WithHuman added in v7.5.0 

func (f EnrichExecutePolicy) WithHuman() func(*EnrichExecutePolicyRequest)

WithHuman makes statistical values human-readable.

func (EnrichExecutePolicy) WithOpaqueID added in v7.5.0 

func (f EnrichExecutePolicy) WithOpaqueID(s string) func(*EnrichExecutePolicyRequest)

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

func (EnrichExecutePolicy) WithPretty added in v7.5.0 

func (f EnrichExecutePolicy) WithPretty() func(*EnrichExecutePolicyRequest)

WithPretty makes the response body pretty-printed.

func (EnrichExecutePolicy) WithWaitForCompletion added in v7.5.0 

func (f EnrichExecutePolicy) WithWaitForCompletion(v bool) func(*EnrichExecutePolicyRequest)

WithWaitForCompletion - should the request should block until the execution is complete..

type EnrichExecutePolicyRequest added in v7.5.0 

type EnrichExecutePolicyRequest struct {
	Name string

	WaitForCompletion *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

EnrichExecutePolicyRequest configures the Enrich Execute Policy API request.

func (EnrichExecutePolicyRequest) Do added in v7.5.0 

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

Do executes the request and returns response or error.

type EnrichGetPolicy added in v7.5.0 

type EnrichGetPolicy func(o ...func(*EnrichGetPolicyRequest)) (*Response, error)

EnrichGetPolicy - Gets information about an enrich policy.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html.

func (EnrichGetPolicy) WithContext added in v7.5.0 

func (f EnrichGetPolicy) WithContext(v context.Context) func(*EnrichGetPolicyRequest)

WithContext sets the request context.

func (EnrichGetPolicy) WithErrorTrace added in v7.5.0 

func (f EnrichGetPolicy) WithErrorTrace() func(*EnrichGetPolicyRequest)

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

func (EnrichGetPolicy) WithFilterPath added in v7.5.0 

func (f EnrichGetPolicy) WithFilterPath(v ...string) func(*EnrichGetPolicyRequest)

WithFilterPath filters the properties of the response body.

func (EnrichGetPolicy) WithHeader added in v7.5.0 

func (f EnrichGetPolicy) WithHeader(h map[string]string) func(*EnrichGetPolicyRequest)

WithHeader adds the headers to the HTTP request.

func (EnrichGetPolicy) WithHuman added in v7.5.0 

func (f EnrichGetPolicy) WithHuman() func(*EnrichGetPolicyRequest)

WithHuman makes statistical values human-readable.

func (EnrichGetPolicy) WithName added in v7.5.0 

func (f EnrichGetPolicy) WithName(v ...string) func(*EnrichGetPolicyRequest)

WithName - a list of enrich policy names.

func (EnrichGetPolicy) WithOpaqueID added in v7.5.0 

func (f EnrichGetPolicy) WithOpaqueID(s string) func(*EnrichGetPolicyRequest)

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

func (EnrichGetPolicy) WithPretty added in v7.5.0 

func (f EnrichGetPolicy) WithPretty() func(*EnrichGetPolicyRequest)

WithPretty makes the response body pretty-printed.

type EnrichGetPolicyRequest added in v7.5.0 

type EnrichGetPolicyRequest struct {
	Name []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

EnrichGetPolicyRequest configures the Enrich Get Policy API request.

func (EnrichGetPolicyRequest) Do added in v7.5.0 

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

Do executes the request and returns response or error.

type EnrichPutPolicy added in v7.5.0 

type EnrichPutPolicy func(name string, body io.Reader, o ...func(*EnrichPutPolicyRequest)) (*Response, error)

EnrichPutPolicy - Creates a new enrich policy.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html.

func (EnrichPutPolicy) WithContext added in v7.5.0 

func (f EnrichPutPolicy) WithContext(v context.Context) func(*EnrichPutPolicyRequest)

WithContext sets the request context.

func (EnrichPutPolicy) WithErrorTrace added in v7.5.0 

func (f EnrichPutPolicy) WithErrorTrace() func(*EnrichPutPolicyRequest)

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

func (EnrichPutPolicy) WithFilterPath added in v7.5.0 

func (f EnrichPutPolicy) WithFilterPath(v ...string) func(*EnrichPutPolicyRequest)

WithFilterPath filters the properties of the response body.

func (EnrichPutPolicy) WithHeader added in v7.5.0 

func (f EnrichPutPolicy) WithHeader(h map[string]string) func(*EnrichPutPolicyRequest)

WithHeader adds the headers to the HTTP request.

func (EnrichPutPolicy) WithHuman added in v7.5.0 

func (f EnrichPutPolicy) WithHuman() func(*EnrichPutPolicyRequest)

WithHuman makes statistical values human-readable.

func (EnrichPutPolicy) WithOpaqueID added in v7.5.0 

func (f EnrichPutPolicy) WithOpaqueID(s string) func(*EnrichPutPolicyRequest)

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

func (EnrichPutPolicy) WithPretty added in v7.5.0 

func (f EnrichPutPolicy) WithPretty() func(*EnrichPutPolicyRequest)

WithPretty makes the response body pretty-printed.

type EnrichPutPolicyRequest added in v7.5.0 

type EnrichPutPolicyRequest struct {
	Body io.Reader

	Name string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

EnrichPutPolicyRequest configures the Enrich Put Policy API request.

func (EnrichPutPolicyRequest) Do added in v7.5.0 

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

Do executes the request and returns response or error.

type EnrichStats added in v7.5.0 

type EnrichStats func(o ...func(*EnrichStatsRequest)) (*Response, error)

EnrichStats - Gets enrich coordinator statistics and information about enrich policies that are currently executing.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html.

func (EnrichStats) WithContext added in v7.5.0 

func (f EnrichStats) WithContext(v context.Context) func(*EnrichStatsRequest)

WithContext sets the request context.

func (EnrichStats) WithErrorTrace added in v7.5.0 

func (f EnrichStats) WithErrorTrace() func(*EnrichStatsRequest)

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

func (EnrichStats) WithFilterPath added in v7.5.0 

func (f EnrichStats) WithFilterPath(v ...string) func(*EnrichStatsRequest)

WithFilterPath filters the properties of the response body.

func (EnrichStats) WithHeader added in v7.5.0 

func (f EnrichStats) WithHeader(h map[string]string) func(*EnrichStatsRequest)

WithHeader adds the headers to the HTTP request.

func (EnrichStats) WithHuman added in v7.5.0 

func (f EnrichStats) WithHuman() func(*EnrichStatsRequest)

WithHuman makes statistical values human-readable.

func (EnrichStats) WithOpaqueID added in v7.5.0 

func (f EnrichStats) WithOpaqueID(s string) func(*EnrichStatsRequest)

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

func (EnrichStats) WithPretty added in v7.5.0 

func (f EnrichStats) WithPretty() func(*EnrichStatsRequest)

WithPretty makes the response body pretty-printed.

type EnrichStatsRequest added in v7.5.0 

type EnrichStatsRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

EnrichStatsRequest configures the Enrich Stats API request.

func (EnrichStatsRequest) Do added in v7.5.0 

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

Do executes the request and returns response or error.

type EqlDelete added in v7.9.0 

type EqlDelete func(id string, o ...func(*EqlDeleteRequest)) (*Response, error)

EqlDelete - Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html.

func (EqlDelete) WithContext added in v7.9.0 

func (f EqlDelete) WithContext(v context.Context) func(*EqlDeleteRequest)

WithContext sets the request context.

func (EqlDelete) WithErrorTrace added in v7.9.0 

func (f EqlDelete) WithErrorTrace() func(*EqlDeleteRequest)

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

func (EqlDelete) WithFilterPath added in v7.9.0 

func (f EqlDelete) WithFilterPath(v ...string) func(*EqlDeleteRequest)

WithFilterPath filters the properties of the response body.

func (EqlDelete) WithHeader added in v7.9.0 

func (f EqlDelete) WithHeader(h map[string]string) func(*EqlDeleteRequest)

WithHeader adds the headers to the HTTP request.

func (EqlDelete) WithHuman added in v7.9.0 

func (f EqlDelete) WithHuman() func(*EqlDeleteRequest)

WithHuman makes statistical values human-readable.

func (EqlDelete) WithOpaqueID added in v7.9.0 

func (f EqlDelete) WithOpaqueID(s string) func(*EqlDeleteRequest)

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

func (EqlDelete) WithPretty added in v7.9.0 

func (f EqlDelete) WithPretty() func(*EqlDeleteRequest)

WithPretty makes the response body pretty-printed.

type EqlDeleteRequest added in v7.9.0 

type EqlDeleteRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

EqlDeleteRequest configures the Eql Delete API request.

func (EqlDeleteRequest) Do added in v7.9.0 

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

Do executes the request and returns response or error.

type EqlGet added in v7.9.0 

type EqlGet func(id string, o ...func(*EqlGetRequest)) (*Response, error)

EqlGet - Returns async results from previously executed Event Query Language (EQL) search

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html.

func (EqlGet) WithContext added in v7.9.0 

func (f EqlGet) WithContext(v context.Context) func(*EqlGetRequest)

WithContext sets the request context.

func (EqlGet) WithErrorTrace added in v7.9.0 

func (f EqlGet) WithErrorTrace() func(*EqlGetRequest)

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

func (EqlGet) WithFilterPath added in v7.9.0 

func (f EqlGet) WithFilterPath(v ...string) func(*EqlGetRequest)

WithFilterPath filters the properties of the response body.

func (EqlGet) WithHeader added in v7.9.0 

func (f EqlGet) WithHeader(h map[string]string) func(*EqlGetRequest)

WithHeader adds the headers to the HTTP request.

func (EqlGet) WithHuman added in v7.9.0 

func (f EqlGet) WithHuman() func(*EqlGetRequest)

WithHuman makes statistical values human-readable.

func (EqlGet) WithKeepAlive added in v7.9.0 

func (f EqlGet) WithKeepAlive(v time.Duration) func(*EqlGetRequest)

WithKeepAlive - update the time interval in which the results (partial or final) for this search will be available.

func (EqlGet) WithOpaqueID added in v7.9.0 

func (f EqlGet) WithOpaqueID(s string) func(*EqlGetRequest)

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

func (EqlGet) WithPretty added in v7.9.0 

func (f EqlGet) WithPretty() func(*EqlGetRequest)

WithPretty makes the response body pretty-printed.

func (EqlGet) WithWaitForCompletionTimeout added in v7.9.0 

func (f EqlGet) WithWaitForCompletionTimeout(v time.Duration) func(*EqlGetRequest)

WithWaitForCompletionTimeout - specify the time that the request should block waiting for the final response.

type EqlGetRequest added in v7.9.0 

type EqlGetRequest struct {
	DocumentID string

	KeepAlive                time.Duration
	WaitForCompletionTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

EqlGetRequest configures the Eql Get API request.

func (EqlGetRequest) Do added in v7.9.0 

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

Do executes the request and returns response or error.

type EqlGetStatus added in v7.12.0 

type EqlGetStatus func(id string, o ...func(*EqlGetStatusRequest)) (*Response, error)

EqlGetStatus - Returns the status of a previously submitted async or stored Event Query Language (EQL) search

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html.

func (EqlGetStatus) WithContext added in v7.12.0 

func (f EqlGetStatus) WithContext(v context.Context) func(*EqlGetStatusRequest)

WithContext sets the request context.

func (EqlGetStatus) WithErrorTrace added in v7.12.0 

func (f EqlGetStatus) WithErrorTrace() func(*EqlGetStatusRequest)

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

func (EqlGetStatus) WithFilterPath added in v7.12.0 

func (f EqlGetStatus) WithFilterPath(v ...string) func(*EqlGetStatusRequest)

WithFilterPath filters the properties of the response body.

func (EqlGetStatus) WithHeader added in v7.12.0 

func (f EqlGetStatus) WithHeader(h map[string]string) func(*EqlGetStatusRequest)

WithHeader adds the headers to the HTTP request.

func (EqlGetStatus) WithHuman added in v7.12.0 

func (f EqlGetStatus) WithHuman() func(*EqlGetStatusRequest)

WithHuman makes statistical values human-readable.

func (EqlGetStatus) WithOpaqueID added in v7.12.0 

func (f EqlGetStatus) WithOpaqueID(s string) func(*EqlGetStatusRequest)

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

func (EqlGetStatus) WithPretty added in v7.12.0 

func (f EqlGetStatus) WithPretty() func(*EqlGetStatusRequest)

WithPretty makes the response body pretty-printed.

type EqlGetStatusRequest added in v7.12.0 

type EqlGetStatusRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

EqlGetStatusRequest configures the Eql Get Status API request.

func (EqlGetStatusRequest) Do added in v7.12.0 

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

Do executes the request and returns response or error.

type EqlSearch added in v7.7.0 

type EqlSearch func(index string, body io.Reader, o ...func(*EqlSearchRequest)) (*Response, error)

EqlSearch - Returns results matching a query expressed in Event Query Language (EQL)

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html.

func (EqlSearch) WithContext added in v7.7.0 

func (f EqlSearch) WithContext(v context.Context) func(*EqlSearchRequest)

WithContext sets the request context.

func (EqlSearch) WithErrorTrace added in v7.7.0 

func (f EqlSearch) WithErrorTrace() func(*EqlSearchRequest)

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

func (EqlSearch) WithFilterPath added in v7.7.0 

func (f EqlSearch) WithFilterPath(v ...string) func(*EqlSearchRequest)

WithFilterPath filters the properties of the response body.

func (EqlSearch) WithHeader added in v7.7.0 

func (f EqlSearch) WithHeader(h map[string]string) func(*EqlSearchRequest)

WithHeader adds the headers to the HTTP request.

func (EqlSearch) WithHuman added in v7.7.0 

func (f EqlSearch) WithHuman() func(*EqlSearchRequest)

WithHuman makes statistical values human-readable.

func (EqlSearch) WithKeepAlive added in v7.9.0 

func (f EqlSearch) WithKeepAlive(v time.Duration) func(*EqlSearchRequest)

WithKeepAlive - update the time interval in which the results (partial or final) for this search will be available.

func (EqlSearch) WithKeepOnCompletion added in v7.9.0 

func (f EqlSearch) WithKeepOnCompletion(v bool) func(*EqlSearchRequest)

WithKeepOnCompletion - control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false).

func (EqlSearch) WithOpaqueID added in v7.7.0 

func (f EqlSearch) WithOpaqueID(s string) func(*EqlSearchRequest)

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

func (EqlSearch) WithPretty added in v7.7.0 

func (f EqlSearch) WithPretty() func(*EqlSearchRequest)

WithPretty makes the response body pretty-printed.

func (EqlSearch) WithWaitForCompletionTimeout added in v7.9.0 

func (f EqlSearch) WithWaitForCompletionTimeout(v time.Duration) func(*EqlSearchRequest)

WithWaitForCompletionTimeout - specify the time that the request should block waiting for the final response.

type EqlSearchRequest added in v7.7.0 

type EqlSearchRequest struct {
	Index string

	Body io.Reader

	KeepAlive                time.Duration
	KeepOnCompletion         *bool
	WaitForCompletionTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

EqlSearchRequest configures the Eql Search API request.

func (EqlSearchRequest) Do added in v7.7.0 

func (r EqlSearchRequest) 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 https://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 v7.2.0 

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 v7.5.0 

func (f Exists) WithOpaqueID(s string) func(*ExistsRequest)

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

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

	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 https://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; deprecated and optional starting with 7.0.

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 v7.2.0 

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 v7.5.0 

func (f ExistsSource) WithOpaqueID(s string) func(*ExistsSourceRequest)

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

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

	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 https://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 v7.2.0 

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 v7.5.0 

func (f Explain) WithOpaqueID(s string) func(*ExplainRequest)

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

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
	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 FeaturesGetFeatures added in v7.12.0 

type FeaturesGetFeatures func(o ...func(*FeaturesGetFeaturesRequest)) (*Response, error)

FeaturesGetFeatures gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-features-api.html.

func (FeaturesGetFeatures) WithContext added in v7.12.0 

func (f FeaturesGetFeatures) WithContext(v context.Context) func(*FeaturesGetFeaturesRequest)

WithContext sets the request context.

func (FeaturesGetFeatures) WithErrorTrace added in v7.12.0 

func (f FeaturesGetFeatures) WithErrorTrace() func(*FeaturesGetFeaturesRequest)

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

func (FeaturesGetFeatures) WithFilterPath added in v7.12.0 

func (f FeaturesGetFeatures) WithFilterPath(v ...string) func(*FeaturesGetFeaturesRequest)

WithFilterPath filters the properties of the response body.

func (FeaturesGetFeatures) WithHeader added in v7.12.0 

func (f FeaturesGetFeatures) WithHeader(h map[string]string) func(*FeaturesGetFeaturesRequest)

WithHeader adds the headers to the HTTP request.

func (FeaturesGetFeatures) WithHuman added in v7.12.0 

func (f FeaturesGetFeatures) WithHuman() func(*FeaturesGetFeaturesRequest)

WithHuman makes statistical values human-readable.

func (FeaturesGetFeatures) WithMasterTimeout added in v7.12.0 

func (f FeaturesGetFeatures) WithMasterTimeout(v time.Duration) func(*FeaturesGetFeaturesRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (FeaturesGetFeatures) WithOpaqueID added in v7.12.0 

func (f FeaturesGetFeatures) WithOpaqueID(s string) func(*FeaturesGetFeaturesRequest)

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

func (FeaturesGetFeatures) WithPretty added in v7.12.0 

func (f FeaturesGetFeatures) WithPretty() func(*FeaturesGetFeaturesRequest)

WithPretty makes the response body pretty-printed.

type FeaturesGetFeaturesRequest added in v7.12.0 

type FeaturesGetFeaturesRequest struct {
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

FeaturesGetFeaturesRequest configures the Features Get Features API request.

func (FeaturesGetFeaturesRequest) Do added in v7.12.0 

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

Do executes the request and returns response or error.

type FeaturesResetFeatures added in v7.13.0 

type FeaturesResetFeatures func(o ...func(*FeaturesResetFeaturesRequest)) (*Response, error)

FeaturesResetFeatures resets the internal state of features, usually by deleting system indices

This API is experimental.

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

func (FeaturesResetFeatures) WithContext added in v7.13.0 

func (f FeaturesResetFeatures) WithContext(v context.Context) func(*FeaturesResetFeaturesRequest)

WithContext sets the request context.

func (FeaturesResetFeatures) WithErrorTrace added in v7.13.0 

func (f FeaturesResetFeatures) WithErrorTrace() func(*FeaturesResetFeaturesRequest)

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

func (FeaturesResetFeatures) WithFilterPath added in v7.13.0 

func (f FeaturesResetFeatures) WithFilterPath(v ...string) func(*FeaturesResetFeaturesRequest)

WithFilterPath filters the properties of the response body.

func (FeaturesResetFeatures) WithHeader added in v7.13.0 

func (f FeaturesResetFeatures) WithHeader(h map[string]string) func(*FeaturesResetFeaturesRequest)

WithHeader adds the headers to the HTTP request.

func (FeaturesResetFeatures) WithHuman added in v7.13.0 

func (f FeaturesResetFeatures) WithHuman() func(*FeaturesResetFeaturesRequest)

WithHuman makes statistical values human-readable.

func (FeaturesResetFeatures) WithOpaqueID added in v7.13.0 

func (f FeaturesResetFeatures) WithOpaqueID(s string) func(*FeaturesResetFeaturesRequest)

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

func (FeaturesResetFeatures) WithPretty added in v7.13.0 

func (f FeaturesResetFeatures) WithPretty() func(*FeaturesResetFeaturesRequest)

WithPretty makes the response body pretty-printed.

type FeaturesResetFeaturesRequest added in v7.13.0 

type FeaturesResetFeaturesRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

FeaturesResetFeaturesRequest configures the Features Reset Features API request.

func (FeaturesResetFeaturesRequest) Do added in v7.13.0 

func (r FeaturesResetFeaturesRequest) 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 https://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 added in v7.9.0 

func (f FieldCaps) WithBody(v io.Reader) func(*FieldCapsRequest)

WithBody - An index filter specified with the Query DSL.

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 v7.2.0 

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) WithIncludeUnmapped added in v7.2.0 

func (f FieldCaps) WithIncludeUnmapped(v bool) func(*FieldCapsRequest)

WithIncludeUnmapped - indicates whether unmapped fields should be included in the response..

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 v7.5.0 

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
	IncludeUnmapped   *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

FieldCapsRequest configures the Field Caps API request.

func (FieldCapsRequest) Do 

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

Do executes the request and returns response or error.

type FleetGlobalCheckpoints added in v7.13.0 

type FleetGlobalCheckpoints func(index string, o ...func(*FleetGlobalCheckpointsRequest)) (*Response, error)

FleetGlobalCheckpoints returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/get-global-checkpoints.html.

func (FleetGlobalCheckpoints) WithCheckpoints added in v7.13.0 

func (f FleetGlobalCheckpoints) WithCheckpoints(v ...string) func(*FleetGlobalCheckpointsRequest)

WithCheckpoints - comma separated list of checkpoints.

func (FleetGlobalCheckpoints) WithContext added in v7.13.0 

func (f FleetGlobalCheckpoints) WithContext(v context.Context) func(*FleetGlobalCheckpointsRequest)

WithContext sets the request context.

func (FleetGlobalCheckpoints) WithErrorTrace added in v7.13.0 

func (f FleetGlobalCheckpoints) WithErrorTrace() func(*FleetGlobalCheckpointsRequest)

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

func (FleetGlobalCheckpoints) WithFilterPath added in v7.13.0 

func (f FleetGlobalCheckpoints) WithFilterPath(v ...string) func(*FleetGlobalCheckpointsRequest)

WithFilterPath filters the properties of the response body.

func (FleetGlobalCheckpoints) WithHeader added in v7.13.0 

func (f FleetGlobalCheckpoints) WithHeader(h map[string]string) func(*FleetGlobalCheckpointsRequest)

WithHeader adds the headers to the HTTP request.

func (FleetGlobalCheckpoints) WithHuman added in v7.13.0 

func (f FleetGlobalCheckpoints) WithHuman() func(*FleetGlobalCheckpointsRequest)

WithHuman makes statistical values human-readable.

func (FleetGlobalCheckpoints) WithOpaqueID added in v7.13.0 

func (f FleetGlobalCheckpoints) WithOpaqueID(s string) func(*FleetGlobalCheckpointsRequest)

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

func (FleetGlobalCheckpoints) WithPretty added in v7.13.0 

func (f FleetGlobalCheckpoints) WithPretty() func(*FleetGlobalCheckpointsRequest)

WithPretty makes the response body pretty-printed.

func (FleetGlobalCheckpoints) WithTimeout added in v7.13.0 

func (f FleetGlobalCheckpoints) WithTimeout(v time.Duration) func(*FleetGlobalCheckpointsRequest)

WithTimeout - timeout to wait for global checkpoint to advance.

func (FleetGlobalCheckpoints) WithWaitForAdvance added in v7.13.0 

func (f FleetGlobalCheckpoints) WithWaitForAdvance(v bool) func(*FleetGlobalCheckpointsRequest)

WithWaitForAdvance - whether to wait for the global checkpoint to advance past the specified current checkpoints.

func (FleetGlobalCheckpoints) WithWaitForIndex added in v7.13.0 

func (f FleetGlobalCheckpoints) WithWaitForIndex(v bool) func(*FleetGlobalCheckpointsRequest)

WithWaitForIndex - whether to wait for the target index to exist and all primary shards be active.

type FleetGlobalCheckpointsRequest added in v7.13.0 

type FleetGlobalCheckpointsRequest struct {
	Index string

	Checkpoints    []string
	Timeout        time.Duration
	WaitForAdvance *bool
	WaitForIndex   *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

FleetGlobalCheckpointsRequest configures the Fleet Global Checkpoints API request.

func (FleetGlobalCheckpointsRequest) Do added in v7.13.0 

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

Do executes the request and returns response or error.

type FleetMsearch added in v7.16.0 

type FleetMsearch func(body io.Reader, o ...func(*FleetMsearchRequest)) (*Response, error)

FleetMsearch multi Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project.

This API is experimental.

func (FleetMsearch) WithContext added in v7.16.0 

func (f FleetMsearch) WithContext(v context.Context) func(*FleetMsearchRequest)

WithContext sets the request context.

func (FleetMsearch) WithErrorTrace added in v7.16.0 

func (f FleetMsearch) WithErrorTrace() func(*FleetMsearchRequest)

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

func (FleetMsearch) WithFilterPath added in v7.16.0 

func (f FleetMsearch) WithFilterPath(v ...string) func(*FleetMsearchRequest)

WithFilterPath filters the properties of the response body.

func (FleetMsearch) WithHeader added in v7.16.0 

func (f FleetMsearch) WithHeader(h map[string]string) func(*FleetMsearchRequest)

WithHeader adds the headers to the HTTP request.

func (FleetMsearch) WithHuman added in v7.16.0 

func (f FleetMsearch) WithHuman() func(*FleetMsearchRequest)

WithHuman makes statistical values human-readable.

func (FleetMsearch) WithIndex added in v7.16.0 

func (f FleetMsearch) WithIndex(v string) func(*FleetMsearchRequest)

WithIndex - the index name to use as the default.

func (FleetMsearch) WithOpaqueID added in v7.16.0 

func (f FleetMsearch) WithOpaqueID(s string) func(*FleetMsearchRequest)

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

func (FleetMsearch) WithPretty added in v7.16.0 

func (f FleetMsearch) WithPretty() func(*FleetMsearchRequest)

WithPretty makes the response body pretty-printed.

type FleetMsearchRequest added in v7.16.0 

type FleetMsearchRequest struct {
	Index string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

FleetMsearchRequest configures the Fleet Msearch API request.

func (FleetMsearchRequest) Do added in v7.16.0 

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

Do executes the request and returns response or error.

type FleetSearch added in v7.16.0 

type FleetSearch func(index string, o ...func(*FleetSearchRequest)) (*Response, error)

FleetSearch search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project.

This API is experimental.

func (FleetSearch) WithAllowPartialSearchResults added in v7.16.0 

func (f FleetSearch) WithAllowPartialSearchResults(v bool) func(*FleetSearchRequest)

WithAllowPartialSearchResults - indicate if an error should be returned if there is a partial search failure or timeout.

func (FleetSearch) WithBody added in v7.16.0 

func (f FleetSearch) WithBody(v io.Reader) func(*FleetSearchRequest)

WithBody - The search definition using the Query DSL.

func (FleetSearch) WithContext added in v7.16.0 

func (f FleetSearch) WithContext(v context.Context) func(*FleetSearchRequest)

WithContext sets the request context.

func (FleetSearch) WithErrorTrace added in v7.16.0 

func (f FleetSearch) WithErrorTrace() func(*FleetSearchRequest)

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

func (FleetSearch) WithFilterPath added in v7.16.0 

func (f FleetSearch) WithFilterPath(v ...string) func(*FleetSearchRequest)

WithFilterPath filters the properties of the response body.

func (FleetSearch) WithHeader added in v7.16.0 

func (f FleetSearch) WithHeader(h map[string]string) func(*FleetSearchRequest)

WithHeader adds the headers to the HTTP request.

func (FleetSearch) WithHuman added in v7.16.0 

func (f FleetSearch) WithHuman() func(*FleetSearchRequest)

WithHuman makes statistical values human-readable.

func (FleetSearch) WithOpaqueID added in v7.16.0 

func (f FleetSearch) WithOpaqueID(s string) func(*FleetSearchRequest)

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

func (FleetSearch) WithPretty added in v7.16.0 

func (f FleetSearch) WithPretty() func(*FleetSearchRequest)

WithPretty makes the response body pretty-printed.

func (FleetSearch) WithWaitForCheckpoints added in v7.16.0 

func (f FleetSearch) WithWaitForCheckpoints(v ...string) func(*FleetSearchRequest)

WithWaitForCheckpoints - comma separated list of checkpoints, one per shard.

func (FleetSearch) WithWaitForCheckpointsTimeout added in v7.16.0 

func (f FleetSearch) WithWaitForCheckpointsTimeout(v time.Duration) func(*FleetSearchRequest)

WithWaitForCheckpointsTimeout - explicit wait_for_checkpoints timeout.

type FleetSearchRequest added in v7.16.0 

type FleetSearchRequest struct {
	Index string

	Body io.Reader

	AllowPartialSearchResults *bool
	WaitForCheckpoints        []string
	WaitForCheckpointsTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

FleetSearchRequest configures the Fleet Search API request.

func (FleetSearchRequest) Do added in v7.16.0 

func (r FleetSearchRequest) 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 https://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 v7.2.0 

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 v7.5.0 

func (f Get) WithOpaqueID(s string) func(*GetRequest)

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

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) WithSourceExcludes 

func (f Get) WithSourceExcludes(v ...string) func(*GetRequest)

WithSourceExcludes - a list of fields to exclude from the returned _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

	Preference     string
	Realtime       *bool
	Refresh        *bool
	Routing        string
	Source         []string
	SourceExcludes []string
	SourceIncludes []string
	StoredFields   []string
	Version        *int
	VersionType    string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

GetRequest configures the Get API request.

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 https://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 v7.2.0 

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 v7.5.0 

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 GetScriptContext added in v7.7.0 

type GetScriptContext func(o ...func(*GetScriptContextRequest)) (*Response, error)

GetScriptContext returns all script contexts.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html.

func (GetScriptContext) WithContext added in v7.7.0 

func (f GetScriptContext) WithContext(v context.Context) func(*GetScriptContextRequest)

WithContext sets the request context.

func (GetScriptContext) WithErrorTrace added in v7.7.0 

func (f GetScriptContext) WithErrorTrace() func(*GetScriptContextRequest)

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

func (GetScriptContext) WithFilterPath added in v7.7.0 

func (f GetScriptContext) WithFilterPath(v ...string) func(*GetScriptContextRequest)

WithFilterPath filters the properties of the response body.

func (GetScriptContext) WithHeader added in v7.7.0 

func (f GetScriptContext) WithHeader(h map[string]string) func(*GetScriptContextRequest)

WithHeader adds the headers to the HTTP request.

func (GetScriptContext) WithHuman added in v7.7.0 

func (f GetScriptContext) WithHuman() func(*GetScriptContextRequest)

WithHuman makes statistical values human-readable.

func (GetScriptContext) WithOpaqueID added in v7.7.0 

func (f GetScriptContext) WithOpaqueID(s string) func(*GetScriptContextRequest)

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

func (GetScriptContext) WithPretty added in v7.7.0 

func (f GetScriptContext) WithPretty() func(*GetScriptContextRequest)

WithPretty makes the response body pretty-printed.

type GetScriptContextRequest added in v7.7.0 

type GetScriptContextRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

GetScriptContextRequest configures the Get Script Context API request.

func (GetScriptContextRequest) Do added in v7.7.0 

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

Do executes the request and returns response or error.

type GetScriptLanguages added in v7.7.0 

type GetScriptLanguages func(o ...func(*GetScriptLanguagesRequest)) (*Response, error)

GetScriptLanguages returns available script types, languages and contexts

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html.

func (GetScriptLanguages) WithContext added in v7.7.0 

func (f GetScriptLanguages) WithContext(v context.Context) func(*GetScriptLanguagesRequest)

WithContext sets the request context.

func (GetScriptLanguages) WithErrorTrace added in v7.7.0 

func (f GetScriptLanguages) WithErrorTrace() func(*GetScriptLanguagesRequest)

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

func (GetScriptLanguages) WithFilterPath added in v7.7.0 

func (f GetScriptLanguages) WithFilterPath(v ...string) func(*GetScriptLanguagesRequest)

WithFilterPath filters the properties of the response body.

func (GetScriptLanguages) WithHeader added in v7.7.0 

func (f GetScriptLanguages) WithHeader(h map[string]string) func(*GetScriptLanguagesRequest)

WithHeader adds the headers to the HTTP request.

func (GetScriptLanguages) WithHuman added in v7.7.0 

func (f GetScriptLanguages) WithHuman() func(*GetScriptLanguagesRequest)

WithHuman makes statistical values human-readable.

func (GetScriptLanguages) WithOpaqueID added in v7.7.0 

func (f GetScriptLanguages) WithOpaqueID(s string) func(*GetScriptLanguagesRequest)

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

func (GetScriptLanguages) WithPretty added in v7.7.0 

func (f GetScriptLanguages) WithPretty() func(*GetScriptLanguagesRequest)

WithPretty makes the response body pretty-printed.

type GetScriptLanguagesRequest added in v7.7.0 

type GetScriptLanguagesRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

GetScriptLanguagesRequest configures the Get Script Languages API request.

func (GetScriptLanguagesRequest) Do added in v7.7.0 

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

Do executes the request and returns response or error.

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 https://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; deprecated and optional starting with 7.0.

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 v7.2.0 

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 v7.5.0 

func (f GetSource) WithOpaqueID(s string) func(*GetSourceRequest)

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

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

	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 GraphExplore added in v7.2.0 

type GraphExplore func(index []string, o ...func(*GraphExploreRequest)) (*Response, error)

GraphExplore - Explore extracted and summarized information about the documents and terms in an index.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html.

func (GraphExplore) WithBody added in v7.2.0 

func (f GraphExplore) WithBody(v io.Reader) func(*GraphExploreRequest)

WithBody - Graph Query DSL.

func (GraphExplore) WithContext added in v7.2.0 

func (f GraphExplore) WithContext(v context.Context) func(*GraphExploreRequest)

WithContext sets the request context.

func (GraphExplore) WithDocumentType added in v7.2.0 

func (f GraphExplore) WithDocumentType(v ...string) func(*GraphExploreRequest)

WithDocumentType - a list of document types to search; leave empty to perform the operation on all types.

func (GraphExplore) WithErrorTrace added in v7.2.0 

func (f GraphExplore) WithErrorTrace() func(*GraphExploreRequest)

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

func (GraphExplore) WithFilterPath added in v7.2.0 

func (f GraphExplore) WithFilterPath(v ...string) func(*GraphExploreRequest)

WithFilterPath filters the properties of the response body.

func (GraphExplore) WithHeader added in v7.2.0 

func (f GraphExplore) WithHeader(h map[string]string) func(*GraphExploreRequest)

WithHeader adds the headers to the HTTP request.

func (GraphExplore) WithHuman added in v7.2.0 

func (f GraphExplore) WithHuman() func(*GraphExploreRequest)

WithHuman makes statistical values human-readable.

func (GraphExplore) WithOpaqueID added in v7.5.0 

func (f GraphExplore) WithOpaqueID(s string) func(*GraphExploreRequest)

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

func (GraphExplore) WithPretty added in v7.2.0 

func (f GraphExplore) WithPretty() func(*GraphExploreRequest)

WithPretty makes the response body pretty-printed.

func (GraphExplore) WithRouting added in v7.2.0 

func (f GraphExplore) WithRouting(v string) func(*GraphExploreRequest)

WithRouting - specific routing value.

func (GraphExplore) WithTimeout added in v7.2.0 

func (f GraphExplore) WithTimeout(v time.Duration) func(*GraphExploreRequest)

WithTimeout - explicit operation timeout.

type GraphExploreRequest added in v7.2.0 

type GraphExploreRequest struct {
	Index        []string
	DocumentType []string

	Body io.Reader

	Routing string
	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

GraphExploreRequest configures the Graph Explore API request.

func (GraphExploreRequest) Do added in v7.2.0 

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

Do executes the request and returns response or error.

type ILM added in v7.2.0 

type ILM struct {
	DeleteLifecycle    ILMDeleteLifecycle
	ExplainLifecycle   ILMExplainLifecycle
	GetLifecycle       ILMGetLifecycle
	GetStatus          ILMGetStatus
	MigrateToDataTiers ILMMigrateToDataTiers
	MoveToStep         ILMMoveToStep
	PutLifecycle       ILMPutLifecycle
	RemovePolicy       ILMRemovePolicy
	Retry              ILMRetry
	Start              ILMStart
	Stop               ILMStop
}

ILM contains the ILM APIs

type ILMDeleteLifecycle added in v7.2.0 

type ILMDeleteLifecycle func(policy string, o ...func(*ILMDeleteLifecycleRequest)) (*Response, error)

ILMDeleteLifecycle - Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html.

func (ILMDeleteLifecycle) WithContext added in v7.2.0 

func (f ILMDeleteLifecycle) WithContext(v context.Context) func(*ILMDeleteLifecycleRequest)

WithContext sets the request context.

func (ILMDeleteLifecycle) WithErrorTrace added in v7.2.0 

func (f ILMDeleteLifecycle) WithErrorTrace() func(*ILMDeleteLifecycleRequest)

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

func (ILMDeleteLifecycle) WithFilterPath added in v7.2.0 

func (f ILMDeleteLifecycle) WithFilterPath(v ...string) func(*ILMDeleteLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (ILMDeleteLifecycle) WithHeader added in v7.2.0 

func (f ILMDeleteLifecycle) WithHeader(h map[string]string) func(*ILMDeleteLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (ILMDeleteLifecycle) WithHuman added in v7.2.0 

func (f ILMDeleteLifecycle) WithHuman() func(*ILMDeleteLifecycleRequest)

WithHuman makes statistical values human-readable.

func (ILMDeleteLifecycle) WithOpaqueID added in v7.5.0 

func (f ILMDeleteLifecycle) WithOpaqueID(s string) func(*ILMDeleteLifecycleRequest)

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

func (ILMDeleteLifecycle) WithPretty added in v7.2.0 

func (f ILMDeleteLifecycle) WithPretty() func(*ILMDeleteLifecycleRequest)

WithPretty makes the response body pretty-printed.

type ILMDeleteLifecycleRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type ILMExplainLifecycle added in v7.2.0 

type ILMExplainLifecycle func(index string, o ...func(*ILMExplainLifecycleRequest)) (*Response, error)

ILMExplainLifecycle - Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html.

func (ILMExplainLifecycle) WithContext added in v7.2.0 

func (f ILMExplainLifecycle) WithContext(v context.Context) func(*ILMExplainLifecycleRequest)

WithContext sets the request context.

func (ILMExplainLifecycle) WithErrorTrace added in v7.2.0 

func (f ILMExplainLifecycle) WithErrorTrace() func(*ILMExplainLifecycleRequest)

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

func (ILMExplainLifecycle) WithFilterPath added in v7.2.0 

func (f ILMExplainLifecycle) WithFilterPath(v ...string) func(*ILMExplainLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (ILMExplainLifecycle) WithHeader added in v7.2.0 

func (f ILMExplainLifecycle) WithHeader(h map[string]string) func(*ILMExplainLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (ILMExplainLifecycle) WithHuman added in v7.2.0 

func (f ILMExplainLifecycle) WithHuman() func(*ILMExplainLifecycleRequest)

WithHuman makes statistical values human-readable.

func (ILMExplainLifecycle) WithOnlyErrors added in v7.4.0 

func (f ILMExplainLifecycle) WithOnlyErrors(v bool) func(*ILMExplainLifecycleRequest)

WithOnlyErrors - filters the indices included in the response to ones in an ilm error state, implies only_managed.

func (ILMExplainLifecycle) WithOnlyManaged added in v7.4.0 

func (f ILMExplainLifecycle) WithOnlyManaged(v bool) func(*ILMExplainLifecycleRequest)

WithOnlyManaged - filters the indices included in the response to ones managed by ilm.

func (ILMExplainLifecycle) WithOpaqueID added in v7.5.0 

func (f ILMExplainLifecycle) WithOpaqueID(s string) func(*ILMExplainLifecycleRequest)

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

func (ILMExplainLifecycle) WithPretty added in v7.2.0 

func (f ILMExplainLifecycle) WithPretty() func(*ILMExplainLifecycleRequest)

WithPretty makes the response body pretty-printed.

type ILMExplainLifecycleRequest added in v7.2.0 

type ILMExplainLifecycleRequest struct {
	Index string

	OnlyErrors  *bool
	OnlyManaged *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

ILMExplainLifecycleRequest configures the ILM Explain Lifecycle API request.

func (ILMExplainLifecycleRequest) Do added in v7.2.0 

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

Do executes the request and returns response or error.

type ILMGetLifecycle added in v7.2.0 

type ILMGetLifecycle func(o ...func(*ILMGetLifecycleRequest)) (*Response, error)

ILMGetLifecycle - Returns the specified policy definition. Includes the policy version and last modified date.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html.

func (ILMGetLifecycle) WithContext added in v7.2.0 

func (f ILMGetLifecycle) WithContext(v context.Context) func(*ILMGetLifecycleRequest)

WithContext sets the request context.

func (ILMGetLifecycle) WithErrorTrace added in v7.2.0 

func (f ILMGetLifecycle) WithErrorTrace() func(*ILMGetLifecycleRequest)

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

func (ILMGetLifecycle) WithFilterPath added in v7.2.0 

func (f ILMGetLifecycle) WithFilterPath(v ...string) func(*ILMGetLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (ILMGetLifecycle) WithHeader added in v7.2.0 

func (f ILMGetLifecycle) WithHeader(h map[string]string) func(*ILMGetLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (ILMGetLifecycle) WithHuman added in v7.2.0 

func (f ILMGetLifecycle) WithHuman() func(*ILMGetLifecycleRequest)

WithHuman makes statistical values human-readable.

func (ILMGetLifecycle) WithOpaqueID added in v7.5.0 

func (f ILMGetLifecycle) WithOpaqueID(s string) func(*ILMGetLifecycleRequest)

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

func (ILMGetLifecycle) WithPolicy added in v7.2.0 

func (f ILMGetLifecycle) WithPolicy(v string) func(*ILMGetLifecycleRequest)

WithPolicy - the name of the index lifecycle policy.

func (ILMGetLifecycle) WithPretty added in v7.2.0 

func (f ILMGetLifecycle) WithPretty() func(*ILMGetLifecycleRequest)

WithPretty makes the response body pretty-printed.

type ILMGetLifecycleRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type ILMGetStatus added in v7.2.0 

type ILMGetStatus func(o ...func(*ILMGetStatusRequest)) (*Response, error)

ILMGetStatus - Retrieves the current index lifecycle management (ILM) status.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html.

func (ILMGetStatus) WithContext added in v7.2.0 

func (f ILMGetStatus) WithContext(v context.Context) func(*ILMGetStatusRequest)

WithContext sets the request context.

func (ILMGetStatus) WithErrorTrace added in v7.2.0 

func (f ILMGetStatus) WithErrorTrace() func(*ILMGetStatusRequest)

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

func (ILMGetStatus) WithFilterPath added in v7.2.0 

func (f ILMGetStatus) WithFilterPath(v ...string) func(*ILMGetStatusRequest)

WithFilterPath filters the properties of the response body.

func (ILMGetStatus) WithHeader added in v7.2.0 

func (f ILMGetStatus) WithHeader(h map[string]string) func(*ILMGetStatusRequest)

WithHeader adds the headers to the HTTP request.

func (ILMGetStatus) WithHuman added in v7.2.0 

func (f ILMGetStatus) WithHuman() func(*ILMGetStatusRequest)

WithHuman makes statistical values human-readable.

func (ILMGetStatus) WithOpaqueID added in v7.5.0 

func (f ILMGetStatus) WithOpaqueID(s string) func(*ILMGetStatusRequest)

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

func (ILMGetStatus) WithPretty added in v7.2.0 

func (f ILMGetStatus) WithPretty() func(*ILMGetStatusRequest)

WithPretty makes the response body pretty-printed.

type ILMGetStatusRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type ILMMigrateToDataTiers added in v7.14.0 

type ILMMigrateToDataTiers func(o ...func(*ILMMigrateToDataTiersRequest)) (*Response, error)

ILMMigrateToDataTiers - Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html.

func (ILMMigrateToDataTiers) WithBody added in v7.14.0 

func (f ILMMigrateToDataTiers) WithBody(v io.Reader) func(*ILMMigrateToDataTiersRequest)

WithBody - Optionally specify a legacy index template name to delete and optionally specify a node attribute name used for index shard routing (defaults to "data").

func (ILMMigrateToDataTiers) WithContext added in v7.14.0 

func (f ILMMigrateToDataTiers) WithContext(v context.Context) func(*ILMMigrateToDataTiersRequest)

WithContext sets the request context.

func (ILMMigrateToDataTiers) WithDryRun added in v7.14.0 

func (f ILMMigrateToDataTiers) WithDryRun(v bool) func(*ILMMigrateToDataTiersRequest)

WithDryRun - if set to true it will simulate the migration, providing a way to retrieve the ilm policies and indices that need to be migrated. the default is false.

func (ILMMigrateToDataTiers) WithErrorTrace added in v7.14.0 

func (f ILMMigrateToDataTiers) WithErrorTrace() func(*ILMMigrateToDataTiersRequest)

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

func (ILMMigrateToDataTiers) WithFilterPath added in v7.14.0 

func (f ILMMigrateToDataTiers) WithFilterPath(v ...string) func(*ILMMigrateToDataTiersRequest)

WithFilterPath filters the properties of the response body.

func (ILMMigrateToDataTiers) WithHeader added in v7.14.0 

func (f ILMMigrateToDataTiers) WithHeader(h map[string]string) func(*ILMMigrateToDataTiersRequest)

WithHeader adds the headers to the HTTP request.

func (ILMMigrateToDataTiers) WithHuman added in v7.14.0 

func (f ILMMigrateToDataTiers) WithHuman() func(*ILMMigrateToDataTiersRequest)

WithHuman makes statistical values human-readable.

func (ILMMigrateToDataTiers) WithOpaqueID added in v7.14.0 

func (f ILMMigrateToDataTiers) WithOpaqueID(s string) func(*ILMMigrateToDataTiersRequest)

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

func (ILMMigrateToDataTiers) WithPretty added in v7.14.0 

func (f ILMMigrateToDataTiers) WithPretty() func(*ILMMigrateToDataTiersRequest)

WithPretty makes the response body pretty-printed.

type ILMMigrateToDataTiersRequest added in v7.14.0 

type ILMMigrateToDataTiersRequest struct {
	Body io.Reader

	DryRun *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

ILMMigrateToDataTiersRequest configures the ILM Migrate To Data Tiers API request.

func (ILMMigrateToDataTiersRequest) Do added in v7.14.0 

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

Do executes the request and returns response or error.

type ILMMoveToStep added in v7.2.0 

type ILMMoveToStep func(index string, o ...func(*ILMMoveToStepRequest)) (*Response, error)

ILMMoveToStep - Manually moves an index into the specified step and executes that step.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html.

func (ILMMoveToStep) WithBody added in v7.2.0 

func (f ILMMoveToStep) WithBody(v io.Reader) func(*ILMMoveToStepRequest)

WithBody - The new lifecycle step to move to.

func (ILMMoveToStep) WithContext added in v7.2.0 

func (f ILMMoveToStep) WithContext(v context.Context) func(*ILMMoveToStepRequest)

WithContext sets the request context.

func (ILMMoveToStep) WithErrorTrace added in v7.2.0 

func (f ILMMoveToStep) WithErrorTrace() func(*ILMMoveToStepRequest)

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

func (ILMMoveToStep) WithFilterPath added in v7.2.0 

func (f ILMMoveToStep) WithFilterPath(v ...string) func(*ILMMoveToStepRequest)

WithFilterPath filters the properties of the response body.

func (ILMMoveToStep) WithHeader added in v7.2.0 

func (f ILMMoveToStep) WithHeader(h map[string]string) func(*ILMMoveToStepRequest)

WithHeader adds the headers to the HTTP request.

func (ILMMoveToStep) WithHuman added in v7.2.0 

func (f ILMMoveToStep) WithHuman() func(*ILMMoveToStepRequest)

WithHuman makes statistical values human-readable.

func (ILMMoveToStep) WithOpaqueID added in v7.5.0 

func (f ILMMoveToStep) WithOpaqueID(s string) func(*ILMMoveToStepRequest)

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

func (ILMMoveToStep) WithPretty added in v7.2.0 

func (f ILMMoveToStep) WithPretty() func(*ILMMoveToStepRequest)

WithPretty makes the response body pretty-printed.

type ILMMoveToStepRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type ILMPutLifecycle added in v7.2.0 

type ILMPutLifecycle func(policy string, o ...func(*ILMPutLifecycleRequest)) (*Response, error)

ILMPutLifecycle - Creates a lifecycle policy

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html.

func (ILMPutLifecycle) WithBody added in v7.2.0 

func (f ILMPutLifecycle) WithBody(v io.Reader) func(*ILMPutLifecycleRequest)

WithBody - The lifecycle policy definition to register.

func (ILMPutLifecycle) WithContext added in v7.2.0 

func (f ILMPutLifecycle) WithContext(v context.Context) func(*ILMPutLifecycleRequest)

WithContext sets the request context.

func (ILMPutLifecycle) WithErrorTrace added in v7.2.0 

func (f ILMPutLifecycle) WithErrorTrace() func(*ILMPutLifecycleRequest)

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

func (ILMPutLifecycle) WithFilterPath added in v7.2.0 

func (f ILMPutLifecycle) WithFilterPath(v ...string) func(*ILMPutLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (ILMPutLifecycle) WithHeader added in v7.2.0 

func (f ILMPutLifecycle) WithHeader(h map[string]string) func(*ILMPutLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (ILMPutLifecycle) WithHuman added in v7.2.0 

func (f ILMPutLifecycle) WithHuman() func(*ILMPutLifecycleRequest)

WithHuman makes statistical values human-readable.

func (ILMPutLifecycle) WithOpaqueID added in v7.5.0 

func (f ILMPutLifecycle) WithOpaqueID(s string) func(*ILMPutLifecycleRequest)

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

func (ILMPutLifecycle) WithPretty added in v7.2.0 

func (f ILMPutLifecycle) WithPretty() func(*ILMPutLifecycleRequest)

WithPretty makes the response body pretty-printed.

type ILMPutLifecycleRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type ILMRemovePolicy added in v7.2.0 

type ILMRemovePolicy func(index string, o ...func(*ILMRemovePolicyRequest)) (*Response, error)

ILMRemovePolicy - Removes the assigned lifecycle policy and stops managing the specified index

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html.

func (ILMRemovePolicy) WithContext added in v7.2.0 

func (f ILMRemovePolicy) WithContext(v context.Context) func(*ILMRemovePolicyRequest)

WithContext sets the request context.

func (ILMRemovePolicy) WithErrorTrace added in v7.2.0 

func (f ILMRemovePolicy) WithErrorTrace() func(*ILMRemovePolicyRequest)

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

func (ILMRemovePolicy) WithFilterPath added in v7.2.0 

func (f ILMRemovePolicy) WithFilterPath(v ...string) func(*ILMRemovePolicyRequest)

WithFilterPath filters the properties of the response body.

func (ILMRemovePolicy) WithHeader added in v7.2.0 

func (f ILMRemovePolicy) WithHeader(h map[string]string) func(*ILMRemovePolicyRequest)

WithHeader adds the headers to the HTTP request.

func (ILMRemovePolicy) WithHuman added in v7.2.0 

func (f ILMRemovePolicy) WithHuman() func(*ILMRemovePolicyRequest)

WithHuman makes statistical values human-readable.

func (ILMRemovePolicy) WithOpaqueID added in v7.5.0 

func (f ILMRemovePolicy) WithOpaqueID(s string) func(*ILMRemovePolicyRequest)

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

func (ILMRemovePolicy) WithPretty added in v7.2.0 

func (f ILMRemovePolicy) WithPretty() func(*ILMRemovePolicyRequest)

WithPretty makes the response body pretty-printed.

type ILMRemovePolicyRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type ILMRetry added in v7.2.0 

type ILMRetry func(index string, o ...func(*ILMRetryRequest)) (*Response, error)

ILMRetry - Retries executing the policy for an index that is in the ERROR step.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html.

func (ILMRetry) WithContext added in v7.2.0 

func (f ILMRetry) WithContext(v context.Context) func(*ILMRetryRequest)

WithContext sets the request context.

func (ILMRetry) WithErrorTrace added in v7.2.0 

func (f ILMRetry) WithErrorTrace() func(*ILMRetryRequest)

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

func (ILMRetry) WithFilterPath added in v7.2.0 

func (f ILMRetry) WithFilterPath(v ...string) func(*ILMRetryRequest)

WithFilterPath filters the properties of the response body.

func (ILMRetry) WithHeader added in v7.2.0 

func (f ILMRetry) WithHeader(h map[string]string) func(*ILMRetryRequest)

WithHeader adds the headers to the HTTP request.

func (ILMRetry) WithHuman added in v7.2.0 

func (f ILMRetry) WithHuman() func(*ILMRetryRequest)

WithHuman makes statistical values human-readable.

func (ILMRetry) WithOpaqueID added in v7.5.0 

func (f ILMRetry) WithOpaqueID(s string) func(*ILMRetryRequest)

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

func (ILMRetry) WithPretty added in v7.2.0 

func (f ILMRetry) WithPretty() func(*ILMRetryRequest)

WithPretty makes the response body pretty-printed.

type ILMRetryRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type ILMStart added in v7.2.0 

type ILMStart func(o ...func(*ILMStartRequest)) (*Response, error)

ILMStart - Start the index lifecycle management (ILM) plugin.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html.

func (ILMStart) WithContext added in v7.2.0 

func (f ILMStart) WithContext(v context.Context) func(*ILMStartRequest)

WithContext sets the request context.

func (ILMStart) WithErrorTrace added in v7.2.0 

func (f ILMStart) WithErrorTrace() func(*ILMStartRequest)

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

func (ILMStart) WithFilterPath added in v7.2.0 

func (f ILMStart) WithFilterPath(v ...string) func(*ILMStartRequest)

WithFilterPath filters the properties of the response body.

func (ILMStart) WithHeader added in v7.2.0 

func (f ILMStart) WithHeader(h map[string]string) func(*ILMStartRequest)

WithHeader adds the headers to the HTTP request.

func (ILMStart) WithHuman added in v7.2.0 

func (f ILMStart) WithHuman() func(*ILMStartRequest)

WithHuman makes statistical values human-readable.

func (ILMStart) WithOpaqueID added in v7.5.0 

func (f ILMStart) WithOpaqueID(s string) func(*ILMStartRequest)

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

func (ILMStart) WithPretty added in v7.2.0 

func (f ILMStart) WithPretty() func(*ILMStartRequest)

WithPretty makes the response body pretty-printed.

type ILMStartRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type ILMStop added in v7.2.0 

type ILMStop func(o ...func(*ILMStopRequest)) (*Response, error)

ILMStop - Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html.

func (ILMStop) WithContext added in v7.2.0 

func (f ILMStop) WithContext(v context.Context) func(*ILMStopRequest)

WithContext sets the request context.

func (ILMStop) WithErrorTrace added in v7.2.0 

func (f ILMStop) WithErrorTrace() func(*ILMStopRequest)

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

func (ILMStop) WithFilterPath added in v7.2.0 

func (f ILMStop) WithFilterPath(v ...string) func(*ILMStopRequest)

WithFilterPath filters the properties of the response body.

func (ILMStop) WithHeader added in v7.2.0 

func (f ILMStop) WithHeader(h map[string]string) func(*ILMStopRequest)

WithHeader adds the headers to the HTTP request.

func (ILMStop) WithHuman added in v7.2.0 

func (f ILMStop) WithHuman() func(*ILMStopRequest)

WithHuman makes statistical values human-readable.

func (ILMStop) WithOpaqueID added in v7.5.0 

func (f ILMStop) WithOpaqueID(s string) func(*ILMStopRequest)

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

func (ILMStop) WithPretty added in v7.2.0 

func (f ILMStop) WithPretty() func(*ILMStopRequest)

WithPretty makes the response body pretty-printed.

type ILMStopRequest added in v7.2.0 

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 v7.2.0 

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 https://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 v7.2.0 

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. defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID.

func (Index) WithOpaqueID added in v7.5.0 

func (f Index) WithOpaqueID(s string) func(*IndexRequest)

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

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) WithRequireAlias added in v7.10.0 

func (f Index) WithRequireAlias(v bool) func(*IndexRequest)

WithRequireAlias - when true, requires destination to be an alias. default is false.

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
	Pipeline            string
	Refresh             string
	RequireAlias        *bool
	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 {
	AddBlock              IndicesAddBlock
	Analyze               IndicesAnalyze
	ClearCache            IndicesClearCache
	Clone                 IndicesClone
	Close                 IndicesClose
	CreateDataStream      IndicesCreateDataStream
	Create                IndicesCreate
	DataStreamsStats      IndicesDataStreamsStats
	DeleteAlias           IndicesDeleteAlias
	DeleteDataStream      IndicesDeleteDataStream
	DeleteIndexTemplate   IndicesDeleteIndexTemplate
	Delete                IndicesDelete
	DeleteTemplate        IndicesDeleteTemplate
	DiskUsage             IndicesDiskUsage
	ExistsAlias           IndicesExistsAlias
	ExistsDocumentType    IndicesExistsDocumentType
	ExistsIndexTemplate   IndicesExistsIndexTemplate
	Exists                IndicesExists
	ExistsTemplate        IndicesExistsTemplate
	FieldUsageStats       IndicesFieldUsageStats
	Flush                 IndicesFlush
	FlushSynced           IndicesFlushSynced
	Forcemerge            IndicesForcemerge
	Freeze                IndicesFreeze
	GetAlias              IndicesGetAlias
	GetDataStream         IndicesGetDataStream
	GetFieldMapping       IndicesGetFieldMapping
	GetIndexTemplate      IndicesGetIndexTemplate
	GetMapping            IndicesGetMapping
	Get                   IndicesGet
	GetSettings           IndicesGetSettings
	GetTemplate           IndicesGetTemplate
	GetUpgrade            IndicesGetUpgrade
	MigrateToDataStream   IndicesMigrateToDataStream
	ModifyDataStream      IndicesModifyDataStream
	Open                  IndicesOpen
	PromoteDataStream     IndicesPromoteDataStream
	PutAlias              IndicesPutAlias
	PutIndexTemplate      IndicesPutIndexTemplate
	PutMapping            IndicesPutMapping
	PutSettings           IndicesPutSettings
	PutTemplate           IndicesPutTemplate
	Recovery              IndicesRecovery
	Refresh               IndicesRefresh
	ReloadSearchAnalyzers IndicesReloadSearchAnalyzers
	ResolveIndex          IndicesResolveIndex
	Rollover              IndicesRollover
	Segments              IndicesSegments
	ShardStores           IndicesShardStores
	Shrink                IndicesShrink
	SimulateIndexTemplate IndicesSimulateIndexTemplate
	SimulateTemplate      IndicesSimulateTemplate
	Split                 IndicesSplit
	Stats                 IndicesStats
	Unfreeze              IndicesUnfreeze
	UpdateAliases         IndicesUpdateAliases
	Upgrade               IndicesUpgrade
	ValidateQuery         IndicesValidateQuery
}

Indices contains the Indices APIs

type IndicesAddBlock added in v7.9.0 

type IndicesAddBlock func(index []string, block string, o ...func(*IndicesAddBlockRequest)) (*Response, error)

IndicesAddBlock adds a block to an index.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html.

func (IndicesAddBlock) WithAllowNoIndices added in v7.9.0 

func (f IndicesAddBlock) WithAllowNoIndices(v bool) func(*IndicesAddBlockRequest)

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 (IndicesAddBlock) WithContext added in v7.9.0 

func (f IndicesAddBlock) WithContext(v context.Context) func(*IndicesAddBlockRequest)

WithContext sets the request context.

func (IndicesAddBlock) WithErrorTrace added in v7.9.0 

func (f IndicesAddBlock) WithErrorTrace() func(*IndicesAddBlockRequest)

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

func (IndicesAddBlock) WithExpandWildcards added in v7.9.0 

func (f IndicesAddBlock) WithExpandWildcards(v string) func(*IndicesAddBlockRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesAddBlock) WithFilterPath added in v7.9.0 

func (f IndicesAddBlock) WithFilterPath(v ...string) func(*IndicesAddBlockRequest)

WithFilterPath filters the properties of the response body.

func (IndicesAddBlock) WithHeader added in v7.9.0 

func (f IndicesAddBlock) WithHeader(h map[string]string) func(*IndicesAddBlockRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesAddBlock) WithHuman added in v7.9.0 

func (f IndicesAddBlock) WithHuman() func(*IndicesAddBlockRequest)

WithHuman makes statistical values human-readable.

func (IndicesAddBlock) WithIgnoreUnavailable added in v7.9.0 

func (f IndicesAddBlock) WithIgnoreUnavailable(v bool) func(*IndicesAddBlockRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesAddBlock) WithMasterTimeout added in v7.9.0 

func (f IndicesAddBlock) WithMasterTimeout(v time.Duration) func(*IndicesAddBlockRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesAddBlock) WithOpaqueID added in v7.9.0 

func (f IndicesAddBlock) WithOpaqueID(s string) func(*IndicesAddBlockRequest)

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

func (IndicesAddBlock) WithPretty added in v7.9.0 

func (f IndicesAddBlock) WithPretty() func(*IndicesAddBlockRequest)

WithPretty makes the response body pretty-printed.

func (IndicesAddBlock) WithTimeout added in v7.9.0 

func (f IndicesAddBlock) WithTimeout(v time.Duration) func(*IndicesAddBlockRequest)

WithTimeout - explicit operation timeout.

type IndicesAddBlockRequest added in v7.9.0 

type IndicesAddBlockRequest struct {
	Index []string

	Block 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
}

IndicesAddBlockRequest configures the Indices Add Block API request.

func (IndicesAddBlockRequest) Do added in v7.9.0 

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

Do executes the request and returns response or error.

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 https://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 v7.2.0 

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 v7.5.0 

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 https://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.

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 v7.2.0 

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 v7.5.0 

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.

type IndicesClearCacheRequest 

type IndicesClearCacheRequest struct {
	Index []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	Fielddata         *bool
	Fields            []string
	IgnoreUnavailable *bool
	Query             *bool
	Request           *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesClearCacheRequest configures the Indices Clear Cache API request.

func (IndicesClearCacheRequest) Do 

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

Do executes the request and returns response or error.

type IndicesClone added in v7.4.0 

type IndicesClone func(index string, target string, o ...func(*IndicesCloneRequest)) (*Response, error)

IndicesClone clones an index

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html.

func (IndicesClone) WithBody added in v7.4.0 

func (f IndicesClone) WithBody(v io.Reader) func(*IndicesCloneRequest)

WithBody - The configuration for the target index (`settings` and `aliases`).

func (IndicesClone) WithContext added in v7.4.0 

func (f IndicesClone) WithContext(v context.Context) func(*IndicesCloneRequest)

WithContext sets the request context.

func (IndicesClone) WithErrorTrace added in v7.4.0 

func (f IndicesClone) WithErrorTrace() func(*IndicesCloneRequest)

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

func (IndicesClone) WithFilterPath added in v7.4.0 

func (f IndicesClone) WithFilterPath(v ...string) func(*IndicesCloneRequest)

WithFilterPath filters the properties of the response body.

func (IndicesClone) WithHeader added in v7.4.0 

func (f IndicesClone) WithHeader(h map[string]string) func(*IndicesCloneRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesClone) WithHuman added in v7.4.0 

func (f IndicesClone) WithHuman() func(*IndicesCloneRequest)

WithHuman makes statistical values human-readable.

func (IndicesClone) WithMasterTimeout added in v7.4.0 

func (f IndicesClone) WithMasterTimeout(v time.Duration) func(*IndicesCloneRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesClone) WithOpaqueID added in v7.5.0 

func (f IndicesClone) WithOpaqueID(s string) func(*IndicesCloneRequest)

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

func (IndicesClone) WithPretty added in v7.4.0 

func (f IndicesClone) WithPretty() func(*IndicesCloneRequest)

WithPretty makes the response body pretty-printed.

func (IndicesClone) WithTimeout added in v7.4.0 

func (f IndicesClone) WithTimeout(v time.Duration) func(*IndicesCloneRequest)

WithTimeout - explicit operation timeout.

func (IndicesClone) WithWaitForActiveShards added in v7.4.0 

func (f IndicesClone) WithWaitForActiveShards(v string) func(*IndicesCloneRequest)

WithWaitForActiveShards - set the number of active shards to wait for on the cloned index before the operation returns..

type IndicesCloneRequest added in v7.4.0 

type IndicesCloneRequest struct {
	Index string

	Body io.Reader

	Target string

	MasterTimeout       time.Duration
	Timeout             time.Duration
	WaitForActiveShards string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesCloneRequest configures the Indices Clone API request.

func (IndicesCloneRequest) Do added in v7.4.0 

func (r IndicesCloneRequest) 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 https://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 v7.2.0 

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 v7.5.0 

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.

func (IndicesClose) WithWaitForActiveShards added in v7.2.0 

func (f IndicesClose) WithWaitForActiveShards(v string) func(*IndicesCloseRequest)

WithWaitForActiveShards - sets the number of active shards to wait for before the operation returns. set to `index-setting` to wait according to the index setting `index.write.wait_for_active_shards`, or `all` to wait for all shards, or an integer. defaults to `0`..

type IndicesCloseRequest 

type IndicesCloseRequest 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
}

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 https://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 v7.2.0 

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 v7.5.0 

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) WithWaitForActiveShards 

func (f IndicesCreate) WithWaitForActiveShards(v string) func(*IndicesCreateRequest)

WithWaitForActiveShards - set the number of active shards to wait for before the operation returns..

type IndicesCreateDataStream added in v7.7.0 

type IndicesCreateDataStream func(name string, o ...func(*IndicesCreateDataStreamRequest)) (*Response, error)

IndicesCreateDataStream - Creates a data stream

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html.

func (IndicesCreateDataStream) WithContext added in v7.7.0 

func (f IndicesCreateDataStream) WithContext(v context.Context) func(*IndicesCreateDataStreamRequest)

WithContext sets the request context.

func (IndicesCreateDataStream) WithErrorTrace added in v7.7.0 

func (f IndicesCreateDataStream) WithErrorTrace() func(*IndicesCreateDataStreamRequest)

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

func (IndicesCreateDataStream) WithFilterPath added in v7.7.0 

func (f IndicesCreateDataStream) WithFilterPath(v ...string) func(*IndicesCreateDataStreamRequest)

WithFilterPath filters the properties of the response body.

func (IndicesCreateDataStream) WithHeader added in v7.7.0 

func (f IndicesCreateDataStream) WithHeader(h map[string]string) func(*IndicesCreateDataStreamRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesCreateDataStream) WithHuman added in v7.7.0 

func (f IndicesCreateDataStream) WithHuman() func(*IndicesCreateDataStreamRequest)

WithHuman makes statistical values human-readable.

func (IndicesCreateDataStream) WithOpaqueID added in v7.7.0 

func (f IndicesCreateDataStream) WithOpaqueID(s string) func(*IndicesCreateDataStreamRequest)

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

func (IndicesCreateDataStream) WithPretty added in v7.7.0 

func (f IndicesCreateDataStream) WithPretty() func(*IndicesCreateDataStreamRequest)

WithPretty makes the response body pretty-printed.

type IndicesCreateDataStreamRequest added in v7.7.0 

type IndicesCreateDataStreamRequest struct {
	Name string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesCreateDataStreamRequest configures the Indices Create Data Stream API request.

func (IndicesCreateDataStreamRequest) Do added in v7.7.0 

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

Do executes the request and returns response or error.

type IndicesCreateRequest 

type IndicesCreateRequest struct {
	Index string

	Body io.Reader

	IncludeTypeName     *bool
	MasterTimeout       time.Duration
	Timeout             time.Duration
	WaitForActiveShards string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesCreateRequest configures the Indices Create API request.

func (IndicesCreateRequest) Do 

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

Do executes the request and returns response or error.

type IndicesDataStreamsStats added in v7.9.0 

type IndicesDataStreamsStats func(o ...func(*IndicesDataStreamsStatsRequest)) (*Response, error)

IndicesDataStreamsStats - Provides statistics on operations happening in a data stream.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html.

func (IndicesDataStreamsStats) WithContext added in v7.9.0 

func (f IndicesDataStreamsStats) WithContext(v context.Context) func(*IndicesDataStreamsStatsRequest)

WithContext sets the request context.

func (IndicesDataStreamsStats) WithErrorTrace added in v7.9.0 

func (f IndicesDataStreamsStats) WithErrorTrace() func(*IndicesDataStreamsStatsRequest)

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

func (IndicesDataStreamsStats) WithFilterPath added in v7.9.0 

func (f IndicesDataStreamsStats) WithFilterPath(v ...string) func(*IndicesDataStreamsStatsRequest)

WithFilterPath filters the properties of the response body.

func (IndicesDataStreamsStats) WithHeader added in v7.9.0 

func (f IndicesDataStreamsStats) WithHeader(h map[string]string) func(*IndicesDataStreamsStatsRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesDataStreamsStats) WithHuman added in v7.9.0 

func (f IndicesDataStreamsStats) WithHuman() func(*IndicesDataStreamsStatsRequest)

WithHuman makes statistical values human-readable.

func (IndicesDataStreamsStats) WithName added in v7.9.0 

func (f IndicesDataStreamsStats) WithName(v ...string) func(*IndicesDataStreamsStatsRequest)

WithName - a list of data stream names; use _all to perform the operation on all data streams.

func (IndicesDataStreamsStats) WithOpaqueID added in v7.9.0 

func (f IndicesDataStreamsStats) WithOpaqueID(s string) func(*IndicesDataStreamsStatsRequest)

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

func (IndicesDataStreamsStats) WithPretty added in v7.9.0 

func (f IndicesDataStreamsStats) WithPretty() func(*IndicesDataStreamsStatsRequest)

WithPretty makes the response body pretty-printed.

type IndicesDataStreamsStatsRequest added in v7.9.0 

type IndicesDataStreamsStatsRequest struct {
	Name []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesDataStreamsStatsRequest configures the Indices Data Streams Stats API request.

func (IndicesDataStreamsStatsRequest) Do added in v7.9.0 

func (r IndicesDataStreamsStatsRequest) 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 https://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, closed, or hidden indices.

func (IndicesDelete) WithFilterPath 

func (f IndicesDelete) WithFilterPath(v ...string) func(*IndicesDeleteRequest)

WithFilterPath filters the properties of the response body.

func (IndicesDelete) WithHeader added in v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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 IndicesDeleteDataStream added in v7.7.0 

type IndicesDeleteDataStream func(name []string, o ...func(*IndicesDeleteDataStreamRequest)) (*Response, error)

IndicesDeleteDataStream - Deletes a data stream.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html.

func (IndicesDeleteDataStream) WithContext added in v7.7.0 

func (f IndicesDeleteDataStream) WithContext(v context.Context) func(*IndicesDeleteDataStreamRequest)

WithContext sets the request context.

func (IndicesDeleteDataStream) WithErrorTrace added in v7.7.0 

func (f IndicesDeleteDataStream) WithErrorTrace() func(*IndicesDeleteDataStreamRequest)

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

func (IndicesDeleteDataStream) WithExpandWildcards added in v7.11.0 

func (f IndicesDeleteDataStream) WithExpandWildcards(v string) func(*IndicesDeleteDataStreamRequest)

WithExpandWildcards - whether wildcard expressions should get expanded to open or closed indices (default: open).

func (IndicesDeleteDataStream) WithFilterPath added in v7.7.0 

func (f IndicesDeleteDataStream) WithFilterPath(v ...string) func(*IndicesDeleteDataStreamRequest)

WithFilterPath filters the properties of the response body.

func (IndicesDeleteDataStream) WithHeader added in v7.7.0 

func (f IndicesDeleteDataStream) WithHeader(h map[string]string) func(*IndicesDeleteDataStreamRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesDeleteDataStream) WithHuman added in v7.7.0 

func (f IndicesDeleteDataStream) WithHuman() func(*IndicesDeleteDataStreamRequest)

WithHuman makes statistical values human-readable.

func (IndicesDeleteDataStream) WithOpaqueID added in v7.7.0 

func (f IndicesDeleteDataStream) WithOpaqueID(s string) func(*IndicesDeleteDataStreamRequest)

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

func (IndicesDeleteDataStream) WithPretty added in v7.7.0 

func (f IndicesDeleteDataStream) WithPretty() func(*IndicesDeleteDataStreamRequest)

WithPretty makes the response body pretty-printed.

type IndicesDeleteDataStreamRequest added in v7.7.0 

type IndicesDeleteDataStreamRequest struct {
	Name []string

	ExpandWildcards string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesDeleteDataStreamRequest configures the Indices Delete Data Stream API request.

func (IndicesDeleteDataStreamRequest) Do added in v7.7.0 

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

Do executes the request and returns response or error.

type IndicesDeleteIndexTemplate added in v7.7.0 

type IndicesDeleteIndexTemplate func(name string, o ...func(*IndicesDeleteIndexTemplateRequest)) (*Response, error)

IndicesDeleteIndexTemplate deletes an index template.

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

func (IndicesDeleteIndexTemplate) WithContext added in v7.7.0 

func (f IndicesDeleteIndexTemplate) WithContext(v context.Context) func(*IndicesDeleteIndexTemplateRequest)

WithContext sets the request context.

func (IndicesDeleteIndexTemplate) WithErrorTrace added in v7.7.0 

func (f IndicesDeleteIndexTemplate) WithErrorTrace() func(*IndicesDeleteIndexTemplateRequest)

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

func (IndicesDeleteIndexTemplate) WithFilterPath added in v7.7.0 

func (f IndicesDeleteIndexTemplate) WithFilterPath(v ...string) func(*IndicesDeleteIndexTemplateRequest)

WithFilterPath filters the properties of the response body.

func (IndicesDeleteIndexTemplate) WithHeader added in v7.7.0 

func (f IndicesDeleteIndexTemplate) WithHeader(h map[string]string) func(*IndicesDeleteIndexTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesDeleteIndexTemplate) WithHuman added in v7.7.0 

func (f IndicesDeleteIndexTemplate) WithHuman() func(*IndicesDeleteIndexTemplateRequest)

WithHuman makes statistical values human-readable.

func (IndicesDeleteIndexTemplate) WithMasterTimeout added in v7.7.0 

func (f IndicesDeleteIndexTemplate) WithMasterTimeout(v time.Duration) func(*IndicesDeleteIndexTemplateRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesDeleteIndexTemplate) WithOpaqueID added in v7.7.0 

func (f IndicesDeleteIndexTemplate) WithOpaqueID(s string) func(*IndicesDeleteIndexTemplateRequest)

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

func (IndicesDeleteIndexTemplate) WithPretty added in v7.7.0 

func (f IndicesDeleteIndexTemplate) WithPretty() func(*IndicesDeleteIndexTemplateRequest)

WithPretty makes the response body pretty-printed.

func (IndicesDeleteIndexTemplate) WithTimeout added in v7.7.0 

func (f IndicesDeleteIndexTemplate) WithTimeout(v time.Duration) func(*IndicesDeleteIndexTemplateRequest)

WithTimeout - explicit operation timeout.

type IndicesDeleteIndexTemplateRequest added in v7.7.0 

type IndicesDeleteIndexTemplateRequest 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
}

IndicesDeleteIndexTemplateRequest configures the Indices Delete Index Template API request.

func (IndicesDeleteIndexTemplateRequest) Do added in v7.7.0 

func (r IndicesDeleteIndexTemplateRequest) 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 https://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 v7.2.0 

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 v7.5.0 

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 IndicesDiskUsage added in v7.15.0 

type IndicesDiskUsage func(index string, o ...func(*IndicesDiskUsageRequest)) (*Response, error)

IndicesDiskUsage analyzes the disk usage of each field of an index or data stream

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-disk-usage.html.

func (IndicesDiskUsage) WithAllowNoIndices added in v7.15.0 

func (f IndicesDiskUsage) WithAllowNoIndices(v bool) func(*IndicesDiskUsageRequest)

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 (IndicesDiskUsage) WithContext added in v7.15.0 

func (f IndicesDiskUsage) WithContext(v context.Context) func(*IndicesDiskUsageRequest)

WithContext sets the request context.

func (IndicesDiskUsage) WithErrorTrace added in v7.15.0 

func (f IndicesDiskUsage) WithErrorTrace() func(*IndicesDiskUsageRequest)

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

func (IndicesDiskUsage) WithExpandWildcards added in v7.15.0 

func (f IndicesDiskUsage) WithExpandWildcards(v string) func(*IndicesDiskUsageRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesDiskUsage) WithFilterPath added in v7.15.0 

func (f IndicesDiskUsage) WithFilterPath(v ...string) func(*IndicesDiskUsageRequest)

WithFilterPath filters the properties of the response body.

func (IndicesDiskUsage) WithFlush added in v7.15.0 

func (f IndicesDiskUsage) WithFlush(v bool) func(*IndicesDiskUsageRequest)

WithFlush - whether flush or not before analyzing the index disk usage. defaults to true.

func (IndicesDiskUsage) WithHeader added in v7.15.0 

func (f IndicesDiskUsage) WithHeader(h map[string]string) func(*IndicesDiskUsageRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesDiskUsage) WithHuman added in v7.15.0 

func (f IndicesDiskUsage) WithHuman() func(*IndicesDiskUsageRequest)

WithHuman makes statistical values human-readable.

func (IndicesDiskUsage) WithIgnoreUnavailable added in v7.15.0 

func (f IndicesDiskUsage) WithIgnoreUnavailable(v bool) func(*IndicesDiskUsageRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesDiskUsage) WithOpaqueID added in v7.15.0 

func (f IndicesDiskUsage) WithOpaqueID(s string) func(*IndicesDiskUsageRequest)

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

func (IndicesDiskUsage) WithPretty added in v7.15.0 

func (f IndicesDiskUsage) WithPretty() func(*IndicesDiskUsageRequest)

WithPretty makes the response body pretty-printed.

func (IndicesDiskUsage) WithRunExpensiveTasks added in v7.15.0 

func (f IndicesDiskUsage) WithRunExpensiveTasks(v bool) func(*IndicesDiskUsageRequest)

WithRunExpensiveTasks - must be set to [true] in order for the task to be performed. defaults to false..

type IndicesDiskUsageRequest added in v7.15.0 

type IndicesDiskUsageRequest struct {
	Index string

	AllowNoIndices    *bool
	ExpandWildcards   string
	Flush             *bool
	IgnoreUnavailable *bool
	RunExpensiveTasks *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesDiskUsageRequest configures the Indices Disk Usage API request.

func (IndicesDiskUsageRequest) Do added in v7.15.0 

func (r IndicesDiskUsageRequest) 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 https://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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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 v7.2.0 

type IndicesExistsDocumentType func(index []string, o ...func(*IndicesExistsDocumentTypeRequest)) (*Response, error)

IndicesExistsDocumentType returns information about whether a particular document type exists. (DEPRECATED)

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html.

func (IndicesExistsDocumentType) WithAllowNoIndices added in v7.2.0 

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 v7.2.0 

func (f IndicesExistsDocumentType) WithContext(v context.Context) func(*IndicesExistsDocumentTypeRequest)

WithContext sets the request context.

func (IndicesExistsDocumentType) WithDocumentType added in v7.2.0 

func (f IndicesExistsDocumentType) WithDocumentType(v ...string) func(*IndicesExistsDocumentTypeRequest)

WithDocumentType - a list of document types to check.

func (IndicesExistsDocumentType) WithErrorTrace added in v7.2.0 

func (f IndicesExistsDocumentType) WithErrorTrace() func(*IndicesExistsDocumentTypeRequest)

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

func (IndicesExistsDocumentType) WithExpandWildcards added in v7.2.0 

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 v7.2.0 

func (f IndicesExistsDocumentType) WithFilterPath(v ...string) func(*IndicesExistsDocumentTypeRequest)

WithFilterPath filters the properties of the response body.

func (IndicesExistsDocumentType) WithHeader added in v7.2.0 

func (f IndicesExistsDocumentType) WithHeader(h map[string]string) func(*IndicesExistsDocumentTypeRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesExistsDocumentType) WithHuman added in v7.2.0 

func (f IndicesExistsDocumentType) WithHuman() func(*IndicesExistsDocumentTypeRequest)

WithHuman makes statistical values human-readable.

func (IndicesExistsDocumentType) WithIgnoreUnavailable added in v7.2.0 

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 v7.2.0 

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 v7.5.0 

func (f IndicesExistsDocumentType) WithOpaqueID(s string) func(*IndicesExistsDocumentTypeRequest)

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

func (IndicesExistsDocumentType) WithPretty added in v7.2.0 

func (f IndicesExistsDocumentType) WithPretty() func(*IndicesExistsDocumentTypeRequest)

WithPretty makes the response body pretty-printed.

type IndicesExistsDocumentTypeRequest added in v7.2.0 

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 v7.2.0 

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

Do executes the request and returns response or error.

type IndicesExistsIndexTemplate added in v7.7.0 

type IndicesExistsIndexTemplate func(name string, o ...func(*IndicesExistsIndexTemplateRequest)) (*Response, error)

IndicesExistsIndexTemplate returns information about whether a particular index template exists.

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

func (IndicesExistsIndexTemplate) WithContext added in v7.7.0 

func (f IndicesExistsIndexTemplate) WithContext(v context.Context) func(*IndicesExistsIndexTemplateRequest)

WithContext sets the request context.

func (IndicesExistsIndexTemplate) WithErrorTrace added in v7.7.0 

func (f IndicesExistsIndexTemplate) WithErrorTrace() func(*IndicesExistsIndexTemplateRequest)

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

func (IndicesExistsIndexTemplate) WithFilterPath added in v7.7.0 

func (f IndicesExistsIndexTemplate) WithFilterPath(v ...string) func(*IndicesExistsIndexTemplateRequest)

WithFilterPath filters the properties of the response body.

func (IndicesExistsIndexTemplate) WithFlatSettings added in v7.7.0 

func (f IndicesExistsIndexTemplate) WithFlatSettings(v bool) func(*IndicesExistsIndexTemplateRequest)

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

func (IndicesExistsIndexTemplate) WithHeader added in v7.7.0 

func (f IndicesExistsIndexTemplate) WithHeader(h map[string]string) func(*IndicesExistsIndexTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesExistsIndexTemplate) WithHuman added in v7.7.0 

func (f IndicesExistsIndexTemplate) WithHuman() func(*IndicesExistsIndexTemplateRequest)

WithHuman makes statistical values human-readable.

func (IndicesExistsIndexTemplate) WithLocal added in v7.7.0 

func (f IndicesExistsIndexTemplate) WithLocal(v bool) func(*IndicesExistsIndexTemplateRequest)

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

func (IndicesExistsIndexTemplate) WithMasterTimeout added in v7.7.0 

func (f IndicesExistsIndexTemplate) WithMasterTimeout(v time.Duration) func(*IndicesExistsIndexTemplateRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (IndicesExistsIndexTemplate) WithOpaqueID added in v7.7.0 

func (f IndicesExistsIndexTemplate) WithOpaqueID(s string) func(*IndicesExistsIndexTemplateRequest)

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

func (IndicesExistsIndexTemplate) WithPretty added in v7.7.0 

func (f IndicesExistsIndexTemplate) WithPretty() func(*IndicesExistsIndexTemplateRequest)

WithPretty makes the response body pretty-printed.

type IndicesExistsIndexTemplateRequest added in v7.7.0 

type IndicesExistsIndexTemplateRequest 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
}

IndicesExistsIndexTemplateRequest configures the Indices Exists Index Template API request.

func (IndicesExistsIndexTemplateRequest) Do added in v7.7.0 

func (r IndicesExistsIndexTemplateRequest) 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 https://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 v7.2.0 

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 v7.5.0 

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 IndicesFieldUsageStats added in v7.15.0 

type IndicesFieldUsageStats func(index string, o ...func(*IndicesFieldUsageStatsRequest)) (*Response, error)

IndicesFieldUsageStats returns the field usage stats for each field of an index

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/field-usage-stats.html.

func (IndicesFieldUsageStats) WithAllowNoIndices added in v7.15.0 

func (f IndicesFieldUsageStats) WithAllowNoIndices(v bool) func(*IndicesFieldUsageStatsRequest)

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 (IndicesFieldUsageStats) WithContext added in v7.15.0 

func (f IndicesFieldUsageStats) WithContext(v context.Context) func(*IndicesFieldUsageStatsRequest)

WithContext sets the request context.

func (IndicesFieldUsageStats) WithErrorTrace added in v7.15.0 

func (f IndicesFieldUsageStats) WithErrorTrace() func(*IndicesFieldUsageStatsRequest)

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

func (IndicesFieldUsageStats) WithExpandWildcards added in v7.15.0 

func (f IndicesFieldUsageStats) WithExpandWildcards(v string) func(*IndicesFieldUsageStatsRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesFieldUsageStats) WithFields added in v7.15.0 

func (f IndicesFieldUsageStats) WithFields(v ...string) func(*IndicesFieldUsageStatsRequest)

WithFields - a list of fields to include in the stats if only a subset of fields should be returned (supports wildcards).

func (IndicesFieldUsageStats) WithFilterPath added in v7.15.0 

func (f IndicesFieldUsageStats) WithFilterPath(v ...string) func(*IndicesFieldUsageStatsRequest)

WithFilterPath filters the properties of the response body.

func (IndicesFieldUsageStats) WithHeader added in v7.15.0 

func (f IndicesFieldUsageStats) WithHeader(h map[string]string) func(*IndicesFieldUsageStatsRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesFieldUsageStats) WithHuman added in v7.15.0 

func (f IndicesFieldUsageStats) WithHuman() func(*IndicesFieldUsageStatsRequest)

WithHuman makes statistical values human-readable.

func (IndicesFieldUsageStats) WithIgnoreUnavailable added in v7.15.0 

func (f IndicesFieldUsageStats) WithIgnoreUnavailable(v bool) func(*IndicesFieldUsageStatsRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesFieldUsageStats) WithOpaqueID added in v7.15.0 

func (f IndicesFieldUsageStats) WithOpaqueID(s string) func(*IndicesFieldUsageStatsRequest)

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

func (IndicesFieldUsageStats) WithPretty added in v7.15.0 

func (f IndicesFieldUsageStats) WithPretty() func(*IndicesFieldUsageStatsRequest)

WithPretty makes the response body pretty-printed.

type IndicesFieldUsageStatsRequest added in v7.15.0 

type IndicesFieldUsageStatsRequest struct {
	Index string

	AllowNoIndices    *bool
	ExpandWildcards   string
	Fields            []string
	IgnoreUnavailable *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesFieldUsageStatsRequest configures the Indices Field Usage Stats API request.

func (IndicesFieldUsageStatsRequest) Do added in v7.15.0 

func (r IndicesFieldUsageStatsRequest) 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 https://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 v7.2.0 

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 v7.5.0 

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. Synced flush is deprecated and will be removed in 8.0. Use flush instead

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush-api.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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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 v7.2.0 

type IndicesFreeze func(index string, o ...func(*IndicesFreezeRequest)) (*Response, error)

IndicesFreeze - Freezes an index. A frozen index has almost no overhead on the cluster (except for maintaining its metadata in memory) and is read-only.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/freeze-index-api.html.

func (IndicesFreeze) WithAllowNoIndices added in v7.2.0 

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 v7.2.0 

func (f IndicesFreeze) WithContext(v context.Context) func(*IndicesFreezeRequest)

WithContext sets the request context.

func (IndicesFreeze) WithErrorTrace added in v7.2.0 

func (f IndicesFreeze) WithErrorTrace() func(*IndicesFreezeRequest)

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

func (IndicesFreeze) WithExpandWildcards added in v7.2.0 

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 v7.2.0 

func (f IndicesFreeze) WithFilterPath(v ...string) func(*IndicesFreezeRequest)

WithFilterPath filters the properties of the response body.

func (IndicesFreeze) WithHeader added in v7.2.0 

func (f IndicesFreeze) WithHeader(h map[string]string) func(*IndicesFreezeRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesFreeze) WithHuman added in v7.2.0 

func (f IndicesFreeze) WithHuman() func(*IndicesFreezeRequest)

WithHuman makes statistical values human-readable.

func (IndicesFreeze) WithIgnoreUnavailable added in v7.2.0 

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 v7.2.0 

func (f IndicesFreeze) WithMasterTimeout(v time.Duration) func(*IndicesFreezeRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesFreeze) WithOpaqueID added in v7.5.0 

func (f IndicesFreeze) WithOpaqueID(s string) func(*IndicesFreezeRequest)

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

func (IndicesFreeze) WithPretty added in v7.2.0 

func (f IndicesFreeze) WithPretty() func(*IndicesFreezeRequest)

WithPretty makes the response body pretty-printed.

func (IndicesFreeze) WithTimeout added in v7.2.0 

func (f IndicesFreeze) WithTimeout(v time.Duration) func(*IndicesFreezeRequest)

WithTimeout - explicit operation timeout.

func (IndicesFreeze) WithWaitForActiveShards added in v7.2.0 

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 v7.2.0 

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 v7.2.0 

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 https://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 v7.2.0 

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: false).

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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 IndicesGetDataStream added in v7.9.0 

type IndicesGetDataStream func(o ...func(*IndicesGetDataStreamRequest)) (*Response, error)

IndicesGetDataStream - Returns data streams.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html.

func (IndicesGetDataStream) WithContext added in v7.9.0 

func (f IndicesGetDataStream) WithContext(v context.Context) func(*IndicesGetDataStreamRequest)

WithContext sets the request context.

func (IndicesGetDataStream) WithErrorTrace added in v7.9.0 

func (f IndicesGetDataStream) WithErrorTrace() func(*IndicesGetDataStreamRequest)

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

func (IndicesGetDataStream) WithExpandWildcards added in v7.11.0 

func (f IndicesGetDataStream) WithExpandWildcards(v string) func(*IndicesGetDataStreamRequest)

WithExpandWildcards - whether wildcard expressions should get expanded to open or closed indices (default: open).

func (IndicesGetDataStream) WithFilterPath added in v7.9.0 

func (f IndicesGetDataStream) WithFilterPath(v ...string) func(*IndicesGetDataStreamRequest)

WithFilterPath filters the properties of the response body.

func (IndicesGetDataStream) WithHeader added in v7.9.0 

func (f IndicesGetDataStream) WithHeader(h map[string]string) func(*IndicesGetDataStreamRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesGetDataStream) WithHuman added in v7.9.0 

func (f IndicesGetDataStream) WithHuman() func(*IndicesGetDataStreamRequest)

WithHuman makes statistical values human-readable.

func (IndicesGetDataStream) WithName added in v7.9.0 

func (f IndicesGetDataStream) WithName(v ...string) func(*IndicesGetDataStreamRequest)

WithName - a list of data streams to get; use `*` to get all data streams.

func (IndicesGetDataStream) WithOpaqueID added in v7.9.0 

func (f IndicesGetDataStream) WithOpaqueID(s string) func(*IndicesGetDataStreamRequest)

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

func (IndicesGetDataStream) WithPretty added in v7.9.0 

func (f IndicesGetDataStream) WithPretty() func(*IndicesGetDataStreamRequest)

WithPretty makes the response body pretty-printed.

type IndicesGetDataStreamRequest added in v7.9.0 

type IndicesGetDataStreamRequest struct {
	Name []string

	ExpandWildcards string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesGetDataStreamRequest configures the Indices Get Data Stream API request.

func (IndicesGetDataStreamRequest) Do added in v7.9.0 

func (r IndicesGetDataStreamRequest) 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 https://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 v7.2.0 

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 v7.5.0 

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 IndicesGetIndexTemplate added in v7.7.0 

type IndicesGetIndexTemplate func(o ...func(*IndicesGetIndexTemplateRequest)) (*Response, error)

IndicesGetIndexTemplate returns an index template.

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

func (IndicesGetIndexTemplate) WithContext added in v7.7.0 

func (f IndicesGetIndexTemplate) WithContext(v context.Context) func(*IndicesGetIndexTemplateRequest)

WithContext sets the request context.

func (IndicesGetIndexTemplate) WithErrorTrace added in v7.7.0 

func (f IndicesGetIndexTemplate) WithErrorTrace() func(*IndicesGetIndexTemplateRequest)

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

func (IndicesGetIndexTemplate) WithFilterPath added in v7.7.0 

func (f IndicesGetIndexTemplate) WithFilterPath(v ...string) func(*IndicesGetIndexTemplateRequest)

WithFilterPath filters the properties of the response body.

func (IndicesGetIndexTemplate) WithFlatSettings added in v7.7.0 

func (f IndicesGetIndexTemplate) WithFlatSettings(v bool) func(*IndicesGetIndexTemplateRequest)

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

func (IndicesGetIndexTemplate) WithHeader added in v7.7.0 

func (f IndicesGetIndexTemplate) WithHeader(h map[string]string) func(*IndicesGetIndexTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesGetIndexTemplate) WithHuman added in v7.7.0 

func (f IndicesGetIndexTemplate) WithHuman() func(*IndicesGetIndexTemplateRequest)

WithHuman makes statistical values human-readable.

func (IndicesGetIndexTemplate) WithLocal added in v7.7.0 

func (f IndicesGetIndexTemplate) WithLocal(v bool) func(*IndicesGetIndexTemplateRequest)

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

func (IndicesGetIndexTemplate) WithMasterTimeout added in v7.7.0 

func (f IndicesGetIndexTemplate) WithMasterTimeout(v time.Duration) func(*IndicesGetIndexTemplateRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (IndicesGetIndexTemplate) WithName added in v7.7.0 

func (f IndicesGetIndexTemplate) WithName(v string) func(*IndicesGetIndexTemplateRequest)

WithName - a pattern that returned template names must match.

func (IndicesGetIndexTemplate) WithOpaqueID added in v7.7.0 

func (f IndicesGetIndexTemplate) WithOpaqueID(s string) func(*IndicesGetIndexTemplateRequest)

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

func (IndicesGetIndexTemplate) WithPretty added in v7.7.0 

func (f IndicesGetIndexTemplate) WithPretty() func(*IndicesGetIndexTemplateRequest)

WithPretty makes the response body pretty-printed.

type IndicesGetIndexTemplateRequest added in v7.7.0 

type IndicesGetIndexTemplateRequest 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
}

IndicesGetIndexTemplateRequest configures the Indices Get Index Template API request.

func (IndicesGetIndexTemplateRequest) Do added in v7.7.0 

func (r IndicesGetIndexTemplateRequest) 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 https://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 v7.2.0 

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 (default: false).

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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 deprecated Returns a progress status of current upgrade.

See full documentation at https://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 v7.2.0 

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 v7.5.0 

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 IndicesMigrateToDataStream added in v7.11.0 

type IndicesMigrateToDataStream func(name string, o ...func(*IndicesMigrateToDataStreamRequest)) (*Response, error)

IndicesMigrateToDataStream - Migrates an alias to a data stream

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html.

func (IndicesMigrateToDataStream) WithContext added in v7.11.0 

func (f IndicesMigrateToDataStream) WithContext(v context.Context) func(*IndicesMigrateToDataStreamRequest)

WithContext sets the request context.

func (IndicesMigrateToDataStream) WithErrorTrace added in v7.11.0 

func (f IndicesMigrateToDataStream) WithErrorTrace() func(*IndicesMigrateToDataStreamRequest)

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

func (IndicesMigrateToDataStream) WithFilterPath added in v7.11.0 

func (f IndicesMigrateToDataStream) WithFilterPath(v ...string) func(*IndicesMigrateToDataStreamRequest)

WithFilterPath filters the properties of the response body.

func (IndicesMigrateToDataStream) WithHeader added in v7.11.0 

func (f IndicesMigrateToDataStream) WithHeader(h map[string]string) func(*IndicesMigrateToDataStreamRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesMigrateToDataStream) WithHuman added in v7.11.0 

func (f IndicesMigrateToDataStream) WithHuman() func(*IndicesMigrateToDataStreamRequest)

WithHuman makes statistical values human-readable.

func (IndicesMigrateToDataStream) WithOpaqueID added in v7.11.0 

func (f IndicesMigrateToDataStream) WithOpaqueID(s string) func(*IndicesMigrateToDataStreamRequest)

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

func (IndicesMigrateToDataStream) WithPretty added in v7.11.0 

func (f IndicesMigrateToDataStream) WithPretty() func(*IndicesMigrateToDataStreamRequest)

WithPretty makes the response body pretty-printed.

type IndicesMigrateToDataStreamRequest added in v7.11.0 

type IndicesMigrateToDataStreamRequest struct {
	Name string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesMigrateToDataStreamRequest configures the Indices Migrate To Data Stream API request.

func (IndicesMigrateToDataStreamRequest) Do added in v7.11.0 

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

Do executes the request and returns response or error.

type IndicesModifyDataStream added in v7.16.0 

type IndicesModifyDataStream func(body io.Reader, o ...func(*IndicesModifyDataStreamRequest)) (*Response, error)

IndicesModifyDataStream modifies a data stream

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html.

func (IndicesModifyDataStream) WithContext added in v7.16.0 

func (f IndicesModifyDataStream) WithContext(v context.Context) func(*IndicesModifyDataStreamRequest)

WithContext sets the request context.

func (IndicesModifyDataStream) WithErrorTrace added in v7.16.0 

func (f IndicesModifyDataStream) WithErrorTrace() func(*IndicesModifyDataStreamRequest)

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

func (IndicesModifyDataStream) WithFilterPath added in v7.16.0 

func (f IndicesModifyDataStream) WithFilterPath(v ...string) func(*IndicesModifyDataStreamRequest)

WithFilterPath filters the properties of the response body.

func (IndicesModifyDataStream) WithHeader added in v7.16.0 

func (f IndicesModifyDataStream) WithHeader(h map[string]string) func(*IndicesModifyDataStreamRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesModifyDataStream) WithHuman added in v7.16.0 

func (f IndicesModifyDataStream) WithHuman() func(*IndicesModifyDataStreamRequest)

WithHuman makes statistical values human-readable.

func (IndicesModifyDataStream) WithOpaqueID added in v7.16.0 

func (f IndicesModifyDataStream) WithOpaqueID(s string) func(*IndicesModifyDataStreamRequest)

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

func (IndicesModifyDataStream) WithPretty added in v7.16.0 

func (f IndicesModifyDataStream) WithPretty() func(*IndicesModifyDataStreamRequest)

WithPretty makes the response body pretty-printed.

type IndicesModifyDataStreamRequest added in v7.16.0 

type IndicesModifyDataStreamRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesModifyDataStreamRequest configures the Indices Modify Data Stream API request.

func (IndicesModifyDataStreamRequest) Do added in v7.16.0 

func (r IndicesModifyDataStreamRequest) 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 https://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 v7.2.0 

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 v7.5.0 

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 IndicesPromoteDataStream added in v7.11.0 

type IndicesPromoteDataStream func(name string, o ...func(*IndicesPromoteDataStreamRequest)) (*Response, error)

IndicesPromoteDataStream - Promotes a data stream from a replicated data stream managed by CCR to a regular data stream

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html.

func (IndicesPromoteDataStream) WithContext added in v7.11.0 

func (f IndicesPromoteDataStream) WithContext(v context.Context) func(*IndicesPromoteDataStreamRequest)

WithContext sets the request context.

func (IndicesPromoteDataStream) WithErrorTrace added in v7.11.0 

func (f IndicesPromoteDataStream) WithErrorTrace() func(*IndicesPromoteDataStreamRequest)

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

func (IndicesPromoteDataStream) WithFilterPath added in v7.11.0 

func (f IndicesPromoteDataStream) WithFilterPath(v ...string) func(*IndicesPromoteDataStreamRequest)

WithFilterPath filters the properties of the response body.

func (IndicesPromoteDataStream) WithHeader added in v7.11.0 

func (f IndicesPromoteDataStream) WithHeader(h map[string]string) func(*IndicesPromoteDataStreamRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesPromoteDataStream) WithHuman added in v7.11.0 

func (f IndicesPromoteDataStream) WithHuman() func(*IndicesPromoteDataStreamRequest)

WithHuman makes statistical values human-readable.

func (IndicesPromoteDataStream) WithOpaqueID added in v7.11.0 

func (f IndicesPromoteDataStream) WithOpaqueID(s string) func(*IndicesPromoteDataStreamRequest)

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

func (IndicesPromoteDataStream) WithPretty added in v7.11.0 

func (f IndicesPromoteDataStream) WithPretty() func(*IndicesPromoteDataStreamRequest)

WithPretty makes the response body pretty-printed.

type IndicesPromoteDataStreamRequest added in v7.11.0 

type IndicesPromoteDataStreamRequest struct {
	Name string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesPromoteDataStreamRequest configures the Indices Promote Data Stream API request.

func (IndicesPromoteDataStreamRequest) Do added in v7.11.0 

func (r IndicesPromoteDataStreamRequest) 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 https://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 v7.2.0 

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 v7.5.0 

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 IndicesPutIndexTemplate added in v7.7.0 

type IndicesPutIndexTemplate func(name string, body io.Reader, o ...func(*IndicesPutIndexTemplateRequest)) (*Response, error)

IndicesPutIndexTemplate creates or updates an index template.

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

func (IndicesPutIndexTemplate) WithCause added in v7.8.0 

func (f IndicesPutIndexTemplate) WithCause(v string) func(*IndicesPutIndexTemplateRequest)

WithCause - user defined reason for creating/updating the index template.

func (IndicesPutIndexTemplate) WithContext added in v7.7.0 

func (f IndicesPutIndexTemplate) WithContext(v context.Context) func(*IndicesPutIndexTemplateRequest)

WithContext sets the request context.

func (IndicesPutIndexTemplate) WithCreate added in v7.7.0 

func (f IndicesPutIndexTemplate) WithCreate(v bool) func(*IndicesPutIndexTemplateRequest)

WithCreate - whether the index template should only be added if new or can also replace an existing one.

func (IndicesPutIndexTemplate) WithErrorTrace added in v7.7.0 

func (f IndicesPutIndexTemplate) WithErrorTrace() func(*IndicesPutIndexTemplateRequest)

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

func (IndicesPutIndexTemplate) WithFilterPath added in v7.7.0 

func (f IndicesPutIndexTemplate) WithFilterPath(v ...string) func(*IndicesPutIndexTemplateRequest)

WithFilterPath filters the properties of the response body.

func (IndicesPutIndexTemplate) WithHeader added in v7.7.0 

func (f IndicesPutIndexTemplate) WithHeader(h map[string]string) func(*IndicesPutIndexTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesPutIndexTemplate) WithHuman added in v7.7.0 

func (f IndicesPutIndexTemplate) WithHuman() func(*IndicesPutIndexTemplateRequest)

WithHuman makes statistical values human-readable.

func (IndicesPutIndexTemplate) WithMasterTimeout added in v7.7.0 

func (f IndicesPutIndexTemplate) WithMasterTimeout(v time.Duration) func(*IndicesPutIndexTemplateRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesPutIndexTemplate) WithOpaqueID added in v7.7.0 

func (f IndicesPutIndexTemplate) WithOpaqueID(s string) func(*IndicesPutIndexTemplateRequest)

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

func (IndicesPutIndexTemplate) WithPretty added in v7.7.0 

func (f IndicesPutIndexTemplate) WithPretty() func(*IndicesPutIndexTemplateRequest)

WithPretty makes the response body pretty-printed.

type IndicesPutIndexTemplateRequest added in v7.7.0 

type IndicesPutIndexTemplateRequest struct {
	Body io.Reader

	Name string

	Cause         string
	Create        *bool
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesPutIndexTemplateRequest configures the Indices Put Index Template API request.

func (IndicesPutIndexTemplateRequest) Do added in v7.7.0 

func (r IndicesPutIndexTemplateRequest) 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 https://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 v7.2.0 

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 v7.5.0 

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) WithWriteIndexOnly added in v7.9.0 

func (f IndicesPutMapping) WithWriteIndexOnly(v bool) func(*IndicesPutMappingRequest)

WithWriteIndexOnly - when true, applies mappings only to the write index of an alias or data stream.

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
	WriteIndexOnly    *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 https://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 v7.2.0 

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 v7.5.0 

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 https://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) WithHeader added in v7.2.0 

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 v7.5.0 

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.

type IndicesPutTemplateRequest 

type IndicesPutTemplateRequest struct {
	Body io.Reader

	Name string

	Create          *bool
	IncludeTypeName *bool
	MasterTimeout   time.Duration
	Order           *int

	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 https://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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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 IndicesReloadSearchAnalyzers added in v7.2.0 

type IndicesReloadSearchAnalyzers func(index []string, o ...func(*IndicesReloadSearchAnalyzersRequest)) (*Response, error)

IndicesReloadSearchAnalyzers - Reloads an index's search analyzers and their resources.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-reload-analyzers.html.

func (IndicesReloadSearchAnalyzers) WithAllowNoIndices added in v7.2.0 

func (f IndicesReloadSearchAnalyzers) WithAllowNoIndices(v bool) func(*IndicesReloadSearchAnalyzersRequest)

WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).

func (IndicesReloadSearchAnalyzers) WithContext added in v7.2.0 

func (f IndicesReloadSearchAnalyzers) WithContext(v context.Context) func(*IndicesReloadSearchAnalyzersRequest)

WithContext sets the request context.

func (IndicesReloadSearchAnalyzers) WithErrorTrace added in v7.2.0 

func (f IndicesReloadSearchAnalyzers) WithErrorTrace() func(*IndicesReloadSearchAnalyzersRequest)

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

func (IndicesReloadSearchAnalyzers) WithExpandWildcards added in v7.2.0 

func (f IndicesReloadSearchAnalyzers) WithExpandWildcards(v string) func(*IndicesReloadSearchAnalyzersRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (IndicesReloadSearchAnalyzers) WithFilterPath added in v7.2.0 

func (f IndicesReloadSearchAnalyzers) WithFilterPath(v ...string) func(*IndicesReloadSearchAnalyzersRequest)

WithFilterPath filters the properties of the response body.

func (IndicesReloadSearchAnalyzers) WithHeader added in v7.2.0 

func (f IndicesReloadSearchAnalyzers) WithHeader(h map[string]string) func(*IndicesReloadSearchAnalyzersRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesReloadSearchAnalyzers) WithHuman added in v7.2.0 

func (f IndicesReloadSearchAnalyzers) WithHuman() func(*IndicesReloadSearchAnalyzersRequest)

WithHuman makes statistical values human-readable.

func (IndicesReloadSearchAnalyzers) WithIgnoreUnavailable added in v7.2.0 

func (f IndicesReloadSearchAnalyzers) WithIgnoreUnavailable(v bool) func(*IndicesReloadSearchAnalyzersRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (IndicesReloadSearchAnalyzers) WithOpaqueID added in v7.5.0 

func (f IndicesReloadSearchAnalyzers) WithOpaqueID(s string) func(*IndicesReloadSearchAnalyzersRequest)

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

func (IndicesReloadSearchAnalyzers) WithPretty added in v7.2.0 

func (f IndicesReloadSearchAnalyzers) WithPretty() func(*IndicesReloadSearchAnalyzersRequest)

WithPretty makes the response body pretty-printed.

type IndicesReloadSearchAnalyzersRequest added in v7.2.0 

type IndicesReloadSearchAnalyzersRequest 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
}

IndicesReloadSearchAnalyzersRequest configures the Indices Reload Search Analyzers API request.

func (IndicesReloadSearchAnalyzersRequest) Do added in v7.2.0 

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

Do executes the request and returns response or error.

type IndicesResolveIndex added in v7.9.0 

type IndicesResolveIndex func(name []string, o ...func(*IndicesResolveIndexRequest)) (*Response, error)

IndicesResolveIndex returns information about any matching indices, aliases, and data streams

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html.

func (IndicesResolveIndex) WithContext added in v7.9.0 

func (f IndicesResolveIndex) WithContext(v context.Context) func(*IndicesResolveIndexRequest)

WithContext sets the request context.

func (IndicesResolveIndex) WithErrorTrace added in v7.9.0 

func (f IndicesResolveIndex) WithErrorTrace() func(*IndicesResolveIndexRequest)

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

func (IndicesResolveIndex) WithExpandWildcards added in v7.9.0 

func (f IndicesResolveIndex) WithExpandWildcards(v string) func(*IndicesResolveIndexRequest)

WithExpandWildcards - whether wildcard expressions should get expanded to open or closed indices (default: open).

func (IndicesResolveIndex) WithFilterPath added in v7.9.0 

func (f IndicesResolveIndex) WithFilterPath(v ...string) func(*IndicesResolveIndexRequest)

WithFilterPath filters the properties of the response body.

func (IndicesResolveIndex) WithHeader added in v7.9.0 

func (f IndicesResolveIndex) WithHeader(h map[string]string) func(*IndicesResolveIndexRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesResolveIndex) WithHuman added in v7.9.0 

func (f IndicesResolveIndex) WithHuman() func(*IndicesResolveIndexRequest)

WithHuman makes statistical values human-readable.

func (IndicesResolveIndex) WithOpaqueID added in v7.9.0 

func (f IndicesResolveIndex) WithOpaqueID(s string) func(*IndicesResolveIndexRequest)

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

func (IndicesResolveIndex) WithPretty added in v7.9.0 

func (f IndicesResolveIndex) WithPretty() func(*IndicesResolveIndexRequest)

WithPretty makes the response body pretty-printed.

type IndicesResolveIndexRequest added in v7.9.0 

type IndicesResolveIndexRequest struct {
	Name []string

	ExpandWildcards string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesResolveIndexRequest configures the Indices Resolve Index API request.

func (IndicesResolveIndexRequest) Do added in v7.9.0 

func (r IndicesResolveIndexRequest) 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 https://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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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 https://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 v7.2.0 

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 v7.5.0 

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 IndicesSimulateIndexTemplate added in v7.8.0 

type IndicesSimulateIndexTemplate func(name string, o ...func(*IndicesSimulateIndexTemplateRequest)) (*Response, error)

IndicesSimulateIndexTemplate simulate matching the given index name against the index templates in the system

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

func (IndicesSimulateIndexTemplate) WithBody added in v7.8.0 

func (f IndicesSimulateIndexTemplate) WithBody(v io.Reader) func(*IndicesSimulateIndexTemplateRequest)

WithBody - New index template definition, which will be included in the simulation, as if it already exists in the system.

func (IndicesSimulateIndexTemplate) WithCause added in v7.8.0 

func (f IndicesSimulateIndexTemplate) WithCause(v string) func(*IndicesSimulateIndexTemplateRequest)

WithCause - user defined reason for dry-run creating the new template for simulation purposes.

func (IndicesSimulateIndexTemplate) WithContext added in v7.8.0 

func (f IndicesSimulateIndexTemplate) WithContext(v context.Context) func(*IndicesSimulateIndexTemplateRequest)

WithContext sets the request context.

func (IndicesSimulateIndexTemplate) WithCreate added in v7.8.0 

func (f IndicesSimulateIndexTemplate) WithCreate(v bool) func(*IndicesSimulateIndexTemplateRequest)

WithCreate - whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one.

func (IndicesSimulateIndexTemplate) WithErrorTrace added in v7.8.0 

func (f IndicesSimulateIndexTemplate) WithErrorTrace() func(*IndicesSimulateIndexTemplateRequest)

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

func (IndicesSimulateIndexTemplate) WithFilterPath added in v7.8.0 

func (f IndicesSimulateIndexTemplate) WithFilterPath(v ...string) func(*IndicesSimulateIndexTemplateRequest)

WithFilterPath filters the properties of the response body.

func (IndicesSimulateIndexTemplate) WithHeader added in v7.8.0 

func (f IndicesSimulateIndexTemplate) WithHeader(h map[string]string) func(*IndicesSimulateIndexTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesSimulateIndexTemplate) WithHuman added in v7.8.0 

func (f IndicesSimulateIndexTemplate) WithHuman() func(*IndicesSimulateIndexTemplateRequest)

WithHuman makes statistical values human-readable.

func (IndicesSimulateIndexTemplate) WithMasterTimeout added in v7.8.0 

func (f IndicesSimulateIndexTemplate) WithMasterTimeout(v time.Duration) func(*IndicesSimulateIndexTemplateRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesSimulateIndexTemplate) WithOpaqueID added in v7.8.0 

func (f IndicesSimulateIndexTemplate) WithOpaqueID(s string) func(*IndicesSimulateIndexTemplateRequest)

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

func (IndicesSimulateIndexTemplate) WithPretty added in v7.8.0 

func (f IndicesSimulateIndexTemplate) WithPretty() func(*IndicesSimulateIndexTemplateRequest)

WithPretty makes the response body pretty-printed.

type IndicesSimulateIndexTemplateRequest added in v7.8.0 

type IndicesSimulateIndexTemplateRequest struct {
	Body io.Reader

	Name string

	Cause         string
	Create        *bool
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesSimulateIndexTemplateRequest configures the Indices Simulate Index Template API request.

func (IndicesSimulateIndexTemplateRequest) Do added in v7.8.0 

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

Do executes the request and returns response or error.

type IndicesSimulateTemplate added in v7.9.0 

type IndicesSimulateTemplate func(o ...func(*IndicesSimulateTemplateRequest)) (*Response, error)

IndicesSimulateTemplate simulate resolving the given template name or body

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

func (IndicesSimulateTemplate) WithBody added in v7.9.0 

func (f IndicesSimulateTemplate) WithBody(v io.Reader) func(*IndicesSimulateTemplateRequest)

WithBody - New index template definition to be simulated, if no index template name is specified.

func (IndicesSimulateTemplate) WithCause added in v7.9.0 

func (f IndicesSimulateTemplate) WithCause(v string) func(*IndicesSimulateTemplateRequest)

WithCause - user defined reason for dry-run creating the new template for simulation purposes.

func (IndicesSimulateTemplate) WithContext added in v7.9.0 

func (f IndicesSimulateTemplate) WithContext(v context.Context) func(*IndicesSimulateTemplateRequest)

WithContext sets the request context.

func (IndicesSimulateTemplate) WithCreate added in v7.9.0 

func (f IndicesSimulateTemplate) WithCreate(v bool) func(*IndicesSimulateTemplateRequest)

WithCreate - whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one.

func (IndicesSimulateTemplate) WithErrorTrace added in v7.9.0 

func (f IndicesSimulateTemplate) WithErrorTrace() func(*IndicesSimulateTemplateRequest)

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

func (IndicesSimulateTemplate) WithFilterPath added in v7.9.0 

func (f IndicesSimulateTemplate) WithFilterPath(v ...string) func(*IndicesSimulateTemplateRequest)

WithFilterPath filters the properties of the response body.

func (IndicesSimulateTemplate) WithHeader added in v7.9.0 

func (f IndicesSimulateTemplate) WithHeader(h map[string]string) func(*IndicesSimulateTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesSimulateTemplate) WithHuman added in v7.9.0 

func (f IndicesSimulateTemplate) WithHuman() func(*IndicesSimulateTemplateRequest)

WithHuman makes statistical values human-readable.

func (IndicesSimulateTemplate) WithMasterTimeout added in v7.9.0 

func (f IndicesSimulateTemplate) WithMasterTimeout(v time.Duration) func(*IndicesSimulateTemplateRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesSimulateTemplate) WithName added in v7.9.0 

func (f IndicesSimulateTemplate) WithName(v string) func(*IndicesSimulateTemplateRequest)

WithName - the name of the index template.

func (IndicesSimulateTemplate) WithOpaqueID added in v7.9.0 

func (f IndicesSimulateTemplate) WithOpaqueID(s string) func(*IndicesSimulateTemplateRequest)

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

func (IndicesSimulateTemplate) WithPretty added in v7.9.0 

func (f IndicesSimulateTemplate) WithPretty() func(*IndicesSimulateTemplateRequest)

WithPretty makes the response body pretty-printed.

type IndicesSimulateTemplateRequest added in v7.9.0 

type IndicesSimulateTemplateRequest struct {
	Body io.Reader

	Name string

	Cause         string
	Create        *bool
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header
	// contains filtered or unexported fields
}

IndicesSimulateTemplateRequest configures the Indices Simulate Template API request.

func (IndicesSimulateTemplateRequest) Do added in v7.9.0 

func (r IndicesSimulateTemplateRequest) 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 https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html.

func (IndicesSplit) WithBody