esapi

package
v8.18.0 Latest Latest
Warning

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

 Go to latest Published: Apr 17, 2025 License: Apache-2.0 Imports: 12 Imported by: 476

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://pkg.go.dev/github.com/elastic/go-elasticsearch, or locally by: 

go doc github.com/elastic/go-elasticsearch/v8/esapi Index
go doc github.com/elastic/go-elasticsearch/v8/esapi IndexRequest

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
	AutoscalingGetAutoscalingPolicy               AutoscalingGetAutoscalingPolicy
	AutoscalingPutAutoscalingPolicy               AutoscalingPutAutoscalingPolicy
	Bulk                                          Bulk
	Capabilities                                  Capabilities
	ClearScroll                                   ClearScroll
	ClosePointInTime                              ClosePointInTime
	ConnectorCheckIn                              ConnectorCheckIn
	ConnectorDelete                               ConnectorDelete
	ConnectorGet                                  ConnectorGet
	ConnectorLastSync                             ConnectorLastSync
	ConnectorList                                 ConnectorList
	ConnectorPost                                 ConnectorPost
	ConnectorPut                                  ConnectorPut
	ConnectorSecretDelete                         ConnectorSecretDelete
	ConnectorSecretGet                            ConnectorSecretGet
	ConnectorSecretPost                           ConnectorSecretPost
	ConnectorSecretPut                            ConnectorSecretPut
	ConnectorSyncJobCancel                        ConnectorSyncJobCancel
	ConnectorSyncJobCheckIn                       ConnectorSyncJobCheckIn
	ConnectorSyncJobClaim                         ConnectorSyncJobClaim
	ConnectorSyncJobDelete                        ConnectorSyncJobDelete
	ConnectorSyncJobError                         ConnectorSyncJobError
	ConnectorSyncJobGet                           ConnectorSyncJobGet
	ConnectorSyncJobList                          ConnectorSyncJobList
	ConnectorSyncJobPost                          ConnectorSyncJobPost
	ConnectorSyncJobUpdateStats                   ConnectorSyncJobUpdateStats
	ConnectorUpdateAPIKeyDocumentID               ConnectorUpdateAPIKeyDocumentID
	ConnectorUpdateActiveFiltering                ConnectorUpdateActiveFiltering
	ConnectorUpdateConfiguration                  ConnectorUpdateConfiguration
	ConnectorUpdateError                          ConnectorUpdateError
	ConnectorUpdateFeatures                       ConnectorUpdateFeatures
	ConnectorUpdateFiltering                      ConnectorUpdateFiltering
	ConnectorUpdateFilteringValidation            ConnectorUpdateFilteringValidation
	ConnectorUpdateIndexName                      ConnectorUpdateIndexName
	ConnectorUpdateName                           ConnectorUpdateName
	ConnectorUpdateNative                         ConnectorUpdateNative
	ConnectorUpdatePipeline                       ConnectorUpdatePipeline
	ConnectorUpdateScheduling                     ConnectorUpdateScheduling
	ConnectorUpdateServiceDocumentType            ConnectorUpdateServiceDocumentType
	ConnectorUpdateStatus                         ConnectorUpdateStatus
	Count                                         Count
	Create                                        Create
	DanglingIndicesDeleteDanglingIndex            DanglingIndicesDeleteDanglingIndex
	DanglingIndicesImportDanglingIndex            DanglingIndicesImportDanglingIndex
	DanglingIndicesListDanglingIndices            DanglingIndicesListDanglingIndices
	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
	EsqlAsyncQueryDelete                          EsqlAsyncQueryDelete
	EsqlAsyncQueryGet                             EsqlAsyncQueryGet
	EsqlAsyncQuery                                EsqlAsyncQuery
	EsqlAsyncQueryStop                            EsqlAsyncQueryStop
	EsqlQuery                                     EsqlQuery
	Exists                                        Exists
	ExistsSource                                  ExistsSource
	Explain                                       Explain
	FeaturesGetFeatures                           FeaturesGetFeatures
	FeaturesResetFeatures                         FeaturesResetFeatures
	FieldCaps                                     FieldCaps
	FleetDeleteSecret                             FleetDeleteSecret
	FleetGetSecret                                FleetGetSecret
	FleetGlobalCheckpoints                        FleetGlobalCheckpoints
	FleetMsearch                                  FleetMsearch
	FleetPostSecret                               FleetPostSecret
	FleetSearch                                   FleetSearch
	Get                                           Get
	GetScriptContext                              GetScriptContext
	GetScriptLanguages                            GetScriptLanguages
	GetScript                                     GetScript
	GetSource                                     GetSource
	GraphExplore                                  GraphExplore
	HealthReport                                  HealthReport
	Index                                         Index
	InferenceChatCompletionUnified                InferenceChatCompletionUnified
	InferenceCompletion                           InferenceCompletion
	InferenceDelete                               InferenceDelete
	InferenceGet                                  InferenceGet
	InferenceInference                            InferenceInference
	InferencePutAlibabacloud                      InferencePutAlibabacloud
	InferencePutAmazonbedrock                     InferencePutAmazonbedrock
	InferencePutAnthropic                         InferencePutAnthropic
	InferencePutAzureaistudio                     InferencePutAzureaistudio
	InferencePutAzureopenai                       InferencePutAzureopenai
	InferencePutCohere                            InferencePutCohere
	InferencePutElasticsearch                     InferencePutElasticsearch
	InferencePutElser                             InferencePutElser
	InferencePutGoogleaistudio                    InferencePutGoogleaistudio
	InferencePutGooglevertexai                    InferencePutGooglevertexai
	InferencePutHuggingFace                       InferencePutHuggingFace
	InferencePutJinaai                            InferencePutJinaai
	InferencePutMistral                           InferencePutMistral
	InferencePutOpenai                            InferencePutOpenai
	InferencePut                                  InferencePut
	InferencePutVoyageai                          InferencePutVoyageai
	InferencePutWatsonx                           InferencePutWatsonx
	InferenceRerank                               InferenceRerank
	InferenceSparseEmbedding                      InferenceSparseEmbedding
	InferenceStreamCompletion                     InferenceStreamCompletion
	InferenceTextEmbedding                        InferenceTextEmbedding
	InferenceUpdate                               InferenceUpdate
	Info                                          Info
	KnnSearch                                     KnnSearch
	LogstashDeletePipeline                        LogstashDeletePipeline
	LogstashGetPipeline                           LogstashGetPipeline
	LogstashPutPipeline                           LogstashPutPipeline
	Mget                                          Mget
	Msearch                                       Msearch
	MsearchTemplate                               MsearchTemplate
	Mtermvectors                                  Mtermvectors
	OpenPointInTime                               OpenPointInTime
	Ping                                          Ping
	ProfilingFlamegraph                           ProfilingFlamegraph
	ProfilingStacktraces                          ProfilingStacktraces
	ProfilingStatus                               ProfilingStatus
	ProfilingTopnFunctions                        ProfilingTopnFunctions
	PutScript                                     PutScript
	QueryRulesDeleteRule                          QueryRulesDeleteRule
	QueryRulesDeleteRuleset                       QueryRulesDeleteRuleset
	QueryRulesGetRule                             QueryRulesGetRule
	QueryRulesGetRuleset                          QueryRulesGetRuleset
	QueryRulesListRulesets                        QueryRulesListRulesets
	QueryRulesPutRule                             QueryRulesPutRule
	QueryRulesPutRuleset                          QueryRulesPutRuleset
	QueryRulesTest                                QueryRulesTest
	RankEval                                      RankEval
	Reindex                                       Reindex
	ReindexRethrottle                             ReindexRethrottle
	RenderSearchTemplate                          RenderSearchTemplate
	ScriptsPainlessExecute                        ScriptsPainlessExecute
	Scroll                                        Scroll
	SearchApplicationDeleteBehavioralAnalytics    SearchApplicationDeleteBehavioralAnalytics
	SearchApplicationDelete                       SearchApplicationDelete
	SearchApplicationGetBehavioralAnalytics       SearchApplicationGetBehavioralAnalytics
	SearchApplicationGet                          SearchApplicationGet
	SearchApplicationList                         SearchApplicationList
	SearchApplicationPostBehavioralAnalyticsEvent SearchApplicationPostBehavioralAnalyticsEvent
	SearchApplicationPutBehavioralAnalytics       SearchApplicationPutBehavioralAnalytics
	SearchApplicationPut                          SearchApplicationPut
	SearchApplicationRenderQuery                  SearchApplicationRenderQuery
	SearchApplicationSearch                       SearchApplicationSearch
	SearchMvt                                     SearchMvt
	Search                                        Search
	SearchShards                                  SearchShards
	SearchTemplate                                SearchTemplate
	SearchableSnapshotsCacheStats                 SearchableSnapshotsCacheStats
	SearchableSnapshotsClearCache                 SearchableSnapshotsClearCache
	SearchableSnapshotsMount                      SearchableSnapshotsMount
	SearchableSnapshotsStats                      SearchableSnapshotsStats
	ShutdownDeleteNode                            ShutdownDeleteNode
	ShutdownGetNode                               ShutdownGetNode
	ShutdownPutNode                               ShutdownPutNode
	SimulateIngest                                SimulateIngest
	SlmDeleteLifecycle                            SlmDeleteLifecycle
	SlmExecuteLifecycle                           SlmExecuteLifecycle
	SlmExecuteRetention                           SlmExecuteRetention
	SlmGetLifecycle                               SlmGetLifecycle
	SlmGetStats                                   SlmGetStats
	SlmGetStatus                                  SlmGetStatus
	SlmPutLifecycle                               SlmPutLifecycle
	SlmStart                                      SlmStart
	SlmStop                                       SlmStop
	SynonymsDeleteSynonym                         SynonymsDeleteSynonym
	SynonymsDeleteSynonymRule                     SynonymsDeleteSynonymRule
	SynonymsGetSynonym                            SynonymsGetSynonym
	SynonymsGetSynonymRule                        SynonymsGetSynonymRule
	SynonymsGetSynonymsSets                       SynonymsGetSynonymsSets
	SynonymsPutSynonym                            SynonymsPutSynonym
	SynonymsPutSynonymRule                        SynonymsPutSynonymRule
	TermsEnum                                     TermsEnum
	Termvectors                                   Termvectors
	TextStructureFindFieldStructure               TextStructureFindFieldStructure
	TextStructureFindMessageStructure             TextStructureFindMessageStructure
	TextStructureFindStructure                    TextStructureFindStructure
	TextStructureTestGrokPattern                  TextStructureTestGrokPattern
	TransformDeleteTransform                      TransformDeleteTransform
	TransformGetNodeStats                         TransformGetNodeStats
	TransformGetTransform                         TransformGetTransform
	TransformGetTransformStats                    TransformGetTransformStats
	TransformPreviewTransform                     TransformPreviewTransform
	TransformPutTransform                         TransformPutTransform
	TransformResetTransform                       TransformResetTransform
	TransformScheduleNowTransform                 TransformScheduleNowTransform
	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 ¶ 

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

AsyncSearch contains the AsyncSearch APIs

type AsyncSearchDelete ¶ 

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 ¶ 

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

WithContext sets the request context.

func (AsyncSearchDelete) WithErrorTrace ¶ 

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

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

func (AsyncSearchDelete) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (AsyncSearchDelete) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (AsyncSearchDelete) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (AsyncSearchDelete) WithOpaqueID ¶ 

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

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

func (AsyncSearchDelete) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

type AsyncSearchDeleteRequest ¶ 

type AsyncSearchDeleteRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

AsyncSearchDeleteRequest configures the Async Search Delete API request.

func (AsyncSearchDeleteRequest) Do ¶ 

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

Do executes the request and returns response or error.

type AsyncSearchGet ¶ 

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 ¶ 

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

WithContext sets the request context.

func (AsyncSearchGet) WithErrorTrace ¶ 

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

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

func (AsyncSearchGet) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (AsyncSearchGet) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (AsyncSearchGet) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (AsyncSearchGet) WithKeepAlive ¶ 

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 ¶ 

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

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

func (AsyncSearchGet) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

func (AsyncSearchGet) WithTypedKeys ¶ 

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 ¶ 

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 ¶ 

type AsyncSearchGetRequest struct {
	DocumentID string

	KeepAlive                time.Duration
	TypedKeys                *bool
	WaitForCompletionTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

AsyncSearchGetRequest configures the Async Search Get API request.

func (AsyncSearchGetRequest) Do ¶ 

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

Do executes the request and returns response or error.

type AsyncSearchStatus ¶ 

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 ¶ 

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

WithContext sets the request context.

func (AsyncSearchStatus) WithErrorTrace ¶ 

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

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

func (AsyncSearchStatus) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (AsyncSearchStatus) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (AsyncSearchStatus) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (AsyncSearchStatus) WithKeepAlive ¶ added in v8.13.0 

func (f AsyncSearchStatus) WithKeepAlive(v time.Duration) func(*AsyncSearchStatusRequest)

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

func (AsyncSearchStatus) WithOpaqueID ¶ 

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

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

func (AsyncSearchStatus) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

type AsyncSearchStatusRequest ¶ 

type AsyncSearchStatusRequest struct {
	DocumentID string

	KeepAlive time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

AsyncSearchStatusRequest configures the Async Search Status API request.

func (AsyncSearchStatusRequest) Do ¶ 

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

Do executes the request and returns response or error.

type AsyncSearchSubmit ¶ 

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 ¶ 

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 ¶ 

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 ¶ 

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

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

func (AsyncSearchSubmit) WithAnalyzer ¶ 

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

WithAnalyzer - the analyzer to use for the query string.

func (AsyncSearchSubmit) WithBatchedReduceSize ¶ 

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 ¶ 

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

WithBody - The search definition using the Query DSL.

func (AsyncSearchSubmit) WithCcsMinimizeRoundtrips ¶ added in v8.17.0 

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

WithCcsMinimizeRoundtrips - when doing a cross-cluster search, setting it to true may improve overall search latency, particularly when searching clusters with a large number of shards. however, when set to true, the progress of searches on the remote clusters will not be received until the search finishes on all clusters..

func (AsyncSearchSubmit) WithContext ¶ 

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

WithContext sets the request context.

func (AsyncSearchSubmit) WithDefaultOperator ¶ 

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

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

func (AsyncSearchSubmit) WithDf ¶ 

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 ¶ 

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 ¶ 

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

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

func (AsyncSearchSubmit) WithExpandWildcards ¶ 

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 ¶ 

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 ¶ 

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

WithFilterPath filters the properties of the response body.

func (AsyncSearchSubmit) WithFrom ¶ 

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

WithFrom - starting offset (default: 0).

func (AsyncSearchSubmit) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (AsyncSearchSubmit) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (AsyncSearchSubmit) WithIgnoreThrottled ¶ 

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

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

func (AsyncSearchSubmit) WithIgnoreUnavailable ¶ 

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

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

func (AsyncSearchSubmit) WithIndex ¶ 

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 ¶ 

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 ¶ 

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 ¶ 

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 ¶ 

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 ¶ 

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

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

func (AsyncSearchSubmit) WithPreference ¶ 

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 ¶ 

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

WithPretty makes the response body pretty-printed.

func (AsyncSearchSubmit) WithQuery ¶ 

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

WithQuery - query in the lucene query string syntax.

func (AsyncSearchSubmit) WithRequestCache ¶ 

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) WithRestTotalHitsAsInt ¶ added in v8.17.0 

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

WithRestTotalHitsAsInt - indicates whether hits.total should be rendered as an integer or an object in the rest search response.

func (AsyncSearchSubmit) WithRouting ¶ 

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

WithRouting - a list of specific routing values.

func (AsyncSearchSubmit) WithSearchType ¶ 

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

WithSearchType - search operation type.

func (AsyncSearchSubmit) WithSeqNoPrimaryTerm ¶ 

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 ¶ 

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

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

func (AsyncSearchSubmit) WithSort ¶ 

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

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

func (AsyncSearchSubmit) WithSource ¶ 

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 ¶ 

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

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

func (AsyncSearchSubmit) WithSourceIncludes ¶ 

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

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

func (AsyncSearchSubmit) WithStats ¶ 

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

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

func (AsyncSearchSubmit) WithStoredFields ¶ 

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

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

func (AsyncSearchSubmit) WithSuggestField ¶ 

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

WithSuggestField - specify which field to use for suggestions.

func (AsyncSearchSubmit) WithSuggestMode ¶ 

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

WithSuggestMode - specify suggest mode.

func (AsyncSearchSubmit) WithSuggestSize ¶ 

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

WithSuggestSize - how many suggestions to return in response.

func (AsyncSearchSubmit) WithSuggestText ¶ 

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

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

func (AsyncSearchSubmit) WithTerminateAfter ¶ 

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 ¶ 

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

WithTimeout - explicit operation timeout.

func (AsyncSearchSubmit) WithTrackScores ¶ 

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 ¶ 

func (f AsyncSearchSubmit) WithTrackTotalHits(v interface{}) func(*AsyncSearchSubmitRequest)

WithTrackTotalHits - indicate if the number of documents that match the query should be tracked. a number can also be specified, to accurately track the total hit count up to the number..

func (AsyncSearchSubmit) WithTypedKeys ¶ 

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 ¶ 

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

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

func (AsyncSearchSubmit) WithWaitForCompletionTimeout ¶ 

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 ¶ 

type AsyncSearchSubmitRequest struct {
	Index []string

	Body io.Reader

	AllowNoIndices             *bool
	AllowPartialSearchResults  *bool
	Analyzer                   string
	AnalyzeWildcard            *bool
	BatchedReduceSize          *int
	CcsMinimizeRoundtrips      *bool
	DefaultOperator            string
	Df                         string
	DocvalueFields             []string
	ExpandWildcards            string
	Explain                    *bool
	From                       *int
	IgnoreThrottled            *bool
	IgnoreUnavailable          *bool
	KeepAlive                  time.Duration
	KeepOnCompletion           *bool
	Lenient                    *bool
	MaxConcurrentShardRequests *int
	Preference                 string
	Query                      string
	RequestCache               *bool
	RestTotalHitsAsInt         *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             interface{}
	TypedKeys                  *bool
	Version                    *bool
	WaitForCompletionTimeout   time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

AsyncSearchSubmitRequest configures the Async Search Submit API request.

func (AsyncSearchSubmitRequest) Do ¶ 

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

Do executes the request and returns response or error.

type AutoscalingDeleteAutoscalingPolicy ¶ 

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 ¶ 

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

WithContext sets the request context.

func (AutoscalingDeleteAutoscalingPolicy) WithErrorTrace ¶ 

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

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

func (AutoscalingDeleteAutoscalingPolicy) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (AutoscalingDeleteAutoscalingPolicy) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (AutoscalingDeleteAutoscalingPolicy) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (AutoscalingDeleteAutoscalingPolicy) WithMasterTimeout ¶ added in v8.15.0 

func (f AutoscalingDeleteAutoscalingPolicy) WithMasterTimeout(v time.Duration) func(*AutoscalingDeleteAutoscalingPolicyRequest)

WithMasterTimeout - timeout for processing on master node.

func (AutoscalingDeleteAutoscalingPolicy) WithOpaqueID ¶ 

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

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

func (AutoscalingDeleteAutoscalingPolicy) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

func (AutoscalingDeleteAutoscalingPolicy) WithTimeout ¶ added in v8.15.0 

func (f AutoscalingDeleteAutoscalingPolicy) WithTimeout(v time.Duration) func(*AutoscalingDeleteAutoscalingPolicyRequest)

WithTimeout - timeout for acknowledgement of update from all nodes in cluster.

type AutoscalingDeleteAutoscalingPolicyRequest ¶ 

type AutoscalingDeleteAutoscalingPolicyRequest struct {
	Name string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

AutoscalingDeleteAutoscalingPolicyRequest configures the Autoscaling Delete Autoscaling Policy API request.

func (AutoscalingDeleteAutoscalingPolicyRequest) Do ¶ 

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

Do executes the request and returns response or error.

type AutoscalingGetAutoscalingCapacity ¶ 

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 ¶ 

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

WithContext sets the request context.

func (AutoscalingGetAutoscalingCapacity) WithErrorTrace ¶ 

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

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

func (AutoscalingGetAutoscalingCapacity) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (AutoscalingGetAutoscalingCapacity) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (AutoscalingGetAutoscalingCapacity) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (AutoscalingGetAutoscalingCapacity) WithMasterTimeout ¶ added in v8.15.0 

func (f AutoscalingGetAutoscalingCapacity) WithMasterTimeout(v time.Duration) func(*AutoscalingGetAutoscalingCapacityRequest)

WithMasterTimeout - timeout for processing on master node.

func (AutoscalingGetAutoscalingCapacity) WithOpaqueID ¶ 

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

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

func (AutoscalingGetAutoscalingCapacity) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

type AutoscalingGetAutoscalingCapacityRequest ¶ 

type AutoscalingGetAutoscalingCapacityRequest struct {
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

AutoscalingGetAutoscalingCapacityRequest configures the Autoscaling Get Autoscaling Capacity API request.

func (AutoscalingGetAutoscalingCapacityRequest) Do ¶ 

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

Do executes the request and returns response or error.

type AutoscalingGetAutoscalingPolicy ¶ 

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 ¶ 

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

WithContext sets the request context.

func (AutoscalingGetAutoscalingPolicy) WithErrorTrace ¶ 

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

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

func (AutoscalingGetAutoscalingPolicy) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (AutoscalingGetAutoscalingPolicy) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (AutoscalingGetAutoscalingPolicy) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (AutoscalingGetAutoscalingPolicy) WithMasterTimeout ¶ added in v8.15.0 

func (f AutoscalingGetAutoscalingPolicy) WithMasterTimeout(v time.Duration) func(*AutoscalingGetAutoscalingPolicyRequest)

WithMasterTimeout - timeout for processing on master node.

func (AutoscalingGetAutoscalingPolicy) WithOpaqueID ¶ 

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

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

func (AutoscalingGetAutoscalingPolicy) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

type AutoscalingGetAutoscalingPolicyRequest ¶ 

type AutoscalingGetAutoscalingPolicyRequest struct {
	Name string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

AutoscalingGetAutoscalingPolicyRequest configures the Autoscaling Get Autoscaling Policy API request.

func (AutoscalingGetAutoscalingPolicyRequest) Do ¶ 

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

Do executes the request and returns response or error.

type AutoscalingPutAutoscalingPolicy ¶ 

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 ¶ 

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

WithContext sets the request context.

func (AutoscalingPutAutoscalingPolicy) WithErrorTrace ¶ 

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

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

func (AutoscalingPutAutoscalingPolicy) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (AutoscalingPutAutoscalingPolicy) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (AutoscalingPutAutoscalingPolicy) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (AutoscalingPutAutoscalingPolicy) WithMasterTimeout ¶ added in v8.15.0 

func (f AutoscalingPutAutoscalingPolicy) WithMasterTimeout(v time.Duration) func(*AutoscalingPutAutoscalingPolicyRequest)

WithMasterTimeout - timeout for processing on master node.

func (AutoscalingPutAutoscalingPolicy) WithOpaqueID ¶ 

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

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

func (AutoscalingPutAutoscalingPolicy) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

func (AutoscalingPutAutoscalingPolicy) WithTimeout ¶ added in v8.15.0 

func (f AutoscalingPutAutoscalingPolicy) WithTimeout(v time.Duration) func(*AutoscalingPutAutoscalingPolicyRequest)

WithTimeout - timeout for acknowledgement of update from all nodes in cluster.

type AutoscalingPutAutoscalingPolicyRequest ¶ 

type AutoscalingPutAutoscalingPolicyRequest struct {
	Body io.Reader

	Name string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

AutoscalingPutAutoscalingPolicyRequest configures the Autoscaling Put Autoscaling Policy API request.

func (AutoscalingPutAutoscalingPolicyRequest) Do ¶ 

func (r AutoscalingPutAutoscalingPolicyRequest) Do(providedCtx 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 ¶ 

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) WithIncludeSourceOnError ¶ added in v8.18.0 

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

WithIncludeSourceOnError - true or false if to include the document source in the error message in case of parsing errors. defaults to true..

func (Bulk) WithIndex ¶ 

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

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

func (Bulk) WithListExecutedPipelines ¶ added in v8.12.0 

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

WithListExecutedPipelines - sets list_executed_pipelines for all incoming documents. defaults to unset (false).

func (Bulk) WithOpaqueID ¶ 

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 ¶ 

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

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

func (Bulk) WithRequireDataStream ¶ added in v8.13.0 

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

WithRequireDataStream - when true, requires the destination to be a data stream (existing or to-be-created). default is 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

	Body io.Reader

	IncludeSourceOnError  *bool
	ListExecutedPipelines *bool
	Pipeline              string
	Refresh               string
	RequireAlias          *bool
	RequireDataStream     *bool
	Routing               string
	Source                []string
	SourceExcludes        []string
	SourceIncludes        []string
	Timeout               time.Duration
	DocumentType          string
	WaitForActiveShards   string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

BulkRequest configures the Bulk API request.

func (BulkRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CCR ¶ 

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 ¶ 

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 ¶ 

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

WithContext sets the request context.

func (CCRDeleteAutoFollowPattern) WithErrorTrace ¶ 

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

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

func (CCRDeleteAutoFollowPattern) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CCRDeleteAutoFollowPattern) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CCRDeleteAutoFollowPattern) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CCRDeleteAutoFollowPattern) WithMasterTimeout ¶ added in v8.14.0 

func (f CCRDeleteAutoFollowPattern) WithMasterTimeout(v time.Duration) func(*CCRDeleteAutoFollowPatternRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CCRDeleteAutoFollowPattern) WithOpaqueID ¶ 

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

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

func (CCRDeleteAutoFollowPattern) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

type CCRDeleteAutoFollowPatternRequest ¶ 

type CCRDeleteAutoFollowPatternRequest struct {
	Name string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CCRDeleteAutoFollowPatternRequest configures the CCR Delete Auto Follow Pattern API request.

func (CCRDeleteAutoFollowPatternRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CCRFollow ¶ 

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 ¶ 

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

WithContext sets the request context.

func (CCRFollow) WithErrorTrace ¶ 

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

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

func (CCRFollow) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CCRFollow) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CCRFollow) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CCRFollow) WithMasterTimeout ¶ added in v8.14.0 

func (f CCRFollow) WithMasterTimeout(v time.Duration) func(*CCRFollowRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CCRFollow) WithOpaqueID ¶ 

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

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

func (CCRFollow) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

func (CCRFollow) WithWaitForActiveShards ¶ 

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 ¶ 

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 ¶ 

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

WithContext sets the request context.

func (CCRFollowInfo) WithErrorTrace ¶ 

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

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

func (CCRFollowInfo) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CCRFollowInfo) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CCRFollowInfo) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CCRFollowInfo) WithMasterTimeout ¶ added in v8.14.0 

func (f CCRFollowInfo) WithMasterTimeout(v time.Duration) func(*CCRFollowInfoRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CCRFollowInfo) WithOpaqueID ¶ 

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

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

func (CCRFollowInfo) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

type CCRFollowInfoRequest ¶ 

type CCRFollowInfoRequest struct {
	Index []string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CCRFollowInfoRequest configures the CCR Follow Info API request.

func (CCRFollowInfoRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CCRFollowRequest ¶ 

type CCRFollowRequest struct {
	Index string

	Body io.Reader

	MasterTimeout       time.Duration
	WaitForActiveShards string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CCRFollowRequest configures the CCR Follow API request.

func (CCRFollowRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CCRFollowStats ¶ 

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 ¶ 

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

WithContext sets the request context.

func (CCRFollowStats) WithErrorTrace ¶ 

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

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

func (CCRFollowStats) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CCRFollowStats) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CCRFollowStats) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CCRFollowStats) WithOpaqueID ¶ 

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

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

func (CCRFollowStats) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

func (CCRFollowStats) WithTimeout ¶ added in v8.14.0 

func (f CCRFollowStats) WithTimeout(v time.Duration) func(*CCRFollowStatsRequest)

WithTimeout - explicit operation timeout.

type CCRFollowStatsRequest ¶ 

type CCRFollowStatsRequest struct {
	Index []string

	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CCRFollowStatsRequest configures the CCR Follow Stats API request.

func (CCRFollowStatsRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CCRForgetFollower ¶ 

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 ¶ 

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

WithContext sets the request context.

func (CCRForgetFollower) WithErrorTrace ¶ 

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

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

func (CCRForgetFollower) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CCRForgetFollower) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CCRForgetFollower) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CCRForgetFollower) WithOpaqueID ¶ 

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

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

func (CCRForgetFollower) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

func (CCRForgetFollower) WithTimeout ¶ added in v8.14.0 

func (f CCRForgetFollower) WithTimeout(v time.Duration) func(*CCRForgetFollowerRequest)

WithTimeout - explicit operation timeout.

type CCRForgetFollowerRequest ¶ 

type CCRForgetFollowerRequest struct {
	Index string

	Body io.Reader

	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CCRForgetFollowerRequest configures the CCR Forget Follower API request.

func (CCRForgetFollowerRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CCRGetAutoFollowPattern ¶ 

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 ¶ 

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

WithContext sets the request context.

func (CCRGetAutoFollowPattern) WithErrorTrace ¶ 

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

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

func (CCRGetAutoFollowPattern) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CCRGetAutoFollowPattern) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CCRGetAutoFollowPattern) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CCRGetAutoFollowPattern) WithMasterTimeout ¶ added in v8.14.0 

func (f CCRGetAutoFollowPattern) WithMasterTimeout(v time.Duration) func(*CCRGetAutoFollowPatternRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CCRGetAutoFollowPattern) WithName ¶ 

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

WithName - the name of the auto follow pattern..

func (CCRGetAutoFollowPattern) WithOpaqueID ¶ 

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

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

func (CCRGetAutoFollowPattern) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

type CCRGetAutoFollowPatternRequest ¶ 

type CCRGetAutoFollowPatternRequest struct {
	Name string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CCRGetAutoFollowPatternRequest configures the CCR Get Auto Follow Pattern API request.

func (CCRGetAutoFollowPatternRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CCRPauseAutoFollowPattern ¶ 

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 ¶ 

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

WithContext sets the request context.

func (CCRPauseAutoFollowPattern) WithErrorTrace ¶ 

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

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

func (CCRPauseAutoFollowPattern) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CCRPauseAutoFollowPattern) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CCRPauseAutoFollowPattern) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CCRPauseAutoFollowPattern) WithMasterTimeout ¶ added in v8.14.0 

func (f CCRPauseAutoFollowPattern) WithMasterTimeout(v time.Duration) func(*CCRPauseAutoFollowPatternRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CCRPauseAutoFollowPattern) WithOpaqueID ¶ 

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

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

func (CCRPauseAutoFollowPattern) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

type CCRPauseAutoFollowPatternRequest ¶ 

type CCRPauseAutoFollowPatternRequest struct {
	Name string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CCRPauseAutoFollowPatternRequest configures the CCR Pause Auto Follow Pattern API request.

func (CCRPauseAutoFollowPatternRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CCRPauseFollow ¶ 

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 ¶ 

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

WithContext sets the request context.

func (CCRPauseFollow) WithErrorTrace ¶ 

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

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

func (CCRPauseFollow) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CCRPauseFollow) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CCRPauseFollow) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CCRPauseFollow) WithMasterTimeout ¶ added in v8.14.0 

func (f CCRPauseFollow) WithMasterTimeout(v time.Duration) func(*CCRPauseFollowRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CCRPauseFollow) WithOpaqueID ¶ 

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

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

func (CCRPauseFollow) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

type CCRPauseFollowRequest ¶ 

type CCRPauseFollowRequest struct {
	Index string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CCRPauseFollowRequest configures the CCR Pause Follow API request.

func (CCRPauseFollowRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CCRPutAutoFollowPattern ¶ 

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 ¶ 

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

WithContext sets the request context.

func (CCRPutAutoFollowPattern) WithErrorTrace ¶ 

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

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

func (CCRPutAutoFollowPattern) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CCRPutAutoFollowPattern) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CCRPutAutoFollowPattern) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CCRPutAutoFollowPattern) WithMasterTimeout ¶ added in v8.14.0 

func (f CCRPutAutoFollowPattern) WithMasterTimeout(v time.Duration) func(*CCRPutAutoFollowPatternRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CCRPutAutoFollowPattern) WithOpaqueID ¶ 

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

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

func (CCRPutAutoFollowPattern) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

type CCRPutAutoFollowPatternRequest ¶ 

type CCRPutAutoFollowPatternRequest struct {
	Body io.Reader

	Name string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CCRPutAutoFollowPatternRequest configures the CCR Put Auto Follow Pattern API request.

func (CCRPutAutoFollowPatternRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CCRResumeAutoFollowPattern ¶ 

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 ¶ 

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

WithContext sets the request context.

func (CCRResumeAutoFollowPattern) WithErrorTrace ¶ 

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

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

func (CCRResumeAutoFollowPattern) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CCRResumeAutoFollowPattern) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CCRResumeAutoFollowPattern) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CCRResumeAutoFollowPattern) WithMasterTimeout ¶ added in v8.14.0 

func (f CCRResumeAutoFollowPattern) WithMasterTimeout(v time.Duration) func(*CCRResumeAutoFollowPatternRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CCRResumeAutoFollowPattern) WithOpaqueID ¶ 

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

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

func (CCRResumeAutoFollowPattern) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

type CCRResumeAutoFollowPatternRequest ¶ 

type CCRResumeAutoFollowPatternRequest struct {
	Name string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CCRResumeAutoFollowPatternRequest configures the CCR Resume Auto Follow Pattern API request.

func (CCRResumeAutoFollowPatternRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CCRResumeFollow ¶ 

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 ¶ 

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 ¶ 

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

WithContext sets the request context.

func (CCRResumeFollow) WithErrorTrace ¶ 

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

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

func (CCRResumeFollow) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CCRResumeFollow) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CCRResumeFollow) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CCRResumeFollow) WithMasterTimeout ¶ added in v8.14.0 

func (f CCRResumeFollow) WithMasterTimeout(v time.Duration) func(*CCRResumeFollowRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CCRResumeFollow) WithOpaqueID ¶ 

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

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

func (CCRResumeFollow) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

type CCRResumeFollowRequest ¶ 

type CCRResumeFollowRequest struct {
	Index string

	Body io.Reader

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CCRResumeFollowRequest configures the CCR Resume Follow API request.

func (CCRResumeFollowRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CCRStats ¶ 

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 ¶ 

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

WithContext sets the request context.

func (CCRStats) WithErrorTrace ¶ 

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

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

func (CCRStats) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CCRStats) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CCRStats) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CCRStats) WithMasterTimeout ¶ added in v8.14.0 

func (f CCRStats) WithMasterTimeout(v time.Duration) func(*CCRStatsRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CCRStats) WithOpaqueID ¶ 

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

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

func (CCRStats) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

func (CCRStats) WithTimeout ¶ added in v8.14.0 

func (f CCRStats) WithTimeout(v time.Duration) func(*CCRStatsRequest)

WithTimeout - explicit operation timeout.

type CCRStatsRequest ¶ 

type CCRStatsRequest struct {
	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CCRStatsRequest configures the CCR Stats API request.

func (CCRStatsRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CCRUnfollow ¶ 

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 ¶ 

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

WithContext sets the request context.

func (CCRUnfollow) WithErrorTrace ¶ 

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

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

func (CCRUnfollow) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CCRUnfollow) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CCRUnfollow) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CCRUnfollow) WithMasterTimeout ¶ added in v8.14.0 

func (f CCRUnfollow) WithMasterTimeout(v time.Duration) func(*CCRUnfollowRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CCRUnfollow) WithOpaqueID ¶ 

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

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

func (CCRUnfollow) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

type CCRUnfollowRequest ¶ 

type CCRUnfollowRequest struct {
	Index string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CCRUnfollowRequest configures the CCR Unfollow API request.

func (CCRUnfollowRequest) Do ¶ 

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

Do executes the request and returns response or error.

type Capabilities ¶ added in v8.15.0 

type Capabilities func(o ...func(*CapabilitiesRequest)) (*Response, error)

Capabilities checks if the specified combination of method, API, parameters, and arbitrary capabilities are supported

This API is experimental.

See full documentation at https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/README.asciidoc#require-or-skip-api-capabilities.

func (Capabilities) WithCapabilities ¶ added in v8.15.0 

func (f Capabilities) WithCapabilities(v string) func(*CapabilitiesRequest)

WithCapabilities - comma-separated list of arbitrary api capabilities to check.

func (Capabilities) WithContext ¶ added in v8.15.0 

func (f Capabilities) WithContext(v context.Context) func(*CapabilitiesRequest)

WithContext sets the request context.

func (Capabilities) WithErrorTrace ¶ added in v8.15.0 

func (f Capabilities) WithErrorTrace() func(*CapabilitiesRequest)

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

func (Capabilities) WithFilterPath ¶ added in v8.15.0 

func (f Capabilities) WithFilterPath(v ...string) func(*CapabilitiesRequest)

WithFilterPath filters the properties of the response body.

func (Capabilities) WithHeader ¶ added in v8.15.0 

func (f Capabilities) WithHeader(h map[string]string) func(*CapabilitiesRequest)

WithHeader adds the headers to the HTTP request.

func (Capabilities) WithHuman ¶ added in v8.15.0 

func (f Capabilities) WithHuman() func(*CapabilitiesRequest)

WithHuman makes statistical values human-readable.

func (Capabilities) WithLocalOnly ¶ added in v8.16.0 

func (f Capabilities) WithLocalOnly(v bool) func(*CapabilitiesRequest)

WithLocalOnly - true if only the node being called should be considered.

func (Capabilities) WithMethod ¶ added in v8.15.0 

func (f Capabilities) WithMethod(v string) func(*CapabilitiesRequest)

WithMethod - rest method to check.

func (Capabilities) WithOpaqueID ¶ added in v8.15.0 

func (f Capabilities) WithOpaqueID(s string) func(*CapabilitiesRequest)

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

func (Capabilities) WithParameters ¶ added in v8.15.0 

func (f Capabilities) WithParameters(v string) func(*CapabilitiesRequest)

WithParameters - comma-separated list of api parameters to check.

func (Capabilities) WithPath ¶ added in v8.15.0 

func (f Capabilities) WithPath(v string) func(*CapabilitiesRequest)

WithPath - api path to check.

func (Capabilities) WithPretty ¶ added in v8.15.0 

func (f Capabilities) WithPretty() func(*CapabilitiesRequest)

WithPretty makes the response body pretty-printed.

type CapabilitiesRequest ¶ added in v8.15.0 

type CapabilitiesRequest struct {
	Capabilities string
	LocalOnly    *bool
	Method       string
	Parameters   string
	Path         string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CapabilitiesRequest configures the Capabilities API request.

func (CapabilitiesRequest) Do ¶ added in v8.15.0 

func (r CapabilitiesRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Cat ¶ 

type Cat struct {
	Aliases              CatAliases
	Allocation           CatAllocation
	ComponentTemplates   CatComponentTemplates
	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 ¶ 

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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatAliasesRequest configures the Cat Aliases API request.

func (CatAliasesRequest) Do ¶ 

func (r CatAliasesRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatAllocationRequest configures the Cat Allocation API request.

func (CatAllocationRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CatComponentTemplates ¶ added in v8.2.0 

type CatComponentTemplates func(o ...func(*CatComponentTemplatesRequest)) (*Response, error)

CatComponentTemplates returns information about existing component_templates templates.

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

func (CatComponentTemplates) WithContext ¶ added in v8.2.0 

func (f CatComponentTemplates) WithContext(v context.Context) func(*CatComponentTemplatesRequest)

WithContext sets the request context.

func (CatComponentTemplates) WithErrorTrace ¶ added in v8.2.0 

func (f CatComponentTemplates) WithErrorTrace() func(*CatComponentTemplatesRequest)

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

func (CatComponentTemplates) WithFilterPath ¶ added in v8.2.0 

func (f CatComponentTemplates) WithFilterPath(v ...string) func(*CatComponentTemplatesRequest)

WithFilterPath filters the properties of the response body.

func (CatComponentTemplates) WithFormat ¶ added in v8.2.0 

func (f CatComponentTemplates) WithFormat(v string) func(*CatComponentTemplatesRequest)

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

func (CatComponentTemplates) WithH ¶ added in v8.2.0 

func (f CatComponentTemplates) WithH(v ...string) func(*CatComponentTemplatesRequest)

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

func (CatComponentTemplates) WithHeader ¶ added in v8.2.0 

func (f CatComponentTemplates) WithHeader(h map[string]string) func(*CatComponentTemplatesRequest)

WithHeader adds the headers to the HTTP request.

func (CatComponentTemplates) WithHelp ¶ added in v8.2.0 

func (f CatComponentTemplates) WithHelp(v bool) func(*CatComponentTemplatesRequest)

WithHelp - return help information.

func (CatComponentTemplates) WithHuman ¶ added in v8.2.0 

func (f CatComponentTemplates) WithHuman() func(*CatComponentTemplatesRequest)

WithHuman makes statistical values human-readable.

func (CatComponentTemplates) WithLocal ¶ added in v8.2.0 

func (f CatComponentTemplates) WithLocal(v bool) func(*CatComponentTemplatesRequest)

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

func (CatComponentTemplates) WithMasterTimeout ¶ added in v8.2.0 

func (f CatComponentTemplates) WithMasterTimeout(v time.Duration) func(*CatComponentTemplatesRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatComponentTemplates) WithName ¶ added in v8.2.0 

func (f CatComponentTemplates) WithName(v string) func(*CatComponentTemplatesRequest)

WithName - a pattern that returned component template names must match.

func (CatComponentTemplates) WithOpaqueID ¶ added in v8.2.0 

func (f CatComponentTemplates) WithOpaqueID(s string) func(*CatComponentTemplatesRequest)

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

func (CatComponentTemplates) WithPretty ¶ added in v8.2.0 

func (f CatComponentTemplates) WithPretty() func(*CatComponentTemplatesRequest)

WithPretty makes the response body pretty-printed.

func (CatComponentTemplates) WithS ¶ added in v8.2.0 

func (f CatComponentTemplates) WithS(v ...string) func(*CatComponentTemplatesRequest)

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

func (CatComponentTemplates) WithV ¶ added in v8.2.0 

func (f CatComponentTemplates) WithV(v bool) func(*CatComponentTemplatesRequest)

WithV - verbose mode. display column headers.

type CatComponentTemplatesRequest ¶ added in v8.2.0 

type CatComponentTemplatesRequest 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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatComponentTemplatesRequest configures the Cat Component Templates API request.

func (CatComponentTemplatesRequest) Do ¶ added in v8.2.0 

func (r CatComponentTemplatesRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatCountRequest configures the Cat Count API request.

func (CatCountRequest) Do ¶ 

func (r CatCountRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatFielddataRequest configures the Cat Fielddata API request.

func (CatFielddataRequest) Do ¶ 

func (r CatFielddataRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatHealthRequest configures the Cat Health API request.

func (CatHealthRequest) Do ¶ 

func (r CatHealthRequest) Do(providedCtx 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 ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CatHelp) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CatHelp) WithOpaqueID ¶ 

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.

type CatHelpRequest ¶ 

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

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatHelpRequest configures the Cat Help API request.

func (CatHelpRequest) Do ¶ 

func (r CatHelpRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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 ¶ 

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) WithMasterTimeout ¶ 

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

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatIndices) WithOpaqueID ¶ 

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 ¶ 

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
	MasterTimeout           time.Duration
	Pri                     *bool
	S                       []string
	Time                    string
	V                       *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatIndicesRequest configures the Cat Indices API request.

func (CatIndicesRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CatMLDataFrameAnalytics ¶ 

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 ¶ 

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 ¶ 

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

WithBytes - the unit in which to display byte values.

func (CatMLDataFrameAnalytics) WithContext ¶ 

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

WithContext sets the request context.

func (CatMLDataFrameAnalytics) WithDocumentID ¶ 

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

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

func (CatMLDataFrameAnalytics) WithErrorTrace ¶ 

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

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

func (CatMLDataFrameAnalytics) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CatMLDataFrameAnalytics) WithFormat ¶ 

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

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

func (CatMLDataFrameAnalytics) WithH ¶ 

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

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

func (CatMLDataFrameAnalytics) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CatMLDataFrameAnalytics) WithHelp ¶ 

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

WithHelp - return help information.

func (CatMLDataFrameAnalytics) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CatMLDataFrameAnalytics) WithOpaqueID ¶ 

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

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

func (CatMLDataFrameAnalytics) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

func (CatMLDataFrameAnalytics) WithS ¶ 

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

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

func (CatMLDataFrameAnalytics) WithTime ¶ 

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

WithTime - the unit in which to display time values.

func (CatMLDataFrameAnalytics) WithV ¶ 

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

WithV - verbose mode. display column headers.

type CatMLDataFrameAnalyticsRequest ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatMLDataFrameAnalyticsRequest configures the CatML Data Frame Analytics API request.

func (CatMLDataFrameAnalyticsRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CatMLDatafeeds ¶ 

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) WithAllowNoMatch ¶ 

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 ¶ 

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

WithContext sets the request context.

func (CatMLDatafeeds) WithDatafeedID ¶ 

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

WithDatafeedID - the ID of the datafeeds stats to fetch.

func (CatMLDatafeeds) WithErrorTrace ¶ 

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

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

func (CatMLDatafeeds) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CatMLDatafeeds) WithFormat ¶ 

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

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

func (CatMLDatafeeds) WithH ¶ 

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

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

func (CatMLDatafeeds) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CatMLDatafeeds) WithHelp ¶ 

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

WithHelp - return help information.

func (CatMLDatafeeds) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CatMLDatafeeds) WithOpaqueID ¶ 

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

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

func (CatMLDatafeeds) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

func (CatMLDatafeeds) WithS ¶ 

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

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

func (CatMLDatafeeds) WithTime ¶ 

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

WithTime - the unit in which to display time values.

func (CatMLDatafeeds) WithV ¶ 

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

WithV - verbose mode. display column headers.

type CatMLDatafeedsRequest ¶ 

type CatMLDatafeedsRequest struct {
	DatafeedID string

	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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatMLDatafeedsRequest configures the CatML Datafeeds API request.

func (CatMLDatafeedsRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CatMLJobs ¶ 

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) WithAllowNoMatch ¶ 

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 ¶ 

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

WithBytes - the unit in which to display byte values.

func (CatMLJobs) WithContext ¶ 

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

WithContext sets the request context.

func (CatMLJobs) WithErrorTrace ¶ 

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

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

func (CatMLJobs) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CatMLJobs) WithFormat ¶ 

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

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

func (CatMLJobs) WithH ¶ 

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

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

func (CatMLJobs) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CatMLJobs) WithHelp ¶ 

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

WithHelp - return help information.

func (CatMLJobs) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CatMLJobs) WithJobID ¶ 

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

WithJobID - the ID of the jobs stats to fetch.

func (CatMLJobs) WithOpaqueID ¶ 

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

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

func (CatMLJobs) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

func (CatMLJobs) WithS ¶ 

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

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

func (CatMLJobs) WithTime ¶ 

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

WithTime - the unit in which to display time values.

func (CatMLJobs) WithV ¶ 

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

WithV - verbose mode. display column headers.

type CatMLJobsRequest ¶ 

type CatMLJobsRequest struct {
	JobID 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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatMLJobsRequest configures the CatML Jobs API request.

func (CatMLJobsRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CatMLTrainedModels ¶ 

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 ¶ 

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 ¶ 

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

WithBytes - the unit in which to display byte values.

func (CatMLTrainedModels) WithContext ¶ 

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

WithContext sets the request context.

func (CatMLTrainedModels) WithErrorTrace ¶ 

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

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

func (CatMLTrainedModels) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CatMLTrainedModels) WithFormat ¶ 

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

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

func (CatMLTrainedModels) WithFrom ¶ 

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

WithFrom - skips a number of trained models.

func (CatMLTrainedModels) WithH ¶ 

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

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

func (CatMLTrainedModels) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CatMLTrainedModels) WithHelp ¶ 

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

WithHelp - return help information.

func (CatMLTrainedModels) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CatMLTrainedModels) WithModelID ¶ 

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

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

func (CatMLTrainedModels) WithOpaqueID ¶ 

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

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

func (CatMLTrainedModels) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

func (CatMLTrainedModels) WithS ¶ 

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

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

func (CatMLTrainedModels) WithSize ¶ 

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

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

func (CatMLTrainedModels) WithTime ¶ 

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

WithTime - the unit in which to display time values.

func (CatMLTrainedModels) WithV ¶ 

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

WithV - verbose mode. display column headers.

type CatMLTrainedModelsRequest ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatMLTrainedModelsRequest configures the CatML Trained Models API request.

func (CatMLTrainedModelsRequest) Do ¶ 

func (r CatMLTrainedModelsRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatMasterRequest configures the Cat Master API request.

func (CatMasterRequest) Do ¶ 

func (r CatMasterRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatNodeattrsRequest configures the Cat Nodeattrs API request.

func (CatNodeattrsRequest) Do ¶ 

func (r CatNodeattrsRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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 ¶ 

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) WithMasterTimeout ¶ 

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

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatNodes) WithOpaqueID ¶ 

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 ¶ 

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
	MasterTimeout           time.Duration
	S                       []string
	Time                    string
	V                       *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatNodesRequest configures the Cat Nodes API request.

func (CatNodesRequest) Do ¶ 

func (r CatNodesRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatPendingTasksRequest configures the Cat Pending Tasks API request.

func (CatPendingTasksRequest) Do ¶ 

func (r CatPendingTasksRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatPluginsRequest configures the Cat Plugins API request.

func (CatPluginsRequest) Do ¶ 

func (r CatPluginsRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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 ¶ 

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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatRecoveryRequest configures the Cat Recovery API request.

func (CatRecoveryRequest) Do ¶ 

func (r CatRecoveryRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatRepositoriesRequest configures the Cat Repositories API request.

func (CatRepositoriesRequest) Do ¶ 

func (r CatRepositoriesRequest) Do(providedCtx 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 ¶ 

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) WithLocal ¶ added in v8.18.0 

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

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

func (CatSegments) WithMasterTimeout ¶ added in v8.18.0 

func (f CatSegments) WithMasterTimeout(v time.Duration) func(*CatSegmentsRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatSegments) WithOpaqueID ¶ 

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
	Local         *bool
	MasterTimeout time.Duration
	S             []string
	V             *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatSegmentsRequest configures the Cat Segments API request.

func (CatSegmentsRequest) Do ¶ 

func (r CatSegmentsRequest) Do(providedCtx 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 ¶ 

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) WithMasterTimeout ¶ 

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

WithMasterTimeout - explicit operation timeout for connection to master node.

func (CatShards) WithOpaqueID ¶ 

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 ¶ 

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
	MasterTimeout time.Duration
	S             []string
	Time          string
	V             *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatShardsRequest configures the Cat Shards API request.

func (CatShardsRequest) Do ¶ 

func (r CatShardsRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatSnapshotsRequest configures the Cat Snapshots API request.

func (CatSnapshotsRequest) Do ¶ 

func (r CatSnapshotsRequest) Do(providedCtx 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.

This API is experimental.

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 ¶ 

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 ¶ 

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 ¶ 

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

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

func (CatTasks) WithParentTaskID ¶ 

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 ¶ 

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

WithTime - the unit in which to display time values.

func (CatTasks) WithTimeout ¶ added in v8.18.0 

func (f CatTasks) WithTimeout(v time.Duration) func(*CatTasksRequest)

WithTimeout - period to wait for a response. if no response is received before the timeout expires, the request fails and returns an error..

func (CatTasks) WithV ¶ 

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

WithV - verbose mode. display column headers.

func (CatTasks) WithWaitForCompletion ¶ added in v8.18.0 

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

WithWaitForCompletion - if `true`, the request blocks until the task has completed..

type CatTasksRequest ¶ 

type CatTasksRequest struct {
	Actions           []string
	Detailed          *bool
	Format            string
	H                 []string
	Help              *bool
	Nodes             []string
	ParentTaskID      string
	S                 []string
	Time              string
	Timeout           time.Duration
	V                 *bool
	WaitForCompletion *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatTasksRequest configures the Cat Tasks API request.

func (CatTasksRequest) Do ¶ 

func (r CatTasksRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatTemplatesRequest configures the Cat Templates API request.

func (CatTemplatesRequest) Do ¶ 

func (r CatTemplatesRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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) 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) WithTime ¶ 

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

WithTime - the unit in which to display time values.

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
	Time          string
	V             *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatThreadPoolRequest configures the Cat Thread Pool API request.

func (CatThreadPoolRequest) Do ¶ 

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

Do executes the request and returns response or error.

type CatTransforms ¶ 

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 ¶ 

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 ¶ 

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

WithContext sets the request context.

func (CatTransforms) WithErrorTrace ¶ 

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

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

func (CatTransforms) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (CatTransforms) WithFormat ¶ 

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

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

func (CatTransforms) WithFrom ¶ 

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

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

func (CatTransforms) WithH ¶ 

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

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

func (CatTransforms) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (CatTransforms) WithHelp ¶ 

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

WithHelp - return help information.

func (CatTransforms) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (CatTransforms) WithOpaqueID ¶ 

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

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

func (CatTransforms) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

func (CatTransforms) WithS ¶ 

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

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

func (CatTransforms) WithSize ¶ 

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

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

func (CatTransforms) WithTime ¶ 

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

WithTime - the unit in which to display time values.

func (CatTransforms) WithTransformID ¶ 

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 ¶ 

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

WithV - verbose mode. display column headers.

type CatTransformsRequest ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CatTransformsRequest configures the Cat Transforms API request.

func (CatTransformsRequest) Do ¶ 

func (r CatTransformsRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClearScrollRequest configures the Clear Scroll API request.

func (ClearScrollRequest) Do ¶ 

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

Do executes the request and returns response or error.

type ClosePointInTime ¶ 

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 ¶ 

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

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

func (ClosePointInTime) WithContext ¶ 

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

WithContext sets the request context.

func (ClosePointInTime) WithErrorTrace ¶ 

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

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

func (ClosePointInTime) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (ClosePointInTime) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (ClosePointInTime) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (ClosePointInTime) WithOpaqueID ¶ 

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

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

func (ClosePointInTime) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

type ClosePointInTimeRequest ¶ 

type ClosePointInTimeRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClosePointInTimeRequest configures the Close Point In Time API request.

func (ClosePointInTimeRequest) Do ¶ 

func (r ClosePointInTimeRequest) Do(providedCtx 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
	Info                         ClusterInfo
	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 ¶ 

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) WithMasterTimeout ¶ added in v8.15.0 

func (f ClusterAllocationExplain) WithMasterTimeout(v time.Duration) func(*ClusterAllocationExplainRequest)

WithMasterTimeout - timeout for connection to master node.

func (ClusterAllocationExplain) WithOpaqueID ¶ 

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
	MasterTimeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClusterAllocationExplainRequest configures the Cluster Allocation Explain API request.

func (ClusterAllocationExplainRequest) Do ¶ 

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

Do executes the request and returns response or error.

type ClusterDeleteComponentTemplate ¶ 

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 ¶ 

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

WithContext sets the request context.

func (ClusterDeleteComponentTemplate) WithErrorTrace ¶ 

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

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

func (ClusterDeleteComponentTemplate) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (ClusterDeleteComponentTemplate) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (ClusterDeleteComponentTemplate) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (ClusterDeleteComponentTemplate) WithMasterTimeout ¶ 

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

WithMasterTimeout - specify timeout for connection to master.

func (ClusterDeleteComponentTemplate) WithOpaqueID ¶ 

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

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

func (ClusterDeleteComponentTemplate) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

func (ClusterDeleteComponentTemplate) WithTimeout ¶ 

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

WithTimeout - explicit operation timeout.

type ClusterDeleteComponentTemplateRequest ¶ 

type ClusterDeleteComponentTemplateRequest struct {
	Name string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClusterDeleteComponentTemplateRequest configures the Cluster Delete Component Template API request.

func (ClusterDeleteComponentTemplateRequest) Do ¶ 

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

Do executes the request and returns response or error.

type ClusterDeleteVotingConfigExclusions ¶ 

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 ¶ 

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

WithContext sets the request context.

func (ClusterDeleteVotingConfigExclusions) WithErrorTrace ¶ 

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

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

func (ClusterDeleteVotingConfigExclusions) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (ClusterDeleteVotingConfigExclusions) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (ClusterDeleteVotingConfigExclusions) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (ClusterDeleteVotingConfigExclusions) WithMasterTimeout ¶ added in v8.3.0 

func (f ClusterDeleteVotingConfigExclusions) WithMasterTimeout(v time.Duration) func(*ClusterDeleteVotingConfigExclusionsRequest)

WithMasterTimeout - timeout for submitting request to master.

func (ClusterDeleteVotingConfigExclusions) WithOpaqueID ¶ 

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

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

func (ClusterDeleteVotingConfigExclusions) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

func (ClusterDeleteVotingConfigExclusions) WithWaitForRemoval ¶ 

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 ¶ 

type ClusterDeleteVotingConfigExclusionsRequest struct {
	MasterTimeout  time.Duration
	WaitForRemoval *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClusterDeleteVotingConfigExclusionsRequest configures the Cluster Delete Voting Config Exclusions API request.

func (ClusterDeleteVotingConfigExclusionsRequest) Do ¶ 

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

Do executes the request and returns response or error.

type ClusterExistsComponentTemplate ¶ 

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 ¶ 

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

WithContext sets the request context.

func (ClusterExistsComponentTemplate) WithErrorTrace ¶ 

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

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

func (ClusterExistsComponentTemplate) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (ClusterExistsComponentTemplate) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (ClusterExistsComponentTemplate) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (ClusterExistsComponentTemplate) WithLocal ¶ 

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 ¶ 

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

WithMasterTimeout - explicit operation timeout for connection to master node.

func (ClusterExistsComponentTemplate) WithOpaqueID ¶ 

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

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

func (ClusterExistsComponentTemplate) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

type ClusterExistsComponentTemplateRequest ¶ 

type ClusterExistsComponentTemplateRequest struct {
	Name string

	Local         *bool
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClusterExistsComponentTemplateRequest configures the Cluster Exists Component Template API request.

func (ClusterExistsComponentTemplateRequest) Do ¶ 

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

Do executes the request and returns response or error.

type ClusterGetComponentTemplate ¶ 

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 ¶ 

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

WithContext sets the request context.

func (ClusterGetComponentTemplate) WithErrorTrace ¶ 

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

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

func (ClusterGetComponentTemplate) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (ClusterGetComponentTemplate) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (ClusterGetComponentTemplate) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (ClusterGetComponentTemplate) WithIncludeDefaults ¶ added in v8.8.0 

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

WithIncludeDefaults - return all default configurations for the component template (default: false).

func (ClusterGetComponentTemplate) WithLocal ¶ 

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 ¶ 

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

WithMasterTimeout - explicit operation timeout for connection to master node.

func (ClusterGetComponentTemplate) WithName ¶ 

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

WithName - the comma separated names of the component templates.

func (ClusterGetComponentTemplate) WithOpaqueID ¶ 

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

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

func (ClusterGetComponentTemplate) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

type ClusterGetComponentTemplateRequest ¶ 

type ClusterGetComponentTemplateRequest struct {
	Name []string

	IncludeDefaults *bool
	Local           *bool
	MasterTimeout   time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClusterGetComponentTemplateRequest configures the Cluster Get Component Template API request.

func (ClusterGetComponentTemplateRequest) Do ¶ 

func (r ClusterGetComponentTemplateRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClusterGetSettingsRequest configures the Cluster Get Settings API request.

func (ClusterGetSettingsRequest) Do ¶ 

func (r ClusterGetSettingsRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClusterHealthRequest configures the Cluster Health API request.

func (ClusterHealthRequest) Do ¶ 

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

Do executes the request and returns response or error.

type ClusterInfo ¶ added in v8.9.0 

type ClusterInfo func(target []string, o ...func(*ClusterInfoRequest)) (*Response, error)

ClusterInfo returns different information about the cluster.

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

func (ClusterInfo) WithContext ¶ added in v8.9.0 

func (f ClusterInfo) WithContext(v context.Context) func(*ClusterInfoRequest)

WithContext sets the request context.

func (ClusterInfo) WithErrorTrace ¶ added in v8.9.0 

func (f ClusterInfo) WithErrorTrace() func(*ClusterInfoRequest)

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

func (ClusterInfo) WithFilterPath ¶ added in v8.9.0 

func (f ClusterInfo) WithFilterPath(v ...string) func(*ClusterInfoRequest)

WithFilterPath filters the properties of the response body.

func (ClusterInfo) WithHeader ¶ added in v8.9.0 

func (f ClusterInfo) WithHeader(h map[string]string) func(*ClusterInfoRequest)

WithHeader adds the headers to the HTTP request.

func (ClusterInfo) WithHuman ¶ added in v8.9.0 

func (f ClusterInfo) WithHuman() func(*ClusterInfoRequest)

WithHuman makes statistical values human-readable.

func (ClusterInfo) WithOpaqueID ¶ added in v8.9.0 

func (f ClusterInfo) WithOpaqueID(s string) func(*ClusterInfoRequest)

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

func (ClusterInfo) WithPretty ¶ added in v8.9.0 

func (f ClusterInfo) WithPretty() func(*ClusterInfoRequest)

WithPretty makes the response body pretty-printed.

type ClusterInfoRequest ¶ added in v8.9.0 

type ClusterInfoRequest struct {
	Target []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClusterInfoRequest configures the Cluster Info API request.

func (ClusterInfoRequest) Do ¶ added in v8.9.0 

func (r ClusterInfoRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClusterPendingTasksRequest configures the Cluster Pending Tasks API request.

func (ClusterPendingTasksRequest) Do ¶ 

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

Do executes the request and returns response or error.

type ClusterPostVotingConfigExclusions ¶ 

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 ¶ 

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

WithContext sets the request context.

func (ClusterPostVotingConfigExclusions) WithErrorTrace ¶ 

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

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

func (ClusterPostVotingConfigExclusions) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (ClusterPostVotingConfigExclusions) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (ClusterPostVotingConfigExclusions) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (ClusterPostVotingConfigExclusions) WithMasterTimeout ¶ added in v8.3.0 

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

WithMasterTimeout - timeout for submitting request to master.

func (ClusterPostVotingConfigExclusions) WithNodeIds ¶ 

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 ¶ 

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 ¶ 

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

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

func (ClusterPostVotingConfigExclusions) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

func (ClusterPostVotingConfigExclusions) WithTimeout ¶ 

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

WithTimeout - explicit operation timeout.

type ClusterPostVotingConfigExclusionsRequest ¶ 

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

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClusterPostVotingConfigExclusionsRequest configures the Cluster Post Voting Config Exclusions API request.

func (ClusterPostVotingConfigExclusionsRequest) Do ¶ 

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

Do executes the request and returns response or error.

type ClusterPutComponentTemplate ¶ 

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 ¶ 

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

WithContext sets the request context.

func (ClusterPutComponentTemplate) WithCreate ¶ 

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 ¶ 

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

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

func (ClusterPutComponentTemplate) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (ClusterPutComponentTemplate) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (ClusterPutComponentTemplate) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (ClusterPutComponentTemplate) WithMasterTimeout ¶ 

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

WithMasterTimeout - specify timeout for connection to master.

func (ClusterPutComponentTemplate) WithOpaqueID ¶ 

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

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

func (ClusterPutComponentTemplate) WithPretty ¶ 

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

WithPretty makes the response body pretty-printed.

func (ClusterPutComponentTemplate) WithTimeout ¶ 

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

WithTimeout - explicit operation timeout.

type ClusterPutComponentTemplateRequest ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClusterPutComponentTemplateRequest configures the Cluster Put Component Template API request.

func (ClusterPutComponentTemplateRequest) Do ¶ 

func (r ClusterPutComponentTemplateRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClusterPutSettingsRequest configures the Cluster Put Settings API request.

func (ClusterPutSettingsRequest) Do ¶ 

func (r ClusterPutSettingsRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClusterRemoteInfoRequest configures the Cluster Remote Info API request.

func (ClusterRemoteInfoRequest) Do ¶ 

func (r ClusterRemoteInfoRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClusterRerouteRequest configures the Cluster Reroute API request.

func (ClusterRerouteRequest) Do ¶ 

func (r ClusterRerouteRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClusterStateRequest configures the Cluster State API request.

func (ClusterStateRequest) Do ¶ 

func (r ClusterStateRequest) Do(providedCtx 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) WithHeader ¶ 

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) WithIncludeRemotes ¶ added in v8.16.0 

func (f ClusterStats) WithIncludeRemotes(v bool) func(*ClusterStatsRequest)

WithIncludeRemotes - include remote cluster data into the response (default: false).

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 ¶ 

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

	IncludeRemotes *bool
	Timeout        time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ClusterStatsRequest configures the Cluster Stats API request.

func (ClusterStatsRequest) Do ¶ 

func (r ClusterStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorCheckIn ¶ added in v8.12.0 

type ConnectorCheckIn func(connector_id string, o ...func(*ConnectorCheckInRequest)) (*Response, error)

ConnectorCheckIn updates the last_seen timestamp in the connector document.

This API is experimental.

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

func (ConnectorCheckIn) WithContext ¶ added in v8.12.0 

func (f ConnectorCheckIn) WithContext(v context.Context) func(*ConnectorCheckInRequest)

WithContext sets the request context.

func (ConnectorCheckIn) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorCheckIn) WithErrorTrace() func(*ConnectorCheckInRequest)

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

func (ConnectorCheckIn) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorCheckIn) WithFilterPath(v ...string) func(*ConnectorCheckInRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorCheckIn) WithHeader ¶ added in v8.12.0 

func (f ConnectorCheckIn) WithHeader(h map[string]string) func(*ConnectorCheckInRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorCheckIn) WithHuman ¶ added in v8.12.0 

func (f ConnectorCheckIn) WithHuman() func(*ConnectorCheckInRequest)

WithHuman makes statistical values human-readable.

func (ConnectorCheckIn) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorCheckIn) WithOpaqueID(s string) func(*ConnectorCheckInRequest)

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

func (ConnectorCheckIn) WithPretty ¶ added in v8.12.0 

func (f ConnectorCheckIn) WithPretty() func(*ConnectorCheckInRequest)

WithPretty makes the response body pretty-printed.

type ConnectorCheckInRequest ¶ added in v8.12.0 

type ConnectorCheckInRequest struct {
	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorCheckInRequest configures the Connector Check In API request.

func (ConnectorCheckInRequest) Do ¶ added in v8.12.0 

func (r ConnectorCheckInRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorDelete ¶ added in v8.12.0 

type ConnectorDelete func(connector_id string, o ...func(*ConnectorDeleteRequest)) (*Response, error)

ConnectorDelete deletes a connector.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-connector-api.html.

func (ConnectorDelete) WithContext ¶ added in v8.12.0 

func (f ConnectorDelete) WithContext(v context.Context) func(*ConnectorDeleteRequest)

WithContext sets the request context.

func (ConnectorDelete) WithDeleteSyncJobs ¶ added in v8.14.0 

func (f ConnectorDelete) WithDeleteSyncJobs(v bool) func(*ConnectorDeleteRequest)

WithDeleteSyncJobs - determines whether associated sync jobs are also deleted..

func (ConnectorDelete) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorDelete) WithErrorTrace() func(*ConnectorDeleteRequest)

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

func (ConnectorDelete) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorDelete) WithFilterPath(v ...string) func(*ConnectorDeleteRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorDelete) WithHeader ¶ added in v8.12.0 

func (f ConnectorDelete) WithHeader(h map[string]string) func(*ConnectorDeleteRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorDelete) WithHuman ¶ added in v8.12.0 

func (f ConnectorDelete) WithHuman() func(*ConnectorDeleteRequest)

WithHuman makes statistical values human-readable.

func (ConnectorDelete) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorDelete) WithOpaqueID(s string) func(*ConnectorDeleteRequest)

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

func (ConnectorDelete) WithPretty ¶ added in v8.12.0 

func (f ConnectorDelete) WithPretty() func(*ConnectorDeleteRequest)

WithPretty makes the response body pretty-printed.

type ConnectorDeleteRequest ¶ added in v8.12.0 

type ConnectorDeleteRequest struct {
	ConnectorID string

	DeleteSyncJobs *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorDeleteRequest configures the Connector Delete API request.

func (ConnectorDeleteRequest) Do ¶ added in v8.12.0 

func (r ConnectorDeleteRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorGet ¶ added in v8.12.0 

type ConnectorGet func(connector_id string, o ...func(*ConnectorGetRequest)) (*Response, error)

ConnectorGet returns the details about a connector.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-connector-api.html.

func (ConnectorGet) WithContext ¶ added in v8.12.0 

func (f ConnectorGet) WithContext(v context.Context) func(*ConnectorGetRequest)

WithContext sets the request context.

func (ConnectorGet) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorGet) WithErrorTrace() func(*ConnectorGetRequest)

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

func (ConnectorGet) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorGet) WithFilterPath(v ...string) func(*ConnectorGetRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorGet) WithHeader ¶ added in v8.12.0 

func (f ConnectorGet) WithHeader(h map[string]string) func(*ConnectorGetRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorGet) WithHuman ¶ added in v8.12.0 

func (f ConnectorGet) WithHuman() func(*ConnectorGetRequest)

WithHuman makes statistical values human-readable.

func (ConnectorGet) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorGet) WithOpaqueID(s string) func(*ConnectorGetRequest)

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

func (ConnectorGet) WithPretty ¶ added in v8.12.0 

func (f ConnectorGet) WithPretty() func(*ConnectorGetRequest)

WithPretty makes the response body pretty-printed.

type ConnectorGetRequest ¶ added in v8.12.0 

type ConnectorGetRequest struct {
	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorGetRequest configures the Connector Get API request.

func (ConnectorGetRequest) Do ¶ added in v8.12.0 

func (r ConnectorGetRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorLastSync ¶ added in v8.12.0 

type ConnectorLastSync func(body io.Reader, connector_id string, o ...func(*ConnectorLastSyncRequest)) (*Response, error)

ConnectorLastSync updates the stats of last sync in the connector document.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-last-sync-api.html.

func (ConnectorLastSync) WithContext ¶ added in v8.12.0 

func (f ConnectorLastSync) WithContext(v context.Context) func(*ConnectorLastSyncRequest)

WithContext sets the request context.

func (ConnectorLastSync) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorLastSync) WithErrorTrace() func(*ConnectorLastSyncRequest)

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

func (ConnectorLastSync) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorLastSync) WithFilterPath(v ...string) func(*ConnectorLastSyncRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorLastSync) WithHeader ¶ added in v8.12.0 

func (f ConnectorLastSync) WithHeader(h map[string]string) func(*ConnectorLastSyncRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorLastSync) WithHuman ¶ added in v8.12.0 

func (f ConnectorLastSync) WithHuman() func(*ConnectorLastSyncRequest)

WithHuman makes statistical values human-readable.

func (ConnectorLastSync) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorLastSync) WithOpaqueID(s string) func(*ConnectorLastSyncRequest)

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

func (ConnectorLastSync) WithPretty ¶ added in v8.12.0 

func (f ConnectorLastSync) WithPretty() func(*ConnectorLastSyncRequest)

WithPretty makes the response body pretty-printed.

type ConnectorLastSyncRequest ¶ added in v8.12.0 

type ConnectorLastSyncRequest struct {
	Body io.Reader

	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorLastSyncRequest configures the Connector Last Sync API request.

func (ConnectorLastSyncRequest) Do ¶ added in v8.12.0 

func (r ConnectorLastSyncRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorList ¶ added in v8.12.0 

type ConnectorList func(o ...func(*ConnectorListRequest)) (*Response, error)

ConnectorList lists all connectors.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/list-connector-api.html.

func (ConnectorList) WithConnectorName ¶ added in v8.13.0 

func (f ConnectorList) WithConnectorName(v ...string) func(*ConnectorListRequest)

WithConnectorName - a list of connector names to fetch connector documents for.

func (ConnectorList) WithContext ¶ added in v8.12.0 

func (f ConnectorList) WithContext(v context.Context) func(*ConnectorListRequest)

WithContext sets the request context.

func (ConnectorList) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorList) WithErrorTrace() func(*ConnectorListRequest)

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

func (ConnectorList) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorList) WithFilterPath(v ...string) func(*ConnectorListRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorList) WithFrom ¶ added in v8.12.0 

func (f ConnectorList) WithFrom(v int) func(*ConnectorListRequest)

WithFrom - starting offset (default: 0).

func (ConnectorList) WithHeader ¶ added in v8.12.0 

func (f ConnectorList) WithHeader(h map[string]string) func(*ConnectorListRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorList) WithHuman ¶ added in v8.12.0 

func (f ConnectorList) WithHuman() func(*ConnectorListRequest)

WithHuman makes statistical values human-readable.

func (ConnectorList) WithIndexName ¶ added in v8.13.0 

func (f ConnectorList) WithIndexName(v ...string) func(*ConnectorListRequest)

WithIndexName - a list of connector index names to fetch connector documents for.

func (ConnectorList) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorList) WithOpaqueID(s string) func(*ConnectorListRequest)

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

func (ConnectorList) WithPretty ¶ added in v8.12.0 

func (f ConnectorList) WithPretty() func(*ConnectorListRequest)

WithPretty makes the response body pretty-printed.

func (ConnectorList) WithQuery ¶ added in v8.13.0 

func (f ConnectorList) WithQuery(v string) func(*ConnectorListRequest)

WithQuery - a search string for querying connectors, filtering results by matching against connector names, descriptions, and index names.

func (ConnectorList) WithServiceType ¶ added in v8.13.0 

func (f ConnectorList) WithServiceType(v ...string) func(*ConnectorListRequest)

WithServiceType - a list of connector service types to fetch connector documents for.

func (ConnectorList) WithSize ¶ added in v8.12.0 

func (f ConnectorList) WithSize(v int) func(*ConnectorListRequest)

WithSize - specifies a max number of results to get (default: 100).

type ConnectorListRequest ¶ added in v8.12.0 

type ConnectorListRequest struct {
	ConnectorName []string
	From          *int
	IndexName     []string
	Query         string
	ServiceType   []string
	Size          *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorListRequest configures the Connector List API request.

func (ConnectorListRequest) Do ¶ added in v8.12.0 

func (r ConnectorListRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorPost ¶ added in v8.12.0 

type ConnectorPost func(o ...func(*ConnectorPostRequest)) (*Response, error)

ConnectorPost creates a connector.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-api.html.

func (ConnectorPost) WithBody ¶ added in v8.15.0 

func (f ConnectorPost) WithBody(v io.Reader) func(*ConnectorPostRequest)

WithBody - The connector configuration..

func (ConnectorPost) WithContext ¶ added in v8.12.0 

func (f ConnectorPost) WithContext(v context.Context) func(*ConnectorPostRequest)

WithContext sets the request context.

func (ConnectorPost) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorPost) WithErrorTrace() func(*ConnectorPostRequest)

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

func (ConnectorPost) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorPost) WithFilterPath(v ...string) func(*ConnectorPostRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorPost) WithHeader ¶ added in v8.12.0 

func (f ConnectorPost) WithHeader(h map[string]string) func(*ConnectorPostRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorPost) WithHuman ¶ added in v8.12.0 

func (f ConnectorPost) WithHuman() func(*ConnectorPostRequest)

WithHuman makes statistical values human-readable.

func (ConnectorPost) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorPost) WithOpaqueID(s string) func(*ConnectorPostRequest)

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

func (ConnectorPost) WithPretty ¶ added in v8.12.0 

func (f ConnectorPost) WithPretty() func(*ConnectorPostRequest)

WithPretty makes the response body pretty-printed.

type ConnectorPostRequest ¶ added in v8.12.0 

type ConnectorPostRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorPostRequest configures the Connector Post API request.

func (ConnectorPostRequest) Do ¶ added in v8.12.0 

func (r ConnectorPostRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorPut ¶ added in v8.12.0 

type ConnectorPut func(o ...func(*ConnectorPutRequest)) (*Response, error)

ConnectorPut creates or updates a connector.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-api.html.

func (ConnectorPut) WithBody ¶ added in v8.15.0 

func (f ConnectorPut) WithBody(v io.Reader) func(*ConnectorPutRequest)

WithBody - The connector configuration..

func (ConnectorPut) WithConnectorID ¶ added in v8.15.0 

func (f ConnectorPut) WithConnectorID(v string) func(*ConnectorPutRequest)

WithConnectorID - the unique identifier of the connector to be created or updated..

func (ConnectorPut) WithContext ¶ added in v8.12.0 

func (f ConnectorPut) WithContext(v context.Context) func(*ConnectorPutRequest)

WithContext sets the request context.

func (ConnectorPut) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorPut) WithErrorTrace() func(*ConnectorPutRequest)

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

func (ConnectorPut) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorPut) WithFilterPath(v ...string) func(*ConnectorPutRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorPut) WithHeader ¶ added in v8.12.0 

func (f ConnectorPut) WithHeader(h map[string]string) func(*ConnectorPutRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorPut) WithHuman ¶ added in v8.12.0 

func (f ConnectorPut) WithHuman() func(*ConnectorPutRequest)

WithHuman makes statistical values human-readable.

func (ConnectorPut) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorPut) WithOpaqueID(s string) func(*ConnectorPutRequest)

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

func (ConnectorPut) WithPretty ¶ added in v8.12.0 

func (f ConnectorPut) WithPretty() func(*ConnectorPutRequest)

WithPretty makes the response body pretty-printed.

type ConnectorPutRequest ¶ added in v8.12.0 

type ConnectorPutRequest struct {
	Body io.Reader

	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorPutRequest configures the Connector Put API request.

func (ConnectorPutRequest) Do ¶ added in v8.12.0 

func (r ConnectorPutRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorSecretDelete ¶ added in v8.13.0 

type ConnectorSecretDelete func(id string, o ...func(*ConnectorSecretDeleteRequest)) (*Response, error)

ConnectorSecretDelete deletes a connector secret.

This API is experimental.

func (ConnectorSecretDelete) WithContext ¶ added in v8.13.0 

func (f ConnectorSecretDelete) WithContext(v context.Context) func(*ConnectorSecretDeleteRequest)

WithContext sets the request context.

func (ConnectorSecretDelete) WithErrorTrace ¶ added in v8.13.0 

func (f ConnectorSecretDelete) WithErrorTrace() func(*ConnectorSecretDeleteRequest)

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

func (ConnectorSecretDelete) WithFilterPath ¶ added in v8.13.0 

func (f ConnectorSecretDelete) WithFilterPath(v ...string) func(*ConnectorSecretDeleteRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorSecretDelete) WithHeader ¶ added in v8.13.0 

func (f ConnectorSecretDelete) WithHeader(h map[string]string) func(*ConnectorSecretDeleteRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorSecretDelete) WithHuman ¶ added in v8.13.0 

func (f ConnectorSecretDelete) WithHuman() func(*ConnectorSecretDeleteRequest)

WithHuman makes statistical values human-readable.

func (ConnectorSecretDelete) WithOpaqueID ¶ added in v8.13.0 

func (f ConnectorSecretDelete) WithOpaqueID(s string) func(*ConnectorSecretDeleteRequest)

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

func (ConnectorSecretDelete) WithPretty ¶ added in v8.13.0 

func (f ConnectorSecretDelete) WithPretty() func(*ConnectorSecretDeleteRequest)

WithPretty makes the response body pretty-printed.

type ConnectorSecretDeleteRequest ¶ added in v8.13.0 

type ConnectorSecretDeleteRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorSecretDeleteRequest configures the Connector Secret Delete API request.

func (ConnectorSecretDeleteRequest) Do ¶ added in v8.13.0 

func (r ConnectorSecretDeleteRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorSecretGet ¶ added in v8.13.0 

type ConnectorSecretGet func(id string, o ...func(*ConnectorSecretGetRequest)) (*Response, error)

ConnectorSecretGet retrieves a secret stored by Connectors.

This API is experimental.

func (ConnectorSecretGet) WithContext ¶ added in v8.13.0 

func (f ConnectorSecretGet) WithContext(v context.Context) func(*ConnectorSecretGetRequest)

WithContext sets the request context.

func (ConnectorSecretGet) WithErrorTrace ¶ added in v8.13.0 

func (f ConnectorSecretGet) WithErrorTrace() func(*ConnectorSecretGetRequest)

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

func (ConnectorSecretGet) WithFilterPath ¶ added in v8.13.0 

func (f ConnectorSecretGet) WithFilterPath(v ...string) func(*ConnectorSecretGetRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorSecretGet) WithHeader ¶ added in v8.13.0 

func (f ConnectorSecretGet) WithHeader(h map[string]string) func(*ConnectorSecretGetRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorSecretGet) WithHuman ¶ added in v8.13.0 

func (f ConnectorSecretGet) WithHuman() func(*ConnectorSecretGetRequest)

WithHuman makes statistical values human-readable.

func (ConnectorSecretGet) WithOpaqueID ¶ added in v8.13.0 

func (f ConnectorSecretGet) WithOpaqueID(s string) func(*ConnectorSecretGetRequest)

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

func (ConnectorSecretGet) WithPretty ¶ added in v8.13.0 

func (f ConnectorSecretGet) WithPretty() func(*ConnectorSecretGetRequest)

WithPretty makes the response body pretty-printed.

type ConnectorSecretGetRequest ¶ added in v8.13.0 

type ConnectorSecretGetRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorSecretGetRequest configures the Connector Secret Get API request.

func (ConnectorSecretGetRequest) Do ¶ added in v8.13.0 

func (r ConnectorSecretGetRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorSecretPost ¶ added in v8.13.0 

type ConnectorSecretPost func(body io.Reader, o ...func(*ConnectorSecretPostRequest)) (*Response, error)

ConnectorSecretPost creates a secret for a Connector.

This API is experimental.

func (ConnectorSecretPost) WithContext ¶ added in v8.13.0 

func (f ConnectorSecretPost) WithContext(v context.Context) func(*ConnectorSecretPostRequest)

WithContext sets the request context.

func (ConnectorSecretPost) WithErrorTrace ¶ added in v8.13.0 

func (f ConnectorSecretPost) WithErrorTrace() func(*ConnectorSecretPostRequest)

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

func (ConnectorSecretPost) WithFilterPath ¶ added in v8.13.0 

func (f ConnectorSecretPost) WithFilterPath(v ...string) func(*ConnectorSecretPostRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorSecretPost) WithHeader ¶ added in v8.13.0 

func (f ConnectorSecretPost) WithHeader(h map[string]string) func(*ConnectorSecretPostRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorSecretPost) WithHuman ¶ added in v8.13.0 

func (f ConnectorSecretPost) WithHuman() func(*ConnectorSecretPostRequest)

WithHuman makes statistical values human-readable.

func (ConnectorSecretPost) WithOpaqueID ¶ added in v8.13.0 

func (f ConnectorSecretPost) WithOpaqueID(s string) func(*ConnectorSecretPostRequest)

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

func (ConnectorSecretPost) WithPretty ¶ added in v8.13.0 

func (f ConnectorSecretPost) WithPretty() func(*ConnectorSecretPostRequest)

WithPretty makes the response body pretty-printed.

type ConnectorSecretPostRequest ¶ added in v8.13.0 

type ConnectorSecretPostRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorSecretPostRequest configures the Connector Secret Post API request.

func (ConnectorSecretPostRequest) Do ¶ added in v8.13.0 

func (r ConnectorSecretPostRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorSecretPut ¶ added in v8.13.0 

type ConnectorSecretPut func(id string, body io.Reader, o ...func(*ConnectorSecretPutRequest)) (*Response, error)

ConnectorSecretPut creates or updates a secret for a Connector.

This API is experimental.

func (ConnectorSecretPut) WithContext ¶ added in v8.13.0 

func (f ConnectorSecretPut) WithContext(v context.Context) func(*ConnectorSecretPutRequest)

WithContext sets the request context.

func (ConnectorSecretPut) WithErrorTrace ¶ added in v8.13.0 

func (f ConnectorSecretPut) WithErrorTrace() func(*ConnectorSecretPutRequest)

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

func (ConnectorSecretPut) WithFilterPath ¶ added in v8.13.0 

func (f ConnectorSecretPut) WithFilterPath(v ...string) func(*ConnectorSecretPutRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorSecretPut) WithHeader ¶ added in v8.13.0 

func (f ConnectorSecretPut) WithHeader(h map[string]string) func(*ConnectorSecretPutRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorSecretPut) WithHuman ¶ added in v8.13.0 

func (f ConnectorSecretPut) WithHuman() func(*ConnectorSecretPutRequest)

WithHuman makes statistical values human-readable.

func (ConnectorSecretPut) WithOpaqueID ¶ added in v8.13.0 

func (f ConnectorSecretPut) WithOpaqueID(s string) func(*ConnectorSecretPutRequest)

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

func (ConnectorSecretPut) WithPretty ¶ added in v8.13.0 

func (f ConnectorSecretPut) WithPretty() func(*ConnectorSecretPutRequest)

WithPretty makes the response body pretty-printed.

type ConnectorSecretPutRequest ¶ added in v8.13.0 

type ConnectorSecretPutRequest struct {
	DocumentID string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorSecretPutRequest configures the Connector Secret Put API request.

func (ConnectorSecretPutRequest) Do ¶ added in v8.13.0 

func (r ConnectorSecretPutRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorSyncJobCancel ¶ added in v8.12.0 

type ConnectorSyncJobCancel func(connector_sync_job_id string, o ...func(*ConnectorSyncJobCancelRequest)) (*Response, error)

ConnectorSyncJobCancel cancels a connector sync job.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cancel-connector-sync-job-api.html.

func (ConnectorSyncJobCancel) WithContext ¶ added in v8.12.0 

func (f ConnectorSyncJobCancel) WithContext(v context.Context) func(*ConnectorSyncJobCancelRequest)

WithContext sets the request context.

func (ConnectorSyncJobCancel) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorSyncJobCancel) WithErrorTrace() func(*ConnectorSyncJobCancelRequest)

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

func (ConnectorSyncJobCancel) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorSyncJobCancel) WithFilterPath(v ...string) func(*ConnectorSyncJobCancelRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorSyncJobCancel) WithHeader ¶ added in v8.12.0 

func (f ConnectorSyncJobCancel) WithHeader(h map[string]string) func(*ConnectorSyncJobCancelRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorSyncJobCancel) WithHuman ¶ added in v8.12.0 

func (f ConnectorSyncJobCancel) WithHuman() func(*ConnectorSyncJobCancelRequest)

WithHuman makes statistical values human-readable.

func (ConnectorSyncJobCancel) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorSyncJobCancel) WithOpaqueID(s string) func(*ConnectorSyncJobCancelRequest)

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

func (ConnectorSyncJobCancel) WithPretty ¶ added in v8.12.0 

func (f ConnectorSyncJobCancel) WithPretty() func(*ConnectorSyncJobCancelRequest)

WithPretty makes the response body pretty-printed.

type ConnectorSyncJobCancelRequest ¶ added in v8.12.0 

type ConnectorSyncJobCancelRequest struct {
	ConnectorSyncJobID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorSyncJobCancelRequest configures the Connector Sync Job Cancel API request.

func (ConnectorSyncJobCancelRequest) Do ¶ added in v8.12.0 

func (r ConnectorSyncJobCancelRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorSyncJobCheckIn ¶ added in v8.12.0 

type ConnectorSyncJobCheckIn func(connector_sync_job_id string, o ...func(*ConnectorSyncJobCheckInRequest)) (*Response, error)

ConnectorSyncJobCheckIn checks in a connector sync job (refreshes 'last_seen').

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/check-in-connector-sync-job-api.html.

func (ConnectorSyncJobCheckIn) WithContext ¶ added in v8.12.0 

func (f ConnectorSyncJobCheckIn) WithContext(v context.Context) func(*ConnectorSyncJobCheckInRequest)

WithContext sets the request context.

func (ConnectorSyncJobCheckIn) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorSyncJobCheckIn) WithErrorTrace() func(*ConnectorSyncJobCheckInRequest)

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

func (ConnectorSyncJobCheckIn) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorSyncJobCheckIn) WithFilterPath(v ...string) func(*ConnectorSyncJobCheckInRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorSyncJobCheckIn) WithHeader ¶ added in v8.12.0 

func (f ConnectorSyncJobCheckIn) WithHeader(h map[string]string) func(*ConnectorSyncJobCheckInRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorSyncJobCheckIn) WithHuman ¶ added in v8.12.0 

func (f ConnectorSyncJobCheckIn) WithHuman() func(*ConnectorSyncJobCheckInRequest)

WithHuman makes statistical values human-readable.

func (ConnectorSyncJobCheckIn) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorSyncJobCheckIn) WithOpaqueID(s string) func(*ConnectorSyncJobCheckInRequest)

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

func (ConnectorSyncJobCheckIn) WithPretty ¶ added in v8.12.0 

func (f ConnectorSyncJobCheckIn) WithPretty() func(*ConnectorSyncJobCheckInRequest)

WithPretty makes the response body pretty-printed.

type ConnectorSyncJobCheckInRequest ¶ added in v8.12.0 

type ConnectorSyncJobCheckInRequest struct {
	ConnectorSyncJobID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorSyncJobCheckInRequest configures the Connector Sync Job Check In API request.

func (ConnectorSyncJobCheckInRequest) Do ¶ added in v8.12.0 

func (r ConnectorSyncJobCheckInRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorSyncJobClaim ¶ added in v8.15.0 

type ConnectorSyncJobClaim func(body io.Reader, connector_sync_job_id string, o ...func(*ConnectorSyncJobClaimRequest)) (*Response, error)

ConnectorSyncJobClaim claims a connector sync job.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/claim-connector-sync-job-api.html.

func (ConnectorSyncJobClaim) WithContext ¶ added in v8.15.0 

func (f ConnectorSyncJobClaim) WithContext(v context.Context) func(*ConnectorSyncJobClaimRequest)

WithContext sets the request context.

func (ConnectorSyncJobClaim) WithErrorTrace ¶ added in v8.15.0 

func (f ConnectorSyncJobClaim) WithErrorTrace() func(*ConnectorSyncJobClaimRequest)

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

func (ConnectorSyncJobClaim) WithFilterPath ¶ added in v8.15.0 

func (f ConnectorSyncJobClaim) WithFilterPath(v ...string) func(*ConnectorSyncJobClaimRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorSyncJobClaim) WithHeader ¶ added in v8.15.0 

func (f ConnectorSyncJobClaim) WithHeader(h map[string]string) func(*ConnectorSyncJobClaimRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorSyncJobClaim) WithHuman ¶ added in v8.15.0 

func (f ConnectorSyncJobClaim) WithHuman() func(*ConnectorSyncJobClaimRequest)

WithHuman makes statistical values human-readable.

func (ConnectorSyncJobClaim) WithOpaqueID ¶ added in v8.15.0 

func (f ConnectorSyncJobClaim) WithOpaqueID(s string) func(*ConnectorSyncJobClaimRequest)

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

func (ConnectorSyncJobClaim) WithPretty ¶ added in v8.15.0 

func (f ConnectorSyncJobClaim) WithPretty() func(*ConnectorSyncJobClaimRequest)

WithPretty makes the response body pretty-printed.

type ConnectorSyncJobClaimRequest ¶ added in v8.15.0 

type ConnectorSyncJobClaimRequest struct {
	Body io.Reader

	ConnectorSyncJobID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorSyncJobClaimRequest configures the Connector Sync Job Claim API request.

func (ConnectorSyncJobClaimRequest) Do ¶ added in v8.15.0 

func (r ConnectorSyncJobClaimRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorSyncJobDelete ¶ added in v8.12.0 

type ConnectorSyncJobDelete func(connector_sync_job_id string, o ...func(*ConnectorSyncJobDeleteRequest)) (*Response, error)

ConnectorSyncJobDelete deletes a connector sync job.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-connector-sync-job-api.html.

func (ConnectorSyncJobDelete) WithContext ¶ added in v8.12.0 

func (f ConnectorSyncJobDelete) WithContext(v context.Context) func(*ConnectorSyncJobDeleteRequest)

WithContext sets the request context.

func (ConnectorSyncJobDelete) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorSyncJobDelete) WithErrorTrace() func(*ConnectorSyncJobDeleteRequest)

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

func (ConnectorSyncJobDelete) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorSyncJobDelete) WithFilterPath(v ...string) func(*ConnectorSyncJobDeleteRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorSyncJobDelete) WithHeader ¶ added in v8.12.0 

func (f ConnectorSyncJobDelete) WithHeader(h map[string]string) func(*ConnectorSyncJobDeleteRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorSyncJobDelete) WithHuman ¶ added in v8.12.0 

func (f ConnectorSyncJobDelete) WithHuman() func(*ConnectorSyncJobDeleteRequest)

WithHuman makes statistical values human-readable.

func (ConnectorSyncJobDelete) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorSyncJobDelete) WithOpaqueID(s string) func(*ConnectorSyncJobDeleteRequest)

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

func (ConnectorSyncJobDelete) WithPretty ¶ added in v8.12.0 

func (f ConnectorSyncJobDelete) WithPretty() func(*ConnectorSyncJobDeleteRequest)

WithPretty makes the response body pretty-printed.

type ConnectorSyncJobDeleteRequest ¶ added in v8.12.0 

type ConnectorSyncJobDeleteRequest struct {
	ConnectorSyncJobID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorSyncJobDeleteRequest configures the Connector Sync Job Delete API request.

func (ConnectorSyncJobDeleteRequest) Do ¶ added in v8.12.0 

func (r ConnectorSyncJobDeleteRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorSyncJobError ¶ added in v8.12.0 

type ConnectorSyncJobError func(body io.Reader, connector_sync_job_id string, o ...func(*ConnectorSyncJobErrorRequest)) (*Response, error)

ConnectorSyncJobError sets an error for a connector sync job.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/set-connector-sync-job-error-api.html.

func (ConnectorSyncJobError) WithContext ¶ added in v8.12.0 

func (f ConnectorSyncJobError) WithContext(v context.Context) func(*ConnectorSyncJobErrorRequest)

WithContext sets the request context.

func (ConnectorSyncJobError) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorSyncJobError) WithErrorTrace() func(*ConnectorSyncJobErrorRequest)

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

func (ConnectorSyncJobError) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorSyncJobError) WithFilterPath(v ...string) func(*ConnectorSyncJobErrorRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorSyncJobError) WithHeader ¶ added in v8.12.0 

func (f ConnectorSyncJobError) WithHeader(h map[string]string) func(*ConnectorSyncJobErrorRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorSyncJobError) WithHuman ¶ added in v8.12.0 

func (f ConnectorSyncJobError) WithHuman() func(*ConnectorSyncJobErrorRequest)

WithHuman makes statistical values human-readable.

func (ConnectorSyncJobError) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorSyncJobError) WithOpaqueID(s string) func(*ConnectorSyncJobErrorRequest)

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

func (ConnectorSyncJobError) WithPretty ¶ added in v8.12.0 

func (f ConnectorSyncJobError) WithPretty() func(*ConnectorSyncJobErrorRequest)

WithPretty makes the response body pretty-printed.

type ConnectorSyncJobErrorRequest ¶ added in v8.12.0 

type ConnectorSyncJobErrorRequest struct {
	Body io.Reader

	ConnectorSyncJobID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorSyncJobErrorRequest configures the Connector Sync Job Error API request.

func (ConnectorSyncJobErrorRequest) Do ¶ added in v8.12.0 

func (r ConnectorSyncJobErrorRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorSyncJobGet ¶ added in v8.12.0 

type ConnectorSyncJobGet func(connector_sync_job_id string, o ...func(*ConnectorSyncJobGetRequest)) (*Response, error)

ConnectorSyncJobGet returns the details about a connector sync job.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-connector-sync-job-api.html.

func (ConnectorSyncJobGet) WithContext ¶ added in v8.12.0 

func (f ConnectorSyncJobGet) WithContext(v context.Context) func(*ConnectorSyncJobGetRequest)

WithContext sets the request context.

func (ConnectorSyncJobGet) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorSyncJobGet) WithErrorTrace() func(*ConnectorSyncJobGetRequest)

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

func (ConnectorSyncJobGet) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorSyncJobGet) WithFilterPath(v ...string) func(*ConnectorSyncJobGetRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorSyncJobGet) WithHeader ¶ added in v8.12.0 

func (f ConnectorSyncJobGet) WithHeader(h map[string]string) func(*ConnectorSyncJobGetRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorSyncJobGet) WithHuman ¶ added in v8.12.0 

func (f ConnectorSyncJobGet) WithHuman() func(*ConnectorSyncJobGetRequest)

WithHuman makes statistical values human-readable.

func (ConnectorSyncJobGet) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorSyncJobGet) WithOpaqueID(s string) func(*ConnectorSyncJobGetRequest)

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

func (ConnectorSyncJobGet) WithPretty ¶ added in v8.12.0 

func (f ConnectorSyncJobGet) WithPretty() func(*ConnectorSyncJobGetRequest)

WithPretty makes the response body pretty-printed.

type ConnectorSyncJobGetRequest ¶ added in v8.12.0 

type ConnectorSyncJobGetRequest struct {
	ConnectorSyncJobID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorSyncJobGetRequest configures the Connector Sync Job Get API request.

func (ConnectorSyncJobGetRequest) Do ¶ added in v8.12.0 

func (r ConnectorSyncJobGetRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorSyncJobList ¶ added in v8.12.0 

type ConnectorSyncJobList func(o ...func(*ConnectorSyncJobListRequest)) (*Response, error)

ConnectorSyncJobList lists all connector sync jobs.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/list-connector-sync-jobs-api.html.

func (ConnectorSyncJobList) WithConnectorID ¶ added in v8.12.0 

func (f ConnectorSyncJobList) WithConnectorID(v string) func(*ConnectorSyncJobListRequest)

WithConnectorID - ID of the connector to fetch the sync jobs for.

func (ConnectorSyncJobList) WithContext ¶ added in v8.12.0 

func (f ConnectorSyncJobList) WithContext(v context.Context) func(*ConnectorSyncJobListRequest)

WithContext sets the request context.

func (ConnectorSyncJobList) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorSyncJobList) WithErrorTrace() func(*ConnectorSyncJobListRequest)

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

func (ConnectorSyncJobList) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorSyncJobList) WithFilterPath(v ...string) func(*ConnectorSyncJobListRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorSyncJobList) WithFrom ¶ added in v8.12.0 

func (f ConnectorSyncJobList) WithFrom(v int) func(*ConnectorSyncJobListRequest)

WithFrom - starting offset (default: 0).

func (ConnectorSyncJobList) WithHeader ¶ added in v8.12.0 

func (f ConnectorSyncJobList) WithHeader(h map[string]string) func(*ConnectorSyncJobListRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorSyncJobList) WithHuman ¶ added in v8.12.0 

func (f ConnectorSyncJobList) WithHuman() func(*ConnectorSyncJobListRequest)

WithHuman makes statistical values human-readable.

func (ConnectorSyncJobList) WithJobType ¶ added in v8.13.0 

func (f ConnectorSyncJobList) WithJobType(v ...string) func(*ConnectorSyncJobListRequest)

WithJobType - a list of job types.

func (ConnectorSyncJobList) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorSyncJobList) WithOpaqueID(s string) func(*ConnectorSyncJobListRequest)

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

func (ConnectorSyncJobList) WithPretty ¶ added in v8.12.0 

func (f ConnectorSyncJobList) WithPretty() func(*ConnectorSyncJobListRequest)

WithPretty makes the response body pretty-printed.

func (ConnectorSyncJobList) WithSize ¶ added in v8.12.0 

func (f ConnectorSyncJobList) WithSize(v int) func(*ConnectorSyncJobListRequest)

WithSize - specifies a max number of results to get (default: 100).

func (ConnectorSyncJobList) WithStatus ¶ added in v8.12.0 

func (f ConnectorSyncJobList) WithStatus(v string) func(*ConnectorSyncJobListRequest)

WithStatus - sync job status, which sync jobs are fetched for.

type ConnectorSyncJobListRequest ¶ added in v8.12.0 

type ConnectorSyncJobListRequest struct {
	ConnectorID string
	From        *int
	JobType     []string
	Size        *int
	Status      string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorSyncJobListRequest configures the Connector Sync Job List API request.

func (ConnectorSyncJobListRequest) Do ¶ added in v8.12.0 

func (r ConnectorSyncJobListRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorSyncJobPost ¶ added in v8.12.0 

type ConnectorSyncJobPost func(body io.Reader, o ...func(*ConnectorSyncJobPostRequest)) (*Response, error)

ConnectorSyncJobPost creates a connector sync job.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-sync-job-api.html.

func (ConnectorSyncJobPost) WithContext ¶ added in v8.12.0 

func (f ConnectorSyncJobPost) WithContext(v context.Context) func(*ConnectorSyncJobPostRequest)

WithContext sets the request context.

func (ConnectorSyncJobPost) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorSyncJobPost) WithErrorTrace() func(*ConnectorSyncJobPostRequest)

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

func (ConnectorSyncJobPost) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorSyncJobPost) WithFilterPath(v ...string) func(*ConnectorSyncJobPostRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorSyncJobPost) WithHeader ¶ added in v8.12.0 

func (f ConnectorSyncJobPost) WithHeader(h map[string]string) func(*ConnectorSyncJobPostRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorSyncJobPost) WithHuman ¶ added in v8.12.0 

func (f ConnectorSyncJobPost) WithHuman() func(*ConnectorSyncJobPostRequest)

WithHuman makes statistical values human-readable.

func (ConnectorSyncJobPost) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorSyncJobPost) WithOpaqueID(s string) func(*ConnectorSyncJobPostRequest)

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

func (ConnectorSyncJobPost) WithPretty ¶ added in v8.12.0 

func (f ConnectorSyncJobPost) WithPretty() func(*ConnectorSyncJobPostRequest)

WithPretty makes the response body pretty-printed.

type ConnectorSyncJobPostRequest ¶ added in v8.12.0 

type ConnectorSyncJobPostRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorSyncJobPostRequest configures the Connector Sync Job Post API request.

func (ConnectorSyncJobPostRequest) Do ¶ added in v8.12.0 

func (r ConnectorSyncJobPostRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorSyncJobUpdateStats ¶ added in v8.12.0 

type ConnectorSyncJobUpdateStats func(body io.Reader, connector_sync_job_id string, o ...func(*ConnectorSyncJobUpdateStatsRequest)) (*Response, error)

ConnectorSyncJobUpdateStats updates the stats fields in the connector sync job document.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/set-connector-sync-job-stats-api.html.

func (ConnectorSyncJobUpdateStats) WithContext ¶ added in v8.12.0 

func (f ConnectorSyncJobUpdateStats) WithContext(v context.Context) func(*ConnectorSyncJobUpdateStatsRequest)

WithContext sets the request context.

func (ConnectorSyncJobUpdateStats) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorSyncJobUpdateStats) WithErrorTrace() func(*ConnectorSyncJobUpdateStatsRequest)

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

func (ConnectorSyncJobUpdateStats) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorSyncJobUpdateStats) WithFilterPath(v ...string) func(*ConnectorSyncJobUpdateStatsRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorSyncJobUpdateStats) WithHeader ¶ added in v8.12.0 

func (f ConnectorSyncJobUpdateStats) WithHeader(h map[string]string) func(*ConnectorSyncJobUpdateStatsRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorSyncJobUpdateStats) WithHuman ¶ added in v8.12.0 

func (f ConnectorSyncJobUpdateStats) WithHuman() func(*ConnectorSyncJobUpdateStatsRequest)

WithHuman makes statistical values human-readable.

func (ConnectorSyncJobUpdateStats) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorSyncJobUpdateStats) WithOpaqueID(s string) func(*ConnectorSyncJobUpdateStatsRequest)

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

func (ConnectorSyncJobUpdateStats) WithPretty ¶ added in v8.12.0 

func (f ConnectorSyncJobUpdateStats) WithPretty() func(*ConnectorSyncJobUpdateStatsRequest)

WithPretty makes the response body pretty-printed.

type ConnectorSyncJobUpdateStatsRequest ¶ added in v8.12.0 

type ConnectorSyncJobUpdateStatsRequest struct {
	Body io.Reader

	ConnectorSyncJobID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorSyncJobUpdateStatsRequest configures the Connector Sync Job Update Stats API request.

func (ConnectorSyncJobUpdateStatsRequest) Do ¶ added in v8.12.0 

func (r ConnectorSyncJobUpdateStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorUpdateAPIKeyDocumentID ¶ added in v8.13.0 

type ConnectorUpdateAPIKeyDocumentID func(body io.Reader, connector_id string, o ...func(*ConnectorUpdateAPIKeyDocumentIDRequest)) (*Response, error)

ConnectorUpdateAPIKeyDocumentID updates the API key id and/or API key secret id fields in the connector document.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-api-key-id-api.html.

func (ConnectorUpdateAPIKeyDocumentID) WithContext ¶ added in v8.13.0 

func (f ConnectorUpdateAPIKeyDocumentID) WithContext(v context.Context) func(*ConnectorUpdateAPIKeyDocumentIDRequest)

WithContext sets the request context.

func (ConnectorUpdateAPIKeyDocumentID) WithErrorTrace ¶ added in v8.13.0 

func (f ConnectorUpdateAPIKeyDocumentID) WithErrorTrace() func(*ConnectorUpdateAPIKeyDocumentIDRequest)

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

func (ConnectorUpdateAPIKeyDocumentID) WithFilterPath ¶ added in v8.13.0 

func (f ConnectorUpdateAPIKeyDocumentID) WithFilterPath(v ...string) func(*ConnectorUpdateAPIKeyDocumentIDRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorUpdateAPIKeyDocumentID) WithHeader ¶ added in v8.13.0 

func (f ConnectorUpdateAPIKeyDocumentID) WithHeader(h map[string]string) func(*ConnectorUpdateAPIKeyDocumentIDRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorUpdateAPIKeyDocumentID) WithHuman ¶ added in v8.13.0 

func (f ConnectorUpdateAPIKeyDocumentID) WithHuman() func(*ConnectorUpdateAPIKeyDocumentIDRequest)

WithHuman makes statistical values human-readable.

func (ConnectorUpdateAPIKeyDocumentID) WithOpaqueID ¶ added in v8.13.0 

func (f ConnectorUpdateAPIKeyDocumentID) WithOpaqueID(s string) func(*ConnectorUpdateAPIKeyDocumentIDRequest)

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

func (ConnectorUpdateAPIKeyDocumentID) WithPretty ¶ added in v8.13.0 

func (f ConnectorUpdateAPIKeyDocumentID) WithPretty() func(*ConnectorUpdateAPIKeyDocumentIDRequest)

WithPretty makes the response body pretty-printed.

type ConnectorUpdateAPIKeyDocumentIDRequest ¶ added in v8.13.0 

type ConnectorUpdateAPIKeyDocumentIDRequest struct {
	Body io.Reader

	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorUpdateAPIKeyDocumentIDRequest configures the Connector UpdateAPI Key DocumentI D API request.

func (ConnectorUpdateAPIKeyDocumentIDRequest) Do ¶ added in v8.13.0 

func (r ConnectorUpdateAPIKeyDocumentIDRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorUpdateActiveFiltering ¶ added in v8.14.0 

type ConnectorUpdateActiveFiltering func(connector_id string, o ...func(*ConnectorUpdateActiveFilteringRequest)) (*Response, error)

ConnectorUpdateActiveFiltering activates the draft filtering rules if they are in a validated state.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-filtering-api.html.

func (ConnectorUpdateActiveFiltering) WithContext ¶ added in v8.14.0 

func (f ConnectorUpdateActiveFiltering) WithContext(v context.Context) func(*ConnectorUpdateActiveFilteringRequest)

WithContext sets the request context.

func (ConnectorUpdateActiveFiltering) WithErrorTrace ¶ added in v8.14.0 

func (f ConnectorUpdateActiveFiltering) WithErrorTrace() func(*ConnectorUpdateActiveFilteringRequest)

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

func (ConnectorUpdateActiveFiltering) WithFilterPath ¶ added in v8.14.0 

func (f ConnectorUpdateActiveFiltering) WithFilterPath(v ...string) func(*ConnectorUpdateActiveFilteringRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorUpdateActiveFiltering) WithHeader ¶ added in v8.14.0 

func (f ConnectorUpdateActiveFiltering) WithHeader(h map[string]string) func(*ConnectorUpdateActiveFilteringRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorUpdateActiveFiltering) WithHuman ¶ added in v8.14.0 

func (f ConnectorUpdateActiveFiltering) WithHuman() func(*ConnectorUpdateActiveFilteringRequest)

WithHuman makes statistical values human-readable.

func (ConnectorUpdateActiveFiltering) WithOpaqueID ¶ added in v8.14.0 

func (f ConnectorUpdateActiveFiltering) WithOpaqueID(s string) func(*ConnectorUpdateActiveFilteringRequest)

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

func (ConnectorUpdateActiveFiltering) WithPretty ¶ added in v8.14.0 

func (f ConnectorUpdateActiveFiltering) WithPretty() func(*ConnectorUpdateActiveFilteringRequest)

WithPretty makes the response body pretty-printed.

type ConnectorUpdateActiveFilteringRequest ¶ added in v8.14.0 

type ConnectorUpdateActiveFilteringRequest struct {
	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorUpdateActiveFilteringRequest configures the Connector Update Active Filtering API request.

func (ConnectorUpdateActiveFilteringRequest) Do ¶ added in v8.14.0 

func (r ConnectorUpdateActiveFilteringRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorUpdateConfiguration ¶ added in v8.12.0 

type ConnectorUpdateConfiguration func(body io.Reader, connector_id string, o ...func(*ConnectorUpdateConfigurationRequest)) (*Response, error)

ConnectorUpdateConfiguration updates the connector configuration.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-configuration-api.html.

func (ConnectorUpdateConfiguration) WithContext ¶ added in v8.12.0 

func (f ConnectorUpdateConfiguration) WithContext(v context.Context) func(*ConnectorUpdateConfigurationRequest)

WithContext sets the request context.

func (ConnectorUpdateConfiguration) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorUpdateConfiguration) WithErrorTrace() func(*ConnectorUpdateConfigurationRequest)

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

func (ConnectorUpdateConfiguration) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorUpdateConfiguration) WithFilterPath(v ...string) func(*ConnectorUpdateConfigurationRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorUpdateConfiguration) WithHeader ¶ added in v8.12.0 

func (f ConnectorUpdateConfiguration) WithHeader(h map[string]string) func(*ConnectorUpdateConfigurationRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorUpdateConfiguration) WithHuman ¶ added in v8.12.0 

func (f ConnectorUpdateConfiguration) WithHuman() func(*ConnectorUpdateConfigurationRequest)

WithHuman makes statistical values human-readable.

func (ConnectorUpdateConfiguration) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorUpdateConfiguration) WithOpaqueID(s string) func(*ConnectorUpdateConfigurationRequest)

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

func (ConnectorUpdateConfiguration) WithPretty ¶ added in v8.12.0 

func (f ConnectorUpdateConfiguration) WithPretty() func(*ConnectorUpdateConfigurationRequest)

WithPretty makes the response body pretty-printed.

type ConnectorUpdateConfigurationRequest ¶ added in v8.12.0 

type ConnectorUpdateConfigurationRequest struct {
	Body io.Reader

	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorUpdateConfigurationRequest configures the Connector Update Configuration API request.

func (ConnectorUpdateConfigurationRequest) Do ¶ added in v8.12.0 

func (r ConnectorUpdateConfigurationRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorUpdateError ¶ added in v8.12.0 

type ConnectorUpdateError func(body io.Reader, connector_id string, o ...func(*ConnectorUpdateErrorRequest)) (*Response, error)

ConnectorUpdateError updates the error field in the connector document.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-error-api.html.

func (ConnectorUpdateError) WithContext ¶ added in v8.12.0 

func (f ConnectorUpdateError) WithContext(v context.Context) func(*ConnectorUpdateErrorRequest)

WithContext sets the request context.

func (ConnectorUpdateError) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorUpdateError) WithErrorTrace() func(*ConnectorUpdateErrorRequest)

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

func (ConnectorUpdateError) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorUpdateError) WithFilterPath(v ...string) func(*ConnectorUpdateErrorRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorUpdateError) WithHeader ¶ added in v8.12.0 

func (f ConnectorUpdateError) WithHeader(h map[string]string) func(*ConnectorUpdateErrorRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorUpdateError) WithHuman ¶ added in v8.12.0 

func (f ConnectorUpdateError) WithHuman() func(*ConnectorUpdateErrorRequest)

WithHuman makes statistical values human-readable.

func (ConnectorUpdateError) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorUpdateError) WithOpaqueID(s string) func(*ConnectorUpdateErrorRequest)

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

func (ConnectorUpdateError) WithPretty ¶ added in v8.12.0 

func (f ConnectorUpdateError) WithPretty() func(*ConnectorUpdateErrorRequest)

WithPretty makes the response body pretty-printed.

type ConnectorUpdateErrorRequest ¶ added in v8.12.0 

type ConnectorUpdateErrorRequest struct {
	Body io.Reader

	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorUpdateErrorRequest configures the Connector Update Error API request.

func (ConnectorUpdateErrorRequest) Do ¶ added in v8.12.0 

func (r ConnectorUpdateErrorRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorUpdateFeatures ¶ added in v8.15.0 

type ConnectorUpdateFeatures func(body io.Reader, connector_id string, o ...func(*ConnectorUpdateFeaturesRequest)) (*Response, error)

ConnectorUpdateFeatures updates the connector features in the connector document.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-features-api.html.

func (ConnectorUpdateFeatures) WithContext ¶ added in v8.15.0 

func (f ConnectorUpdateFeatures) WithContext(v context.Context) func(*ConnectorUpdateFeaturesRequest)

WithContext sets the request context.

func (ConnectorUpdateFeatures) WithErrorTrace ¶ added in v8.15.0 

func (f ConnectorUpdateFeatures) WithErrorTrace() func(*ConnectorUpdateFeaturesRequest)

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

func (ConnectorUpdateFeatures) WithFilterPath ¶ added in v8.15.0 

func (f ConnectorUpdateFeatures) WithFilterPath(v ...string) func(*ConnectorUpdateFeaturesRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorUpdateFeatures) WithHeader ¶ added in v8.15.0 

func (f ConnectorUpdateFeatures) WithHeader(h map[string]string) func(*ConnectorUpdateFeaturesRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorUpdateFeatures) WithHuman ¶ added in v8.15.0 

func (f ConnectorUpdateFeatures) WithHuman() func(*ConnectorUpdateFeaturesRequest)

WithHuman makes statistical values human-readable.

func (ConnectorUpdateFeatures) WithOpaqueID ¶ added in v8.15.0 

func (f ConnectorUpdateFeatures) WithOpaqueID(s string) func(*ConnectorUpdateFeaturesRequest)

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

func (ConnectorUpdateFeatures) WithPretty ¶ added in v8.15.0 

func (f ConnectorUpdateFeatures) WithPretty() func(*ConnectorUpdateFeaturesRequest)

WithPretty makes the response body pretty-printed.

type ConnectorUpdateFeaturesRequest ¶ added in v8.15.0 

type ConnectorUpdateFeaturesRequest struct {
	Body io.Reader

	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorUpdateFeaturesRequest configures the Connector Update Features API request.

func (ConnectorUpdateFeaturesRequest) Do ¶ added in v8.15.0 

func (r ConnectorUpdateFeaturesRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorUpdateFiltering ¶ added in v8.12.0 

type ConnectorUpdateFiltering func(body io.Reader, connector_id string, o ...func(*ConnectorUpdateFilteringRequest)) (*Response, error)

ConnectorUpdateFiltering updates the filtering field in the connector document.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-filtering-api.html.

func (ConnectorUpdateFiltering) WithContext ¶ added in v8.12.0 

func (f ConnectorUpdateFiltering) WithContext(v context.Context) func(*ConnectorUpdateFilteringRequest)

WithContext sets the request context.

func (ConnectorUpdateFiltering) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorUpdateFiltering) WithErrorTrace() func(*ConnectorUpdateFilteringRequest)

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

func (ConnectorUpdateFiltering) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorUpdateFiltering) WithFilterPath(v ...string) func(*ConnectorUpdateFilteringRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorUpdateFiltering) WithHeader ¶ added in v8.12.0 

func (f ConnectorUpdateFiltering) WithHeader(h map[string]string) func(*ConnectorUpdateFilteringRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorUpdateFiltering) WithHuman ¶ added in v8.12.0 

func (f ConnectorUpdateFiltering) WithHuman() func(*ConnectorUpdateFilteringRequest)

WithHuman makes statistical values human-readable.

func (ConnectorUpdateFiltering) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorUpdateFiltering) WithOpaqueID(s string) func(*ConnectorUpdateFilteringRequest)

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

func (ConnectorUpdateFiltering) WithPretty ¶ added in v8.12.0 

func (f ConnectorUpdateFiltering) WithPretty() func(*ConnectorUpdateFilteringRequest)

WithPretty makes the response body pretty-printed.

type ConnectorUpdateFilteringRequest ¶ added in v8.12.0 

type ConnectorUpdateFilteringRequest struct {
	Body io.Reader

	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorUpdateFilteringRequest configures the Connector Update Filtering API request.

func (ConnectorUpdateFilteringRequest) Do ¶ added in v8.12.0 

func (r ConnectorUpdateFilteringRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorUpdateFilteringValidation ¶ added in v8.14.0 

type ConnectorUpdateFilteringValidation func(body io.Reader, connector_id string, o ...func(*ConnectorUpdateFilteringValidationRequest)) (*Response, error)

ConnectorUpdateFilteringValidation updates the validation info of the draft filtering rules.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-filtering-api.html.

func (ConnectorUpdateFilteringValidation) WithContext ¶ added in v8.14.0 

func (f ConnectorUpdateFilteringValidation) WithContext(v context.Context) func(*ConnectorUpdateFilteringValidationRequest)

WithContext sets the request context.

func (ConnectorUpdateFilteringValidation) WithErrorTrace ¶ added in v8.14.0 

func (f ConnectorUpdateFilteringValidation) WithErrorTrace() func(*ConnectorUpdateFilteringValidationRequest)

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

func (ConnectorUpdateFilteringValidation) WithFilterPath ¶ added in v8.14.0 

func (f ConnectorUpdateFilteringValidation) WithFilterPath(v ...string) func(*ConnectorUpdateFilteringValidationRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorUpdateFilteringValidation) WithHeader ¶ added in v8.14.0 

func (f ConnectorUpdateFilteringValidation) WithHeader(h map[string]string) func(*ConnectorUpdateFilteringValidationRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorUpdateFilteringValidation) WithHuman ¶ added in v8.14.0 

func (f ConnectorUpdateFilteringValidation) WithHuman() func(*ConnectorUpdateFilteringValidationRequest)

WithHuman makes statistical values human-readable.

func (ConnectorUpdateFilteringValidation) WithOpaqueID ¶ added in v8.14.0 

func (f ConnectorUpdateFilteringValidation) WithOpaqueID(s string) func(*ConnectorUpdateFilteringValidationRequest)

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

func (ConnectorUpdateFilteringValidation) WithPretty ¶ added in v8.14.0 

func (f ConnectorUpdateFilteringValidation) WithPretty() func(*ConnectorUpdateFilteringValidationRequest)

WithPretty makes the response body pretty-printed.

type ConnectorUpdateFilteringValidationRequest ¶ added in v8.14.0 

type ConnectorUpdateFilteringValidationRequest struct {
	Body io.Reader

	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorUpdateFilteringValidationRequest configures the Connector Update Filtering Validation API request.

func (ConnectorUpdateFilteringValidationRequest) Do ¶ added in v8.14.0 

func (r ConnectorUpdateFilteringValidationRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorUpdateIndexName ¶ added in v8.13.0 

type ConnectorUpdateIndexName func(body io.Reader, connector_id string, o ...func(*ConnectorUpdateIndexNameRequest)) (*Response, error)

ConnectorUpdateIndexName updates the index name of the connector.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-index-name-api.html.

func (ConnectorUpdateIndexName) WithContext ¶ added in v8.13.0 

func (f ConnectorUpdateIndexName) WithContext(v context.Context) func(*ConnectorUpdateIndexNameRequest)

WithContext sets the request context.

func (ConnectorUpdateIndexName) WithErrorTrace ¶ added in v8.13.0 

func (f ConnectorUpdateIndexName) WithErrorTrace() func(*ConnectorUpdateIndexNameRequest)

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

func (ConnectorUpdateIndexName) WithFilterPath ¶ added in v8.13.0 

func (f ConnectorUpdateIndexName) WithFilterPath(v ...string) func(*ConnectorUpdateIndexNameRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorUpdateIndexName) WithHeader ¶ added in v8.13.0 

func (f ConnectorUpdateIndexName) WithHeader(h map[string]string) func(*ConnectorUpdateIndexNameRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorUpdateIndexName) WithHuman ¶ added in v8.13.0 

func (f ConnectorUpdateIndexName) WithHuman() func(*ConnectorUpdateIndexNameRequest)

WithHuman makes statistical values human-readable.

func (ConnectorUpdateIndexName) WithOpaqueID ¶ added in v8.13.0 

func (f ConnectorUpdateIndexName) WithOpaqueID(s string) func(*ConnectorUpdateIndexNameRequest)

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

func (ConnectorUpdateIndexName) WithPretty ¶ added in v8.13.0 

func (f ConnectorUpdateIndexName) WithPretty() func(*ConnectorUpdateIndexNameRequest)

WithPretty makes the response body pretty-printed.

type ConnectorUpdateIndexNameRequest ¶ added in v8.13.0 

type ConnectorUpdateIndexNameRequest struct {
	Body io.Reader

	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorUpdateIndexNameRequest configures the Connector Update Index Name API request.

func (ConnectorUpdateIndexNameRequest) Do ¶ added in v8.13.0 

func (r ConnectorUpdateIndexNameRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorUpdateName ¶ added in v8.12.0 

type ConnectorUpdateName func(body io.Reader, connector_id string, o ...func(*ConnectorUpdateNameRequest)) (*Response, error)

ConnectorUpdateName updates the name and/or description fields in the connector document.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-name-description-api.html.

func (ConnectorUpdateName) WithContext ¶ added in v8.12.0 

func (f ConnectorUpdateName) WithContext(v context.Context) func(*ConnectorUpdateNameRequest)

WithContext sets the request context.

func (ConnectorUpdateName) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorUpdateName) WithErrorTrace() func(*ConnectorUpdateNameRequest)

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

func (ConnectorUpdateName) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorUpdateName) WithFilterPath(v ...string) func(*ConnectorUpdateNameRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorUpdateName) WithHeader ¶ added in v8.12.0 

func (f ConnectorUpdateName) WithHeader(h map[string]string) func(*ConnectorUpdateNameRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorUpdateName) WithHuman ¶ added in v8.12.0 

func (f ConnectorUpdateName) WithHuman() func(*ConnectorUpdateNameRequest)

WithHuman makes statistical values human-readable.

func (ConnectorUpdateName) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorUpdateName) WithOpaqueID(s string) func(*ConnectorUpdateNameRequest)

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

func (ConnectorUpdateName) WithPretty ¶ added in v8.12.0 

func (f ConnectorUpdateName) WithPretty() func(*ConnectorUpdateNameRequest)

WithPretty makes the response body pretty-printed.

type ConnectorUpdateNameRequest ¶ added in v8.12.0 

type ConnectorUpdateNameRequest struct {
	Body io.Reader

	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorUpdateNameRequest configures the Connector Update Name API request.

func (ConnectorUpdateNameRequest) Do ¶ added in v8.12.0 

func (r ConnectorUpdateNameRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorUpdateNative ¶ added in v8.13.0 

type ConnectorUpdateNative func(body io.Reader, connector_id string, o ...func(*ConnectorUpdateNativeRequest)) (*Response, error)

ConnectorUpdateNative updates the is_native flag of the connector.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/connector-apis.html.

func (ConnectorUpdateNative) WithContext ¶ added in v8.13.0 

func (f ConnectorUpdateNative) WithContext(v context.Context) func(*ConnectorUpdateNativeRequest)

WithContext sets the request context.

func (ConnectorUpdateNative) WithErrorTrace ¶ added in v8.13.0 

func (f ConnectorUpdateNative) WithErrorTrace() func(*ConnectorUpdateNativeRequest)

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

func (ConnectorUpdateNative) WithFilterPath ¶ added in v8.13.0 

func (f ConnectorUpdateNative) WithFilterPath(v ...string) func(*ConnectorUpdateNativeRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorUpdateNative) WithHeader ¶ added in v8.13.0 

func (f ConnectorUpdateNative) WithHeader(h map[string]string) func(*ConnectorUpdateNativeRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorUpdateNative) WithHuman ¶ added in v8.13.0 

func (f ConnectorUpdateNative) WithHuman() func(*ConnectorUpdateNativeRequest)

WithHuman makes statistical values human-readable.

func (ConnectorUpdateNative) WithOpaqueID ¶ added in v8.13.0 

func (f ConnectorUpdateNative) WithOpaqueID(s string) func(*ConnectorUpdateNativeRequest)

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

func (ConnectorUpdateNative) WithPretty ¶ added in v8.13.0 

func (f ConnectorUpdateNative) WithPretty() func(*ConnectorUpdateNativeRequest)

WithPretty makes the response body pretty-printed.

type ConnectorUpdateNativeRequest ¶ added in v8.13.0 

type ConnectorUpdateNativeRequest struct {
	Body io.Reader

	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorUpdateNativeRequest configures the Connector Update Native API request.

func (ConnectorUpdateNativeRequest) Do ¶ added in v8.13.0 

func (r ConnectorUpdateNativeRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorUpdatePipeline ¶ added in v8.12.0 

type ConnectorUpdatePipeline func(body io.Reader, connector_id string, o ...func(*ConnectorUpdatePipelineRequest)) (*Response, error)

ConnectorUpdatePipeline updates the pipeline field in the connector document.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-pipeline-api.html.

func (ConnectorUpdatePipeline) WithContext ¶ added in v8.12.0 

func (f ConnectorUpdatePipeline) WithContext(v context.Context) func(*ConnectorUpdatePipelineRequest)

WithContext sets the request context.

func (ConnectorUpdatePipeline) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorUpdatePipeline) WithErrorTrace() func(*ConnectorUpdatePipelineRequest)

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

func (ConnectorUpdatePipeline) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorUpdatePipeline) WithFilterPath(v ...string) func(*ConnectorUpdatePipelineRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorUpdatePipeline) WithHeader ¶ added in v8.12.0 

func (f ConnectorUpdatePipeline) WithHeader(h map[string]string) func(*ConnectorUpdatePipelineRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorUpdatePipeline) WithHuman ¶ added in v8.12.0 

func (f ConnectorUpdatePipeline) WithHuman() func(*ConnectorUpdatePipelineRequest)

WithHuman makes statistical values human-readable.

func (ConnectorUpdatePipeline) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorUpdatePipeline) WithOpaqueID(s string) func(*ConnectorUpdatePipelineRequest)

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

func (ConnectorUpdatePipeline) WithPretty ¶ added in v8.12.0 

func (f ConnectorUpdatePipeline) WithPretty() func(*ConnectorUpdatePipelineRequest)

WithPretty makes the response body pretty-printed.

type ConnectorUpdatePipelineRequest ¶ added in v8.12.0 

type ConnectorUpdatePipelineRequest struct {
	Body io.Reader

	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorUpdatePipelineRequest configures the Connector Update Pipeline API request.

func (ConnectorUpdatePipelineRequest) Do ¶ added in v8.12.0 

func (r ConnectorUpdatePipelineRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorUpdateScheduling ¶ added in v8.12.0 

type ConnectorUpdateScheduling func(body io.Reader, connector_id string, o ...func(*ConnectorUpdateSchedulingRequest)) (*Response, error)

ConnectorUpdateScheduling updates the scheduling field in the connector document.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-scheduling-api.html.

func (ConnectorUpdateScheduling) WithContext ¶ added in v8.12.0 

func (f ConnectorUpdateScheduling) WithContext(v context.Context) func(*ConnectorUpdateSchedulingRequest)

WithContext sets the request context.

func (ConnectorUpdateScheduling) WithErrorTrace ¶ added in v8.12.0 

func (f ConnectorUpdateScheduling) WithErrorTrace() func(*ConnectorUpdateSchedulingRequest)

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

func (ConnectorUpdateScheduling) WithFilterPath ¶ added in v8.12.0 

func (f ConnectorUpdateScheduling) WithFilterPath(v ...string) func(*ConnectorUpdateSchedulingRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorUpdateScheduling) WithHeader ¶ added in v8.12.0 

func (f ConnectorUpdateScheduling) WithHeader(h map[string]string) func(*ConnectorUpdateSchedulingRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorUpdateScheduling) WithHuman ¶ added in v8.12.0 

func (f ConnectorUpdateScheduling) WithHuman() func(*ConnectorUpdateSchedulingRequest)

WithHuman makes statistical values human-readable.

func (ConnectorUpdateScheduling) WithOpaqueID ¶ added in v8.12.0 

func (f ConnectorUpdateScheduling) WithOpaqueID(s string) func(*ConnectorUpdateSchedulingRequest)

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

func (ConnectorUpdateScheduling) WithPretty ¶ added in v8.12.0 

func (f ConnectorUpdateScheduling) WithPretty() func(*ConnectorUpdateSchedulingRequest)

WithPretty makes the response body pretty-printed.

type ConnectorUpdateSchedulingRequest ¶ added in v8.12.0 

type ConnectorUpdateSchedulingRequest struct {
	Body io.Reader

	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorUpdateSchedulingRequest configures the Connector Update Scheduling API request.

func (ConnectorUpdateSchedulingRequest) Do ¶ added in v8.12.0 

func (r ConnectorUpdateSchedulingRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorUpdateServiceDocumentType ¶ added in v8.13.0 

type ConnectorUpdateServiceDocumentType func(body io.Reader, connector_id string, o ...func(*ConnectorUpdateServiceDocumentTypeRequest)) (*Response, error)

ConnectorUpdateServiceDocumentType updates the service type of the connector.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-service-type-api.html.

func (ConnectorUpdateServiceDocumentType) WithContext ¶ added in v8.13.0 

func (f ConnectorUpdateServiceDocumentType) WithContext(v context.Context) func(*ConnectorUpdateServiceDocumentTypeRequest)

WithContext sets the request context.

func (ConnectorUpdateServiceDocumentType) WithErrorTrace ¶ added in v8.13.0 

func (f ConnectorUpdateServiceDocumentType) WithErrorTrace() func(*ConnectorUpdateServiceDocumentTypeRequest)

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

func (ConnectorUpdateServiceDocumentType) WithFilterPath ¶ added in v8.13.0 

func (f ConnectorUpdateServiceDocumentType) WithFilterPath(v ...string) func(*ConnectorUpdateServiceDocumentTypeRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorUpdateServiceDocumentType) WithHeader ¶ added in v8.13.0 

func (f ConnectorUpdateServiceDocumentType) WithHeader(h map[string]string) func(*ConnectorUpdateServiceDocumentTypeRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorUpdateServiceDocumentType) WithHuman ¶ added in v8.13.0 

func (f ConnectorUpdateServiceDocumentType) WithHuman() func(*ConnectorUpdateServiceDocumentTypeRequest)

WithHuman makes statistical values human-readable.

func (ConnectorUpdateServiceDocumentType) WithOpaqueID ¶ added in v8.13.0 

func (f ConnectorUpdateServiceDocumentType) WithOpaqueID(s string) func(*ConnectorUpdateServiceDocumentTypeRequest)

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

func (ConnectorUpdateServiceDocumentType) WithPretty ¶ added in v8.13.0 

func (f ConnectorUpdateServiceDocumentType) WithPretty() func(*ConnectorUpdateServiceDocumentTypeRequest)

WithPretty makes the response body pretty-printed.

type ConnectorUpdateServiceDocumentTypeRequest ¶ added in v8.13.0 

type ConnectorUpdateServiceDocumentTypeRequest struct {
	Body io.Reader

	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorUpdateServiceDocumentTypeRequest configures the Connector Update Service Document Type API request.

func (ConnectorUpdateServiceDocumentTypeRequest) Do ¶ added in v8.13.0 

func (r ConnectorUpdateServiceDocumentTypeRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ConnectorUpdateStatus ¶ added in v8.13.0 

type ConnectorUpdateStatus func(body io.Reader, connector_id string, o ...func(*ConnectorUpdateStatusRequest)) (*Response, error)

ConnectorUpdateStatus updates the status of the connector.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-status-api.html.

func (ConnectorUpdateStatus) WithContext ¶ added in v8.13.0 

func (f ConnectorUpdateStatus) WithContext(v context.Context) func(*ConnectorUpdateStatusRequest)

WithContext sets the request context.

func (ConnectorUpdateStatus) WithErrorTrace ¶ added in v8.13.0 

func (f ConnectorUpdateStatus) WithErrorTrace() func(*ConnectorUpdateStatusRequest)

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

func (ConnectorUpdateStatus) WithFilterPath ¶ added in v8.13.0 

func (f ConnectorUpdateStatus) WithFilterPath(v ...string) func(*ConnectorUpdateStatusRequest)

WithFilterPath filters the properties of the response body.

func (ConnectorUpdateStatus) WithHeader ¶ added in v8.13.0 

func (f ConnectorUpdateStatus) WithHeader(h map[string]string) func(*ConnectorUpdateStatusRequest)

WithHeader adds the headers to the HTTP request.

func (ConnectorUpdateStatus) WithHuman ¶ added in v8.13.0 

func (f ConnectorUpdateStatus) WithHuman() func(*ConnectorUpdateStatusRequest)

WithHuman makes statistical values human-readable.

func (ConnectorUpdateStatus) WithOpaqueID ¶ added in v8.13.0 

func (f ConnectorUpdateStatus) WithOpaqueID(s string) func(*ConnectorUpdateStatusRequest)

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

func (ConnectorUpdateStatus) WithPretty ¶ added in v8.13.0 

func (f ConnectorUpdateStatus) WithPretty() func(*ConnectorUpdateStatusRequest)

WithPretty makes the response body pretty-printed.

type ConnectorUpdateStatusRequest ¶ added in v8.13.0 

type ConnectorUpdateStatusRequest struct {
	Body io.Reader

	ConnectorID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ConnectorUpdateStatusRequest configures the Connector Update Status API request.

func (ConnectorUpdateStatusRequest) Do ¶ added in v8.13.0 

func (r ConnectorUpdateStatusRequest) Do(providedCtx 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) 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 ¶ 

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 ¶ 

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

	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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CountRequest configures the Count API request.

func (CountRequest) Do ¶ 

func (r CountRequest) Do(providedCtx 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) 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 ¶ 

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) WithIncludeSourceOnError ¶ added in v8.18.0 

func (f Create) WithIncludeSourceOnError(v bool) func(*CreateRequest)

WithIncludeSourceOnError - true or false if to include the document source in the error message in case of parsing errors. defaults to true..

func (Create) WithOpaqueID ¶ 

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
	DocumentID string

	Body io.Reader

	IncludeSourceOnError *bool
	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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

CreateRequest configures the Create API request.

func (CreateRequest) Do ¶ 

func (r CreateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type DanglingIndicesDeleteDanglingIndex ¶ 

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 ¶ 

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

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

func (DanglingIndicesDeleteDanglingIndex) WithContext ¶ 

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

WithContext sets the request context.

func (DanglingIndicesDeleteDanglingIndex) WithErrorTrace ¶ 

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

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

func (DanglingIndicesDeleteDanglingIndex) WithFilterPath ¶ 

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

WithFilterPath filters the properties of the response body.

func (DanglingIndicesDeleteDanglingIndex) WithHeader ¶ 

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

WithHeader adds the headers to the HTTP request.

func (DanglingIndicesDeleteDanglingIndex) WithHuman ¶ 

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

WithHuman makes statistical values human-readable.

func (DanglingIndicesDeleteDanglingIndex) WithMasterTimeout ¶ 

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

WithMasterTimeout - specify timeout for connection to master.

func (DanglingIndicesDeleteDanglingIndex) WithOpaqueID ¶ 

func (f DanglingIndicesDeleteDanglingIndex) WithOpaqueID(s string) func(*DanglingIndicesDeleteDanglingIndexRequest)

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

func (DanglingIndicesDeleteDanglingIndex) WithPretty ¶ 

func (f DanglingIndicesDeleteDanglingIndex) WithPretty() func(*DanglingIndicesDeleteDanglingIndexRequest)

WithPretty makes the response body pretty-printed.

func (DanglingIndicesDeleteDanglingIndex) WithTimeout ¶ 

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

WithTimeout - explicit operation timeout.

type DanglingIndicesDeleteDanglingIndexRequest ¶ 

type DanglingIndicesDeleteDanglingIndexRequest struct {
	IndexUUID string

	AcceptDataLoss *bool
	MasterTimeout  time.Duration
	Timeout        time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

DanglingIndicesDeleteDanglingIndexRequest configures the Dangling Indices Delete Dangling Index API request.

func (DanglingIndicesDeleteDanglingIndexRequest) Do ¶ 

func (r DanglingIndicesDeleteDanglingIndexRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type DanglingIndicesImportDanglingIndex ¶ 

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 ¶ 

func (f DanglingIndicesImportDanglingIndex) WithAcceptDataLoss(v bool) func(*DanglingIndicesImportDanglingIndexRequest)

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

func (DanglingIndicesImportDanglingIndex) WithContext ¶ 

func (f DanglingIndicesImportDanglingIndex) WithContext(v context.Context) func(*DanglingIndicesImportDanglingIndexRequest)

WithContext sets the request context.

func (DanglingIndicesImportDanglingIndex) WithErrorTrace ¶ 

func (f DanglingIndicesImportDanglingIndex) WithErrorTrace() func(*DanglingIndicesImportDanglingIndexRequest)

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

func (DanglingIndicesImportDanglingIndex) WithFilterPath ¶ 

func (f DanglingIndicesImportDanglingIndex) WithFilterPath(v ...string) func(*DanglingIndicesImportDanglingIndexRequest)

WithFilterPath filters the properties of the response body.

func (DanglingIndicesImportDanglingIndex) WithHeader ¶ 

func (f DanglingIndicesImportDanglingIndex) WithHeader(h map[string]string) func(*DanglingIndicesImportDanglingIndexRequest)

WithHeader adds the headers to the HTTP request.

func (DanglingIndicesImportDanglingIndex) WithHuman ¶ 

func (f DanglingIndicesImportDanglingIndex) WithHuman() func(*DanglingIndicesImportDanglingIndexRequest)

WithHuman makes statistical values human-readable.

func (DanglingIndicesImportDanglingIndex) WithMasterTimeout ¶ 

func (f DanglingIndicesImportDanglingIndex) WithMasterTimeout(v time.Duration) func(*DanglingIndicesImportDanglingIndexRequest)

WithMasterTimeout - specify timeout for connection to master.

func (DanglingIndicesImportDanglingIndex) WithOpaqueID ¶ 

func (f DanglingIndicesImportDanglingIndex) WithOpaqueID(s string) func(*DanglingIndicesImportDanglingIndexRequest)

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

func (DanglingIndicesImportDanglingIndex) WithPretty ¶ 

func (f DanglingIndicesImportDanglingIndex) WithPretty() func(*DanglingIndicesImportDanglingIndexRequest)

WithPretty makes the response body pretty-printed.

func (DanglingIndicesImportDanglingIndex) WithTimeout ¶ 

func (f DanglingIndicesImportDanglingIndex) WithTimeout(v time.Duration) func(*DanglingIndicesImportDanglingIndexRequest)

WithTimeout - explicit operation timeout.

type DanglingIndicesImportDanglingIndexRequest ¶ 

type DanglingIndicesImportDanglingIndexRequest struct {
	IndexUUID string

	AcceptDataLoss *bool
	MasterTimeout  time.Duration
	Timeout        time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

DanglingIndicesImportDanglingIndexRequest configures the Dangling Indices Import Dangling Index API request.

func (DanglingIndicesImportDanglingIndexRequest) Do ¶ 

func (r DanglingIndicesImportDanglingIndexRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type DanglingIndicesListDanglingIndices ¶ 

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 ¶ 

func (f DanglingIndicesListDanglingIndices) WithContext(v context.Context) func(*DanglingIndicesListDanglingIndicesRequest)

WithContext sets the request context.

func (DanglingIndicesListDanglingIndices) WithErrorTrace ¶ 

func (f DanglingIndicesListDanglingIndices) WithErrorTrace() func(*DanglingIndicesListDanglingIndicesRequest)

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

func (DanglingIndicesListDanglingIndices) WithFilterPath ¶ 

func (f DanglingIndicesListDanglingIndices) WithFilterPath(v ...string) func(*DanglingIndicesListDanglingIndicesRequest)

WithFilterPath filters the properties of the response body.

func (DanglingIndicesListDanglingIndices) WithHeader ¶ 

func (f DanglingIndicesListDanglingIndices) WithHeader(h map[string]string) func(*DanglingIndicesListDanglingIndicesRequest)

WithHeader adds the headers to the HTTP request.

func (DanglingIndicesListDanglingIndices) WithHuman ¶ 

func (f DanglingIndicesListDanglingIndices) WithHuman() func(*DanglingIndicesListDanglingIndicesRequest)

WithHuman makes statistical values human-readable.

func (DanglingIndicesListDanglingIndices) WithOpaqueID ¶ 

func (f DanglingIndicesListDanglingIndices) WithOpaqueID(s string) func(*DanglingIndicesListDanglingIndicesRequest)

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

func (DanglingIndicesListDanglingIndices) WithPretty ¶ 

func (f DanglingIndicesListDanglingIndices) WithPretty() func(*DanglingIndicesListDanglingIndicesRequest)

WithPretty makes the response body pretty-printed.

type DanglingIndicesListDanglingIndicesRequest ¶ 

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

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

DanglingIndicesListDanglingIndicesRequest configures the Dangling Indices List Dangling Indices API request.

func (DanglingIndicesListDanglingIndicesRequest) Do ¶ 

func (r DanglingIndicesListDanglingIndicesRequest) Do(providedCtx 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) 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 ¶ 

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 ¶ 

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

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 ¶ 

func (f DeleteByQuery) WithMaxDocs(v int) func(*DeleteByQueryRequest)

WithMaxDocs - maximum number of documents to process (default: all documents).

func (DeleteByQuery) WithOpaqueID ¶ 

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

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

DeleteByQueryRequest configures the Delete By Query API request.

func (DeleteByQueryRequest) Do ¶ 

func (r DeleteByQueryRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

DeleteByQueryRethrottleRequest configures the Delete By Query Rethrottle API request.

func (DeleteByQueryRethrottleRequest) Do ¶ 

func (r DeleteByQueryRethrottleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type DeleteRequest ¶ 

type DeleteRequest struct {
	Index      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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

DeleteRequest configures the Delete API request.

func (DeleteRequest) Do ¶ 

func (r DeleteRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

DeleteScriptRequest configures the Delete Script API request.

func (DeleteScriptRequest) Do ¶ 

func (r DeleteScriptRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type EnrichDeletePolicy ¶ 

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 ¶ 

func (f EnrichDeletePolicy) WithContext(v context.Context) func(*EnrichDeletePolicyRequest)

WithContext sets the request context.

func (EnrichDeletePolicy) WithErrorTrace ¶ 

func (f EnrichDeletePolicy) WithErrorTrace() func(*EnrichDeletePolicyRequest)

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

func (EnrichDeletePolicy) WithFilterPath ¶ 

func (f EnrichDeletePolicy) WithFilterPath(v ...string) func(*EnrichDeletePolicyRequest)

WithFilterPath filters the properties of the response body.

func (EnrichDeletePolicy) WithHeader ¶ 

func (f EnrichDeletePolicy) WithHeader(h map[string]string) func(*EnrichDeletePolicyRequest)

WithHeader adds the headers to the HTTP request.

func (EnrichDeletePolicy) WithHuman ¶ 

func (f EnrichDeletePolicy) WithHuman() func(*EnrichDeletePolicyRequest)

WithHuman makes statistical values human-readable.

func (EnrichDeletePolicy) WithMasterTimeout ¶ added in v8.15.0 

func (f EnrichDeletePolicy) WithMasterTimeout(v time.Duration) func(*EnrichDeletePolicyRequest)

WithMasterTimeout - timeout for processing on master node.

func (EnrichDeletePolicy) WithOpaqueID ¶ 

func (f EnrichDeletePolicy) WithOpaqueID(s string) func(*EnrichDeletePolicyRequest)

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

func (EnrichDeletePolicy) WithPretty ¶ 

func (f EnrichDeletePolicy) WithPretty() func(*EnrichDeletePolicyRequest)

WithPretty makes the response body pretty-printed.

type EnrichDeletePolicyRequest ¶ 

type EnrichDeletePolicyRequest struct {
	Name string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

EnrichDeletePolicyRequest configures the Enrich Delete Policy API request.

func (EnrichDeletePolicyRequest) Do ¶ 

func (r EnrichDeletePolicyRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type EnrichExecutePolicy ¶ 

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 ¶ 

func (f EnrichExecutePolicy) WithContext(v context.Context) func(*EnrichExecutePolicyRequest)

WithContext sets the request context.

func (EnrichExecutePolicy) WithErrorTrace ¶ 

func (f EnrichExecutePolicy) WithErrorTrace() func(*EnrichExecutePolicyRequest)

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

func (EnrichExecutePolicy) WithFilterPath ¶ 

func (f EnrichExecutePolicy) WithFilterPath(v ...string) func(*EnrichExecutePolicyRequest)

WithFilterPath filters the properties of the response body.

func (EnrichExecutePolicy) WithHeader ¶ 

func (f EnrichExecutePolicy) WithHeader(h map[string]string) func(*EnrichExecutePolicyRequest)

WithHeader adds the headers to the HTTP request.

func (EnrichExecutePolicy) WithHuman ¶ 

func (f EnrichExecutePolicy) WithHuman() func(*EnrichExecutePolicyRequest)

WithHuman makes statistical values human-readable.

func (EnrichExecutePolicy) WithMasterTimeout ¶ added in v8.15.0 

func (f EnrichExecutePolicy) WithMasterTimeout(v time.Duration) func(*EnrichExecutePolicyRequest)

WithMasterTimeout - timeout for processing on master node.

func (EnrichExecutePolicy) WithOpaqueID ¶ 

func (f EnrichExecutePolicy) WithOpaqueID(s string) func(*EnrichExecutePolicyRequest)

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

func (EnrichExecutePolicy) WithPretty ¶ 

func (f EnrichExecutePolicy) WithPretty() func(*EnrichExecutePolicyRequest)

WithPretty makes the response body pretty-printed.

func (EnrichExecutePolicy) WithWaitForCompletion ¶ 

func (f EnrichExecutePolicy) WithWaitForCompletion(v bool) func(*EnrichExecutePolicyRequest)

WithWaitForCompletion - should the request should block until the execution is complete..

type EnrichExecutePolicyRequest ¶ 

type EnrichExecutePolicyRequest struct {
	Name string

	MasterTimeout     time.Duration
	WaitForCompletion *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

EnrichExecutePolicyRequest configures the Enrich Execute Policy API request.

func (EnrichExecutePolicyRequest) Do ¶ 

func (r EnrichExecutePolicyRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type EnrichGetPolicy ¶ 

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 ¶ 

func (f EnrichGetPolicy) WithContext(v context.Context) func(*EnrichGetPolicyRequest)

WithContext sets the request context.

func (EnrichGetPolicy) WithErrorTrace ¶ 

func (f EnrichGetPolicy) WithErrorTrace() func(*EnrichGetPolicyRequest)

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

func (EnrichGetPolicy) WithFilterPath ¶ 

func (f EnrichGetPolicy) WithFilterPath(v ...string) func(*EnrichGetPolicyRequest)

WithFilterPath filters the properties of the response body.

func (EnrichGetPolicy) WithHeader ¶ 

func (f EnrichGetPolicy) WithHeader(h map[string]string) func(*EnrichGetPolicyRequest)

WithHeader adds the headers to the HTTP request.

func (EnrichGetPolicy) WithHuman ¶ 

func (f EnrichGetPolicy) WithHuman() func(*EnrichGetPolicyRequest)

WithHuman makes statistical values human-readable.

func (EnrichGetPolicy) WithMasterTimeout ¶ added in v8.15.0 

func (f EnrichGetPolicy) WithMasterTimeout(v time.Duration) func(*EnrichGetPolicyRequest)

WithMasterTimeout - timeout for processing on master node.

func (EnrichGetPolicy) WithName ¶ 

func (f EnrichGetPolicy) WithName(v ...string) func(*EnrichGetPolicyRequest)

WithName - a list of enrich policy names.

func (EnrichGetPolicy) WithOpaqueID ¶ 

func (f EnrichGetPolicy) WithOpaqueID(s string) func(*EnrichGetPolicyRequest)

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

func (EnrichGetPolicy) WithPretty ¶ 

func (f EnrichGetPolicy) WithPretty() func(*EnrichGetPolicyRequest)

WithPretty makes the response body pretty-printed.

type EnrichGetPolicyRequest ¶ 

type EnrichGetPolicyRequest struct {
	Name []string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

EnrichGetPolicyRequest configures the Enrich Get Policy API request.

func (EnrichGetPolicyRequest) Do ¶ 

func (r EnrichGetPolicyRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type EnrichPutPolicy ¶ 

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 ¶ 

func (f EnrichPutPolicy) WithContext(v context.Context) func(*EnrichPutPolicyRequest)

WithContext sets the request context.

func (EnrichPutPolicy) WithErrorTrace ¶ 

func (f EnrichPutPolicy) WithErrorTrace() func(*EnrichPutPolicyRequest)

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

func (EnrichPutPolicy) WithFilterPath ¶ 

func (f EnrichPutPolicy) WithFilterPath(v ...string) func(*EnrichPutPolicyRequest)

WithFilterPath filters the properties of the response body.

func (EnrichPutPolicy) WithHeader ¶ 

func (f EnrichPutPolicy) WithHeader(h map[string]string) func(*EnrichPutPolicyRequest)

WithHeader adds the headers to the HTTP request.

func (EnrichPutPolicy) WithHuman ¶ 

func (f EnrichPutPolicy) WithHuman() func(*EnrichPutPolicyRequest)

WithHuman makes statistical values human-readable.

func (EnrichPutPolicy) WithMasterTimeout ¶ added in v8.15.0 

func (f EnrichPutPolicy) WithMasterTimeout(v time.Duration) func(*EnrichPutPolicyRequest)

WithMasterTimeout - timeout for processing on master node.

func (EnrichPutPolicy) WithOpaqueID ¶ 

func (f EnrichPutPolicy) WithOpaqueID(s string) func(*EnrichPutPolicyRequest)

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

func (EnrichPutPolicy) WithPretty ¶ 

func (f EnrichPutPolicy) WithPretty() func(*EnrichPutPolicyRequest)

WithPretty makes the response body pretty-printed.

type EnrichPutPolicyRequest ¶ 

type EnrichPutPolicyRequest struct {
	Body io.Reader

	Name string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

EnrichPutPolicyRequest configures the Enrich Put Policy API request.

func (EnrichPutPolicyRequest) Do ¶ 

func (r EnrichPutPolicyRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type EnrichStats ¶ 

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 ¶ 

func (f EnrichStats) WithContext(v context.Context) func(*EnrichStatsRequest)

WithContext sets the request context.

func (EnrichStats) WithErrorTrace ¶ 

func (f EnrichStats) WithErrorTrace() func(*EnrichStatsRequest)

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

func (EnrichStats) WithFilterPath ¶ 

func (f EnrichStats) WithFilterPath(v ...string) func(*EnrichStatsRequest)

WithFilterPath filters the properties of the response body.

func (EnrichStats) WithHeader ¶ 

func (f EnrichStats) WithHeader(h map[string]string) func(*EnrichStatsRequest)

WithHeader adds the headers to the HTTP request.

func (EnrichStats) WithHuman ¶ 

func (f EnrichStats) WithHuman() func(*EnrichStatsRequest)

WithHuman makes statistical values human-readable.

func (EnrichStats) WithMasterTimeout ¶ added in v8.15.0 

func (f EnrichStats) WithMasterTimeout(v time.Duration) func(*EnrichStatsRequest)

WithMasterTimeout - timeout for processing on master node.

func (EnrichStats) WithOpaqueID ¶ 

func (f EnrichStats) WithOpaqueID(s string) func(*EnrichStatsRequest)

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

func (EnrichStats) WithPretty ¶ 

func (f EnrichStats) WithPretty() func(*EnrichStatsRequest)

WithPretty makes the response body pretty-printed.

type EnrichStatsRequest ¶ 

type EnrichStatsRequest struct {
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

EnrichStatsRequest configures the Enrich Stats API request.

func (EnrichStatsRequest) Do ¶ 

func (r EnrichStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type EqlDelete ¶ 

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 ¶ 

func (f EqlDelete) WithContext(v context.Context) func(*EqlDeleteRequest)

WithContext sets the request context.

func (EqlDelete) WithErrorTrace ¶ 

func (f EqlDelete) WithErrorTrace() func(*EqlDeleteRequest)

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

func (EqlDelete) WithFilterPath ¶ 

func (f EqlDelete) WithFilterPath(v ...string) func(*EqlDeleteRequest)

WithFilterPath filters the properties of the response body.

func (EqlDelete) WithHeader ¶ 

func (f EqlDelete) WithHeader(h map[string]string) func(*EqlDeleteRequest)

WithHeader adds the headers to the HTTP request.

func (EqlDelete) WithHuman ¶ 

func (f EqlDelete) WithHuman() func(*EqlDeleteRequest)

WithHuman makes statistical values human-readable.

func (EqlDelete) WithOpaqueID ¶ 

func (f EqlDelete) WithOpaqueID(s string) func(*EqlDeleteRequest)

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

func (EqlDelete) WithPretty ¶ 

func (f EqlDelete) WithPretty() func(*EqlDeleteRequest)

WithPretty makes the response body pretty-printed.

type EqlDeleteRequest ¶ 

type EqlDeleteRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

EqlDeleteRequest configures the Eql Delete API request.

func (EqlDeleteRequest) Do ¶ 

func (r EqlDeleteRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type EqlGet ¶ 

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 ¶ 

func (f EqlGet) WithContext(v context.Context) func(*EqlGetRequest)

WithContext sets the request context.

func (EqlGet) WithErrorTrace ¶ 

func (f EqlGet) WithErrorTrace() func(*EqlGetRequest)

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

func (EqlGet) WithFilterPath ¶ 

func (f EqlGet) WithFilterPath(v ...string) func(*EqlGetRequest)

WithFilterPath filters the properties of the response body.

func (EqlGet) WithHeader ¶ 

func (f EqlGet) WithHeader(h map[string]string) func(*EqlGetRequest)

WithHeader adds the headers to the HTTP request.

func (EqlGet) WithHuman ¶ 

func (f EqlGet) WithHuman() func(*EqlGetRequest)

WithHuman makes statistical values human-readable.

func (EqlGet) WithKeepAlive ¶ 

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 ¶ 

func (f EqlGet) WithOpaqueID(s string) func(*EqlGetRequest)

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

func (EqlGet) WithPretty ¶ 

func (f EqlGet) WithPretty() func(*EqlGetRequest)

WithPretty makes the response body pretty-printed.

func (EqlGet) WithWaitForCompletionTimeout ¶ 

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 ¶ 

type EqlGetRequest struct {
	DocumentID string

	KeepAlive                time.Duration
	WaitForCompletionTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

EqlGetRequest configures the Eql Get API request.

func (EqlGetRequest) Do ¶ 

func (r EqlGetRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type EqlGetStatus ¶ 

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 ¶ 

func (f EqlGetStatus) WithContext(v context.Context) func(*EqlGetStatusRequest)

WithContext sets the request context.

func (EqlGetStatus) WithErrorTrace ¶ 

func (f EqlGetStatus) WithErrorTrace() func(*EqlGetStatusRequest)

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

func (EqlGetStatus) WithFilterPath ¶ 

func (f EqlGetStatus) WithFilterPath(v ...string) func(*EqlGetStatusRequest)

WithFilterPath filters the properties of the response body.

func (EqlGetStatus) WithHeader ¶ 

func (f EqlGetStatus) WithHeader(h map[string]string) func(*EqlGetStatusRequest)

WithHeader adds the headers to the HTTP request.

func (EqlGetStatus) WithHuman ¶ 

func (f EqlGetStatus) WithHuman() func(*EqlGetStatusRequest)

WithHuman makes statistical values human-readable.

func (EqlGetStatus) WithOpaqueID ¶ 

func (f EqlGetStatus) WithOpaqueID(s string) func(*EqlGetStatusRequest)

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

func (EqlGetStatus) WithPretty ¶ 

func (f EqlGetStatus) WithPretty() func(*EqlGetStatusRequest)

WithPretty makes the response body pretty-printed.

type EqlGetStatusRequest ¶ 

type EqlGetStatusRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

EqlGetStatusRequest configures the Eql Get Status API request.

func (EqlGetStatusRequest) Do ¶ 

func (r EqlGetStatusRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type EqlSearch ¶ 

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) WithAllowPartialSearchResults ¶ added in v8.18.0 

func (f EqlSearch) WithAllowPartialSearchResults(v bool) func(*EqlSearchRequest)

WithAllowPartialSearchResults - control whether the query should keep running in case of shard failures, and return partial results.

func (EqlSearch) WithAllowPartialSequenceResults ¶ added in v8.18.0 

func (f EqlSearch) WithAllowPartialSequenceResults(v bool) func(*EqlSearchRequest)

WithAllowPartialSequenceResults - control whether a sequence query should return partial results or no results at all in case of shard failures. this option has effect only if [allow_partial_search_results] is true..

func (EqlSearch) WithContext ¶ 

func (f EqlSearch) WithContext(v context.Context) func(*EqlSearchRequest)

WithContext sets the request context.

func (EqlSearch) WithErrorTrace ¶ 

func (f EqlSearch) WithErrorTrace() func(*EqlSearchRequest)

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

func (EqlSearch) WithFilterPath ¶ 

func (f EqlSearch) WithFilterPath(v ...string) func(*EqlSearchRequest)

WithFilterPath filters the properties of the response body.

func (EqlSearch) WithHeader ¶ 

func (f EqlSearch) WithHeader(h map[string]string) func(*EqlSearchRequest)

WithHeader adds the headers to the HTTP request.

func (EqlSearch) WithHuman ¶ 

func (f EqlSearch) WithHuman() func(*EqlSearchRequest)

WithHuman makes statistical values human-readable.

func (EqlSearch) WithKeepAlive ¶ 

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 ¶ 

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 ¶ 

func (f EqlSearch) WithOpaqueID(s string) func(*EqlSearchRequest)

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

func (EqlSearch) WithPretty ¶ 

func (f EqlSearch) WithPretty() func(*EqlSearchRequest)

WithPretty makes the response body pretty-printed.

func (EqlSearch) WithWaitForCompletionTimeout ¶ 

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 ¶ 

type EqlSearchRequest struct {
	Index string

	Body io.Reader

	AllowPartialSearchResults   *bool
	AllowPartialSequenceResults *bool
	KeepAlive                   time.Duration
	KeepOnCompletion            *bool
	WaitForCompletionTimeout    time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

EqlSearchRequest configures the Eql Search API request.

func (EqlSearchRequest) Do ¶ 

func (r EqlSearchRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type EsqlAsyncQuery ¶ added in v8.13.0 

type EsqlAsyncQuery func(body io.Reader, o ...func(*EsqlAsyncQueryRequest)) (*Response, error)

EsqlAsyncQuery - Executes an ESQL request asynchronously

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-api.html.

func (EsqlAsyncQuery) WithContext ¶ added in v8.13.0 

func (f EsqlAsyncQuery) WithContext(v context.Context) func(*EsqlAsyncQueryRequest)

WithContext sets the request context.

func (EsqlAsyncQuery) WithDelimiter ¶ added in v8.13.0 

func (f EsqlAsyncQuery) WithDelimiter(v string) func(*EsqlAsyncQueryRequest)

WithDelimiter - the character to use between values within a csv row. only valid for the csv format..

func (EsqlAsyncQuery) WithDropNullColumns ¶ added in v8.13.0 

func (f EsqlAsyncQuery) WithDropNullColumns(v bool) func(*EsqlAsyncQueryRequest)

WithDropNullColumns - should entirely null columns be removed from the results? their name and type will be returning in a new `all_columns` section..

func (EsqlAsyncQuery) WithErrorTrace ¶ added in v8.13.0 

func (f EsqlAsyncQuery) WithErrorTrace() func(*EsqlAsyncQueryRequest)

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

func (EsqlAsyncQuery) WithFilterPath ¶ added in v8.13.0 

func (f EsqlAsyncQuery) WithFilterPath(v ...string) func(*EsqlAsyncQueryRequest)

WithFilterPath filters the properties of the response body.

func (EsqlAsyncQuery) WithFormat ¶ added in v8.13.0 

func (f EsqlAsyncQuery) WithFormat(v string) func(*EsqlAsyncQueryRequest)

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

func (EsqlAsyncQuery) WithHeader ¶ added in v8.13.0 

func (f EsqlAsyncQuery) WithHeader(h map[string]string) func(*EsqlAsyncQueryRequest)

WithHeader adds the headers to the HTTP request.

func (EsqlAsyncQuery) WithHuman ¶ added in v8.13.0 

func (f EsqlAsyncQuery) WithHuman() func(*EsqlAsyncQueryRequest)

WithHuman makes statistical values human-readable.

func (EsqlAsyncQuery) WithOpaqueID ¶ added in v8.13.0 

func (f EsqlAsyncQuery) WithOpaqueID(s string) func(*EsqlAsyncQueryRequest)

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

func (EsqlAsyncQuery) WithPretty ¶ added in v8.13.0 

func (f EsqlAsyncQuery) WithPretty() func(*EsqlAsyncQueryRequest)

WithPretty makes the response body pretty-printed.

type EsqlAsyncQueryDelete ¶ added in v8.18.0 

type EsqlAsyncQueryDelete func(id string, o ...func(*EsqlAsyncQueryDeleteRequest)) (*Response, error)

EsqlAsyncQueryDelete - Delete an async query request given its ID.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-delete-api.html.

func (EsqlAsyncQueryDelete) WithContext ¶ added in v8.18.0 

func (f EsqlAsyncQueryDelete) WithContext(v context.Context) func(*EsqlAsyncQueryDeleteRequest)

WithContext sets the request context.

func (EsqlAsyncQueryDelete) WithErrorTrace ¶ added in v8.18.0 

func (f EsqlAsyncQueryDelete) WithErrorTrace() func(*EsqlAsyncQueryDeleteRequest)

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

func (EsqlAsyncQueryDelete) WithFilterPath ¶ added in v8.18.0 

func (f EsqlAsyncQueryDelete) WithFilterPath(v ...string) func(*EsqlAsyncQueryDeleteRequest)

WithFilterPath filters the properties of the response body.

func (EsqlAsyncQueryDelete) WithHeader ¶ added in v8.18.0 

func (f EsqlAsyncQueryDelete) WithHeader(h map[string]string) func(*EsqlAsyncQueryDeleteRequest)

WithHeader adds the headers to the HTTP request.

func (EsqlAsyncQueryDelete) WithHuman ¶ added in v8.18.0 

func (f EsqlAsyncQueryDelete) WithHuman() func(*EsqlAsyncQueryDeleteRequest)

WithHuman makes statistical values human-readable.

func (EsqlAsyncQueryDelete) WithOpaqueID ¶ added in v8.18.0 

func (f EsqlAsyncQueryDelete) WithOpaqueID(s string) func(*EsqlAsyncQueryDeleteRequest)

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

func (EsqlAsyncQueryDelete) WithPretty ¶ added in v8.18.0 

func (f EsqlAsyncQueryDelete) WithPretty() func(*EsqlAsyncQueryDeleteRequest)

WithPretty makes the response body pretty-printed.

type EsqlAsyncQueryDeleteRequest ¶ added in v8.18.0 

type EsqlAsyncQueryDeleteRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

EsqlAsyncQueryDeleteRequest configures the Esql Async Query Delete API request.

func (EsqlAsyncQueryDeleteRequest) Do ¶ added in v8.18.0 

func (r EsqlAsyncQueryDeleteRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type EsqlAsyncQueryGet ¶ added in v8.13.0 

type EsqlAsyncQueryGet func(id string, o ...func(*EsqlAsyncQueryGetRequest)) (*Response, error)

EsqlAsyncQueryGet - Retrieves the results of a previously submitted async query request given its ID.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-get-api.html.

func (EsqlAsyncQueryGet) WithContext ¶ added in v8.13.0 

func (f EsqlAsyncQueryGet) WithContext(v context.Context) func(*EsqlAsyncQueryGetRequest)

WithContext sets the request context.

func (EsqlAsyncQueryGet) WithDropNullColumns ¶ added in v8.13.0 

func (f EsqlAsyncQueryGet) WithDropNullColumns(v bool) func(*EsqlAsyncQueryGetRequest)

WithDropNullColumns - should entirely null columns be removed from the results? their name and type will be returning in a new `all_columns` section..

func (EsqlAsyncQueryGet) WithErrorTrace ¶ added in v8.13.0 

func (f EsqlAsyncQueryGet) WithErrorTrace() func(*EsqlAsyncQueryGetRequest)

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

func (EsqlAsyncQueryGet) WithFilterPath ¶ added in v8.13.0 

func (f EsqlAsyncQueryGet) WithFilterPath(v ...string) func(*EsqlAsyncQueryGetRequest)

WithFilterPath filters the properties of the response body.

func (EsqlAsyncQueryGet) WithHeader ¶ added in v8.13.0 

func (f EsqlAsyncQueryGet) WithHeader(h map[string]string) func(*EsqlAsyncQueryGetRequest)

WithHeader adds the headers to the HTTP request.

func (EsqlAsyncQueryGet) WithHuman ¶ added in v8.13.0 

func (f EsqlAsyncQueryGet) WithHuman() func(*EsqlAsyncQueryGetRequest)

WithHuman makes statistical values human-readable.

func (EsqlAsyncQueryGet) WithKeepAlive ¶ added in v8.13.0 

func (f EsqlAsyncQueryGet) WithKeepAlive(v time.Duration) func(*EsqlAsyncQueryGetRequest)

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

func (EsqlAsyncQueryGet) WithOpaqueID ¶ added in v8.13.0 

func (f EsqlAsyncQueryGet) WithOpaqueID(s string) func(*EsqlAsyncQueryGetRequest)

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

func (EsqlAsyncQueryGet) WithPretty ¶ added in v8.13.0 

func (f EsqlAsyncQueryGet) WithPretty() func(*EsqlAsyncQueryGetRequest)

WithPretty makes the response body pretty-printed.

func (EsqlAsyncQueryGet) WithWaitForCompletionTimeout ¶ added in v8.13.0 

func (f EsqlAsyncQueryGet) WithWaitForCompletionTimeout(v time.Duration) func(*EsqlAsyncQueryGetRequest)

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

type EsqlAsyncQueryGetRequest ¶ added in v8.13.0 

type EsqlAsyncQueryGetRequest struct {
	DocumentID string

	DropNullColumns          *bool
	KeepAlive                time.Duration
	WaitForCompletionTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

EsqlAsyncQueryGetRequest configures the Esql Async Query Get API request.

func (EsqlAsyncQueryGetRequest) Do ¶ added in v8.13.0 

func (r EsqlAsyncQueryGetRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type EsqlAsyncQueryRequest ¶ added in v8.13.0 

type EsqlAsyncQueryRequest struct {
	Body io.Reader

	Delimiter       string
	DropNullColumns *bool
	Format          string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

EsqlAsyncQueryRequest configures the Esql Async Query API request.

func (EsqlAsyncQueryRequest) Do ¶ added in v8.13.0 

func (r EsqlAsyncQueryRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type EsqlAsyncQueryStop ¶ added in v8.18.0 

type EsqlAsyncQueryStop func(id string, o ...func(*EsqlAsyncQueryStopRequest)) (*Response, error)

EsqlAsyncQueryStop - Stops a previously submitted async query request given its ID and collects the results.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-stop-api.html.

func (EsqlAsyncQueryStop) WithContext ¶ added in v8.18.0 

func (f EsqlAsyncQueryStop) WithContext(v context.Context) func(*EsqlAsyncQueryStopRequest)

WithContext sets the request context.

func (EsqlAsyncQueryStop) WithErrorTrace ¶ added in v8.18.0 

func (f EsqlAsyncQueryStop) WithErrorTrace() func(*EsqlAsyncQueryStopRequest)

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

func (EsqlAsyncQueryStop) WithFilterPath ¶ added in v8.18.0 

func (f EsqlAsyncQueryStop) WithFilterPath(v ...string) func(*EsqlAsyncQueryStopRequest)

WithFilterPath filters the properties of the response body.

func (EsqlAsyncQueryStop) WithHeader ¶ added in v8.18.0 

func (f EsqlAsyncQueryStop) WithHeader(h map[string]string) func(*EsqlAsyncQueryStopRequest)

WithHeader adds the headers to the HTTP request.

func (EsqlAsyncQueryStop) WithHuman ¶ added in v8.18.0 

func (f EsqlAsyncQueryStop) WithHuman() func(*EsqlAsyncQueryStopRequest)

WithHuman makes statistical values human-readable.

func (EsqlAsyncQueryStop) WithOpaqueID ¶ added in v8.18.0 

func (f EsqlAsyncQueryStop) WithOpaqueID(s string) func(*EsqlAsyncQueryStopRequest)

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

func (EsqlAsyncQueryStop) WithPretty ¶ added in v8.18.0 

func (f EsqlAsyncQueryStop) WithPretty() func(*EsqlAsyncQueryStopRequest)

WithPretty makes the response body pretty-printed.

type EsqlAsyncQueryStopRequest ¶ added in v8.18.0 

type EsqlAsyncQueryStopRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

EsqlAsyncQueryStopRequest configures the Esql Async Query Stop API request.

func (EsqlAsyncQueryStopRequest) Do ¶ added in v8.18.0 

func (r EsqlAsyncQueryStopRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type EsqlQuery ¶ added in v8.11.0 

type EsqlQuery func(body io.Reader, o ...func(*EsqlQueryRequest)) (*Response, error)

EsqlQuery - Executes an ESQL request

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-query-api.html.

func (EsqlQuery) WithContext ¶ added in v8.11.0 

func (f EsqlQuery) WithContext(v context.Context) func(*EsqlQueryRequest)

WithContext sets the request context.

func (EsqlQuery) WithDelimiter ¶ added in v8.11.0 

func (f EsqlQuery) WithDelimiter(v string) func(*EsqlQueryRequest)

WithDelimiter - the character to use between values within a csv row. only valid for the csv format..

func (EsqlQuery) WithDropNullColumns ¶ added in v8.13.0 

func (f EsqlQuery) WithDropNullColumns(v bool) func(*EsqlQueryRequest)

WithDropNullColumns - should entirely null columns be removed from the results? their name and type will be returning in a new `all_columns` section..

func (EsqlQuery) WithErrorTrace ¶ added in v8.11.0 

func (f EsqlQuery) WithErrorTrace() func(*EsqlQueryRequest)

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

func (EsqlQuery) WithFilterPath ¶ added in v8.11.0 

func (f EsqlQuery) WithFilterPath(v ...string) func(*EsqlQueryRequest)

WithFilterPath filters the properties of the response body.

func (EsqlQuery) WithFormat ¶ added in v8.11.0 

func (f EsqlQuery) WithFormat(v string) func(*EsqlQueryRequest)

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

func (EsqlQuery) WithHeader ¶ added in v8.11.0 

func (f EsqlQuery) WithHeader(h map[string]string) func(*EsqlQueryRequest)

WithHeader adds the headers to the HTTP request.

func (EsqlQuery) WithHuman ¶ added in v8.11.0 

func (f EsqlQuery) WithHuman() func(*EsqlQueryRequest)

WithHuman makes statistical values human-readable.

func (EsqlQuery) WithOpaqueID ¶ added in v8.11.0 

func (f EsqlQuery) WithOpaqueID(s string) func(*EsqlQueryRequest)

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

func (EsqlQuery) WithPretty ¶ added in v8.11.0 

func (f EsqlQuery) WithPretty() func(*EsqlQueryRequest)

WithPretty makes the response body pretty-printed.

type EsqlQueryRequest ¶ added in v8.11.0 

type EsqlQueryRequest struct {
	Body io.Reader

	Delimiter       string
	DropNullColumns *bool
	Format          string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

EsqlQueryRequest configures the Esql Query API request.

func (EsqlQueryRequest) Do ¶ added in v8.11.0 

func (r EsqlQueryRequest) Do(providedCtx 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) 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ExistsRequest configures the Exists API request.

func (ExistsRequest) Do ¶ 

func (r ExistsRequest) Do(providedCtx 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) 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ExistsSourceRequest configures the Exists Source API request.

func (ExistsSourceRequest) Do ¶ 

func (r ExistsSourceRequest) Do(providedCtx 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) 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ExplainRequest configures the Explain API request.

func (ExplainRequest) Do ¶ 

func (r ExplainRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type FeaturesGetFeatures ¶ 

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 ¶ 

func (f FeaturesGetFeatures) WithContext(v context.Context) func(*FeaturesGetFeaturesRequest)

WithContext sets the request context.

func (FeaturesGetFeatures) WithErrorTrace ¶ 

func (f FeaturesGetFeatures) WithErrorTrace() func(*FeaturesGetFeaturesRequest)

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

func (FeaturesGetFeatures) WithFilterPath ¶ 

func (f FeaturesGetFeatures) WithFilterPath(v ...string) func(*FeaturesGetFeaturesRequest)

WithFilterPath filters the properties of the response body.

func (FeaturesGetFeatures) WithHeader ¶ 

func (f FeaturesGetFeatures) WithHeader(h map[string]string) func(*FeaturesGetFeaturesRequest)

WithHeader adds the headers to the HTTP request.

func (FeaturesGetFeatures) WithHuman ¶ 

func (f FeaturesGetFeatures) WithHuman() func(*FeaturesGetFeaturesRequest)

WithHuman makes statistical values human-readable.

func (FeaturesGetFeatures) WithMasterTimeout ¶ 

func (f FeaturesGetFeatures) WithMasterTimeout(v time.Duration) func(*FeaturesGetFeaturesRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (FeaturesGetFeatures) WithOpaqueID ¶ 

func (f FeaturesGetFeatures) WithOpaqueID(s string) func(*FeaturesGetFeaturesRequest)

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

func (FeaturesGetFeatures) WithPretty ¶ 

func (f FeaturesGetFeatures) WithPretty() func(*FeaturesGetFeaturesRequest)

WithPretty makes the response body pretty-printed.

type FeaturesGetFeaturesRequest ¶ 

type FeaturesGetFeaturesRequest struct {
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

FeaturesGetFeaturesRequest configures the Features Get Features API request.

func (FeaturesGetFeaturesRequest) Do ¶ 

func (r FeaturesGetFeaturesRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type FeaturesResetFeatures ¶ 

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 ¶ 

func (f FeaturesResetFeatures) WithContext(v context.Context) func(*FeaturesResetFeaturesRequest)

WithContext sets the request context.

func (FeaturesResetFeatures) WithErrorTrace ¶ 

func (f FeaturesResetFeatures) WithErrorTrace() func(*FeaturesResetFeaturesRequest)

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

func (FeaturesResetFeatures) WithFilterPath ¶ 

func (f FeaturesResetFeatures) WithFilterPath(v ...string) func(*FeaturesResetFeaturesRequest)

WithFilterPath filters the properties of the response body.

func (FeaturesResetFeatures) WithHeader ¶ 

func (f FeaturesResetFeatures) WithHeader(h map[string]string) func(*FeaturesResetFeaturesRequest)

WithHeader adds the headers to the HTTP request.

func (FeaturesResetFeatures) WithHuman ¶ 

func (f FeaturesResetFeatures) WithHuman() func(*FeaturesResetFeaturesRequest)

WithHuman makes statistical values human-readable.

func (FeaturesResetFeatures) WithMasterTimeout ¶ added in v8.15.0 

func (f FeaturesResetFeatures) WithMasterTimeout(v time.Duration) func(*FeaturesResetFeaturesRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (FeaturesResetFeatures) WithOpaqueID ¶ 

func (f FeaturesResetFeatures) WithOpaqueID(s string) func(*FeaturesResetFeaturesRequest)

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

func (FeaturesResetFeatures) WithPretty ¶ 

func (f FeaturesResetFeatures) WithPretty() func(*FeaturesResetFeaturesRequest)

WithPretty makes the response body pretty-printed.

type FeaturesResetFeaturesRequest ¶ 

type FeaturesResetFeaturesRequest struct {
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

FeaturesResetFeaturesRequest configures the Features Reset Features API request.

func (FeaturesResetFeaturesRequest) Do ¶ 

func (r FeaturesResetFeaturesRequest) Do(providedCtx 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 ¶ 

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) WithFilters ¶ added in v8.2.0 

func (f FieldCaps) WithFilters(v ...string) func(*FieldCapsRequest)

WithFilters - an optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent.

func (FieldCaps) WithHeader ¶ 

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) WithIncludeEmptyFields ¶ added in v8.13.0 

func (f FieldCaps) WithIncludeEmptyFields(v bool) func(*FieldCapsRequest)

WithIncludeEmptyFields - include empty fields in result.

func (FieldCaps) WithIncludeUnmapped ¶ 

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 ¶ 

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.

func (FieldCaps) WithTypes ¶ added in v8.2.0 

func (f FieldCaps) WithTypes(v ...string) func(*FieldCapsRequest)

WithTypes - only return results for fields that have one of the types in the list.

type FieldCapsRequest ¶ 

type FieldCapsRequest struct {
	Index []string

	Body io.Reader

	AllowNoIndices     *bool
	ExpandWildcards    string
	Fields             []string
	Filters            []string
	IgnoreUnavailable  *bool
	IncludeEmptyFields *bool
	IncludeUnmapped    *bool
	Types              []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

FieldCapsRequest configures the Field Caps API request.

func (FieldCapsRequest) Do ¶ 

func (r FieldCapsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type FleetDeleteSecret ¶ added in v8.10.0 

type FleetDeleteSecret func(id string, o ...func(*FleetDeleteSecretRequest)) (*Response, error)

FleetDeleteSecret deletes a secret stored by Fleet.

This API is experimental.

func (FleetDeleteSecret) WithContext ¶ added in v8.10.0 

func (f FleetDeleteSecret) WithContext(v context.Context) func(*FleetDeleteSecretRequest)

WithContext sets the request context.

func (FleetDeleteSecret) WithErrorTrace ¶ added in v8.10.0 

func (f FleetDeleteSecret) WithErrorTrace() func(*FleetDeleteSecretRequest)

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

func (FleetDeleteSecret) WithFilterPath ¶ added in v8.10.0 

func (f FleetDeleteSecret) WithFilterPath(v ...string) func(*FleetDeleteSecretRequest)

WithFilterPath filters the properties of the response body.

func (FleetDeleteSecret) WithHeader ¶ added in v8.10.0 

func (f FleetDeleteSecret) WithHeader(h map[string]string) func(*FleetDeleteSecretRequest)

WithHeader adds the headers to the HTTP request.

func (FleetDeleteSecret) WithHuman ¶ added in v8.10.0 

func (f FleetDeleteSecret) WithHuman() func(*FleetDeleteSecretRequest)

WithHuman makes statistical values human-readable.

func (FleetDeleteSecret) WithOpaqueID ¶ added in v8.10.0 

func (f FleetDeleteSecret) WithOpaqueID(s string) func(*FleetDeleteSecretRequest)

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

func (FleetDeleteSecret) WithPretty ¶ added in v8.10.0 

func (f FleetDeleteSecret) WithPretty() func(*FleetDeleteSecretRequest)

WithPretty makes the response body pretty-printed.

type FleetDeleteSecretRequest ¶ added in v8.10.0 

type FleetDeleteSecretRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

FleetDeleteSecretRequest configures the Fleet Delete Secret API request.

func (FleetDeleteSecretRequest) Do ¶ added in v8.10.0 

func (r FleetDeleteSecretRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type FleetGetSecret ¶ added in v8.10.0 

type FleetGetSecret func(id string, o ...func(*FleetGetSecretRequest)) (*Response, error)

FleetGetSecret retrieves a secret stored by Fleet.

This API is experimental.

func (FleetGetSecret) WithContext ¶ added in v8.10.0 

func (f FleetGetSecret) WithContext(v context.Context) func(*FleetGetSecretRequest)

WithContext sets the request context.

func (FleetGetSecret) WithErrorTrace ¶ added in v8.10.0 

func (f FleetGetSecret) WithErrorTrace() func(*FleetGetSecretRequest)

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

func (FleetGetSecret) WithFilterPath ¶ added in v8.10.0 

func (f FleetGetSecret) WithFilterPath(v ...string) func(*FleetGetSecretRequest)

WithFilterPath filters the properties of the response body.

func (FleetGetSecret) WithHeader ¶ added in v8.10.0 

func (f FleetGetSecret) WithHeader(h map[string]string) func(*FleetGetSecretRequest)

WithHeader adds the headers to the HTTP request.

func (FleetGetSecret) WithHuman ¶ added in v8.10.0 

func (f FleetGetSecret) WithHuman() func(*FleetGetSecretRequest)

WithHuman makes statistical values human-readable.

func (FleetGetSecret) WithOpaqueID ¶ added in v8.10.0 

func (f FleetGetSecret) WithOpaqueID(s string) func(*FleetGetSecretRequest)

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

func (FleetGetSecret) WithPretty ¶ added in v8.10.0 

func (f FleetGetSecret) WithPretty() func(*FleetGetSecretRequest)

WithPretty makes the response body pretty-printed.

type FleetGetSecretRequest ¶ added in v8.10.0 

type FleetGetSecretRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

FleetGetSecretRequest configures the Fleet Get Secret API request.

func (FleetGetSecretRequest) Do ¶ added in v8.10.0 

func (r FleetGetSecretRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type FleetGlobalCheckpoints ¶ 

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 ¶ 

func (f FleetGlobalCheckpoints) WithCheckpoints(v ...string) func(*FleetGlobalCheckpointsRequest)

WithCheckpoints - comma separated list of checkpoints.

func (FleetGlobalCheckpoints) WithContext ¶ 

func (f FleetGlobalCheckpoints) WithContext(v context.Context) func(*FleetGlobalCheckpointsRequest)

WithContext sets the request context.

func (FleetGlobalCheckpoints) WithErrorTrace ¶ 

func (f FleetGlobalCheckpoints) WithErrorTrace() func(*FleetGlobalCheckpointsRequest)

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

func (FleetGlobalCheckpoints) WithFilterPath ¶ 

func (f FleetGlobalCheckpoints) WithFilterPath(v ...string) func(*FleetGlobalCheckpointsRequest)

WithFilterPath filters the properties of the response body.

func (FleetGlobalCheckpoints) WithHeader ¶ 

func (f FleetGlobalCheckpoints) WithHeader(h map[string]string) func(*FleetGlobalCheckpointsRequest)

WithHeader adds the headers to the HTTP request.

func (FleetGlobalCheckpoints) WithHuman ¶ 

func (f FleetGlobalCheckpoints) WithHuman() func(*FleetGlobalCheckpointsRequest)

WithHuman makes statistical values human-readable.

func (FleetGlobalCheckpoints) WithOpaqueID ¶ 

func (f FleetGlobalCheckpoints) WithOpaqueID(s string) func(*FleetGlobalCheckpointsRequest)

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

func (FleetGlobalCheckpoints) WithPretty ¶ 

func (f FleetGlobalCheckpoints) WithPretty() func(*FleetGlobalCheckpointsRequest)

WithPretty makes the response body pretty-printed.

func (FleetGlobalCheckpoints) WithTimeout ¶ 

func (f FleetGlobalCheckpoints) WithTimeout(v time.Duration) func(*FleetGlobalCheckpointsRequest)

WithTimeout - timeout to wait for global checkpoint to advance.

func (FleetGlobalCheckpoints) WithWaitForAdvance ¶ 

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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

FleetGlobalCheckpointsRequest configures the Fleet Global Checkpoints API request.

func (FleetGlobalCheckpointsRequest) Do ¶ 

func (r FleetGlobalCheckpointsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type FleetMsearch ¶ 

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 ¶ 

func (f FleetMsearch) WithContext(v context.Context) func(*FleetMsearchRequest)

WithContext sets the request context.

func (FleetMsearch) WithErrorTrace ¶ 

func (f FleetMsearch) WithErrorTrace() func(*FleetMsearchRequest)

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

func (FleetMsearch) WithFilterPath ¶ 

func (f FleetMsearch) WithFilterPath(v ...string) func(*FleetMsearchRequest)

WithFilterPath filters the properties of the response body.

func (FleetMsearch) WithHeader ¶ 

func (f FleetMsearch) WithHeader(h map[string]string) func(*FleetMsearchRequest)

WithHeader adds the headers to the HTTP request.

func (FleetMsearch) WithHuman ¶ 

func (f FleetMsearch) WithHuman() func(*FleetMsearchRequest)

WithHuman makes statistical values human-readable.

func (FleetMsearch) WithIndex ¶ 

func (f FleetMsearch) WithIndex(v string) func(*FleetMsearchRequest)

WithIndex - the index name to use as the default.

func (FleetMsearch) WithOpaqueID ¶ 

func (f FleetMsearch) WithOpaqueID(s string) func(*FleetMsearchRequest)

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

func (FleetMsearch) WithPretty ¶ 

func (f FleetMsearch) WithPretty() func(*FleetMsearchRequest)

WithPretty makes the response body pretty-printed.

type FleetMsearchRequest ¶ 

type FleetMsearchRequest struct {
	Index string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

FleetMsearchRequest configures the Fleet Msearch API request.

func (FleetMsearchRequest) Do ¶ 

func (r FleetMsearchRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type FleetPostSecret ¶ added in v8.10.0 

type FleetPostSecret func(body io.Reader, o ...func(*FleetPostSecretRequest)) (*Response, error)

FleetPostSecret creates a secret stored by Fleet.

This API is experimental.

func (FleetPostSecret) WithContext ¶ added in v8.10.0 

func (f FleetPostSecret) WithContext(v context.Context) func(*FleetPostSecretRequest)

WithContext sets the request context.

func (FleetPostSecret) WithErrorTrace ¶ added in v8.10.0 

func (f FleetPostSecret) WithErrorTrace() func(*FleetPostSecretRequest)

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

func (FleetPostSecret) WithFilterPath ¶ added in v8.10.0 

func (f FleetPostSecret) WithFilterPath(v ...string) func(*FleetPostSecretRequest)

WithFilterPath filters the properties of the response body.

func (FleetPostSecret) WithHeader ¶ added in v8.10.0 

func (f FleetPostSecret) WithHeader(h map[string]string) func(*FleetPostSecretRequest)

WithHeader adds the headers to the HTTP request.

func (FleetPostSecret) WithHuman ¶ added in v8.10.0 

func (f FleetPostSecret) WithHuman() func(*FleetPostSecretRequest)

WithHuman makes statistical values human-readable.

func (FleetPostSecret) WithOpaqueID ¶ added in v8.10.0 

func (f FleetPostSecret) WithOpaqueID(s string) func(*FleetPostSecretRequest)

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

func (FleetPostSecret) WithPretty ¶ added in v8.10.0 

func (f FleetPostSecret) WithPretty() func(*FleetPostSecretRequest)

WithPretty makes the response body pretty-printed.

type FleetPostSecretRequest ¶ added in v8.10.0 

type FleetPostSecretRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

FleetPostSecretRequest configures the Fleet Post Secret API request.

func (FleetPostSecretRequest) Do ¶ added in v8.10.0 

func (r FleetPostSecretRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type FleetSearch ¶ 

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 ¶ 

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 ¶ 

func (f FleetSearch) WithBody(v io.Reader) func(*FleetSearchRequest)

WithBody - The search definition using the Query DSL.

func (FleetSearch) WithContext ¶ 

func (f FleetSearch) WithContext(v context.Context) func(*FleetSearchRequest)

WithContext sets the request context.

func (FleetSearch) WithErrorTrace ¶ 

func (f FleetSearch) WithErrorTrace() func(*FleetSearchRequest)

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

func (FleetSearch) WithFilterPath ¶ 

func (f FleetSearch) WithFilterPath(v ...string) func(*FleetSearchRequest)

WithFilterPath filters the properties of the response body.

func (FleetSearch) WithHeader ¶ 

func (f FleetSearch) WithHeader(h map[string]string) func(*FleetSearchRequest)

WithHeader adds the headers to the HTTP request.

func (FleetSearch) WithHuman ¶ 

func (f FleetSearch) WithHuman() func(*FleetSearchRequest)

WithHuman makes statistical values human-readable.

func (FleetSearch) WithOpaqueID ¶ 

func (f FleetSearch) WithOpaqueID(s string) func(*FleetSearchRequest)

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

func (FleetSearch) WithPretty ¶ 

func (f FleetSearch) WithPretty() func(*FleetSearchRequest)

WithPretty makes the response body pretty-printed.

func (FleetSearch) WithWaitForCheckpoints ¶ 

func (f FleetSearch) WithWaitForCheckpoints(v ...string) func(*FleetSearchRequest)

WithWaitForCheckpoints - comma separated list of checkpoints, one per shard.

func (FleetSearch) WithWaitForCheckpointsTimeout ¶ 

func (f FleetSearch) WithWaitForCheckpointsTimeout(v time.Duration) func(*FleetSearchRequest)

WithWaitForCheckpointsTimeout - explicit wait_for_checkpoints timeout.

type FleetSearchRequest ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

FleetSearchRequest configures the Fleet Search API request.

func (FleetSearchRequest) Do ¶ 

func (r FleetSearchRequest) Do(providedCtx 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) 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) WithForceSyntheticSource ¶ added in v8.4.0 

func (f Get) WithForceSyntheticSource(v bool) func(*GetRequest)

WithForceSyntheticSource - should this request force synthetic _source? use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. fetches with this enabled will be slower the enabling synthetic source natively in the index..

func (Get) WithHeader ¶ 

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 ¶ 

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
	DocumentID string

	ForceSyntheticSource *bool
	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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

GetRequest configures the Get API request.

func (GetRequest) Do ¶ 

func (r GetRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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 ¶ 

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 ¶ 

func (f GetScriptContext) WithContext(v context.Context) func(*GetScriptContextRequest)

WithContext sets the request context.

func (GetScriptContext) WithErrorTrace ¶ 

func (f GetScriptContext) WithErrorTrace() func(*GetScriptContextRequest)

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

func (GetScriptContext) WithFilterPath ¶ 

func (f GetScriptContext) WithFilterPath(v ...string) func(*GetScriptContextRequest)

WithFilterPath filters the properties of the response body.

func (GetScriptContext) WithHeader ¶ 

func (f GetScriptContext) WithHeader(h map[string]string) func(*GetScriptContextRequest)

WithHeader adds the headers to the HTTP request.

func (GetScriptContext) WithHuman ¶ 

func (f GetScriptContext) WithHuman() func(*GetScriptContextRequest)

WithHuman makes statistical values human-readable.

func (GetScriptContext) WithOpaqueID ¶ 

func (f GetScriptContext) WithOpaqueID(s string) func(*GetScriptContextRequest)

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

func (GetScriptContext) WithPretty ¶ 

func (f GetScriptContext) WithPretty() func(*GetScriptContextRequest)

WithPretty makes the response body pretty-printed.

type GetScriptContextRequest ¶ 

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

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

GetScriptContextRequest configures the Get Script Context API request.

func (GetScriptContextRequest) Do ¶ 

func (r GetScriptContextRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type GetScriptLanguages ¶ 

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 ¶ 

func (f GetScriptLanguages) WithContext(v context.Context) func(*GetScriptLanguagesRequest)

WithContext sets the request context.

func (GetScriptLanguages) WithErrorTrace ¶ 

func (f GetScriptLanguages) WithErrorTrace() func(*GetScriptLanguagesRequest)

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

func (GetScriptLanguages) WithFilterPath ¶ 

func (f GetScriptLanguages) WithFilterPath(v ...string) func(*GetScriptLanguagesRequest)

WithFilterPath filters the properties of the response body.

func (GetScriptLanguages) WithHeader ¶ 

func (f GetScriptLanguages) WithHeader(h map[string]string) func(*GetScriptLanguagesRequest)

WithHeader adds the headers to the HTTP request.

func (GetScriptLanguages) WithHuman ¶ 

func (f GetScriptLanguages) WithHuman() func(*GetScriptLanguagesRequest)

WithHuman makes statistical values human-readable.

func (GetScriptLanguages) WithOpaqueID ¶ 

func (f GetScriptLanguages) WithOpaqueID(s string) func(*GetScriptLanguagesRequest)

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

func (GetScriptLanguages) WithPretty ¶ 

func (f GetScriptLanguages) WithPretty() func(*GetScriptLanguagesRequest)

WithPretty makes the response body pretty-printed.

type GetScriptLanguagesRequest ¶ 

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

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

GetScriptLanguagesRequest configures the Get Script Languages API request.

func (GetScriptLanguagesRequest) Do ¶ 

func (r GetScriptLanguagesRequest) Do(providedCtx 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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

GetScriptRequest configures the Get Script API request.

func (GetScriptRequest) Do ¶ 

func (r GetScriptRequest) Do(providedCtx 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) 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

GetSourceRequest configures the Get Source API request.

func (GetSourceRequest) Do ¶ 

func (r GetSourceRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type GraphExplore ¶ 

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 ¶ 

func (f GraphExplore) WithBody(v io.Reader) func(*GraphExploreRequest)

WithBody - Graph Query DSL.

func (GraphExplore) WithContext ¶ 

func (f GraphExplore) WithContext(v context.Context) func(*GraphExploreRequest)

WithContext sets the request context.

func (GraphExplore) WithErrorTrace ¶ 

func (f GraphExplore) WithErrorTrace() func(*GraphExploreRequest)

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

func (GraphExplore) WithFilterPath ¶ 

func (f GraphExplore) WithFilterPath(v ...string) func(*GraphExploreRequest)

WithFilterPath filters the properties of the response body.

func (GraphExplore) WithHeader ¶ 

func (f GraphExplore) WithHeader(h map[string]string) func(*GraphExploreRequest)

WithHeader adds the headers to the HTTP request.

func (GraphExplore) WithHuman ¶ 

func (f GraphExplore) WithHuman() func(*GraphExploreRequest)

WithHuman makes statistical values human-readable.

func (GraphExplore) WithOpaqueID ¶ 

func (f GraphExplore) WithOpaqueID(s string) func(*GraphExploreRequest)

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

func (GraphExplore) WithPretty ¶ 

func (f GraphExplore) WithPretty() func(*GraphExploreRequest)

WithPretty makes the response body pretty-printed.

func (GraphExplore) WithRouting ¶ 

func (f GraphExplore) WithRouting(v string) func(*GraphExploreRequest)

WithRouting - specific routing value.

func (GraphExplore) WithTimeout ¶ 

func (f GraphExplore) WithTimeout(v time.Duration) func(*GraphExploreRequest)

WithTimeout - explicit operation timeout.

type GraphExploreRequest ¶ 

type GraphExploreRequest struct {
	Index []string

	Body io.Reader

	Routing string
	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

GraphExploreRequest configures the Graph Explore API request.

func (GraphExploreRequest) Do ¶ 

func (r GraphExploreRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type HealthReport ¶ added in v8.7.0 

type HealthReport func(o ...func(*HealthReportRequest)) (*Response, error)

HealthReport returns the health of the cluster.

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

func (HealthReport) WithContext ¶ added in v8.7.0 

func (f HealthReport) WithContext(v context.Context) func(*HealthReportRequest)

WithContext sets the request context.

func (HealthReport) WithErrorTrace ¶ added in v8.7.0 

func (f HealthReport) WithErrorTrace() func(*HealthReportRequest)

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

func (HealthReport) WithFeature ¶ added in v8.7.0 

func (f HealthReport) WithFeature(v string) func(*HealthReportRequest)

WithFeature - a feature of the cluster, as returned by the top-level health api.

func (HealthReport) WithFilterPath ¶ added in v8.7.0 

func (f HealthReport) WithFilterPath(v ...string) func(*HealthReportRequest)

WithFilterPath filters the properties of the response body.

func (HealthReport) WithHeader ¶ added in v8.7.0 

func (f HealthReport) WithHeader(h map[string]string) func(*HealthReportRequest)

WithHeader adds the headers to the HTTP request.

func (HealthReport) WithHuman ¶ added in v8.7.0 

func (f HealthReport) WithHuman() func(*HealthReportRequest)

WithHuman makes statistical values human-readable.

func (HealthReport) WithOpaqueID ¶ added in v8.7.0 

func (f HealthReport) WithOpaqueID(s string) func(*HealthReportRequest)

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

func (HealthReport) WithPretty ¶ added in v8.7.0 

func (f HealthReport) WithPretty() func(*HealthReportRequest)

WithPretty makes the response body pretty-printed.

func (HealthReport) WithSize ¶ added in v8.7.0 

func (f HealthReport) WithSize(v int) func(*HealthReportRequest)

WithSize - limit the number of affected resources the health api returns.

func (HealthReport) WithTimeout ¶ added in v8.7.0 

func (f HealthReport) WithTimeout(v time.Duration) func(*HealthReportRequest)

WithTimeout - explicit operation timeout.

func (HealthReport) WithVerbose ¶ added in v8.7.0 

func (f HealthReport) WithVerbose(v bool) func(*HealthReportRequest)

WithVerbose - opt in for more information about the health of the system.

type HealthReportRequest ¶ added in v8.7.0 

type HealthReportRequest struct {
	Feature string

	Size    *int
	Timeout time.Duration
	Verbose *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

HealthReportRequest configures the Health Report API request.

func (HealthReportRequest) Do ¶ added in v8.7.0 

func (r HealthReportRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILM ¶ 

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 ¶ 

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 ¶ 

func (f ILMDeleteLifecycle) WithContext(v context.Context) func(*ILMDeleteLifecycleRequest)

WithContext sets the request context.

func (ILMDeleteLifecycle) WithErrorTrace ¶ 

func (f ILMDeleteLifecycle) WithErrorTrace() func(*ILMDeleteLifecycleRequest)

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

func (ILMDeleteLifecycle) WithFilterPath ¶ 

func (f ILMDeleteLifecycle) WithFilterPath(v ...string) func(*ILMDeleteLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (ILMDeleteLifecycle) WithHeader ¶ 

func (f ILMDeleteLifecycle) WithHeader(h map[string]string) func(*ILMDeleteLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (ILMDeleteLifecycle) WithHuman ¶ 

func (f ILMDeleteLifecycle) WithHuman() func(*ILMDeleteLifecycleRequest)

WithHuman makes statistical values human-readable.

func (ILMDeleteLifecycle) WithOpaqueID ¶ 

func (f ILMDeleteLifecycle) WithOpaqueID(s string) func(*ILMDeleteLifecycleRequest)

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

func (ILMDeleteLifecycle) WithPretty ¶ 

func (f ILMDeleteLifecycle) WithPretty() func(*ILMDeleteLifecycleRequest)

WithPretty makes the response body pretty-printed.

type ILMDeleteLifecycleRequest ¶ 

type ILMDeleteLifecycleRequest struct {
	Policy string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ILMDeleteLifecycleRequest configures the ILM Delete Lifecycle API request.

func (ILMDeleteLifecycleRequest) Do ¶ 

func (r ILMDeleteLifecycleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMExplainLifecycle ¶ 

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 ¶ 

func (f ILMExplainLifecycle) WithContext(v context.Context) func(*ILMExplainLifecycleRequest)

WithContext sets the request context.

func (ILMExplainLifecycle) WithErrorTrace ¶ 

func (f ILMExplainLifecycle) WithErrorTrace() func(*ILMExplainLifecycleRequest)

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

func (ILMExplainLifecycle) WithFilterPath ¶ 

func (f ILMExplainLifecycle) WithFilterPath(v ...string) func(*ILMExplainLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (ILMExplainLifecycle) WithHeader ¶ 

func (f ILMExplainLifecycle) WithHeader(h map[string]string) func(*ILMExplainLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (ILMExplainLifecycle) WithHuman ¶ 

func (f ILMExplainLifecycle) WithHuman() func(*ILMExplainLifecycleRequest)

WithHuman makes statistical values human-readable.

func (ILMExplainLifecycle) WithOnlyErrors ¶ 

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 ¶ 

func (f ILMExplainLifecycle) WithOnlyManaged(v bool) func(*ILMExplainLifecycleRequest)

WithOnlyManaged - filters the indices included in the response to ones managed by ilm.

func (ILMExplainLifecycle) WithOpaqueID ¶ 

func (f ILMExplainLifecycle) WithOpaqueID(s string) func(*ILMExplainLifecycleRequest)

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

func (ILMExplainLifecycle) WithPretty ¶ 

func (f ILMExplainLifecycle) WithPretty() func(*ILMExplainLifecycleRequest)

WithPretty makes the response body pretty-printed.

type ILMExplainLifecycleRequest ¶ 

type ILMExplainLifecycleRequest struct {
	Index string

	OnlyErrors  *bool
	OnlyManaged *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ILMExplainLifecycleRequest configures the ILM Explain Lifecycle API request.

func (ILMExplainLifecycleRequest) Do ¶ 

func (r ILMExplainLifecycleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMGetLifecycle ¶ 

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 ¶ 

func (f ILMGetLifecycle) WithContext(v context.Context) func(*ILMGetLifecycleRequest)

WithContext sets the request context.

func (ILMGetLifecycle) WithErrorTrace ¶ 

func (f ILMGetLifecycle) WithErrorTrace() func(*ILMGetLifecycleRequest)

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

func (ILMGetLifecycle) WithFilterPath ¶ 

func (f ILMGetLifecycle) WithFilterPath(v ...string) func(*ILMGetLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (ILMGetLifecycle) WithHeader ¶ 

func (f ILMGetLifecycle) WithHeader(h map[string]string) func(*ILMGetLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (ILMGetLifecycle) WithHuman ¶ 

func (f ILMGetLifecycle) WithHuman() func(*ILMGetLifecycleRequest)

WithHuman makes statistical values human-readable.

func (ILMGetLifecycle) WithOpaqueID ¶ 

func (f ILMGetLifecycle) WithOpaqueID(s string) func(*ILMGetLifecycleRequest)

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

func (ILMGetLifecycle) WithPolicy ¶ 

func (f ILMGetLifecycle) WithPolicy(v string) func(*ILMGetLifecycleRequest)

WithPolicy - the name of the index lifecycle policy.

func (ILMGetLifecycle) WithPretty ¶ 

func (f ILMGetLifecycle) WithPretty() func(*ILMGetLifecycleRequest)

WithPretty makes the response body pretty-printed.

type ILMGetLifecycleRequest ¶ 

type ILMGetLifecycleRequest struct {
	Policy string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ILMGetLifecycleRequest configures the ILM Get Lifecycle API request.

func (ILMGetLifecycleRequest) Do ¶ 

func (r ILMGetLifecycleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMGetStatus ¶ 

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 ¶ 

func (f ILMGetStatus) WithContext(v context.Context) func(*ILMGetStatusRequest)

WithContext sets the request context.

func (ILMGetStatus) WithErrorTrace ¶ 

func (f ILMGetStatus) WithErrorTrace() func(*ILMGetStatusRequest)

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

func (ILMGetStatus) WithFilterPath ¶ 

func (f ILMGetStatus) WithFilterPath(v ...string) func(*ILMGetStatusRequest)

WithFilterPath filters the properties of the response body.

func (ILMGetStatus) WithHeader ¶ 

func (f ILMGetStatus) WithHeader(h map[string]string) func(*ILMGetStatusRequest)

WithHeader adds the headers to the HTTP request.

func (ILMGetStatus) WithHuman ¶ 

func (f ILMGetStatus) WithHuman() func(*ILMGetStatusRequest)

WithHuman makes statistical values human-readable.

func (ILMGetStatus) WithOpaqueID ¶ 

func (f ILMGetStatus) WithOpaqueID(s string) func(*ILMGetStatusRequest)

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

func (ILMGetStatus) WithPretty ¶ 

func (f ILMGetStatus) WithPretty() func(*ILMGetStatusRequest)

WithPretty makes the response body pretty-printed.

type ILMGetStatusRequest ¶ 

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

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ILMGetStatusRequest configures the ILM Get Status API request.

func (ILMGetStatusRequest) Do ¶ 

func (r ILMGetStatusRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMMigrateToDataTiers ¶ 

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 ¶ 

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 ¶ 

func (f ILMMigrateToDataTiers) WithContext(v context.Context) func(*ILMMigrateToDataTiersRequest)

WithContext sets the request context.

func (ILMMigrateToDataTiers) WithDryRun ¶ 

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 ¶ 

func (f ILMMigrateToDataTiers) WithErrorTrace() func(*ILMMigrateToDataTiersRequest)

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

func (ILMMigrateToDataTiers) WithFilterPath ¶ 

func (f ILMMigrateToDataTiers) WithFilterPath(v ...string) func(*ILMMigrateToDataTiersRequest)

WithFilterPath filters the properties of the response body.

func (ILMMigrateToDataTiers) WithHeader ¶ 

func (f ILMMigrateToDataTiers) WithHeader(h map[string]string) func(*ILMMigrateToDataTiersRequest)

WithHeader adds the headers to the HTTP request.

func (ILMMigrateToDataTiers) WithHuman ¶ 

func (f ILMMigrateToDataTiers) WithHuman() func(*ILMMigrateToDataTiersRequest)

WithHuman makes statistical values human-readable.

func (ILMMigrateToDataTiers) WithOpaqueID ¶ 

func (f ILMMigrateToDataTiers) WithOpaqueID(s string) func(*ILMMigrateToDataTiersRequest)

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

func (ILMMigrateToDataTiers) WithPretty ¶ 

func (f ILMMigrateToDataTiers) WithPretty() func(*ILMMigrateToDataTiersRequest)

WithPretty makes the response body pretty-printed.

type ILMMigrateToDataTiersRequest ¶ 

type ILMMigrateToDataTiersRequest struct {
	Body io.Reader

	DryRun *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ILMMigrateToDataTiersRequest configures the ILM Migrate To Data Tiers API request.

func (ILMMigrateToDataTiersRequest) Do ¶ 

func (r ILMMigrateToDataTiersRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMMoveToStep ¶ 

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 ¶ 

func (f ILMMoveToStep) WithBody(v io.Reader) func(*ILMMoveToStepRequest)

WithBody - The new lifecycle step to move to.

func (ILMMoveToStep) WithContext ¶ 

func (f ILMMoveToStep) WithContext(v context.Context) func(*ILMMoveToStepRequest)

WithContext sets the request context.

func (ILMMoveToStep) WithErrorTrace ¶ 

func (f ILMMoveToStep) WithErrorTrace() func(*ILMMoveToStepRequest)

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

func (ILMMoveToStep) WithFilterPath ¶ 

func (f ILMMoveToStep) WithFilterPath(v ...string) func(*ILMMoveToStepRequest)

WithFilterPath filters the properties of the response body.

func (ILMMoveToStep) WithHeader ¶ 

func (f ILMMoveToStep) WithHeader(h map[string]string) func(*ILMMoveToStepRequest)

WithHeader adds the headers to the HTTP request.

func (ILMMoveToStep) WithHuman ¶ 

func (f ILMMoveToStep) WithHuman() func(*ILMMoveToStepRequest)

WithHuman makes statistical values human-readable.

func (ILMMoveToStep) WithOpaqueID ¶ 

func (f ILMMoveToStep) WithOpaqueID(s string) func(*ILMMoveToStepRequest)

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

func (ILMMoveToStep) WithPretty ¶ 

func (f ILMMoveToStep) WithPretty() func(*ILMMoveToStepRequest)

WithPretty makes the response body pretty-printed.

type ILMMoveToStepRequest ¶ 

type ILMMoveToStepRequest struct {
	Index string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ILMMoveToStepRequest configures the ILM Move To Step API request.

func (ILMMoveToStepRequest) Do ¶ 

func (r ILMMoveToStepRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMPutLifecycle ¶ 

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 ¶ 

func (f ILMPutLifecycle) WithBody(v io.Reader) func(*ILMPutLifecycleRequest)

WithBody - The lifecycle policy definition to register.

func (ILMPutLifecycle) WithContext ¶ 

func (f ILMPutLifecycle) WithContext(v context.Context) func(*ILMPutLifecycleRequest)

WithContext sets the request context.

func (ILMPutLifecycle) WithErrorTrace ¶ 

func (f ILMPutLifecycle) WithErrorTrace() func(*ILMPutLifecycleRequest)

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

func (ILMPutLifecycle) WithFilterPath ¶ 

func (f ILMPutLifecycle) WithFilterPath(v ...string) func(*ILMPutLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (ILMPutLifecycle) WithHeader ¶ 

func (f ILMPutLifecycle) WithHeader(h map[string]string) func(*ILMPutLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (ILMPutLifecycle) WithHuman ¶ 

func (f ILMPutLifecycle) WithHuman() func(*ILMPutLifecycleRequest)

WithHuman makes statistical values human-readable.

func (ILMPutLifecycle) WithOpaqueID ¶ 

func (f ILMPutLifecycle) WithOpaqueID(s string) func(*ILMPutLifecycleRequest)

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

func (ILMPutLifecycle) WithPretty ¶ 

func (f ILMPutLifecycle) WithPretty() func(*ILMPutLifecycleRequest)

WithPretty makes the response body pretty-printed.

type ILMPutLifecycleRequest ¶ 

type ILMPutLifecycleRequest struct {
	Body io.Reader

	Policy string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ILMPutLifecycleRequest configures the ILM Put Lifecycle API request.

func (ILMPutLifecycleRequest) Do ¶ 

func (r ILMPutLifecycleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMRemovePolicy ¶ 

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 ¶ 

func (f ILMRemovePolicy) WithContext(v context.Context) func(*ILMRemovePolicyRequest)

WithContext sets the request context.

func (ILMRemovePolicy) WithErrorTrace ¶ 

func (f ILMRemovePolicy) WithErrorTrace() func(*ILMRemovePolicyRequest)

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

func (ILMRemovePolicy) WithFilterPath ¶ 

func (f ILMRemovePolicy) WithFilterPath(v ...string) func(*ILMRemovePolicyRequest)

WithFilterPath filters the properties of the response body.

func (ILMRemovePolicy) WithHeader ¶ 

func (f ILMRemovePolicy) WithHeader(h map[string]string) func(*ILMRemovePolicyRequest)

WithHeader adds the headers to the HTTP request.

func (ILMRemovePolicy) WithHuman ¶ 

func (f ILMRemovePolicy) WithHuman() func(*ILMRemovePolicyRequest)

WithHuman makes statistical values human-readable.

func (ILMRemovePolicy) WithOpaqueID ¶ 

func (f ILMRemovePolicy) WithOpaqueID(s string) func(*ILMRemovePolicyRequest)

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

func (ILMRemovePolicy) WithPretty ¶ 

func (f ILMRemovePolicy) WithPretty() func(*ILMRemovePolicyRequest)

WithPretty makes the response body pretty-printed.

type ILMRemovePolicyRequest ¶ 

type ILMRemovePolicyRequest struct {
	Index string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ILMRemovePolicyRequest configures the ILM Remove Policy API request.

func (ILMRemovePolicyRequest) Do ¶ 

func (r ILMRemovePolicyRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMRetry ¶ 

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 ¶ 

func (f ILMRetry) WithContext(v context.Context) func(*ILMRetryRequest)

WithContext sets the request context.

func (ILMRetry) WithErrorTrace ¶ 

func (f ILMRetry) WithErrorTrace() func(*ILMRetryRequest)

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

func (ILMRetry) WithFilterPath ¶ 

func (f ILMRetry) WithFilterPath(v ...string) func(*ILMRetryRequest)

WithFilterPath filters the properties of the response body.

func (ILMRetry) WithHeader ¶ 

func (f ILMRetry) WithHeader(h map[string]string) func(*ILMRetryRequest)

WithHeader adds the headers to the HTTP request.

func (ILMRetry) WithHuman ¶ 

func (f ILMRetry) WithHuman() func(*ILMRetryRequest)

WithHuman makes statistical values human-readable.

func (ILMRetry) WithOpaqueID ¶ 

func (f ILMRetry) WithOpaqueID(s string) func(*ILMRetryRequest)

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

func (ILMRetry) WithPretty ¶ 

func (f ILMRetry) WithPretty() func(*ILMRetryRequest)

WithPretty makes the response body pretty-printed.

type ILMRetryRequest ¶ 

type ILMRetryRequest struct {
	Index string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ILMRetryRequest configures the ILM Retry API request.

func (ILMRetryRequest) Do ¶ 

func (r ILMRetryRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMStart ¶ 

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 ¶ 

func (f ILMStart) WithContext(v context.Context) func(*ILMStartRequest)

WithContext sets the request context.

func (ILMStart) WithErrorTrace ¶ 

func (f ILMStart) WithErrorTrace() func(*ILMStartRequest)

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

func (ILMStart) WithFilterPath ¶ 

func (f ILMStart) WithFilterPath(v ...string) func(*ILMStartRequest)

WithFilterPath filters the properties of the response body.

func (ILMStart) WithHeader ¶ 

func (f ILMStart) WithHeader(h map[string]string) func(*ILMStartRequest)

WithHeader adds the headers to the HTTP request.

func (ILMStart) WithHuman ¶ 

func (f ILMStart) WithHuman() func(*ILMStartRequest)

WithHuman makes statistical values human-readable.

func (ILMStart) WithOpaqueID ¶ 

func (f ILMStart) WithOpaqueID(s string) func(*ILMStartRequest)

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

func (ILMStart) WithPretty ¶ 

func (f ILMStart) WithPretty() func(*ILMStartRequest)

WithPretty makes the response body pretty-printed.

type ILMStartRequest ¶ 

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

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ILMStartRequest configures the ILM Start API request.

func (ILMStartRequest) Do ¶ 

func (r ILMStartRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ILMStop ¶ 

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 ¶ 

func (f ILMStop) WithContext(v context.Context) func(*ILMStopRequest)

WithContext sets the request context.

func (ILMStop) WithErrorTrace ¶ 

func (f ILMStop) WithErrorTrace() func(*ILMStopRequest)

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

func (ILMStop) WithFilterPath ¶ 

func (f ILMStop) WithFilterPath(v ...string) func(*ILMStopRequest)

WithFilterPath filters the properties of the response body.

func (ILMStop) WithHeader ¶ 

func (f ILMStop) WithHeader(h map[string]string) func(*ILMStopRequest)

WithHeader adds the headers to the HTTP request.

func (ILMStop) WithHuman ¶ 

func (f ILMStop) WithHuman() func(*ILMStopRequest)

WithHuman makes statistical values human-readable.

func (ILMStop) WithOpaqueID ¶ 

func (f ILMStop) WithOpaqueID(s string) func(*ILMStopRequest)

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

func (ILMStop) WithPretty ¶ 

func (f ILMStop) WithPretty() func(*ILMStopRequest)

WithPretty makes the response body pretty-printed.

type ILMStopRequest ¶ 

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

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ILMStopRequest configures the ILM Stop API request.

func (ILMStopRequest) Do ¶ 

func (r ILMStopRequest) Do(providedCtx 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) 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 ¶ 

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) WithIncludeSourceOnError ¶ added in v8.18.0 

func (f Index) WithIncludeSourceOnError(v bool) func(*IndexRequest)

WithIncludeSourceOnError - true or false if to include the document source in the error message in case of parsing errors. defaults to true..

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 ¶ 

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 ¶ 

func (f Index) WithRequireAlias(v bool) func(*IndexRequest)

WithRequireAlias - when true, requires destination to be an alias. default is false.

func (Index) WithRequireDataStream ¶ added in v8.13.0 

func (f Index) WithRequireDataStream(v bool) func(*IndexRequest)

WithRequireDataStream - when true, requires the destination to be a data stream (existing or to-be-created). 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
	DocumentID string

	Body io.Reader

	IfPrimaryTerm        *int
	IfSeqNo              *int
	IncludeSourceOnError *bool
	OpType               string
	Pipeline             string
	Refresh              string
	RequireAlias         *bool
	RequireDataStream    *bool
	Routing              string
	Timeout              time.Duration
	Version              *int
	VersionType          string
	WaitForActiveShards  string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndexRequest configures the Index API request.

func (IndexRequest) Do ¶ 

func (r IndexRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Indices ¶ 

type Indices struct {
	AddBlock                IndicesAddBlock
	Analyze                 IndicesAnalyze
	CancelMigrateReindex    IndicesCancelMigrateReindex
	ClearCache              IndicesClearCache
	Clone                   IndicesClone
	Close                   IndicesClose
	CreateDataStream        IndicesCreateDataStream
	CreateFrom              IndicesCreateFrom
	Create                  IndicesCreate
	DataStreamsStats        IndicesDataStreamsStats
	DeleteAlias             IndicesDeleteAlias
	DeleteDataLifecycle     IndicesDeleteDataLifecycle
	DeleteDataStream        IndicesDeleteDataStream
	DeleteIndexTemplate     IndicesDeleteIndexTemplate
	Delete                  IndicesDelete
	DeleteTemplate          IndicesDeleteTemplate
	DiskUsage               IndicesDiskUsage
	Downsample              IndicesDownsample
	ExistsAlias             IndicesExistsAlias
	ExistsIndexTemplate     IndicesExistsIndexTemplate
	Exists                  IndicesExists
	ExistsTemplate          IndicesExistsTemplate
	ExplainDataLifecycle    IndicesExplainDataLifecycle
	FieldUsageStats         IndicesFieldUsageStats
	Flush                   IndicesFlush
	Forcemerge              IndicesForcemerge
	GetAlias                IndicesGetAlias
	GetDataLifecycle        IndicesGetDataLifecycle
	GetDataLifecycleStats   IndicesGetDataLifecycleStats
	GetDataStream           IndicesGetDataStream
	GetFieldMapping         IndicesGetFieldMapping
	GetIndexTemplate        IndicesGetIndexTemplate
	GetMapping              IndicesGetMapping
	GetMigrateReindexStatus IndicesGetMigrateReindexStatus
	Get                     IndicesGet
	GetSettings             IndicesGetSettings
	GetTemplate             IndicesGetTemplate
	MigrateReindex          IndicesMigrateReindex
	MigrateToDataStream     IndicesMigrateToDataStream
	ModifyDataStream        IndicesModifyDataStream
	Open                    IndicesOpen
	PromoteDataStream       IndicesPromoteDataStream
	PutAlias                IndicesPutAlias
	PutDataLifecycle        IndicesPutDataLifecycle
	PutIndexTemplate        IndicesPutIndexTemplate
	PutMapping              IndicesPutMapping
	PutSettings             IndicesPutSettings
	PutTemplate             IndicesPutTemplate
	Recovery                IndicesRecovery
	Refresh                 IndicesRefresh
	ReloadSearchAnalyzers   IndicesReloadSearchAnalyzers
	ResolveCluster          IndicesResolveCluster
	ResolveIndex            IndicesResolveIndex
	Rollover                IndicesRollover
	Segments                IndicesSegments
	ShardStores             IndicesShardStores
	Shrink                  IndicesShrink
	SimulateIndexTemplate   IndicesSimulateIndexTemplate
	SimulateTemplate        IndicesSimulateTemplate
	Split                   IndicesSplit
	Stats                   IndicesStats
	Unfreeze                IndicesUnfreeze
	UpdateAliases           IndicesUpdateAliases
	ValidateQuery           IndicesValidateQuery
}

Indices contains the Indices APIs

type IndicesAddBlock ¶ 

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 ¶ 

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 ¶ 

func (f IndicesAddBlock) WithContext(v context.Context) func(*IndicesAddBlockRequest)

WithContext sets the request context.

func (IndicesAddBlock) WithErrorTrace ¶ 

func (f IndicesAddBlock) WithErrorTrace() func(*IndicesAddBlockRequest)

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

func (IndicesAddBlock) WithExpandWildcards ¶ 

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 ¶ 

func (f IndicesAddBlock) WithFilterPath(v ...string) func(*IndicesAddBlockRequest)

WithFilterPath filters the properties of the response body.

func (IndicesAddBlock) WithHeader ¶ 

func (f IndicesAddBlock) WithHeader(h map[string]string) func(*IndicesAddBlockRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesAddBlock) WithHuman ¶ 

func (f IndicesAddBlock) WithHuman() func(*IndicesAddBlockRequest)

WithHuman makes statistical values human-readable.

func (IndicesAddBlock) WithIgnoreUnavailable ¶ 

func (f IndicesAddBlock) WithIgnoreUnavailable(v bool) func(*IndicesAddBlockRequest)

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

func (IndicesAddBlock) WithMasterTimeout ¶ 

func (f IndicesAddBlock) WithMasterTimeout(v time.Duration) func(*IndicesAddBlockRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesAddBlock) WithOpaqueID ¶ 

func (f IndicesAddBlock) WithOpaqueID(s string) func(*IndicesAddBlockRequest)

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

func (IndicesAddBlock) WithPretty ¶ 

func (f IndicesAddBlock) WithPretty() func(*IndicesAddBlockRequest)

WithPretty makes the response body pretty-printed.

func (IndicesAddBlock) WithTimeout ¶ 

func (f IndicesAddBlock) WithTimeout(v time.Duration) func(*IndicesAddBlockRequest)

WithTimeout - explicit operation timeout.

type IndicesAddBlockRequest ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesAddBlockRequest configures the Indices Add Block API request.

func (IndicesAddBlockRequest) Do ¶ 

func (r IndicesAddBlockRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesAnalyzeRequest configures the Indices Analyze API request.

func (IndicesAnalyzeRequest) Do ¶ 

func (r IndicesAnalyzeRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesCancelMigrateReindex ¶ added in v8.18.0 

type IndicesCancelMigrateReindex func(index string, o ...func(*IndicesCancelMigrateReindexRequest)) (*Response, error)

IndicesCancelMigrateReindex this API returns the status of a migration reindex attempt for a data stream or index

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex-cancel-api.html.

func (IndicesCancelMigrateReindex) WithContext ¶ added in v8.18.0 

func (f IndicesCancelMigrateReindex) WithContext(v context.Context) func(*IndicesCancelMigrateReindexRequest)

WithContext sets the request context.

func (IndicesCancelMigrateReindex) WithErrorTrace ¶ added in v8.18.0 

func (f IndicesCancelMigrateReindex) WithErrorTrace() func(*IndicesCancelMigrateReindexRequest)

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

func (IndicesCancelMigrateReindex) WithFilterPath ¶ added in v8.18.0 

func (f IndicesCancelMigrateReindex) WithFilterPath(v ...string) func(*IndicesCancelMigrateReindexRequest)

WithFilterPath filters the properties of the response body.

func (IndicesCancelMigrateReindex) WithHeader ¶ added in v8.18.0 

func (f IndicesCancelMigrateReindex) WithHeader(h map[string]string) func(*IndicesCancelMigrateReindexRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesCancelMigrateReindex) WithHuman ¶ added in v8.18.0 

func (f IndicesCancelMigrateReindex) WithHuman() func(*IndicesCancelMigrateReindexRequest)

WithHuman makes statistical values human-readable.

func (IndicesCancelMigrateReindex) WithOpaqueID ¶ added in v8.18.0 

func (f IndicesCancelMigrateReindex) WithOpaqueID(s string) func(*IndicesCancelMigrateReindexRequest)

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

func (IndicesCancelMigrateReindex) WithPretty ¶ added in v8.18.0 

func (f IndicesCancelMigrateReindex) WithPretty() func(*IndicesCancelMigrateReindexRequest)

WithPretty makes the response body pretty-printed.

type IndicesCancelMigrateReindexRequest ¶ added in v8.18.0 

type IndicesCancelMigrateReindexRequest struct {
	Index string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesCancelMigrateReindexRequest configures the Indices Cancel Migrate Reindex API request.

func (IndicesCancelMigrateReindexRequest) Do ¶ added in v8.18.0 

func (r IndicesCancelMigrateReindexRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesClearCacheRequest configures the Indices Clear Cache API request.

func (IndicesClearCacheRequest) Do ¶ 

func (r IndicesClearCacheRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesClone ¶ 

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 ¶ 

func (f IndicesClone) WithBody(v io.Reader) func(*IndicesCloneRequest)

WithBody - The configuration for the target index (`settings` and `aliases`).

func (IndicesClone) WithContext ¶ 

func (f IndicesClone) WithContext(v context.Context) func(*IndicesCloneRequest)

WithContext sets the request context.

func (IndicesClone) WithErrorTrace ¶ 

func (f IndicesClone) WithErrorTrace() func(*IndicesCloneRequest)

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

func (IndicesClone) WithFilterPath ¶ 

func (f IndicesClone) WithFilterPath(v ...string) func(*IndicesCloneRequest)

WithFilterPath filters the properties of the response body.

func (IndicesClone) WithHeader ¶ 

func (f IndicesClone) WithHeader(h map[string]string) func(*IndicesCloneRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesClone) WithHuman ¶ 

func (f IndicesClone) WithHuman() func(*IndicesCloneRequest)

WithHuman makes statistical values human-readable.

func (IndicesClone) WithMasterTimeout ¶ 

func (f IndicesClone) WithMasterTimeout(v time.Duration) func(*IndicesCloneRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesClone) WithOpaqueID ¶ 

func (f IndicesClone) WithOpaqueID(s string) func(*IndicesCloneRequest)

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

func (IndicesClone) WithPretty ¶ 

func (f IndicesClone) WithPretty() func(*IndicesCloneRequest)

WithPretty makes the response body pretty-printed.

func (IndicesClone) WithTimeout ¶ 

func (f IndicesClone) WithTimeout(v time.Duration) func(*IndicesCloneRequest)

WithTimeout - explicit operation timeout.

func (IndicesClone) WithWaitForActiveShards ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesCloneRequest configures the Indices Clone API request.

func (IndicesCloneRequest) Do ¶ 

func (r IndicesCloneRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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 ¶ 

func (f IndicesClose) WithWaitForActiveShards(v string) func(*IndicesCloseRequest)

WithWaitForActiveShards - sets the number of active shards to wait for before the operation returns..

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesCloseRequest configures the Indices Close API request.

func (IndicesCloseRequest) Do ¶ 

func (r IndicesCloseRequest) Do(providedCtx 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 ¶ 

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) WithMasterTimeout ¶ 

func (f IndicesCreate) WithMasterTimeout(v time.Duration) func(*IndicesCreateRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesCreate) WithOpaqueID ¶ 

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 ¶ 

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 ¶ 

func (f IndicesCreateDataStream) WithContext(v context.Context) func(*IndicesCreateDataStreamRequest)

WithContext sets the request context.

func (IndicesCreateDataStream) WithErrorTrace ¶ 

func (f IndicesCreateDataStream) WithErrorTrace() func(*IndicesCreateDataStreamRequest)

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

func (IndicesCreateDataStream) WithFilterPath ¶ 

func (f IndicesCreateDataStream) WithFilterPath(v ...string) func(*IndicesCreateDataStreamRequest)

WithFilterPath filters the properties of the response body.

func (IndicesCreateDataStream) WithHeader ¶ 

func (f IndicesCreateDataStream) WithHeader(h map[string]string) func(*IndicesCreateDataStreamRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesCreateDataStream) WithHuman ¶ 

func (f IndicesCreateDataStream) WithHuman() func(*IndicesCreateDataStreamRequest)

WithHuman makes statistical values human-readable.

func (IndicesCreateDataStream) WithMasterTimeout ¶ added in v8.16.0 

func (f IndicesCreateDataStream) WithMasterTimeout(v time.Duration) func(*IndicesCreateDataStreamRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesCreateDataStream) WithOpaqueID ¶ 

func (f IndicesCreateDataStream) WithOpaqueID(s string) func(*IndicesCreateDataStreamRequest)

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

func (IndicesCreateDataStream) WithPretty ¶ 

func (f IndicesCreateDataStream) WithPretty() func(*IndicesCreateDataStreamRequest)

WithPretty makes the response body pretty-printed.

func (IndicesCreateDataStream) WithTimeout ¶ added in v8.16.0 

func (f IndicesCreateDataStream) WithTimeout(v time.Duration) func(*IndicesCreateDataStreamRequest)

WithTimeout - specify timeout for acknowledging the cluster state update.

type IndicesCreateDataStreamRequest ¶ 

type IndicesCreateDataStreamRequest struct {
	Name string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesCreateDataStreamRequest configures the Indices Create Data Stream API request.

func (IndicesCreateDataStreamRequest) Do ¶ 

func (r IndicesCreateDataStreamRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesCreateFrom ¶ added in v8.18.0 

type IndicesCreateFrom func(dest string, source string, o ...func(*IndicesCreateFromRequest)) (*Response, error)

IndicesCreateFrom this API creates a destination from a source index. It copies the mappings and settings from the source index while allowing request settings and mappings to override the source values.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index-from-source.html.

func (IndicesCreateFrom) WithBody ¶ added in v8.18.0 

func (f IndicesCreateFrom) WithBody(v io.Reader) func(*IndicesCreateFromRequest)

WithBody - The body contains the fields `mappings_override`, `settings_override`, and `remove_index_blocks`..

func (IndicesCreateFrom) WithContext ¶ added in v8.18.0 

func (f IndicesCreateFrom) WithContext(v context.Context) func(*IndicesCreateFromRequest)

WithContext sets the request context.

func (IndicesCreateFrom) WithErrorTrace ¶ added in v8.18.0 

func (f IndicesCreateFrom) WithErrorTrace() func(*IndicesCreateFromRequest)

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

func (IndicesCreateFrom) WithFilterPath ¶ added in v8.18.0 

func (f IndicesCreateFrom) WithFilterPath(v ...string) func(*IndicesCreateFromRequest)

WithFilterPath filters the properties of the response body.

func (IndicesCreateFrom) WithHeader ¶ added in v8.18.0 

func (f IndicesCreateFrom) WithHeader(h map[string]string) func(*IndicesCreateFromRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesCreateFrom) WithHuman ¶ added in v8.18.0 

func (f IndicesCreateFrom) WithHuman() func(*IndicesCreateFromRequest)

WithHuman makes statistical values human-readable.

func (IndicesCreateFrom) WithOpaqueID ¶ added in v8.18.0 

func (f IndicesCreateFrom) WithOpaqueID(s string) func(*IndicesCreateFromRequest)

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

func (IndicesCreateFrom) WithPretty ¶ added in v8.18.0 

func (f IndicesCreateFrom) WithPretty() func(*IndicesCreateFromRequest)

WithPretty makes the response body pretty-printed.

type IndicesCreateFromRequest ¶ added in v8.18.0 

type IndicesCreateFromRequest struct {
	Body io.Reader

	Dest   string
	Source string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesCreateFromRequest configures the Indices Create From API request.

func (IndicesCreateFromRequest) Do ¶ added in v8.18.0 

func (r IndicesCreateFromRequest) Do(providedCtx 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

	MasterTimeout       time.Duration
	Timeout             time.Duration
	WaitForActiveShards string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesCreateRequest configures the Indices Create API request.

func (IndicesCreateRequest) Do ¶ 

func (r IndicesCreateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesDataStreamsStats ¶ 

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 ¶ 

func (f IndicesDataStreamsStats) WithContext(v context.Context) func(*IndicesDataStreamsStatsRequest)

WithContext sets the request context.

func (IndicesDataStreamsStats) WithErrorTrace ¶ 

func (f IndicesDataStreamsStats) WithErrorTrace() func(*IndicesDataStreamsStatsRequest)

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

func (IndicesDataStreamsStats) WithFilterPath ¶ 

func (f IndicesDataStreamsStats) WithFilterPath(v ...string) func(*IndicesDataStreamsStatsRequest)

WithFilterPath filters the properties of the response body.

func (IndicesDataStreamsStats) WithHeader ¶ 

func (f IndicesDataStreamsStats) WithHeader(h map[string]string) func(*IndicesDataStreamsStatsRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesDataStreamsStats) WithHuman ¶ 

func (f IndicesDataStreamsStats) WithHuman() func(*IndicesDataStreamsStatsRequest)

WithHuman makes statistical values human-readable.

func (IndicesDataStreamsStats) WithName ¶ 

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 ¶ 

func (f IndicesDataStreamsStats) WithOpaqueID(s string) func(*IndicesDataStreamsStatsRequest)

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

func (IndicesDataStreamsStats) WithPretty ¶ 

func (f IndicesDataStreamsStats) WithPretty() func(*IndicesDataStreamsStatsRequest)

WithPretty makes the response body pretty-printed.

type IndicesDataStreamsStatsRequest ¶ 

type IndicesDataStreamsStatsRequest struct {
	Name []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesDataStreamsStatsRequest configures the Indices Data Streams Stats API request.

func (IndicesDataStreamsStatsRequest) Do ¶ 

func (r IndicesDataStreamsStatsRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesDeleteAliasRequest configures the Indices Delete Alias API request.

func (IndicesDeleteAliasRequest) Do ¶ 

func (r IndicesDeleteAliasRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesDeleteDataLifecycle ¶ added in v8.8.0 

type IndicesDeleteDataLifecycle func(name []string, o ...func(*IndicesDeleteDataLifecycleRequest)) (*Response, error)

IndicesDeleteDataLifecycle deletes the data stream lifecycle of the selected data streams.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html.

func (IndicesDeleteDataLifecycle) WithContext ¶ added in v8.8.0 

func (f IndicesDeleteDataLifecycle) WithContext(v context.Context) func(*IndicesDeleteDataLifecycleRequest)

WithContext sets the request context.

func (IndicesDeleteDataLifecycle) WithErrorTrace ¶ added in v8.8.0 

func (f IndicesDeleteDataLifecycle) WithErrorTrace() func(*IndicesDeleteDataLifecycleRequest)

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

func (IndicesDeleteDataLifecycle) WithExpandWildcards ¶ added in v8.8.0 

func (f IndicesDeleteDataLifecycle) WithExpandWildcards(v string) func(*IndicesDeleteDataLifecycleRequest)

WithExpandWildcards - whether wildcard expressions should get expanded to open or closed indices (default: open).

func (IndicesDeleteDataLifecycle) WithFilterPath ¶ added in v8.8.0 

func (f IndicesDeleteDataLifecycle) WithFilterPath(v ...string) func(*IndicesDeleteDataLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (IndicesDeleteDataLifecycle) WithHeader ¶ added in v8.8.0 

func (f IndicesDeleteDataLifecycle) WithHeader(h map[string]string) func(*IndicesDeleteDataLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesDeleteDataLifecycle) WithHuman ¶ added in v8.8.0 

func (f IndicesDeleteDataLifecycle) WithHuman() func(*IndicesDeleteDataLifecycleRequest)

WithHuman makes statistical values human-readable.

func (IndicesDeleteDataLifecycle) WithMasterTimeout ¶ added in v8.8.0 

func (f IndicesDeleteDataLifecycle) WithMasterTimeout(v time.Duration) func(*IndicesDeleteDataLifecycleRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesDeleteDataLifecycle) WithOpaqueID ¶ added in v8.8.0 

func (f IndicesDeleteDataLifecycle) WithOpaqueID(s string) func(*IndicesDeleteDataLifecycleRequest)

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

func (IndicesDeleteDataLifecycle) WithPretty ¶ added in v8.8.0 

func (f IndicesDeleteDataLifecycle) WithPretty() func(*IndicesDeleteDataLifecycleRequest)

WithPretty makes the response body pretty-printed.

func (IndicesDeleteDataLifecycle) WithTimeout ¶ added in v8.8.0 

func (f IndicesDeleteDataLifecycle) WithTimeout(v time.Duration) func(*IndicesDeleteDataLifecycleRequest)

WithTimeout - explicit timestamp for the document.

type IndicesDeleteDataLifecycleRequest ¶ added in v8.8.0 

type IndicesDeleteDataLifecycleRequest struct {
	Name []string

	ExpandWildcards string
	MasterTimeout   time.Duration
	Timeout         time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesDeleteDataLifecycleRequest configures the Indices Delete Data Lifecycle API request.

func (IndicesDeleteDataLifecycleRequest) Do ¶ added in v8.8.0 

func (r IndicesDeleteDataLifecycleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesDeleteDataStream ¶ 

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 ¶ 

func (f IndicesDeleteDataStream) WithContext(v context.Context) func(*IndicesDeleteDataStreamRequest)

WithContext sets the request context.

func (IndicesDeleteDataStream) WithErrorTrace ¶ 

func (f IndicesDeleteDataStream) WithErrorTrace() func(*IndicesDeleteDataStreamRequest)

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

func (IndicesDeleteDataStream) WithExpandWildcards ¶ 

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 ¶ 

func (f IndicesDeleteDataStream) WithFilterPath(v ...string) func(*IndicesDeleteDataStreamRequest)

WithFilterPath filters the properties of the response body.

func (IndicesDeleteDataStream) WithHeader ¶ 

func (f IndicesDeleteDataStream) WithHeader(h map[string]string) func(*IndicesDeleteDataStreamRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesDeleteDataStream) WithHuman ¶ 

func (f IndicesDeleteDataStream) WithHuman() func(*IndicesDeleteDataStreamRequest)

WithHuman makes statistical values human-readable.

func (IndicesDeleteDataStream) WithMasterTimeout ¶ added in v8.16.0 

func (f IndicesDeleteDataStream) WithMasterTimeout(v time.Duration) func(*IndicesDeleteDataStreamRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesDeleteDataStream) WithOpaqueID ¶ 

func (f IndicesDeleteDataStream) WithOpaqueID(s string) func(*IndicesDeleteDataStreamRequest)

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

func (IndicesDeleteDataStream) WithPretty ¶ 

func (f IndicesDeleteDataStream) WithPretty() func(*IndicesDeleteDataStreamRequest)

WithPretty makes the response body pretty-printed.

type IndicesDeleteDataStreamRequest ¶ 

type IndicesDeleteDataStreamRequest struct {
	Name []string

	ExpandWildcards string
	MasterTimeout   time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesDeleteDataStreamRequest configures the Indices Delete Data Stream API request.

func (IndicesDeleteDataStreamRequest) Do ¶ 

func (r IndicesDeleteDataStreamRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesDeleteIndexTemplate ¶ 

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-delete-template.html.

func (IndicesDeleteIndexTemplate) WithContext ¶ 

func (f IndicesDeleteIndexTemplate) WithContext(v context.Context) func(*IndicesDeleteIndexTemplateRequest)

WithContext sets the request context.

func (IndicesDeleteIndexTemplate) WithErrorTrace ¶ 

func (f IndicesDeleteIndexTemplate) WithErrorTrace() func(*IndicesDeleteIndexTemplateRequest)

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

func (IndicesDeleteIndexTemplate) WithFilterPath ¶ 

func (f IndicesDeleteIndexTemplate) WithFilterPath(v ...string) func(*IndicesDeleteIndexTemplateRequest)

WithFilterPath filters the properties of the response body.

func (IndicesDeleteIndexTemplate) WithHeader ¶ 

func (f IndicesDeleteIndexTemplate) WithHeader(h map[string]string) func(*IndicesDeleteIndexTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesDeleteIndexTemplate) WithHuman ¶ 

func (f IndicesDeleteIndexTemplate) WithHuman() func(*IndicesDeleteIndexTemplateRequest)

WithHuman makes statistical values human-readable.

func (IndicesDeleteIndexTemplate) WithMasterTimeout ¶ 

func (f IndicesDeleteIndexTemplate) WithMasterTimeout(v time.Duration) func(*IndicesDeleteIndexTemplateRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesDeleteIndexTemplate) WithOpaqueID ¶ 

func (f IndicesDeleteIndexTemplate) WithOpaqueID(s string) func(*IndicesDeleteIndexTemplateRequest)

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

func (IndicesDeleteIndexTemplate) WithPretty ¶ 

func (f IndicesDeleteIndexTemplate) WithPretty() func(*IndicesDeleteIndexTemplateRequest)

WithPretty makes the response body pretty-printed.

func (IndicesDeleteIndexTemplate) WithTimeout ¶ 

func (f IndicesDeleteIndexTemplate) WithTimeout(v time.Duration) func(*IndicesDeleteIndexTemplateRequest)

WithTimeout - explicit operation timeout.

type IndicesDeleteIndexTemplateRequest ¶ 

type IndicesDeleteIndexTemplateRequest struct {
	Name string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesDeleteIndexTemplateRequest configures the Indices Delete Index Template API request.

func (IndicesDeleteIndexTemplateRequest) Do ¶ 

func (r IndicesDeleteIndexTemplateRequest) Do(providedCtx 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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesDeleteRequest configures the Indices Delete API request.

func (IndicesDeleteRequest) Do ¶ 

func (r IndicesDeleteRequest) Do(providedCtx 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-delete-template-v1.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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesDeleteTemplateRequest configures the Indices Delete Template API request.

func (IndicesDeleteTemplateRequest) Do ¶ 

func (r IndicesDeleteTemplateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesDiskUsage ¶ 

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 ¶ 

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 ¶ 

func (f IndicesDiskUsage) WithContext(v context.Context) func(*IndicesDiskUsageRequest)

WithContext sets the request context.

func (IndicesDiskUsage) WithErrorTrace ¶ 

func (f IndicesDiskUsage) WithErrorTrace() func(*IndicesDiskUsageRequest)

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

func (IndicesDiskUsage) WithExpandWildcards ¶ 

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 ¶ 

func (f IndicesDiskUsage) WithFilterPath(v ...string) func(*IndicesDiskUsageRequest)

WithFilterPath filters the properties of the response body.

func (IndicesDiskUsage) WithFlush ¶ 

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 ¶ 

func (f IndicesDiskUsage) WithHeader(h map[string]string) func(*IndicesDiskUsageRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesDiskUsage) WithHuman ¶ 

func (f IndicesDiskUsage) WithHuman() func(*IndicesDiskUsageRequest)

WithHuman makes statistical values human-readable.

func (IndicesDiskUsage) WithIgnoreUnavailable ¶ 

func (f IndicesDiskUsage) WithIgnoreUnavailable(v bool) func(*IndicesDiskUsageRequest)

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

func (IndicesDiskUsage) WithOpaqueID ¶ 

func (f IndicesDiskUsage) WithOpaqueID(s string) func(*IndicesDiskUsageRequest)

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

func (IndicesDiskUsage) WithPretty ¶ 

func (f IndicesDiskUsage) WithPretty() func(*IndicesDiskUsageRequest)

WithPretty makes the response body pretty-printed.

func (IndicesDiskUsage) WithRunExpensiveTasks ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesDiskUsageRequest configures the Indices Disk Usage API request.

func (IndicesDiskUsageRequest) Do ¶ 

func (r IndicesDiskUsageRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesDownsample ¶ added in v8.5.0 

type IndicesDownsample func(index string, body io.Reader, target_index string, o ...func(*IndicesDownsampleRequest)) (*Response, error)

IndicesDownsample downsample an index

This API is experimental.

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

func (IndicesDownsample) WithContext ¶ added in v8.5.0 

func (f IndicesDownsample) WithContext(v context.Context) func(*IndicesDownsampleRequest)

WithContext sets the request context.

func (IndicesDownsample) WithErrorTrace ¶ added in v8.5.0 

func (f IndicesDownsample) WithErrorTrace() func(*IndicesDownsampleRequest)

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

func (IndicesDownsample) WithFilterPath ¶ added in v8.5.0 

func (f IndicesDownsample) WithFilterPath(v ...string) func(*IndicesDownsampleRequest)

WithFilterPath filters the properties of the response body.

func (IndicesDownsample) WithHeader ¶ added in v8.5.0 

func (f IndicesDownsample) WithHeader(h map[string]string) func(*IndicesDownsampleRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesDownsample) WithHuman ¶ added in v8.5.0 

func (f IndicesDownsample) WithHuman() func(*IndicesDownsampleRequest)

WithHuman makes statistical values human-readable.

func (IndicesDownsample) WithOpaqueID ¶ added in v8.5.0 

func (f IndicesDownsample) WithOpaqueID(s string) func(*IndicesDownsampleRequest)

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

func (IndicesDownsample) WithPretty ¶ added in v8.5.0 

func (f IndicesDownsample) WithPretty() func(*IndicesDownsampleRequest)

WithPretty makes the response body pretty-printed.

type IndicesDownsampleRequest ¶ added in v8.5.0 

type IndicesDownsampleRequest struct {
	Index string

	Body io.Reader

	TargetIndex string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesDownsampleRequest configures the Indices Downsample API request.

func (IndicesDownsampleRequest) Do ¶ added in v8.5.0 

func (r IndicesDownsampleRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesExistsAliasRequest configures the Indices Exists Alias API request.

func (IndicesExistsAliasRequest) Do ¶ 

func (r IndicesExistsAliasRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesExistsIndexTemplate ¶ 

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/index-templates.html.

func (IndicesExistsIndexTemplate) WithContext ¶ 

func (f IndicesExistsIndexTemplate) WithContext(v context.Context) func(*IndicesExistsIndexTemplateRequest)

WithContext sets the request context.

func (IndicesExistsIndexTemplate) WithErrorTrace ¶ 

func (f IndicesExistsIndexTemplate) WithErrorTrace() func(*IndicesExistsIndexTemplateRequest)

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

func (IndicesExistsIndexTemplate) WithFilterPath ¶ 

func (f IndicesExistsIndexTemplate) WithFilterPath(v ...string) func(*IndicesExistsIndexTemplateRequest)

WithFilterPath filters the properties of the response body.

func (IndicesExistsIndexTemplate) WithFlatSettings ¶ 

func (f IndicesExistsIndexTemplate) WithFlatSettings(v bool) func(*IndicesExistsIndexTemplateRequest)

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

func (IndicesExistsIndexTemplate) WithHeader ¶ 

func (f IndicesExistsIndexTemplate) WithHeader(h map[string]string) func(*IndicesExistsIndexTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesExistsIndexTemplate) WithHuman ¶ 

func (f IndicesExistsIndexTemplate) WithHuman() func(*IndicesExistsIndexTemplateRequest)

WithHuman makes statistical values human-readable.

func (IndicesExistsIndexTemplate) WithLocal ¶ 

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 ¶ 

func (f IndicesExistsIndexTemplate) WithMasterTimeout(v time.Duration) func(*IndicesExistsIndexTemplateRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (IndicesExistsIndexTemplate) WithOpaqueID ¶ 

func (f IndicesExistsIndexTemplate) WithOpaqueID(s string) func(*IndicesExistsIndexTemplateRequest)

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

func (IndicesExistsIndexTemplate) WithPretty ¶ 

func (f IndicesExistsIndexTemplate) WithPretty() func(*IndicesExistsIndexTemplateRequest)

WithPretty makes the response body pretty-printed.

type IndicesExistsIndexTemplateRequest ¶ 

type IndicesExistsIndexTemplateRequest struct {
	Name string

	FlatSettings  *bool
	Local         *bool
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesExistsIndexTemplateRequest configures the Indices Exists Index Template API request.

func (IndicesExistsIndexTemplateRequest) Do ¶ 

func (r IndicesExistsIndexTemplateRequest) Do(providedCtx 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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesExistsRequest configures the Indices Exists API request.

func (IndicesExistsRequest) Do ¶ 

func (r IndicesExistsRequest) Do(providedCtx 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-template-exists-v1.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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesExistsTemplateRequest configures the Indices Exists Template API request.

func (IndicesExistsTemplateRequest) Do ¶ 

func (r IndicesExistsTemplateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesExplainDataLifecycle ¶ added in v8.8.0 

type IndicesExplainDataLifecycle func(index string, o ...func(*IndicesExplainDataLifecycleRequest)) (*Response, error)

IndicesExplainDataLifecycle retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html.

func (IndicesExplainDataLifecycle) WithContext ¶ added in v8.8.0 

func (f IndicesExplainDataLifecycle) WithContext(v context.Context) func(*IndicesExplainDataLifecycleRequest)

WithContext sets the request context.

func (IndicesExplainDataLifecycle) WithErrorTrace ¶ added in v8.8.0 

func (f IndicesExplainDataLifecycle) WithErrorTrace() func(*IndicesExplainDataLifecycleRequest)

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

func (IndicesExplainDataLifecycle) WithFilterPath ¶ added in v8.8.0 

func (f IndicesExplainDataLifecycle) WithFilterPath(v ...string) func(*IndicesExplainDataLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (IndicesExplainDataLifecycle) WithHeader ¶ added in v8.8.0 

func (f IndicesExplainDataLifecycle) WithHeader(h map[string]string) func(*IndicesExplainDataLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesExplainDataLifecycle) WithHuman ¶ added in v8.8.0 

func (f IndicesExplainDataLifecycle) WithHuman() func(*IndicesExplainDataLifecycleRequest)

WithHuman makes statistical values human-readable.

func (IndicesExplainDataLifecycle) WithIncludeDefaults ¶ added in v8.8.0 

func (f IndicesExplainDataLifecycle) WithIncludeDefaults(v bool) func(*IndicesExplainDataLifecycleRequest)

WithIncludeDefaults - indicates if the api should return the default values the system uses for the index's lifecycle.

func (IndicesExplainDataLifecycle) WithMasterTimeout ¶ added in v8.8.0 

func (f IndicesExplainDataLifecycle) WithMasterTimeout(v time.Duration) func(*IndicesExplainDataLifecycleRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesExplainDataLifecycle) WithOpaqueID ¶ added in v8.8.0 

func (f IndicesExplainDataLifecycle) WithOpaqueID(s string) func(*IndicesExplainDataLifecycleRequest)

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

func (IndicesExplainDataLifecycle) WithPretty ¶ added in v8.8.0 

func (f IndicesExplainDataLifecycle) WithPretty() func(*IndicesExplainDataLifecycleRequest)

WithPretty makes the response body pretty-printed.

type IndicesExplainDataLifecycleRequest ¶ added in v8.8.0 

type IndicesExplainDataLifecycleRequest struct {
	Index string

	IncludeDefaults *bool
	MasterTimeout   time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesExplainDataLifecycleRequest configures the Indices Explain Data Lifecycle API request.

func (IndicesExplainDataLifecycleRequest) Do ¶ added in v8.8.0 

func (r IndicesExplainDataLifecycleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesFieldUsageStats ¶ 

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 ¶ 

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 ¶ 

func (f IndicesFieldUsageStats) WithContext(v context.Context) func(*IndicesFieldUsageStatsRequest)

WithContext sets the request context.

func (IndicesFieldUsageStats) WithErrorTrace ¶ 

func (f IndicesFieldUsageStats) WithErrorTrace() func(*IndicesFieldUsageStatsRequest)

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

func (IndicesFieldUsageStats) WithExpandWildcards ¶ 

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 ¶ 

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 ¶ 

func (f IndicesFieldUsageStats) WithFilterPath(v ...string) func(*IndicesFieldUsageStatsRequest)

WithFilterPath filters the properties of the response body.

func (IndicesFieldUsageStats) WithHeader ¶ 

func (f IndicesFieldUsageStats) WithHeader(h map[string]string) func(*IndicesFieldUsageStatsRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesFieldUsageStats) WithHuman ¶ 

func (f IndicesFieldUsageStats) WithHuman() func(*IndicesFieldUsageStatsRequest)

WithHuman makes statistical values human-readable.

func (IndicesFieldUsageStats) WithIgnoreUnavailable ¶ 

func (f IndicesFieldUsageStats) WithIgnoreUnavailable(v bool) func(*IndicesFieldUsageStatsRequest)

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

func (IndicesFieldUsageStats) WithOpaqueID ¶ 

func (f IndicesFieldUsageStats) WithOpaqueID(s string) func(*IndicesFieldUsageStatsRequest)

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

func (IndicesFieldUsageStats) WithPretty ¶ 

func (f IndicesFieldUsageStats) WithPretty() func(*IndicesFieldUsageStatsRequest)

WithPretty makes the response body pretty-printed.

type IndicesFieldUsageStatsRequest ¶ 

type IndicesFieldUsageStatsRequest struct {
	Index string

	AllowNoIndices    *bool
	ExpandWildcards   string
	Fields            []string
	IgnoreUnavailable *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesFieldUsageStatsRequest configures the Indices Field Usage Stats API request.

func (IndicesFieldUsageStatsRequest) Do ¶ 

func (r IndicesFieldUsageStatsRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesFlushRequest configures the Indices Flush API request.

func (IndicesFlushRequest) Do ¶ 

func (r IndicesFlushRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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.

func (IndicesForcemerge) WithWaitForCompletion ¶ added in v8.1.0 

func (f IndicesForcemerge) WithWaitForCompletion(v bool) func(*IndicesForcemergeRequest)

WithWaitForCompletion - should the request wait until the force merge is completed..

type IndicesForcemergeRequest ¶ 

type IndicesForcemergeRequest struct {
	Index []string

	AllowNoIndices     *bool
	ExpandWildcards    string
	Flush              *bool
	IgnoreUnavailable  *bool
	MaxNumSegments     *int
	OnlyExpungeDeletes *bool
	WaitForCompletion  *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesForcemergeRequest configures the Indices Forcemerge API request.

func (IndicesForcemergeRequest) Do ¶ 

func (r IndicesForcemergeRequest) Do(providedCtx 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) WithFeatures ¶ added in v8.1.0 

func (f IndicesGet) WithFeatures(v string) func(*IndicesGetRequest)

WithFeatures - return only information on specified index features.

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 ¶ 

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

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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesGetAliasRequest configures the Indices Get Alias API request.

func (IndicesGetAliasRequest) Do ¶ 

func (r IndicesGetAliasRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesGetDataLifecycle ¶ added in v8.8.0 

type IndicesGetDataLifecycle func(name []string, o ...func(*IndicesGetDataLifecycleRequest)) (*Response, error)

IndicesGetDataLifecycle returns the data stream lifecycle of the selected data streams.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html.

func (IndicesGetDataLifecycle) WithContext ¶ added in v8.8.0 

func (f IndicesGetDataLifecycle) WithContext(v context.Context) func(*IndicesGetDataLifecycleRequest)

WithContext sets the request context.

func (IndicesGetDataLifecycle) WithErrorTrace ¶ added in v8.8.0 

func (f IndicesGetDataLifecycle) WithErrorTrace() func(*IndicesGetDataLifecycleRequest)

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

func (IndicesGetDataLifecycle) WithExpandWildcards ¶ added in v8.8.0 

func (f IndicesGetDataLifecycle) WithExpandWildcards(v string) func(*IndicesGetDataLifecycleRequest)

WithExpandWildcards - whether wildcard expressions should get expanded to open or closed indices (default: open).

func (IndicesGetDataLifecycle) WithFilterPath ¶ added in v8.8.0 

func (f IndicesGetDataLifecycle) WithFilterPath(v ...string) func(*IndicesGetDataLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (IndicesGetDataLifecycle) WithHeader ¶ added in v8.8.0 

func (f IndicesGetDataLifecycle) WithHeader(h map[string]string) func(*IndicesGetDataLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesGetDataLifecycle) WithHuman ¶ added in v8.8.0 

func (f IndicesGetDataLifecycle) WithHuman() func(*IndicesGetDataLifecycleRequest)

WithHuman makes statistical values human-readable.

func (IndicesGetDataLifecycle) WithIncludeDefaults ¶ added in v8.8.0 

func (f IndicesGetDataLifecycle) WithIncludeDefaults(v bool) func(*IndicesGetDataLifecycleRequest)

WithIncludeDefaults - return all relevant default configurations for the data stream (default: false).

func (IndicesGetDataLifecycle) WithMasterTimeout ¶ added in v8.16.0 

func (f IndicesGetDataLifecycle) WithMasterTimeout(v time.Duration) func(*IndicesGetDataLifecycleRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesGetDataLifecycle) WithOpaqueID ¶ added in v8.8.0 

func (f IndicesGetDataLifecycle) WithOpaqueID(s string) func(*IndicesGetDataLifecycleRequest)

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

func (IndicesGetDataLifecycle) WithPretty ¶ added in v8.8.0 

func (f IndicesGetDataLifecycle) WithPretty() func(*IndicesGetDataLifecycleRequest)

WithPretty makes the response body pretty-printed.

type IndicesGetDataLifecycleRequest ¶ added in v8.8.0 

type IndicesGetDataLifecycleRequest struct {
	Name []string

	ExpandWildcards string
	IncludeDefaults *bool
	MasterTimeout   time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesGetDataLifecycleRequest configures the Indices Get Data Lifecycle API request.

func (IndicesGetDataLifecycleRequest) Do ¶ added in v8.8.0 

func (r IndicesGetDataLifecycleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesGetDataLifecycleStats ¶ added in v8.18.0 

type IndicesGetDataLifecycleStats func(o ...func(*IndicesGetDataLifecycleStatsRequest)) (*Response, error)

IndicesGetDataLifecycleStats get data stream lifecycle statistics.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle-stats.html.

func (IndicesGetDataLifecycleStats) WithContext ¶ added in v8.18.0 

func (f IndicesGetDataLifecycleStats) WithContext(v context.Context) func(*IndicesGetDataLifecycleStatsRequest)

WithContext sets the request context.

func (IndicesGetDataLifecycleStats) WithErrorTrace ¶ added in v8.18.0 

func (f IndicesGetDataLifecycleStats) WithErrorTrace() func(*IndicesGetDataLifecycleStatsRequest)

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

func (IndicesGetDataLifecycleStats) WithFilterPath ¶ added in v8.18.0 

func (f IndicesGetDataLifecycleStats) WithFilterPath(v ...string) func(*IndicesGetDataLifecycleStatsRequest)

WithFilterPath filters the properties of the response body.

func (IndicesGetDataLifecycleStats) WithHeader ¶ added in v8.18.0 

func (f IndicesGetDataLifecycleStats) WithHeader(h map[string]string) func(*IndicesGetDataLifecycleStatsRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesGetDataLifecycleStats) WithHuman ¶ added in v8.18.0 

func (f IndicesGetDataLifecycleStats) WithHuman() func(*IndicesGetDataLifecycleStatsRequest)

WithHuman makes statistical values human-readable.

func (IndicesGetDataLifecycleStats) WithOpaqueID ¶ added in v8.18.0 

func (f IndicesGetDataLifecycleStats) WithOpaqueID(s string) func(*IndicesGetDataLifecycleStatsRequest)

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

func (IndicesGetDataLifecycleStats) WithPretty ¶ added in v8.18.0 

func (f IndicesGetDataLifecycleStats) WithPretty() func(*IndicesGetDataLifecycleStatsRequest)

WithPretty makes the response body pretty-printed.

type IndicesGetDataLifecycleStatsRequest ¶ added in v8.18.0 

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

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesGetDataLifecycleStatsRequest configures the Indices Get Data Lifecycle Stats API request.

func (IndicesGetDataLifecycleStatsRequest) Do ¶ added in v8.18.0 

func (r IndicesGetDataLifecycleStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesGetDataStream ¶ 

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 ¶ 

func (f IndicesGetDataStream) WithContext(v context.Context) func(*IndicesGetDataStreamRequest)

WithContext sets the request context.

func (IndicesGetDataStream) WithErrorTrace ¶ 

func (f IndicesGetDataStream) WithErrorTrace() func(*IndicesGetDataStreamRequest)

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

func (IndicesGetDataStream) WithExpandWildcards ¶ 

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 ¶ 

func (f IndicesGetDataStream) WithFilterPath(v ...string) func(*IndicesGetDataStreamRequest)

WithFilterPath filters the properties of the response body.

func (IndicesGetDataStream) WithHeader ¶ 

func (f IndicesGetDataStream) WithHeader(h map[string]string) func(*IndicesGetDataStreamRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesGetDataStream) WithHuman ¶ 

func (f IndicesGetDataStream) WithHuman() func(*IndicesGetDataStreamRequest)

WithHuman makes statistical values human-readable.

func (IndicesGetDataStream) WithIncludeDefaults ¶ added in v8.8.0 

func (f IndicesGetDataStream) WithIncludeDefaults(v bool) func(*IndicesGetDataStreamRequest)

WithIncludeDefaults - return all relevant default configurations for the data stream (default: false).

func (IndicesGetDataStream) WithMasterTimeout ¶ added in v8.16.0 

func (f IndicesGetDataStream) WithMasterTimeout(v time.Duration) func(*IndicesGetDataStreamRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesGetDataStream) WithName ¶ 

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 ¶ 

func (f IndicesGetDataStream) WithOpaqueID(s string) func(*IndicesGetDataStreamRequest)

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

func (IndicesGetDataStream) WithPretty ¶ 

func (f IndicesGetDataStream) WithPretty() func(*IndicesGetDataStreamRequest)

WithPretty makes the response body pretty-printed.

func (IndicesGetDataStream) WithVerbose ¶ added in v8.16.0 

func (f IndicesGetDataStream) WithVerbose(v bool) func(*IndicesGetDataStreamRequest)

WithVerbose - whether the maximum timestamp for each data stream should be calculated and returned (default: false).

type IndicesGetDataStreamRequest ¶ 

type IndicesGetDataStreamRequest struct {
	Name []string

	ExpandWildcards string
	IncludeDefaults *bool
	MasterTimeout   time.Duration
	Verbose         *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesGetDataStreamRequest configures the Indices Get Data Stream API request.

func (IndicesGetDataStreamRequest) Do ¶ 

func (r IndicesGetDataStreamRequest) Do(providedCtx 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) 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 ¶ 

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

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

	Fields []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *bool
	IncludeDefaults   *bool
	Local             *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesGetFieldMappingRequest configures the Indices Get Field Mapping API request.

func (IndicesGetFieldMappingRequest) Do ¶ 

func (r IndicesGetFieldMappingRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesGetIndexTemplate ¶ 

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-get-template.html.

func (IndicesGetIndexTemplate) WithContext ¶ 

func (f IndicesGetIndexTemplate) WithContext(v context.Context) func(*IndicesGetIndexTemplateRequest)

WithContext sets the request context.

func (IndicesGetIndexTemplate) WithErrorTrace ¶ 

func (f IndicesGetIndexTemplate) WithErrorTrace() func(*IndicesGetIndexTemplateRequest)

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

func (IndicesGetIndexTemplate) WithFilterPath ¶ 

func (f IndicesGetIndexTemplate) WithFilterPath(v ...string) func(*IndicesGetIndexTemplateRequest)

WithFilterPath filters the properties of the response body.

func (IndicesGetIndexTemplate) WithFlatSettings ¶ 

func (f IndicesGetIndexTemplate) WithFlatSettings(v bool) func(*IndicesGetIndexTemplateRequest)

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

func (IndicesGetIndexTemplate) WithHeader ¶ 

func (f IndicesGetIndexTemplate) WithHeader(h map[string]string) func(*IndicesGetIndexTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesGetIndexTemplate) WithHuman ¶ 

func (f IndicesGetIndexTemplate) WithHuman() func(*IndicesGetIndexTemplateRequest)

WithHuman makes statistical values human-readable.

func (IndicesGetIndexTemplate) WithIncludeDefaults ¶ added in v8.8.0 

func (f IndicesGetIndexTemplate) WithIncludeDefaults(v bool) func(*IndicesGetIndexTemplateRequest)

WithIncludeDefaults - return all relevant default configurations for the index template (default: false).

func (IndicesGetIndexTemplate) WithLocal ¶ 

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 ¶ 

func (f IndicesGetIndexTemplate) WithMasterTimeout(v time.Duration) func(*IndicesGetIndexTemplateRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (IndicesGetIndexTemplate) WithName ¶ 

func (f IndicesGetIndexTemplate) WithName(v string) func(*IndicesGetIndexTemplateRequest)

WithName - a pattern that returned template names must match.

func (IndicesGetIndexTemplate) WithOpaqueID ¶ 

func (f IndicesGetIndexTemplate) WithOpaqueID(s string) func(*IndicesGetIndexTemplateRequest)

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

func (IndicesGetIndexTemplate) WithPretty ¶ 

func (f IndicesGetIndexTemplate) WithPretty() func(*IndicesGetIndexTemplateRequest)

WithPretty makes the response body pretty-printed.

type IndicesGetIndexTemplateRequest ¶ 

type IndicesGetIndexTemplateRequest struct {
	Name string

	FlatSettings    *bool
	IncludeDefaults *bool
	Local           *bool
	MasterTimeout   time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesGetIndexTemplateRequest configures the Indices Get Index Template API request.

func (IndicesGetIndexTemplateRequest) Do ¶ 

func (r IndicesGetIndexTemplateRequest) Do(providedCtx 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) 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 ¶ 

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

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

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *bool
	Local             *bool
	MasterTimeout     time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesGetMappingRequest configures the Indices Get Mapping API request.

func (IndicesGetMappingRequest) Do ¶ 

func (r IndicesGetMappingRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesGetMigrateReindexStatus ¶ added in v8.18.0 

type IndicesGetMigrateReindexStatus func(index string, o ...func(*IndicesGetMigrateReindexStatusRequest)) (*Response, error)

IndicesGetMigrateReindexStatus this API returns the status of a migration reindex attempt for a data stream or index

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex-status-api.html.

func (IndicesGetMigrateReindexStatus) WithContext ¶ added in v8.18.0 

func (f IndicesGetMigrateReindexStatus) WithContext(v context.Context) func(*IndicesGetMigrateReindexStatusRequest)

WithContext sets the request context.

func (IndicesGetMigrateReindexStatus) WithErrorTrace ¶ added in v8.18.0 

func (f IndicesGetMigrateReindexStatus) WithErrorTrace() func(*IndicesGetMigrateReindexStatusRequest)

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

func (IndicesGetMigrateReindexStatus) WithFilterPath ¶ added in v8.18.0 

func (f IndicesGetMigrateReindexStatus) WithFilterPath(v ...string) func(*IndicesGetMigrateReindexStatusRequest)

WithFilterPath filters the properties of the response body.

func (IndicesGetMigrateReindexStatus) WithHeader ¶ added in v8.18.0 

func (f IndicesGetMigrateReindexStatus) WithHeader(h map[string]string) func(*IndicesGetMigrateReindexStatusRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesGetMigrateReindexStatus) WithHuman ¶ added in v8.18.0 

func (f IndicesGetMigrateReindexStatus) WithHuman() func(*IndicesGetMigrateReindexStatusRequest)

WithHuman makes statistical values human-readable.

func (IndicesGetMigrateReindexStatus) WithOpaqueID ¶ added in v8.18.0 

func (f IndicesGetMigrateReindexStatus) WithOpaqueID(s string) func(*IndicesGetMigrateReindexStatusRequest)

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

func (IndicesGetMigrateReindexStatus) WithPretty ¶ added in v8.18.0 

func (f IndicesGetMigrateReindexStatus) WithPretty() func(*IndicesGetMigrateReindexStatusRequest)

WithPretty makes the response body pretty-printed.

type IndicesGetMigrateReindexStatusRequest ¶ added in v8.18.0 

type IndicesGetMigrateReindexStatusRequest struct {
	Index string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesGetMigrateReindexStatusRequest configures the Indices Get Migrate Reindex Status API request.

func (IndicesGetMigrateReindexStatusRequest) Do ¶ added in v8.18.0 

func (r IndicesGetMigrateReindexStatusRequest) Do(providedCtx 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
	Features          string
	FlatSettings      *bool
	IgnoreUnavailable *bool
	IncludeDefaults   *bool
	Local             *bool
	MasterTimeout     time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesGetRequest configures the Indices Get API request.

func (IndicesGetRequest) Do ¶ 

func (r IndicesGetRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesGetSettingsRequest configures the Indices Get Settings API request.

func (IndicesGetSettingsRequest) Do ¶ 

func (r IndicesGetSettingsRequest) Do(providedCtx 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-get-template-v1.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 ¶ 

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

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
	Local         *bool
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesGetTemplateRequest configures the Indices Get Template API request.

func (IndicesGetTemplateRequest) Do ¶ 

func (r IndicesGetTemplateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesMigrateReindex ¶ added in v8.18.0 

type IndicesMigrateReindex func(body io.Reader, o ...func(*IndicesMigrateReindexRequest)) (*Response, error)

IndicesMigrateReindex this API reindexes all legacy backing indices for a data stream. It does this in a persistent task. The persistent task id is returned immediately, and the reindexing work is completed in that task

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex-api.html.

func (IndicesMigrateReindex) WithContext ¶ added in v8.18.0 

func (f IndicesMigrateReindex) WithContext(v context.Context) func(*IndicesMigrateReindexRequest)

WithContext sets the request context.

func (IndicesMigrateReindex) WithErrorTrace ¶ added in v8.18.0 

func (f IndicesMigrateReindex) WithErrorTrace() func(*IndicesMigrateReindexRequest)

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

func (IndicesMigrateReindex) WithFilterPath ¶ added in v8.18.0 

func (f IndicesMigrateReindex) WithFilterPath(v ...string) func(*IndicesMigrateReindexRequest)

WithFilterPath filters the properties of the response body.

func (IndicesMigrateReindex) WithHeader ¶ added in v8.18.0 

func (f IndicesMigrateReindex) WithHeader(h map[string]string) func(*IndicesMigrateReindexRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesMigrateReindex) WithHuman ¶ added in v8.18.0 

func (f IndicesMigrateReindex) WithHuman() func(*IndicesMigrateReindexRequest)

WithHuman makes statistical values human-readable.

func (IndicesMigrateReindex) WithOpaqueID ¶ added in v8.18.0 

func (f IndicesMigrateReindex) WithOpaqueID(s string) func(*IndicesMigrateReindexRequest)

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

func (IndicesMigrateReindex) WithPretty ¶ added in v8.18.0 

func (f IndicesMigrateReindex) WithPretty() func(*IndicesMigrateReindexRequest)

WithPretty makes the response body pretty-printed.

type IndicesMigrateReindexRequest ¶ added in v8.18.0 

type IndicesMigrateReindexRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesMigrateReindexRequest configures the Indices Migrate Reindex API request.

func (IndicesMigrateReindexRequest) Do ¶ added in v8.18.0 

func (r IndicesMigrateReindexRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesMigrateToDataStream ¶ 

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 ¶ 

func (f IndicesMigrateToDataStream) WithContext(v context.Context) func(*IndicesMigrateToDataStreamRequest)

WithContext sets the request context.

func (IndicesMigrateToDataStream) WithErrorTrace ¶ 

func (f IndicesMigrateToDataStream) WithErrorTrace() func(*IndicesMigrateToDataStreamRequest)

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

func (IndicesMigrateToDataStream) WithFilterPath ¶ 

func (f IndicesMigrateToDataStream) WithFilterPath(v ...string) func(*IndicesMigrateToDataStreamRequest)

WithFilterPath filters the properties of the response body.

func (IndicesMigrateToDataStream) WithHeader ¶ 

func (f IndicesMigrateToDataStream) WithHeader(h map[string]string) func(*IndicesMigrateToDataStreamRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesMigrateToDataStream) WithHuman ¶ 

func (f IndicesMigrateToDataStream) WithHuman() func(*IndicesMigrateToDataStreamRequest)

WithHuman makes statistical values human-readable.

func (IndicesMigrateToDataStream) WithMasterTimeout ¶ added in v8.16.0 

func (f IndicesMigrateToDataStream) WithMasterTimeout(v time.Duration) func(*IndicesMigrateToDataStreamRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesMigrateToDataStream) WithOpaqueID ¶ 

func (f IndicesMigrateToDataStream) WithOpaqueID(s string) func(*IndicesMigrateToDataStreamRequest)

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

func (IndicesMigrateToDataStream) WithPretty ¶ 

func (f IndicesMigrateToDataStream) WithPretty() func(*IndicesMigrateToDataStreamRequest)

WithPretty makes the response body pretty-printed.

func (IndicesMigrateToDataStream) WithTimeout ¶ added in v8.16.0 

func (f IndicesMigrateToDataStream) WithTimeout(v time.Duration) func(*IndicesMigrateToDataStreamRequest)

WithTimeout - specify timeout for acknowledging the cluster state update.

type IndicesMigrateToDataStreamRequest ¶ 

type IndicesMigrateToDataStreamRequest struct {
	Name string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesMigrateToDataStreamRequest configures the Indices Migrate To Data Stream API request.

func (IndicesMigrateToDataStreamRequest) Do ¶ 

func (r IndicesMigrateToDataStreamRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesModifyDataStream ¶ 

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 ¶ 

func (f IndicesModifyDataStream) WithContext(v context.Context) func(*IndicesModifyDataStreamRequest)

WithContext sets the request context.

func (IndicesModifyDataStream) WithErrorTrace ¶ 

func (f IndicesModifyDataStream) WithErrorTrace() func(*IndicesModifyDataStreamRequest)

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

func (IndicesModifyDataStream) WithFilterPath ¶ 

func (f IndicesModifyDataStream) WithFilterPath(v ...string) func(*IndicesModifyDataStreamRequest)

WithFilterPath filters the properties of the response body.

func (IndicesModifyDataStream) WithHeader ¶ 

func (f IndicesModifyDataStream) WithHeader(h map[string]string) func(*IndicesModifyDataStreamRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesModifyDataStream) WithHuman ¶ 

func (f IndicesModifyDataStream) WithHuman() func(*IndicesModifyDataStreamRequest)

WithHuman makes statistical values human-readable.

func (IndicesModifyDataStream) WithOpaqueID ¶ 

func (f IndicesModifyDataStream) WithOpaqueID(s string) func(*IndicesModifyDataStreamRequest)

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

func (IndicesModifyDataStream) WithPretty ¶ 

func (f IndicesModifyDataStream) WithPretty() func(*IndicesModifyDataStreamRequest)

WithPretty makes the response body pretty-printed.

type IndicesModifyDataStreamRequest ¶ 

type IndicesModifyDataStreamRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesModifyDataStreamRequest configures the Indices Modify Data Stream API request.

func (IndicesModifyDataStreamRequest) Do ¶ 

func (r IndicesModifyDataStreamRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesOpenRequest configures the Indices Open API request.

func (IndicesOpenRequest) Do ¶ 

func (r IndicesOpenRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesPromoteDataStream ¶ 

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 ¶ 

func (f IndicesPromoteDataStream) WithContext(v context.Context) func(*IndicesPromoteDataStreamRequest)

WithContext sets the request context.

func (IndicesPromoteDataStream) WithErrorTrace ¶ 

func (f IndicesPromoteDataStream) WithErrorTrace() func(*IndicesPromoteDataStreamRequest)

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

func (IndicesPromoteDataStream) WithFilterPath ¶ 

func (f IndicesPromoteDataStream) WithFilterPath(v ...string) func(*IndicesPromoteDataStreamRequest)

WithFilterPath filters the properties of the response body.

func (IndicesPromoteDataStream) WithHeader ¶ 

func (f IndicesPromoteDataStream) WithHeader(h map[string]string) func(*IndicesPromoteDataStreamRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesPromoteDataStream) WithHuman ¶ 

func (f IndicesPromoteDataStream) WithHuman() func(*IndicesPromoteDataStreamRequest)

WithHuman makes statistical values human-readable.

func (IndicesPromoteDataStream) WithMasterTimeout ¶ added in v8.16.0 

func (f IndicesPromoteDataStream) WithMasterTimeout(v time.Duration) func(*IndicesPromoteDataStreamRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesPromoteDataStream) WithOpaqueID ¶ 

func (f IndicesPromoteDataStream) WithOpaqueID(s string) func(*IndicesPromoteDataStreamRequest)

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

func (IndicesPromoteDataStream) WithPretty ¶ 

func (f IndicesPromoteDataStream) WithPretty() func(*IndicesPromoteDataStreamRequest)

WithPretty makes the response body pretty-printed.

type IndicesPromoteDataStreamRequest ¶ 

type IndicesPromoteDataStreamRequest struct {
	Name string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesPromoteDataStreamRequest configures the Indices Promote Data Stream API request.

func (IndicesPromoteDataStreamRequest) Do ¶ 

func (r IndicesPromoteDataStreamRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesPutAliasRequest configures the Indices Put Alias API request.

func (IndicesPutAliasRequest) Do ¶ 

func (r IndicesPutAliasRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesPutDataLifecycle ¶ added in v8.8.0 

type IndicesPutDataLifecycle func(name []string, o ...func(*IndicesPutDataLifecycleRequest)) (*Response, error)

IndicesPutDataLifecycle updates the data stream lifecycle of the selected data streams.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html.

func (IndicesPutDataLifecycle) WithBody ¶ added in v8.8.0 

func (f IndicesPutDataLifecycle) WithBody(v io.Reader) func(*IndicesPutDataLifecycleRequest)

WithBody - The data stream lifecycle configuration that consist of the data retention.

func (IndicesPutDataLifecycle) WithContext ¶ added in v8.8.0 

func (f IndicesPutDataLifecycle) WithContext(v context.Context) func(*IndicesPutDataLifecycleRequest)

WithContext sets the request context.

func (IndicesPutDataLifecycle) WithErrorTrace ¶ added in v8.8.0 

func (f IndicesPutDataLifecycle) WithErrorTrace() func(*IndicesPutDataLifecycleRequest)

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

func (IndicesPutDataLifecycle) WithExpandWildcards ¶ added in v8.8.0 

func (f IndicesPutDataLifecycle) WithExpandWildcards(v string) func(*IndicesPutDataLifecycleRequest)

WithExpandWildcards - whether wildcard expressions should get expanded to open or closed indices (default: open).

func (IndicesPutDataLifecycle) WithFilterPath ¶ added in v8.8.0 

func (f IndicesPutDataLifecycle) WithFilterPath(v ...string) func(*IndicesPutDataLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (IndicesPutDataLifecycle) WithHeader ¶ added in v8.8.0 

func (f IndicesPutDataLifecycle) WithHeader(h map[string]string) func(*IndicesPutDataLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesPutDataLifecycle) WithHuman ¶ added in v8.8.0 

func (f IndicesPutDataLifecycle) WithHuman() func(*IndicesPutDataLifecycleRequest)

WithHuman makes statistical values human-readable.

func (IndicesPutDataLifecycle) WithMasterTimeout ¶ added in v8.8.0 

func (f IndicesPutDataLifecycle) WithMasterTimeout(v time.Duration) func(*IndicesPutDataLifecycleRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesPutDataLifecycle) WithOpaqueID ¶ added in v8.8.0 

func (f IndicesPutDataLifecycle) WithOpaqueID(s string) func(*IndicesPutDataLifecycleRequest)

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

func (IndicesPutDataLifecycle) WithPretty ¶ added in v8.8.0 

func (f IndicesPutDataLifecycle) WithPretty() func(*IndicesPutDataLifecycleRequest)

WithPretty makes the response body pretty-printed.

func (IndicesPutDataLifecycle) WithTimeout ¶ added in v8.8.0 

func (f IndicesPutDataLifecycle) WithTimeout(v time.Duration) func(*IndicesPutDataLifecycleRequest)

WithTimeout - explicit timestamp for the document.

type IndicesPutDataLifecycleRequest ¶ added in v8.8.0 

type IndicesPutDataLifecycleRequest struct {
	Body io.Reader

	Name []string

	ExpandWildcards string
	MasterTimeout   time.Duration
	Timeout         time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesPutDataLifecycleRequest configures the Indices Put Data Lifecycle API request.

func (IndicesPutDataLifecycleRequest) Do ¶ added in v8.8.0 

func (r IndicesPutDataLifecycleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesPutIndexTemplate ¶ 

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-put-template.html.

func (IndicesPutIndexTemplate) WithCause ¶ 

func (f IndicesPutIndexTemplate) WithCause(v string) func(*IndicesPutIndexTemplateRequest)

WithCause - user defined reason for creating/updating the index template.

func (IndicesPutIndexTemplate) WithContext ¶ 

func (f IndicesPutIndexTemplate) WithContext(v context.Context) func(*IndicesPutIndexTemplateRequest)

WithContext sets the request context.

func (IndicesPutIndexTemplate) WithCreate ¶ 

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 ¶ 

func (f IndicesPutIndexTemplate) WithErrorTrace() func(*IndicesPutIndexTemplateRequest)

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

func (IndicesPutIndexTemplate) WithFilterPath ¶ 

func (f IndicesPutIndexTemplate) WithFilterPath(v ...string) func(*IndicesPutIndexTemplateRequest)

WithFilterPath filters the properties of the response body.

func (IndicesPutIndexTemplate) WithHeader ¶ 

func (f IndicesPutIndexTemplate) WithHeader(h map[string]string) func(*IndicesPutIndexTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesPutIndexTemplate) WithHuman ¶ 

func (f IndicesPutIndexTemplate) WithHuman() func(*IndicesPutIndexTemplateRequest)

WithHuman makes statistical values human-readable.

func (IndicesPutIndexTemplate) WithMasterTimeout ¶ 

func (f IndicesPutIndexTemplate) WithMasterTimeout(v time.Duration) func(*IndicesPutIndexTemplateRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesPutIndexTemplate) WithOpaqueID ¶ 

func (f IndicesPutIndexTemplate) WithOpaqueID(s string) func(*IndicesPutIndexTemplateRequest)

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

func (IndicesPutIndexTemplate) WithPretty ¶ 

func (f IndicesPutIndexTemplate) WithPretty() func(*IndicesPutIndexTemplateRequest)

WithPretty makes the response body pretty-printed.

type IndicesPutIndexTemplateRequest ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesPutIndexTemplateRequest configures the Indices Put Index Template API request.

func (IndicesPutIndexTemplateRequest) Do ¶ 

func (r IndicesPutIndexTemplateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesPutMapping ¶ 

type IndicesPutMapping func(index []string, 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) 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 ¶ 

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) WithMasterTimeout ¶ 

func (f IndicesPutMapping) WithMasterTimeout(v time.Duration) func(*IndicesPutMappingRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesPutMapping) WithOpaqueID ¶ 

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 ¶ 

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

	Body io.Reader

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *bool
	MasterTimeout     time.Duration
	Timeout           time.Duration
	WriteIndexOnly    *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesPutMappingRequest configures the Indices Put Mapping API request.

func (IndicesPutMappingRequest) Do ¶ 

func (r IndicesPutMappingRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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) WithReopen ¶ added in v8.12.0 

func (f IndicesPutSettings) WithReopen(v bool) func(*IndicesPutSettingsRequest)

WithReopen - whether to close and reopen the index to apply non-dynamic settings. if set to `true` the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. the default is `false`.

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
	Reopen            *bool
	Timeout           time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesPutSettingsRequest configures the Indices Put Settings API request.

func (IndicesPutSettingsRequest) Do ¶ 

func (r IndicesPutSettingsRequest) Do(providedCtx 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-v1.html.

func (IndicesPutTemplate) WithCause ¶ added in v8.18.0 

func (f IndicesPutTemplate) WithCause(v string) func(*IndicesPutTemplateRequest)

WithCause - user defined reason for creating/updating the index template.

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 ¶ 

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) WithMasterTimeout ¶ 

func (f IndicesPutTemplate) WithMasterTimeout(v time.Duration) func(*IndicesPutTemplateRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesPutTemplate) WithOpaqueID ¶ 

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

	Cause         string
	Create        *bool
	MasterTimeout time.Duration
	Order         *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesPutTemplateRequest configures the Indices Put Template API request.

func (IndicesPutTemplateRequest) Do ¶ 

func (r IndicesPutTemplateRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesRecoveryRequest configures the Indices Recovery API request.

func (IndicesRecoveryRequest) Do ¶ 

func (r IndicesRecoveryRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesRefreshRequest configures the Indices Refresh API request.

func (IndicesRefreshRequest) Do ¶ 

func (r IndicesRefreshRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesReloadSearchAnalyzers ¶ 

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 ¶ 

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 ¶ 

func (f IndicesReloadSearchAnalyzers) WithContext(v context.Context) func(*IndicesReloadSearchAnalyzersRequest)

WithContext sets the request context.

func (IndicesReloadSearchAnalyzers) WithErrorTrace ¶ 

func (f IndicesReloadSearchAnalyzers) WithErrorTrace() func(*IndicesReloadSearchAnalyzersRequest)

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

func (IndicesReloadSearchAnalyzers) WithExpandWildcards ¶ 

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 ¶ 

func (f IndicesReloadSearchAnalyzers) WithFilterPath(v ...string) func(*IndicesReloadSearchAnalyzersRequest)

WithFilterPath filters the properties of the response body.

func (IndicesReloadSearchAnalyzers) WithHeader ¶ 

func (f IndicesReloadSearchAnalyzers) WithHeader(h map[string]string) func(*IndicesReloadSearchAnalyzersRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesReloadSearchAnalyzers) WithHuman ¶ 

func (f IndicesReloadSearchAnalyzers) WithHuman() func(*IndicesReloadSearchAnalyzersRequest)

WithHuman makes statistical values human-readable.

func (IndicesReloadSearchAnalyzers) WithIgnoreUnavailable ¶ 

func (f IndicesReloadSearchAnalyzers) WithIgnoreUnavailable(v bool) func(*IndicesReloadSearchAnalyzersRequest)

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

func (IndicesReloadSearchAnalyzers) WithOpaqueID ¶ 

func (f IndicesReloadSearchAnalyzers) WithOpaqueID(s string) func(*IndicesReloadSearchAnalyzersRequest)

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

func (IndicesReloadSearchAnalyzers) WithPretty ¶ 

func (f IndicesReloadSearchAnalyzers) WithPretty() func(*IndicesReloadSearchAnalyzersRequest)

WithPretty makes the response body pretty-printed.

func (IndicesReloadSearchAnalyzers) WithResource ¶ added in v8.10.0 

func (f IndicesReloadSearchAnalyzers) WithResource(v string) func(*IndicesReloadSearchAnalyzersRequest)

WithResource - changed resource to reload analyzers from if applicable.

type IndicesReloadSearchAnalyzersRequest ¶ 

type IndicesReloadSearchAnalyzersRequest struct {
	Index []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *bool
	Resource          string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesReloadSearchAnalyzersRequest configures the Indices Reload Search Analyzers API request.

func (IndicesReloadSearchAnalyzersRequest) Do ¶ 

func (r IndicesReloadSearchAnalyzersRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesResolveCluster ¶ added in v8.13.0 

type IndicesResolveCluster func(o ...func(*IndicesResolveClusterRequest)) (*Response, error)

IndicesResolveCluster resolves the specified index expressions to return information about each cluster. If no index expression is provided, this endpoint will return information about all the remote clusters that are configured on the local cluster.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-cluster-api.html.

func (IndicesResolveCluster) WithAllowNoIndices ¶ added in v8.13.0 

func (f IndicesResolveCluster) WithAllowNoIndices(v bool) func(*IndicesResolveClusterRequest)

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). only allowed when providing an index expression..

func (IndicesResolveCluster) WithContext ¶ added in v8.13.0 

func (f IndicesResolveCluster) WithContext(v context.Context) func(*IndicesResolveClusterRequest)

WithContext sets the request context.

func (IndicesResolveCluster) WithErrorTrace ¶ added in v8.13.0 

func (f IndicesResolveCluster) WithErrorTrace() func(*IndicesResolveClusterRequest)

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

func (IndicesResolveCluster) WithExpandWildcards ¶ added in v8.13.0 

func (f IndicesResolveCluster) WithExpandWildcards(v string) func(*IndicesResolveClusterRequest)

WithExpandWildcards - whether wildcard expressions should get expanded to open or closed indices (default: open). only allowed when providing an index expression..

func (IndicesResolveCluster) WithFilterPath ¶ added in v8.13.0 

func (f IndicesResolveCluster) WithFilterPath(v ...string) func(*IndicesResolveClusterRequest)

WithFilterPath filters the properties of the response body.

func (IndicesResolveCluster) WithHeader ¶ added in v8.13.0 

func (f IndicesResolveCluster) WithHeader(h map[string]string) func(*IndicesResolveClusterRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesResolveCluster) WithHuman ¶ added in v8.13.0 

func (f IndicesResolveCluster) WithHuman() func(*IndicesResolveClusterRequest)

WithHuman makes statistical values human-readable.

func (IndicesResolveCluster) WithIgnoreThrottled ¶ added in v8.13.0 

func (f IndicesResolveCluster) WithIgnoreThrottled(v bool) func(*IndicesResolveClusterRequest)

WithIgnoreThrottled - whether specified concrete, expanded or aliased indices should be ignored when throttled. only allowed when providing an index expression..

func (IndicesResolveCluster) WithIgnoreUnavailable ¶ added in v8.13.0 

func (f IndicesResolveCluster) WithIgnoreUnavailable(v bool) func(*IndicesResolveClusterRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed). only allowed when providing an index expression..

func (IndicesResolveCluster) WithName ¶ added in v8.18.0 

func (f IndicesResolveCluster) WithName(v ...string) func(*IndicesResolveClusterRequest)

WithName - a list of cluster:index names or wildcard expressions.

func (IndicesResolveCluster) WithOpaqueID ¶ added in v8.13.0 

func (f IndicesResolveCluster) WithOpaqueID(s string) func(*IndicesResolveClusterRequest)

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

func (IndicesResolveCluster) WithPretty ¶ added in v8.13.0 

func (f IndicesResolveCluster) WithPretty() func(*IndicesResolveClusterRequest)

WithPretty makes the response body pretty-printed.

func (IndicesResolveCluster) WithTimeout ¶ added in v8.18.0 

func (f IndicesResolveCluster) WithTimeout(v time.Duration) func(*IndicesResolveClusterRequest)

WithTimeout - the maximum time to wait for remote clusters to respond.

type IndicesResolveClusterRequest ¶ added in v8.13.0 

type IndicesResolveClusterRequest struct {
	Name []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreThrottled   *bool
	IgnoreUnavailable *bool
	Timeout           time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesResolveClusterRequest configures the Indices Resolve Cluster API request.

func (IndicesResolveClusterRequest) Do ¶ added in v8.13.0 

func (r IndicesResolveClusterRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesResolveIndex ¶ 

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) WithAllowNoIndices ¶ added in v8.16.0 

func (f IndicesResolveIndex) WithAllowNoIndices(v bool) func(*IndicesResolveIndexRequest)

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

func (f IndicesResolveIndex) WithContext(v context.Context) func(*IndicesResolveIndexRequest)

WithContext sets the request context.

func (IndicesResolveIndex) WithErrorTrace ¶ 

func (f IndicesResolveIndex) WithErrorTrace() func(*IndicesResolveIndexRequest)

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

func (IndicesResolveIndex) WithExpandWildcards ¶ 

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 ¶ 

func (f IndicesResolveIndex) WithFilterPath(v ...string) func(*IndicesResolveIndexRequest)

WithFilterPath filters the properties of the response body.

func (IndicesResolveIndex) WithHeader ¶ 

func (f IndicesResolveIndex) WithHeader(h map[string]string) func(*IndicesResolveIndexRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesResolveIndex) WithHuman ¶ 

func (f IndicesResolveIndex) WithHuman() func(*IndicesResolveIndexRequest)

WithHuman makes statistical values human-readable.

func (IndicesResolveIndex) WithIgnoreUnavailable ¶ added in v8.16.0 

func (f IndicesResolveIndex) WithIgnoreUnavailable(v bool) func(*IndicesResolveIndexRequest)

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

func (IndicesResolveIndex) WithOpaqueID ¶ 

func (f IndicesResolveIndex) WithOpaqueID(s string) func(*IndicesResolveIndexRequest)

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

func (IndicesResolveIndex) WithPretty ¶ 

func (f IndicesResolveIndex) WithPretty() func(*IndicesResolveIndexRequest)

WithPretty makes the response body pretty-printed.

type IndicesResolveIndexRequest ¶ 

type IndicesResolveIndexRequest struct {
	Name []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesResolveIndexRequest configures the Indices Resolve Index API request.

func (IndicesResolveIndexRequest) Do ¶ 

func (r IndicesResolveIndexRequest) Do(providedCtx 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 ¶ 

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) WithLazy ¶ added in v8.13.0 

func (f IndicesRollover) WithLazy(v bool) func(*IndicesRolloverRequest)

WithLazy - if set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. only allowed on data streams..

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 ¶ 

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
	Lazy                *bool
	MasterTimeout       time.Duration
	Timeout             time.Duration
	WaitForActiveShards string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesRolloverRequest configures the Indices Rollover API request.

func (IndicesRolloverRequest) Do ¶ 

func (r IndicesRolloverRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesSegmentsRequest configures the Indices Segments API request.

func (IndicesSegmentsRequest) Do ¶ 

func (r IndicesSegmentsRequest) Do(providedCtx 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 ¶ 

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 ¶ 

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

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesShardStoresRequest configures the Indices Shard Stores API request.

func (IndicesShardStoresRequest) Do ¶ 

func (r IndicesShardStoresRequest) Do(providedCtx 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) 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 ¶ 

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 ¶ 

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

	MasterTimeout       time.Duration
	Timeout             time.Duration
	WaitForActiveShards string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesShrinkRequest configures the Indices Shrink API request.

func (IndicesShrinkRequest) Do ¶ 

func (r IndicesShrinkRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesSimulateIndexTemplate ¶ 

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-simulate-index.html.

func (IndicesSimulateIndexTemplate) WithBody ¶ 

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 ¶ 

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 ¶ 

func (f IndicesSimulateIndexTemplate) WithContext(v context.Context) func(*IndicesSimulateIndexTemplateRequest)

WithContext sets the request context.

func (IndicesSimulateIndexTemplate) WithCreate ¶ 

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 ¶ 

func (f IndicesSimulateIndexTemplate) WithErrorTrace() func(*IndicesSimulateIndexTemplateRequest)

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

func (IndicesSimulateIndexTemplate) WithFilterPath ¶ 

func (f IndicesSimulateIndexTemplate) WithFilterPath(v ...string) func(*IndicesSimulateIndexTemplateRequest)

WithFilterPath filters the properties of the response body.

func (IndicesSimulateIndexTemplate) WithHeader ¶ 

func (f IndicesSimulateIndexTemplate) WithHeader(h map[string]string) func(*IndicesSimulateIndexTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesSimulateIndexTemplate) WithHuman ¶ 

func (f IndicesSimulateIndexTemplate) WithHuman() func(*IndicesSimulateIndexTemplateRequest)

WithHuman makes statistical values human-readable.

func (IndicesSimulateIndexTemplate) WithIncludeDefaults ¶ added in v8.8.0 

func (f IndicesSimulateIndexTemplate) WithIncludeDefaults(v bool) func(*IndicesSimulateIndexTemplateRequest)

WithIncludeDefaults - return all relevant default configurations for this index template simulation (default: false).

func (IndicesSimulateIndexTemplate) WithMasterTimeout ¶ 

func (f IndicesSimulateIndexTemplate) WithMasterTimeout(v time.Duration) func(*IndicesSimulateIndexTemplateRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesSimulateIndexTemplate) WithOpaqueID ¶ 

func (f IndicesSimulateIndexTemplate) WithOpaqueID(s string) func(*IndicesSimulateIndexTemplateRequest)

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

func (IndicesSimulateIndexTemplate) WithPretty ¶ 

func (f IndicesSimulateIndexTemplate) WithPretty() func(*IndicesSimulateIndexTemplateRequest)

WithPretty makes the response body pretty-printed.

type IndicesSimulateIndexTemplateRequest ¶ 

type IndicesSimulateIndexTemplateRequest struct {
	Body io.Reader

	Name string

	Cause           string
	Create          *bool
	IncludeDefaults *bool
	MasterTimeout   time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesSimulateIndexTemplateRequest configures the Indices Simulate Index Template API request.

func (IndicesSimulateIndexTemplateRequest) Do ¶ 

func (r IndicesSimulateIndexTemplateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesSimulateTemplate ¶ 

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-simulate-template.html.

func (IndicesSimulateTemplate) WithBody ¶ 

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 ¶ 

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 ¶ 

func (f IndicesSimulateTemplate) WithContext(v context.Context) func(*IndicesSimulateTemplateRequest)

WithContext sets the request context.

func (IndicesSimulateTemplate) WithCreate ¶ 

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 ¶ 

func (f IndicesSimulateTemplate) WithErrorTrace() func(*IndicesSimulateTemplateRequest)

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

func (IndicesSimulateTemplate) WithFilterPath ¶ 

func (f IndicesSimulateTemplate) WithFilterPath(v ...string) func(*IndicesSimulateTemplateRequest)

WithFilterPath filters the properties of the response body.

func (IndicesSimulateTemplate) WithHeader ¶ 

func (f IndicesSimulateTemplate) WithHeader(h map[string]string) func(*IndicesSimulateTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesSimulateTemplate) WithHuman ¶ 

func (f IndicesSimulateTemplate) WithHuman() func(*IndicesSimulateTemplateRequest)

WithHuman makes statistical values human-readable.

func (IndicesSimulateTemplate) WithIncludeDefaults ¶ added in v8.8.0 

func (f IndicesSimulateTemplate) WithIncludeDefaults(v bool) func(*IndicesSimulateTemplateRequest)

WithIncludeDefaults - return all relevant default configurations for this template simulation (default: false).

func (IndicesSimulateTemplate) WithMasterTimeout ¶ 

func (f IndicesSimulateTemplate) WithMasterTimeout(v time.Duration) func(*IndicesSimulateTemplateRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesSimulateTemplate) WithName ¶ 

func (f IndicesSimulateTemplate) WithName(v string) func(*IndicesSimulateTemplateRequest)

WithName - the name of the index template.

func (IndicesSimulateTemplate) WithOpaqueID ¶ 

func (f IndicesSimulateTemplate) WithOpaqueID(s string) func(*IndicesSimulateTemplateRequest)

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

func (IndicesSimulateTemplate) WithPretty ¶ 

func (f IndicesSimulateTemplate) WithPretty() func(*IndicesSimulateTemplateRequest)

WithPretty makes the response body pretty-printed.

type IndicesSimulateTemplateRequest ¶ 

type IndicesSimulateTemplateRequest struct {
	Body io.Reader

	Name string

	Cause           string
	Create          *bool
	IncludeDefaults *bool
	MasterTimeout   time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesSimulateTemplateRequest configures the Indices Simulate Template API request.

func (IndicesSimulateTemplateRequest) Do ¶ 

func (r IndicesSimulateTemplateRequest) Do(providedCtx 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 ¶ 

func (f IndicesSplit) WithBody(v io.Reader) func(*IndicesSplitRequest)

WithBody - The configuration for the target index (`settings` and `aliases`).

func (IndicesSplit) WithContext ¶ 

func (f IndicesSplit) WithContext(v context.Context) func(*IndicesSplitRequest)

WithContext sets the request context.

func (IndicesSplit) WithErrorTrace ¶ 

func (f IndicesSplit) WithErrorTrace() func(*IndicesSplitRequest)

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

func (IndicesSplit) WithFilterPath ¶ 

func (f IndicesSplit) WithFilterPath(v ...string) func(*IndicesSplitRequest)

WithFilterPath filters the properties of the response body.

func (IndicesSplit) WithHeader ¶ 

func (f IndicesSplit) WithHeader(h map[string]string) func(*IndicesSplitRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesSplit) WithHuman ¶ 

func (f IndicesSplit) WithHuman() func(*IndicesSplitRequest)

WithHuman makes statistical values human-readable.

func (IndicesSplit) WithMasterTimeout ¶ 

func (f IndicesSplit) WithMasterTimeout(v time.Duration) func(*IndicesSplitRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesSplit) WithOpaqueID ¶ 

func (f IndicesSplit) WithOpaqueID(s string) func(*IndicesSplitRequest)

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

func (IndicesSplit) WithPretty ¶ 

func (f IndicesSplit) WithPretty() func(*IndicesSplitRequest)

WithPretty makes the response body pretty-printed.

func (IndicesSplit) WithTimeout ¶ 

func (f IndicesSplit) WithTimeout(v time.Duration) func(*IndicesSplitRequest)

WithTimeout - explicit operation timeout.

func (IndicesSplit) WithWaitForActiveShards ¶ 

func (f IndicesSplit) WithWaitForActiveShards(v string) func(*IndicesSplitRequest)

WithWaitForActiveShards - set the number of active shards to wait for on the shrunken index before the operation returns..

type IndicesSplitRequest ¶ 

type IndicesSplitRequest struct {
	Index string

	Body io.Reader

	Target string

	MasterTimeout       time.Duration
	Timeout             time.Duration
	WaitForActiveShards string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesSplitRequest configures the Indices Split API request.

func (IndicesSplitRequest) Do ¶ 

func (r IndicesSplitRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesStats ¶ 

type IndicesStats func(o ...func(*IndicesStatsRequest)) (*Response, error)

IndicesStats provides statistics on operations happening in an index.

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

func (IndicesStats) WithCompletionFields ¶ 

func (f IndicesStats) WithCompletionFields(v ...string) func(*IndicesStatsRequest)

WithCompletionFields - a list of fields for the `completion` index metric (supports wildcards).

func (IndicesStats) WithContext ¶ 

func (f IndicesStats) WithContext(v context.Context) func(*IndicesStatsRequest)

WithContext sets the request context.

func (IndicesStats) WithErrorTrace ¶ 

func (f IndicesStats) WithErrorTrace() func(*IndicesStatsRequest)

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

func (IndicesStats) WithExpandWildcards ¶ 

func (f IndicesStats) WithExpandWildcards(v string) func(*IndicesStatsRequest)

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

func (IndicesStats) WithFielddataFields ¶ 

func (f IndicesStats) WithFielddataFields(v ...string) func(*IndicesStatsRequest)

WithFielddataFields - a list of fields for the `fielddata` index metric (supports wildcards).

func (IndicesStats) WithFields ¶ 

func (f IndicesStats) WithFields(v ...string) func(*IndicesStatsRequest)

WithFields - a list of fields for `fielddata` and `completion` index metric (supports wildcards).

func (IndicesStats) WithFilterPath ¶ 

func (f IndicesStats) WithFilterPath(v ...string) func(*IndicesStatsRequest)

WithFilterPath filters the properties of the response body.

func (IndicesStats) WithForbidClosedIndices ¶ 

func (f IndicesStats) WithForbidClosedIndices(v bool) func(*IndicesStatsRequest)

WithForbidClosedIndices - if set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices.

func (IndicesStats) WithGroups ¶ 

func (f IndicesStats) WithGroups(v ...string) func(*IndicesStatsRequest)

WithGroups - a list of search groups for `search` index metric.

func (IndicesStats) WithHeader ¶ 

func (f IndicesStats) WithHeader(h map[string]string) func(*IndicesStatsRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesStats) WithHuman ¶ 

func (f IndicesStats) WithHuman() func(*IndicesStatsRequest)

WithHuman makes statistical values human-readable.

func (IndicesStats) WithIncludeSegmentFileSizes ¶ 

func (f IndicesStats) WithIncludeSegmentFileSizes(v bool) func(*IndicesStatsRequest)

WithIncludeSegmentFileSizes - whether to report the aggregated disk usage of each one of the lucene index files (only applies if segment stats are requested).

func (IndicesStats) WithIncludeUnloadedSegments ¶ 

func (f IndicesStats) WithIncludeUnloadedSegments(v bool) func(*IndicesStatsRequest)

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

func (IndicesStats) WithIndex ¶ 

func (f IndicesStats) WithIndex(v ...string) func(*IndicesStatsRequest)

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

func (IndicesStats) WithLevel ¶ 

func (f IndicesStats) WithLevel(v string) func(*IndicesStatsRequest)

WithLevel - return stats aggregated at cluster, index or shard level.

func (IndicesStats) WithMetric ¶ 

func (f IndicesStats) WithMetric(v ...string) func(*IndicesStatsRequest)

WithMetric - limit the information returned the specific metrics..

func (IndicesStats) WithOpaqueID ¶ 

func (f IndicesStats) WithOpaqueID(s string) func(*IndicesStatsRequest)

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

func (IndicesStats) WithPretty ¶ 

func (f IndicesStats) WithPretty() func(*IndicesStatsRequest)

WithPretty makes the response body pretty-printed.

type IndicesStatsRequest ¶ 

type IndicesStatsRequest struct {
	Index []string

	Metric []string

	CompletionFields        []string
	ExpandWildcards         string
	FielddataFields         []string
	Fields                  []string
	ForbidClosedIndices     *bool
	Groups                  []string
	IncludeSegmentFileSizes *bool
	IncludeUnloadedSegments *bool
	Level                   string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesStatsRequest configures the Indices Stats API request.

func (IndicesStatsRequest) Do ¶ 

func (r IndicesStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesUnfreeze ¶ 

type IndicesUnfreeze func(index string, o ...func(*IndicesUnfreezeRequest)) (*Response, error)

IndicesUnfreeze - Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/unfreeze-index-api.html.

func (IndicesUnfreeze) WithAllowNoIndices ¶ 

func (f IndicesUnfreeze) WithAllowNoIndices(v bool) func(*IndicesUnfreezeRequest)

WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).

func (IndicesUnfreeze) WithContext ¶ 

func (f IndicesUnfreeze) WithContext(v context.Context) func(*IndicesUnfreezeRequest)

WithContext sets the request context.

func (IndicesUnfreeze) WithErrorTrace ¶ 

func (f IndicesUnfreeze) WithErrorTrace() func(*IndicesUnfreezeRequest)

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

func (IndicesUnfreeze) WithExpandWildcards ¶ 

func (f IndicesUnfreeze) WithExpandWildcards(v string) func(*IndicesUnfreezeRequest)

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

func (IndicesUnfreeze) WithFilterPath ¶ 

func (f IndicesUnfreeze) WithFilterPath(v ...string) func(*IndicesUnfreezeRequest)

WithFilterPath filters the properties of the response body.

func (IndicesUnfreeze) WithHeader ¶ 

func (f IndicesUnfreeze) WithHeader(h map[string]string) func(*IndicesUnfreezeRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesUnfreeze) WithHuman ¶ 

func (f IndicesUnfreeze) WithHuman() func(*IndicesUnfreezeRequest)

WithHuman makes statistical values human-readable.

func (IndicesUnfreeze) WithIgnoreUnavailable ¶ 

func (f IndicesUnfreeze) WithIgnoreUnavailable(v bool) func(*IndicesUnfreezeRequest)

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

func (IndicesUnfreeze) WithMasterTimeout ¶ 

func (f IndicesUnfreeze) WithMasterTimeout(v time.Duration) func(*IndicesUnfreezeRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesUnfreeze) WithOpaqueID ¶ 

func (f IndicesUnfreeze) WithOpaqueID(s string) func(*IndicesUnfreezeRequest)

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

func (IndicesUnfreeze) WithPretty ¶ 

func (f IndicesUnfreeze) WithPretty() func(*IndicesUnfreezeRequest)

WithPretty makes the response body pretty-printed.

func (IndicesUnfreeze) WithTimeout ¶ 

func (f IndicesUnfreeze) WithTimeout(v time.Duration) func(*IndicesUnfreezeRequest)

WithTimeout - explicit operation timeout.

func (IndicesUnfreeze) WithWaitForActiveShards ¶ 

func (f IndicesUnfreeze) WithWaitForActiveShards(v string) func(*IndicesUnfreezeRequest)

WithWaitForActiveShards - sets the number of active shards to wait for before the operation returns..

type IndicesUnfreezeRequest ¶ 

type IndicesUnfreezeRequest struct {
	Index string

	AllowNoIndices      *bool
	ExpandWildcards     string
	IgnoreUnavailable   *bool
	MasterTimeout       time.Duration
	Timeout             time.Duration
	WaitForActiveShards string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesUnfreezeRequest configures the Indices Unfreeze API request.

func (IndicesUnfreezeRequest) Do ¶ 

func (r IndicesUnfreezeRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesUpdateAliases ¶ 

type IndicesUpdateAliases func(body io.Reader, o ...func(*IndicesUpdateAliasesRequest)) (*Response, error)

IndicesUpdateAliases updates index aliases.

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

func (IndicesUpdateAliases) WithContext ¶ 

func (f IndicesUpdateAliases) WithContext(v context.Context) func(*IndicesUpdateAliasesRequest)

WithContext sets the request context.

func (IndicesUpdateAliases) WithErrorTrace ¶ 

func (f IndicesUpdateAliases) WithErrorTrace() func(*IndicesUpdateAliasesRequest)

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

func (IndicesUpdateAliases) WithFilterPath ¶ 

func (f IndicesUpdateAliases) WithFilterPath(v ...string) func(*IndicesUpdateAliasesRequest)

WithFilterPath filters the properties of the response body.

func (IndicesUpdateAliases) WithHeader ¶ 

func (f IndicesUpdateAliases) WithHeader(h map[string]string) func(*IndicesUpdateAliasesRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesUpdateAliases) WithHuman ¶ 

func (f IndicesUpdateAliases) WithHuman() func(*IndicesUpdateAliasesRequest)

WithHuman makes statistical values human-readable.

func (IndicesUpdateAliases) WithMasterTimeout ¶ 

func (f IndicesUpdateAliases) WithMasterTimeout(v time.Duration) func(*IndicesUpdateAliasesRequest)

WithMasterTimeout - specify timeout for connection to master.

func (IndicesUpdateAliases) WithOpaqueID ¶ 

func (f IndicesUpdateAliases) WithOpaqueID(s string) func(*IndicesUpdateAliasesRequest)

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

func (IndicesUpdateAliases) WithPretty ¶ 

func (f IndicesUpdateAliases) WithPretty() func(*IndicesUpdateAliasesRequest)

WithPretty makes the response body pretty-printed.

func (IndicesUpdateAliases) WithTimeout ¶ 

func (f IndicesUpdateAliases) WithTimeout(v time.Duration) func(*IndicesUpdateAliasesRequest)

WithTimeout - request timeout.

type IndicesUpdateAliasesRequest ¶ 

type IndicesUpdateAliasesRequest struct {
	Body io.Reader

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesUpdateAliasesRequest configures the Indices Update Aliases API request.

func (IndicesUpdateAliasesRequest) Do ¶ 

func (r IndicesUpdateAliasesRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IndicesValidateQuery ¶ 

type IndicesValidateQuery func(o ...func(*IndicesValidateQueryRequest)) (*Response, error)

IndicesValidateQuery allows a user to validate a potentially expensive query without executing it.

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

func (IndicesValidateQuery) WithAllShards ¶ 

func (f IndicesValidateQuery) WithAllShards(v bool) func(*IndicesValidateQueryRequest)

WithAllShards - execute validation on all shards instead of one random shard per index.

func (IndicesValidateQuery) WithAllowNoIndices ¶ 

func (f IndicesValidateQuery) WithAllowNoIndices(v bool) func(*IndicesValidateQueryRequest)

WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).

func (IndicesValidateQuery) WithAnalyzeWildcard ¶ 

func (f IndicesValidateQuery) WithAnalyzeWildcard(v bool) func(*IndicesValidateQueryRequest)

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

func (IndicesValidateQuery) WithAnalyzer ¶ 

func (f IndicesValidateQuery) WithAnalyzer(v string) func(*IndicesValidateQueryRequest)

WithAnalyzer - the analyzer to use for the query string.

func (IndicesValidateQuery) WithBody ¶ 

func (f IndicesValidateQuery) WithBody(v io.Reader) func(*IndicesValidateQueryRequest)

WithBody - The query definition specified with the Query DSL.

func (IndicesValidateQuery) WithContext ¶ 

func (f IndicesValidateQuery) WithContext(v context.Context) func(*IndicesValidateQueryRequest)

WithContext sets the request context.

func (IndicesValidateQuery) WithDefaultOperator ¶ 

func (f IndicesValidateQuery) WithDefaultOperator(v string) func(*IndicesValidateQueryRequest)

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

func (IndicesValidateQuery) WithDf ¶ 

func (f IndicesValidateQuery) WithDf(v string) func(*IndicesValidateQueryRequest)

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

func (IndicesValidateQuery) WithErrorTrace ¶ 

func (f IndicesValidateQuery) WithErrorTrace() func(*IndicesValidateQueryRequest)

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

func (IndicesValidateQuery) WithExpandWildcards ¶ 

func (f IndicesValidateQuery) WithExpandWildcards(v string) func(*IndicesValidateQueryRequest)

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

func (IndicesValidateQuery) WithExplain ¶ 

func (f IndicesValidateQuery) WithExplain(v bool) func(*IndicesValidateQueryRequest)

WithExplain - return detailed information about the error.

func (IndicesValidateQuery) WithFilterPath ¶ 

func (f IndicesValidateQuery) WithFilterPath(v ...string) func(*IndicesValidateQueryRequest)

WithFilterPath filters the properties of the response body.

func (IndicesValidateQuery) WithHeader ¶ 

func (f IndicesValidateQuery) WithHeader(h map[string]string) func(*IndicesValidateQueryRequest)

WithHeader adds the headers to the HTTP request.

func (IndicesValidateQuery) WithHuman ¶ 

func (f IndicesValidateQuery) WithHuman() func(*IndicesValidateQueryRequest)

WithHuman makes statistical values human-readable.

func (IndicesValidateQuery) WithIgnoreUnavailable ¶ 

func (f IndicesValidateQuery) WithIgnoreUnavailable(v bool) func(*IndicesValidateQueryRequest)

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

func (IndicesValidateQuery) WithIndex ¶ 

func (f IndicesValidateQuery) WithIndex(v ...string) func(*IndicesValidateQueryRequest)

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

func (IndicesValidateQuery) WithLenient ¶ 

func (f IndicesValidateQuery) WithLenient(v bool) func(*IndicesValidateQueryRequest)

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

func (IndicesValidateQuery) WithOpaqueID ¶ 

func (f IndicesValidateQuery) WithOpaqueID(s string) func(*IndicesValidateQueryRequest)

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

func (IndicesValidateQuery) WithPretty ¶ 

func (f IndicesValidateQuery) WithPretty() func(*IndicesValidateQueryRequest)

WithPretty makes the response body pretty-printed.

func (IndicesValidateQuery) WithQuery ¶ 

func (f IndicesValidateQuery) WithQuery(v string) func(*IndicesValidateQueryRequest)

WithQuery - query in the lucene query string syntax.

func (IndicesValidateQuery) WithRewrite ¶ 

func (f IndicesValidateQuery) WithRewrite(v bool) func(*IndicesValidateQueryRequest)

WithRewrite - provide a more detailed explanation showing the actual lucene query that will be executed..

type IndicesValidateQueryRequest ¶ 

type IndicesValidateQueryRequest struct {
	Index []string

	Body io.Reader

	AllowNoIndices    *bool
	AllShards         *bool
	Analyzer          string
	AnalyzeWildcard   *bool
	DefaultOperator   string
	Df                string
	ExpandWildcards   string
	Explain           *bool
	IgnoreUnavailable *bool
	Lenient           *bool
	Query             string
	Rewrite           *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IndicesValidateQueryRequest configures the Indices Validate Query API request.

func (IndicesValidateQueryRequest) Do ¶ 

func (r IndicesValidateQueryRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferenceChatCompletionUnified ¶ added in v8.18.0 

type InferenceChatCompletionUnified func(inference_id string, o ...func(*InferenceChatCompletionUnifiedRequest)) (*Response, error)

InferenceChatCompletionUnified perform chat completion inference

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/chat-completion-inference.html.

func (InferenceChatCompletionUnified) WithBody ¶ added in v8.18.0 

func (f InferenceChatCompletionUnified) WithBody(v io.Reader) func(*InferenceChatCompletionUnifiedRequest)

WithBody - The inference payload.

func (InferenceChatCompletionUnified) WithContext ¶ added in v8.18.0 

func (f InferenceChatCompletionUnified) WithContext(v context.Context) func(*InferenceChatCompletionUnifiedRequest)

WithContext sets the request context.

func (InferenceChatCompletionUnified) WithErrorTrace ¶ added in v8.18.0 

func (f InferenceChatCompletionUnified) WithErrorTrace() func(*InferenceChatCompletionUnifiedRequest)

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

func (InferenceChatCompletionUnified) WithFilterPath ¶ added in v8.18.0 

func (f InferenceChatCompletionUnified) WithFilterPath(v ...string) func(*InferenceChatCompletionUnifiedRequest)

WithFilterPath filters the properties of the response body.

func (InferenceChatCompletionUnified) WithHeader ¶ added in v8.18.0 

func (f InferenceChatCompletionUnified) WithHeader(h map[string]string) func(*InferenceChatCompletionUnifiedRequest)

WithHeader adds the headers to the HTTP request.

func (InferenceChatCompletionUnified) WithHuman ¶ added in v8.18.0 

func (f InferenceChatCompletionUnified) WithHuman() func(*InferenceChatCompletionUnifiedRequest)

WithHuman makes statistical values human-readable.

func (InferenceChatCompletionUnified) WithOpaqueID ¶ added in v8.18.0 

func (f InferenceChatCompletionUnified) WithOpaqueID(s string) func(*InferenceChatCompletionUnifiedRequest)

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

func (InferenceChatCompletionUnified) WithPretty ¶ added in v8.18.0 

func (f InferenceChatCompletionUnified) WithPretty() func(*InferenceChatCompletionUnifiedRequest)

WithPretty makes the response body pretty-printed.

type InferenceChatCompletionUnifiedRequest ¶ added in v8.18.0 

type InferenceChatCompletionUnifiedRequest struct {
	Body io.Reader

	InferenceID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferenceChatCompletionUnifiedRequest configures the Inference Chat Completion Unified API request.

func (InferenceChatCompletionUnifiedRequest) Do ¶ added in v8.18.0 

func (r InferenceChatCompletionUnifiedRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferenceCompletion ¶ added in v8.18.0 

type InferenceCompletion func(inference_id string, o ...func(*InferenceCompletionRequest)) (*Response, error)

InferenceCompletion perform completion inference

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html.

func (InferenceCompletion) WithBody ¶ added in v8.18.0 

func (f InferenceCompletion) WithBody(v io.Reader) func(*InferenceCompletionRequest)

WithBody - The inference payload.

func (InferenceCompletion) WithContext ¶ added in v8.18.0 

func (f InferenceCompletion) WithContext(v context.Context) func(*InferenceCompletionRequest)

WithContext sets the request context.

func (InferenceCompletion) WithErrorTrace ¶ added in v8.18.0 

func (f InferenceCompletion) WithErrorTrace() func(*InferenceCompletionRequest)

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

func (InferenceCompletion) WithFilterPath ¶ added in v8.18.0 

func (f InferenceCompletion) WithFilterPath(v ...string) func(*InferenceCompletionRequest)

WithFilterPath filters the properties of the response body.

func (InferenceCompletion) WithHeader ¶ added in v8.18.0 

func (f InferenceCompletion) WithHeader(h map[string]string) func(*InferenceCompletionRequest)

WithHeader adds the headers to the HTTP request.

func (InferenceCompletion) WithHuman ¶ added in v8.18.0 

func (f InferenceCompletion) WithHuman() func(*InferenceCompletionRequest)

WithHuman makes statistical values human-readable.

func (InferenceCompletion) WithOpaqueID ¶ added in v8.18.0 

func (f InferenceCompletion) WithOpaqueID(s string) func(*InferenceCompletionRequest)

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

func (InferenceCompletion) WithPretty ¶ added in v8.18.0 

func (f InferenceCompletion) WithPretty() func(*InferenceCompletionRequest)

WithPretty makes the response body pretty-printed.

type InferenceCompletionRequest ¶ added in v8.18.0 

type InferenceCompletionRequest struct {
	Body io.Reader

	InferenceID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferenceCompletionRequest configures the Inference Completion API request.

func (InferenceCompletionRequest) Do ¶ added in v8.18.0 

func (r InferenceCompletionRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferenceDelete ¶ added in v8.15.0 

type InferenceDelete func(inference_id string, o ...func(*InferenceDeleteRequest)) (*Response, error)

InferenceDelete delete an inference endpoint

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html.

func (InferenceDelete) WithContext ¶ added in v8.15.0 

func (f InferenceDelete) WithContext(v context.Context) func(*InferenceDeleteRequest)

WithContext sets the request context.

func (InferenceDelete) WithDryRun ¶ added in v8.15.0 

func (f InferenceDelete) WithDryRun(v bool) func(*InferenceDeleteRequest)

WithDryRun - if true the endpoint will not be deleted and a list of ingest processors which reference this endpoint will be returned..

func (InferenceDelete) WithErrorTrace ¶ added in v8.15.0 

func (f InferenceDelete) WithErrorTrace() func(*InferenceDeleteRequest)

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

func (InferenceDelete) WithFilterPath ¶ added in v8.15.0 

func (f InferenceDelete) WithFilterPath(v ...string) func(*InferenceDeleteRequest)

WithFilterPath filters the properties of the response body.

func (InferenceDelete) WithForce ¶ added in v8.15.0 

func (f InferenceDelete) WithForce(v bool) func(*InferenceDeleteRequest)

WithForce - if true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields)..

func (InferenceDelete) WithHeader ¶ added in v8.15.0 

func (f InferenceDelete) WithHeader(h map[string]string) func(*InferenceDeleteRequest)

WithHeader adds the headers to the HTTP request.

func (InferenceDelete) WithHuman ¶ added in v8.15.0 

func (f InferenceDelete) WithHuman() func(*InferenceDeleteRequest)

WithHuman makes statistical values human-readable.

func (InferenceDelete) WithOpaqueID ¶ added in v8.15.0 

func (f InferenceDelete) WithOpaqueID(s string) func(*InferenceDeleteRequest)

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

func (InferenceDelete) WithPretty ¶ added in v8.15.0 

func (f InferenceDelete) WithPretty() func(*InferenceDeleteRequest)

WithPretty makes the response body pretty-printed.

func (InferenceDelete) WithTaskType ¶ added in v8.15.0 

func (f InferenceDelete) WithTaskType(v string) func(*InferenceDeleteRequest)

WithTaskType - the task type.

type InferenceDeleteRequest ¶ added in v8.15.0 

type InferenceDeleteRequest struct {
	InferenceID string
	TaskType    string

	DryRun *bool
	Force  *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferenceDeleteRequest configures the Inference Delete API request.

func (InferenceDeleteRequest) Do ¶ added in v8.15.0 

func (r InferenceDeleteRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferenceGet ¶ added in v8.15.0 

type InferenceGet func(o ...func(*InferenceGetRequest)) (*Response, error)

InferenceGet get an inference endpoint

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html.

func (InferenceGet) WithContext ¶ added in v8.15.0 

func (f InferenceGet) WithContext(v context.Context) func(*InferenceGetRequest)

WithContext sets the request context.

func (InferenceGet) WithErrorTrace ¶ added in v8.15.0 

func (f InferenceGet) WithErrorTrace() func(*InferenceGetRequest)

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

func (InferenceGet) WithFilterPath ¶ added in v8.15.0 

func (f InferenceGet) WithFilterPath(v ...string) func(*InferenceGetRequest)

WithFilterPath filters the properties of the response body.

func (InferenceGet) WithHeader ¶ added in v8.15.0 

func (f InferenceGet) WithHeader(h map[string]string) func(*InferenceGetRequest)

WithHeader adds the headers to the HTTP request.

func (InferenceGet) WithHuman ¶ added in v8.15.0 

func (f InferenceGet) WithHuman() func(*InferenceGetRequest)

WithHuman makes statistical values human-readable.

func (InferenceGet) WithInferenceID ¶ added in v8.15.0 

func (f InferenceGet) WithInferenceID(v string) func(*InferenceGetRequest)

WithInferenceID - the inference ID.

func (InferenceGet) WithOpaqueID ¶ added in v8.15.0 

func (f InferenceGet) WithOpaqueID(s string) func(*InferenceGetRequest)

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

func (InferenceGet) WithPretty ¶ added in v8.15.0 

func (f InferenceGet) WithPretty() func(*InferenceGetRequest)

WithPretty makes the response body pretty-printed.

func (InferenceGet) WithTaskType ¶ added in v8.15.0 

func (f InferenceGet) WithTaskType(v string) func(*InferenceGetRequest)

WithTaskType - the task type.

type InferenceGetRequest ¶ added in v8.15.0 

type InferenceGetRequest struct {
	InferenceID string
	TaskType    string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferenceGetRequest configures the Inference Get API request.

func (InferenceGetRequest) Do ¶ added in v8.15.0 

func (r InferenceGetRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferenceInference ¶ added in v8.11.0 

type InferenceInference func(inference_id string, o ...func(*InferenceInferenceRequest)) (*Response, error)

InferenceInference perform inference

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html.

func (InferenceInference) WithBody ¶ added in v8.11.0 

func (f InferenceInference) WithBody(v io.Reader) func(*InferenceInferenceRequest)

WithBody - The inference payload.

func (InferenceInference) WithContext ¶ added in v8.11.0 

func (f InferenceInference) WithContext(v context.Context) func(*InferenceInferenceRequest)

WithContext sets the request context.

func (InferenceInference) WithErrorTrace ¶ added in v8.11.0 

func (f InferenceInference) WithErrorTrace() func(*InferenceInferenceRequest)

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

func (InferenceInference) WithFilterPath ¶ added in v8.11.0 

func (f InferenceInference) WithFilterPath(v ...string) func(*InferenceInferenceRequest)

WithFilterPath filters the properties of the response body.

func (InferenceInference) WithHeader ¶ added in v8.11.0 

func (f InferenceInference) WithHeader(h map[string]string) func(*InferenceInferenceRequest)

WithHeader adds the headers to the HTTP request.

func (InferenceInference) WithHuman ¶ added in v8.11.0 

func (f InferenceInference) WithHuman() func(*InferenceInferenceRequest)

WithHuman makes statistical values human-readable.

func (InferenceInference) WithOpaqueID ¶ added in v8.11.0 

func (f InferenceInference) WithOpaqueID(s string) func(*InferenceInferenceRequest)

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

func (InferenceInference) WithPretty ¶ added in v8.11.0 

func (f InferenceInference) WithPretty() func(*InferenceInferenceRequest)

WithPretty makes the response body pretty-printed.

func (InferenceInference) WithTaskType ¶ added in v8.13.0 

func (f InferenceInference) WithTaskType(v string) func(*InferenceInferenceRequest)

WithTaskType - the task type.

type InferenceInferenceRequest ¶ added in v8.11.0 

type InferenceInferenceRequest struct {
	Body io.Reader

	InferenceID string
	TaskType    string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferenceInferenceRequest configures the Inference Inference API request.

func (InferenceInferenceRequest) Do ¶ added in v8.11.0 

func (r InferenceInferenceRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferencePut ¶ added in v8.15.0 

type InferencePut func(inference_id string, o ...func(*InferencePutRequest)) (*Response, error)

InferencePut configure an inference endpoint for use in the Inference API

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html.

func (InferencePut) WithBody ¶ added in v8.15.0 

func (f InferencePut) WithBody(v io.Reader) func(*InferencePutRequest)

WithBody - The inference endpoint's task and service settings.

func (InferencePut) WithContext ¶ added in v8.15.0 

func (f InferencePut) WithContext(v context.Context) func(*InferencePutRequest)

WithContext sets the request context.

func (InferencePut) WithErrorTrace ¶ added in v8.15.0 

func (f InferencePut) WithErrorTrace() func(*InferencePutRequest)

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

func (InferencePut) WithFilterPath ¶ added in v8.15.0 

func (f InferencePut) WithFilterPath(v ...string) func(*InferencePutRequest)

WithFilterPath filters the properties of the response body.

func (InferencePut) WithHeader ¶ added in v8.15.0 

func (f InferencePut) WithHeader(h map[string]string) func(*InferencePutRequest)

WithHeader adds the headers to the HTTP request.

func (InferencePut) WithHuman ¶ added in v8.15.0 

func (f InferencePut) WithHuman() func(*InferencePutRequest)

WithHuman makes statistical values human-readable.

func (InferencePut) WithOpaqueID ¶ added in v8.15.0 

func (f InferencePut) WithOpaqueID(s string) func(*InferencePutRequest)

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

func (InferencePut) WithPretty ¶ added in v8.15.0 

func (f InferencePut) WithPretty() func(*InferencePutRequest)

WithPretty makes the response body pretty-printed.

func (InferencePut) WithTaskType ¶ added in v8.15.0 

func (f InferencePut) WithTaskType(v string) func(*InferencePutRequest)

WithTaskType - the task type.

type InferencePutAlibabacloud ¶ added in v8.18.0 

type InferencePutAlibabacloud func(alibabacloud_inference_id string, task_type string, o ...func(*InferencePutAlibabacloudRequest)) (*Response, error)

InferencePutAlibabacloud configure an AlibabaCloud AI Search inference endpoint

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-alibabacloud-ai-search.html.

func (InferencePutAlibabacloud) WithBody ¶ added in v8.18.0 

func (f InferencePutAlibabacloud) WithBody(v io.Reader) func(*InferencePutAlibabacloudRequest)

WithBody - The inference endpoint's task and service settings.

func (InferencePutAlibabacloud) WithContext ¶ added in v8.18.0 

func (f InferencePutAlibabacloud) WithContext(v context.Context) func(*InferencePutAlibabacloudRequest)

WithContext sets the request context.

func (InferencePutAlibabacloud) WithErrorTrace ¶ added in v8.18.0 

func (f InferencePutAlibabacloud) WithErrorTrace() func(*InferencePutAlibabacloudRequest)

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

func (InferencePutAlibabacloud) WithFilterPath ¶ added in v8.18.0 

func (f InferencePutAlibabacloud) WithFilterPath(v ...string) func(*InferencePutAlibabacloudRequest)

WithFilterPath filters the properties of the response body.

func (InferencePutAlibabacloud) WithHeader ¶ added in v8.18.0 

func (f InferencePutAlibabacloud) WithHeader(h map[string]string) func(*InferencePutAlibabacloudRequest)

WithHeader adds the headers to the HTTP request.

func (InferencePutAlibabacloud) WithHuman ¶ added in v8.18.0 

func (f InferencePutAlibabacloud) WithHuman() func(*InferencePutAlibabacloudRequest)

WithHuman makes statistical values human-readable.

func (InferencePutAlibabacloud) WithOpaqueID ¶ added in v8.18.0 

func (f InferencePutAlibabacloud) WithOpaqueID(s string) func(*InferencePutAlibabacloudRequest)

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

func (InferencePutAlibabacloud) WithPretty ¶ added in v8.18.0 

func (f InferencePutAlibabacloud) WithPretty() func(*InferencePutAlibabacloudRequest)

WithPretty makes the response body pretty-printed.

type InferencePutAlibabacloudRequest ¶ added in v8.18.0 

type InferencePutAlibabacloudRequest struct {
	Body io.Reader

	AlibabacloudInferenceID string
	TaskType                string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferencePutAlibabacloudRequest configures the Inference Put Alibabacloud API request.

func (InferencePutAlibabacloudRequest) Do ¶ added in v8.18.0 

func (r InferencePutAlibabacloudRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferencePutAmazonbedrock ¶ added in v8.18.0 

type InferencePutAmazonbedrock func(amazonbedrock_inference_id string, task_type string, o ...func(*InferencePutAmazonbedrockRequest)) (*Response, error)

InferencePutAmazonbedrock configure an Amazon Bedrock inference endpoint

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-amazon-bedrock.html.

func (InferencePutAmazonbedrock) WithBody ¶ added in v8.18.0 

func (f InferencePutAmazonbedrock) WithBody(v io.Reader) func(*InferencePutAmazonbedrockRequest)

WithBody - The inference endpoint's task and service settings.

func (InferencePutAmazonbedrock) WithContext ¶ added in v8.18.0 

func (f InferencePutAmazonbedrock) WithContext(v context.Context) func(*InferencePutAmazonbedrockRequest)

WithContext sets the request context.

func (InferencePutAmazonbedrock) WithErrorTrace ¶ added in v8.18.0 

func (f InferencePutAmazonbedrock) WithErrorTrace() func(*InferencePutAmazonbedrockRequest)

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

func (InferencePutAmazonbedrock) WithFilterPath ¶ added in v8.18.0 

func (f InferencePutAmazonbedrock) WithFilterPath(v ...string) func(*InferencePutAmazonbedrockRequest)

WithFilterPath filters the properties of the response body.

func (InferencePutAmazonbedrock) WithHeader ¶ added in v8.18.0 

func (f InferencePutAmazonbedrock) WithHeader(h map[string]string) func(*InferencePutAmazonbedrockRequest)

WithHeader adds the headers to the HTTP request.

func (InferencePutAmazonbedrock) WithHuman ¶ added in v8.18.0 

func (f InferencePutAmazonbedrock) WithHuman() func(*InferencePutAmazonbedrockRequest)

WithHuman makes statistical values human-readable.

func (InferencePutAmazonbedrock) WithOpaqueID ¶ added in v8.18.0 

func (f InferencePutAmazonbedrock) WithOpaqueID(s string) func(*InferencePutAmazonbedrockRequest)

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

func (InferencePutAmazonbedrock) WithPretty ¶ added in v8.18.0 

func (f InferencePutAmazonbedrock) WithPretty() func(*InferencePutAmazonbedrockRequest)

WithPretty makes the response body pretty-printed.

type InferencePutAmazonbedrockRequest ¶ added in v8.18.0 

type InferencePutAmazonbedrockRequest struct {
	Body io.Reader

	AmazonbedrockInferenceID string
	TaskType                 string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferencePutAmazonbedrockRequest configures the Inference Put Amazonbedrock API request.

func (InferencePutAmazonbedrockRequest) Do ¶ added in v8.18.0 

func (r InferencePutAmazonbedrockRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferencePutAnthropic ¶ added in v8.18.0 

type InferencePutAnthropic func(anthropic_inference_id string, task_type string, o ...func(*InferencePutAnthropicRequest)) (*Response, error)

InferencePutAnthropic configure an Anthropic inference endpoint

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-anthropic.html.

func (InferencePutAnthropic) WithBody ¶ added in v8.18.0 

func (f InferencePutAnthropic) WithBody(v io.Reader) func(*InferencePutAnthropicRequest)

WithBody - The inference endpoint's task and service settings.

func (InferencePutAnthropic) WithContext ¶ added in v8.18.0 

func (f InferencePutAnthropic) WithContext(v context.Context) func(*InferencePutAnthropicRequest)

WithContext sets the request context.

func (InferencePutAnthropic) WithErrorTrace ¶ added in v8.18.0 

func (f InferencePutAnthropic) WithErrorTrace() func(*InferencePutAnthropicRequest)

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

func (InferencePutAnthropic) WithFilterPath ¶ added in v8.18.0 

func (f InferencePutAnthropic) WithFilterPath(v ...string) func(*InferencePutAnthropicRequest)

WithFilterPath filters the properties of the response body.

func (InferencePutAnthropic) WithHeader ¶ added in v8.18.0 

func (f InferencePutAnthropic) WithHeader(h map[string]string) func(*InferencePutAnthropicRequest)

WithHeader adds the headers to the HTTP request.

func (InferencePutAnthropic) WithHuman ¶ added in v8.18.0 

func (f InferencePutAnthropic) WithHuman() func(*InferencePutAnthropicRequest)

WithHuman makes statistical values human-readable.

func (InferencePutAnthropic) WithOpaqueID ¶ added in v8.18.0 

func (f InferencePutAnthropic) WithOpaqueID(s string) func(*InferencePutAnthropicRequest)

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

func (InferencePutAnthropic) WithPretty ¶ added in v8.18.0 

func (f InferencePutAnthropic) WithPretty() func(*InferencePutAnthropicRequest)

WithPretty makes the response body pretty-printed.

type InferencePutAnthropicRequest ¶ added in v8.18.0 

type InferencePutAnthropicRequest struct {
	Body io.Reader

	AnthropicInferenceID string
	TaskType             string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferencePutAnthropicRequest configures the Inference Put Anthropic API request.

func (InferencePutAnthropicRequest) Do ¶ added in v8.18.0 

func (r InferencePutAnthropicRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferencePutAzureaistudio ¶ added in v8.18.0 

type InferencePutAzureaistudio func(azureaistudio_inference_id string, task_type string, o ...func(*InferencePutAzureaistudioRequest)) (*Response, error)

InferencePutAzureaistudio configure an Azure AI Studio inference endpoint

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-azure-ai-studio.html.

func (InferencePutAzureaistudio) WithBody ¶ added in v8.18.0 

func (f InferencePutAzureaistudio) WithBody(v io.Reader) func(*InferencePutAzureaistudioRequest)

WithBody - The inference endpoint's task and service settings.

func (InferencePutAzureaistudio) WithContext ¶ added in v8.18.0 

func (f InferencePutAzureaistudio) WithContext(v context.Context) func(*InferencePutAzureaistudioRequest)

WithContext sets the request context.

func (InferencePutAzureaistudio) WithErrorTrace ¶ added in v8.18.0 

func (f InferencePutAzureaistudio) WithErrorTrace() func(*InferencePutAzureaistudioRequest)

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

func (InferencePutAzureaistudio) WithFilterPath ¶ added in v8.18.0 

func (f InferencePutAzureaistudio) WithFilterPath(v ...string) func(*InferencePutAzureaistudioRequest)

WithFilterPath filters the properties of the response body.

func (InferencePutAzureaistudio) WithHeader ¶ added in v8.18.0 

func (f InferencePutAzureaistudio) WithHeader(h map[string]string) func(*InferencePutAzureaistudioRequest)

WithHeader adds the headers to the HTTP request.

func (InferencePutAzureaistudio) WithHuman ¶ added in v8.18.0 

func (f InferencePutAzureaistudio) WithHuman() func(*InferencePutAzureaistudioRequest)

WithHuman makes statistical values human-readable.

func (InferencePutAzureaistudio) WithOpaqueID ¶ added in v8.18.0 

func (f InferencePutAzureaistudio) WithOpaqueID(s string) func(*InferencePutAzureaistudioRequest)

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

func (InferencePutAzureaistudio) WithPretty ¶ added in v8.18.0 

func (f InferencePutAzureaistudio) WithPretty() func(*InferencePutAzureaistudioRequest)

WithPretty makes the response body pretty-printed.

type InferencePutAzureaistudioRequest ¶ added in v8.18.0 

type InferencePutAzureaistudioRequest struct {
	Body io.Reader

	AzureaistudioInferenceID string
	TaskType                 string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferencePutAzureaistudioRequest configures the Inference Put Azureaistudio API request.

func (InferencePutAzureaistudioRequest) Do ¶ added in v8.18.0 

func (r InferencePutAzureaistudioRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferencePutAzureopenai ¶ added in v8.18.0 

type InferencePutAzureopenai func(azureopenai_inference_id string, task_type string, o ...func(*InferencePutAzureopenaiRequest)) (*Response, error)

InferencePutAzureopenai configure an Azure OpenAI inference endpoint

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-azure-openai.html.

func (InferencePutAzureopenai) WithBody ¶ added in v8.18.0 

func (f InferencePutAzureopenai) WithBody(v io.Reader) func(*InferencePutAzureopenaiRequest)

WithBody - The inference endpoint's task and service settings.

func (InferencePutAzureopenai) WithContext ¶ added in v8.18.0 

func (f InferencePutAzureopenai) WithContext(v context.Context) func(*InferencePutAzureopenaiRequest)

WithContext sets the request context.

func (InferencePutAzureopenai) WithErrorTrace ¶ added in v8.18.0 

func (f InferencePutAzureopenai) WithErrorTrace() func(*InferencePutAzureopenaiRequest)

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

func (InferencePutAzureopenai) WithFilterPath ¶ added in v8.18.0 

func (f InferencePutAzureopenai) WithFilterPath(v ...string) func(*InferencePutAzureopenaiRequest)

WithFilterPath filters the properties of the response body.

func (InferencePutAzureopenai) WithHeader ¶ added in v8.18.0 

func (f InferencePutAzureopenai) WithHeader(h map[string]string) func(*InferencePutAzureopenaiRequest)

WithHeader adds the headers to the HTTP request.

func (InferencePutAzureopenai) WithHuman ¶ added in v8.18.0 

func (f InferencePutAzureopenai) WithHuman() func(*InferencePutAzureopenaiRequest)

WithHuman makes statistical values human-readable.

func (InferencePutAzureopenai) WithOpaqueID ¶ added in v8.18.0 

func (f InferencePutAzureopenai) WithOpaqueID(s string) func(*InferencePutAzureopenaiRequest)

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

func (InferencePutAzureopenai) WithPretty ¶ added in v8.18.0 

func (f InferencePutAzureopenai) WithPretty() func(*InferencePutAzureopenaiRequest)

WithPretty makes the response body pretty-printed.

type InferencePutAzureopenaiRequest ¶ added in v8.18.0 

type InferencePutAzureopenaiRequest struct {
	Body io.Reader

	AzureopenaiInferenceID string
	TaskType               string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferencePutAzureopenaiRequest configures the Inference Put Azureopenai API request.

func (InferencePutAzureopenaiRequest) Do ¶ added in v8.18.0 

func (r InferencePutAzureopenaiRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferencePutCohere ¶ added in v8.18.0 

type InferencePutCohere func(cohere_inference_id string, task_type string, o ...func(*InferencePutCohereRequest)) (*Response, error)

InferencePutCohere configure a Cohere inference endpoint

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-cohere.html.

func (InferencePutCohere) WithBody ¶ added in v8.18.0 

func (f InferencePutCohere) WithBody(v io.Reader) func(*InferencePutCohereRequest)

WithBody - The inference endpoint's task and service settings.

func (InferencePutCohere) WithContext ¶ added in v8.18.0 

func (f InferencePutCohere) WithContext(v context.Context) func(*InferencePutCohereRequest)

WithContext sets the request context.

func (InferencePutCohere) WithErrorTrace ¶ added in v8.18.0 

func (f InferencePutCohere) WithErrorTrace() func(*InferencePutCohereRequest)

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

func (InferencePutCohere) WithFilterPath ¶ added in v8.18.0 

func (f InferencePutCohere) WithFilterPath(v ...string) func(*InferencePutCohereRequest)

WithFilterPath filters the properties of the response body.

func (InferencePutCohere) WithHeader ¶ added in v8.18.0 

func (f InferencePutCohere) WithHeader(h map[string]string) func(*InferencePutCohereRequest)

WithHeader adds the headers to the HTTP request.

func (InferencePutCohere) WithHuman ¶ added in v8.18.0 

func (f InferencePutCohere) WithHuman() func(*InferencePutCohereRequest)

WithHuman makes statistical values human-readable.

func (InferencePutCohere) WithOpaqueID ¶ added in v8.18.0 

func (f InferencePutCohere) WithOpaqueID(s string) func(*InferencePutCohereRequest)

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

func (InferencePutCohere) WithPretty ¶ added in v8.18.0 

func (f InferencePutCohere) WithPretty() func(*InferencePutCohereRequest)

WithPretty makes the response body pretty-printed.

type InferencePutCohereRequest ¶ added in v8.18.0 

type InferencePutCohereRequest struct {
	Body io.Reader

	CohereInferenceID string
	TaskType          string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferencePutCohereRequest configures the Inference Put Cohere API request.

func (InferencePutCohereRequest) Do ¶ added in v8.18.0 

func (r InferencePutCohereRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferencePutElasticsearch ¶ added in v8.18.0 

type InferencePutElasticsearch func(elasticsearch_inference_id string, task_type string, o ...func(*InferencePutElasticsearchRequest)) (*Response, error)

InferencePutElasticsearch configure an Elasticsearch inference endpoint

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

func (InferencePutElasticsearch) WithBody ¶ added in v8.18.0 

func (f InferencePutElasticsearch) WithBody(v io.Reader) func(*InferencePutElasticsearchRequest)

WithBody - The inference endpoint's task and service settings.

func (InferencePutElasticsearch) WithContext ¶ added in v8.18.0 

func (f InferencePutElasticsearch) WithContext(v context.Context) func(*InferencePutElasticsearchRequest)

WithContext sets the request context.

func (InferencePutElasticsearch) WithErrorTrace ¶ added in v8.18.0 

func (f InferencePutElasticsearch) WithErrorTrace() func(*InferencePutElasticsearchRequest)

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

func (InferencePutElasticsearch) WithFilterPath ¶ added in v8.18.0 

func (f InferencePutElasticsearch) WithFilterPath(v ...string) func(*InferencePutElasticsearchRequest)

WithFilterPath filters the properties of the response body.

func (InferencePutElasticsearch) WithHeader ¶ added in v8.18.0 

func (f InferencePutElasticsearch) WithHeader(h map[string]string) func(*InferencePutElasticsearchRequest)

WithHeader adds the headers to the HTTP request.

func (InferencePutElasticsearch) WithHuman ¶ added in v8.18.0 

func (f InferencePutElasticsearch) WithHuman() func(*InferencePutElasticsearchRequest)

WithHuman makes statistical values human-readable.

func (InferencePutElasticsearch) WithOpaqueID ¶ added in v8.18.0 

func (f InferencePutElasticsearch) WithOpaqueID(s string) func(*InferencePutElasticsearchRequest)

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

func (InferencePutElasticsearch) WithPretty ¶ added in v8.18.0 

func (f InferencePutElasticsearch) WithPretty() func(*InferencePutElasticsearchRequest)

WithPretty makes the response body pretty-printed.

type InferencePutElasticsearchRequest ¶ added in v8.18.0 

type InferencePutElasticsearchRequest struct {
	Body io.Reader

	ElasticsearchInferenceID string
	TaskType                 string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferencePutElasticsearchRequest configures the Inference Put Elasticsearch API request.

func (InferencePutElasticsearchRequest) Do ¶ added in v8.18.0 

func (r InferencePutElasticsearchRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferencePutElser ¶ added in v8.18.0 

type InferencePutElser func(elser_inference_id string, task_type string, o ...func(*InferencePutElserRequest)) (*Response, error)

InferencePutElser configure an ELSER inference endpoint

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-elser.html.

func (InferencePutElser) WithBody ¶ added in v8.18.0 

func (f InferencePutElser) WithBody(v io.Reader) func(*InferencePutElserRequest)

WithBody - The inference endpoint's task and service settings.

func (InferencePutElser) WithContext ¶ added in v8.18.0 

func (f InferencePutElser) WithContext(v context.Context) func(*InferencePutElserRequest)

WithContext sets the request context.

func (InferencePutElser) WithErrorTrace ¶ added in v8.18.0 

func (f InferencePutElser) WithErrorTrace() func(*InferencePutElserRequest)

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

func (InferencePutElser) WithFilterPath ¶ added in v8.18.0 

func (f InferencePutElser) WithFilterPath(v ...string) func(*InferencePutElserRequest)

WithFilterPath filters the properties of the response body.

func (InferencePutElser) WithHeader ¶ added in v8.18.0 

func (f InferencePutElser) WithHeader(h map[string]string) func(*InferencePutElserRequest)

WithHeader adds the headers to the HTTP request.

func (InferencePutElser) WithHuman ¶ added in v8.18.0 

func (f InferencePutElser) WithHuman() func(*InferencePutElserRequest)

WithHuman makes statistical values human-readable.

func (InferencePutElser) WithOpaqueID ¶ added in v8.18.0 

func (f InferencePutElser) WithOpaqueID(s string) func(*InferencePutElserRequest)

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

func (InferencePutElser) WithPretty ¶ added in v8.18.0 

func (f InferencePutElser) WithPretty() func(*InferencePutElserRequest)

WithPretty makes the response body pretty-printed.

type InferencePutElserRequest ¶ added in v8.18.0 

type InferencePutElserRequest struct {
	Body io.Reader

	ElserInferenceID string
	TaskType         string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferencePutElserRequest configures the Inference Put Elser API request.

func (InferencePutElserRequest) Do ¶ added in v8.18.0 

func (r InferencePutElserRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferencePutGoogleaistudio ¶ added in v8.18.0 

type InferencePutGoogleaistudio func(googleaistudio_inference_id string, task_type string, o ...func(*InferencePutGoogleaistudioRequest)) (*Response, error)

InferencePutGoogleaistudio configure a Google AI Studio inference endpoint

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-google-ai-studio.html.

func (InferencePutGoogleaistudio) WithBody ¶ added in v8.18.0 

func (f InferencePutGoogleaistudio) WithBody(v io.Reader) func(*InferencePutGoogleaistudioRequest)

WithBody - The inference endpoint's task and service settings.

func (InferencePutGoogleaistudio) WithContext ¶ added in v8.18.0 

func (f InferencePutGoogleaistudio) WithContext(v context.Context) func(*InferencePutGoogleaistudioRequest)

WithContext sets the request context.

func (InferencePutGoogleaistudio) WithErrorTrace ¶ added in v8.18.0 

func (f InferencePutGoogleaistudio) WithErrorTrace() func(*InferencePutGoogleaistudioRequest)

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

func (InferencePutGoogleaistudio) WithFilterPath ¶ added in v8.18.0 

func (f InferencePutGoogleaistudio) WithFilterPath(v ...string) func(*InferencePutGoogleaistudioRequest)

WithFilterPath filters the properties of the response body.

func (InferencePutGoogleaistudio) WithHeader ¶ added in v8.18.0 

func (f InferencePutGoogleaistudio) WithHeader(h map[string]string) func(*InferencePutGoogleaistudioRequest)

WithHeader adds the headers to the HTTP request.

func (InferencePutGoogleaistudio) WithHuman ¶ added in v8.18.0 

func (f InferencePutGoogleaistudio) WithHuman() func(*InferencePutGoogleaistudioRequest)

WithHuman makes statistical values human-readable.

func (InferencePutGoogleaistudio) WithOpaqueID ¶ added in v8.18.0 

func (f InferencePutGoogleaistudio) WithOpaqueID(s string) func(*InferencePutGoogleaistudioRequest)

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

func (InferencePutGoogleaistudio) WithPretty ¶ added in v8.18.0 

func (f InferencePutGoogleaistudio) WithPretty() func(*InferencePutGoogleaistudioRequest)

WithPretty makes the response body pretty-printed.

type InferencePutGoogleaistudioRequest ¶ added in v8.18.0 

type InferencePutGoogleaistudioRequest struct {
	Body io.Reader

	GoogleaistudioInferenceID string
	TaskType                  string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferencePutGoogleaistudioRequest configures the Inference Put Googleaistudio API request.

func (InferencePutGoogleaistudioRequest) Do ¶ added in v8.18.0 

func (r InferencePutGoogleaistudioRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferencePutGooglevertexai ¶ added in v8.18.0 

type InferencePutGooglevertexai func(googlevertexai_inference_id string, task_type string, o ...func(*InferencePutGooglevertexaiRequest)) (*Response, error)

InferencePutGooglevertexai configure a Google Vertex AI inference endpoint

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-google-vertex-ai.html.

func (InferencePutGooglevertexai) WithBody ¶ added in v8.18.0 

func (f InferencePutGooglevertexai) WithBody(v io.Reader) func(*InferencePutGooglevertexaiRequest)

WithBody - The inference endpoint's task and service settings.

func (InferencePutGooglevertexai) WithContext ¶ added in v8.18.0 

func (f InferencePutGooglevertexai) WithContext(v context.Context) func(*InferencePutGooglevertexaiRequest)

WithContext sets the request context.

func (InferencePutGooglevertexai) WithErrorTrace ¶ added in v8.18.0 

func (f InferencePutGooglevertexai) WithErrorTrace() func(*InferencePutGooglevertexaiRequest)

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

func (InferencePutGooglevertexai) WithFilterPath ¶ added in v8.18.0 

func (f InferencePutGooglevertexai) WithFilterPath(v ...string) func(*InferencePutGooglevertexaiRequest)

WithFilterPath filters the properties of the response body.

func (InferencePutGooglevertexai) WithHeader ¶ added in v8.18.0 

func (f InferencePutGooglevertexai) WithHeader(h map[string]string) func(*InferencePutGooglevertexaiRequest)

WithHeader adds the headers to the HTTP request.

func (InferencePutGooglevertexai) WithHuman ¶ added in v8.18.0 

func (f InferencePutGooglevertexai) WithHuman() func(*InferencePutGooglevertexaiRequest)

WithHuman makes statistical values human-readable.

func (InferencePutGooglevertexai) WithOpaqueID ¶ added in v8.18.0 

func (f InferencePutGooglevertexai) WithOpaqueID(s string) func(*InferencePutGooglevertexaiRequest)

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

func (InferencePutGooglevertexai) WithPretty ¶ added in v8.18.0 

func (f InferencePutGooglevertexai) WithPretty() func(*InferencePutGooglevertexaiRequest)

WithPretty makes the response body pretty-printed.

type InferencePutGooglevertexaiRequest ¶ added in v8.18.0 

type InferencePutGooglevertexaiRequest struct {
	Body io.Reader

	GooglevertexaiInferenceID string
	TaskType                  string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferencePutGooglevertexaiRequest configures the Inference Put Googlevertexai API request.

func (InferencePutGooglevertexaiRequest) Do ¶ added in v8.18.0 

func (r InferencePutGooglevertexaiRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferencePutHuggingFace ¶ added in v8.18.0 

type InferencePutHuggingFace func(huggingface_inference_id string, task_type string, o ...func(*InferencePutHuggingFaceRequest)) (*Response, error)

InferencePutHuggingFace configure a HuggingFace inference endpoint

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-hugging-face.html.

func (InferencePutHuggingFace) WithBody ¶ added in v8.18.0 

func (f InferencePutHuggingFace) WithBody(v io.Reader) func(*InferencePutHuggingFaceRequest)

WithBody - The inference endpoint's task and service settings.

func (InferencePutHuggingFace) WithContext ¶ added in v8.18.0 

func (f InferencePutHuggingFace) WithContext(v context.Context) func(*InferencePutHuggingFaceRequest)

WithContext sets the request context.

func (InferencePutHuggingFace) WithErrorTrace ¶ added in v8.18.0 

func (f InferencePutHuggingFace) WithErrorTrace() func(*InferencePutHuggingFaceRequest)

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

func (InferencePutHuggingFace) WithFilterPath ¶ added in v8.18.0 

func (f InferencePutHuggingFace) WithFilterPath(v ...string) func(*InferencePutHuggingFaceRequest)

WithFilterPath filters the properties of the response body.

func (InferencePutHuggingFace) WithHeader ¶ added in v8.18.0 

func (f InferencePutHuggingFace) WithHeader(h map[string]string) func(*InferencePutHuggingFaceRequest)

WithHeader adds the headers to the HTTP request.

func (InferencePutHuggingFace) WithHuman ¶ added in v8.18.0 

func (f InferencePutHuggingFace) WithHuman() func(*InferencePutHuggingFaceRequest)

WithHuman makes statistical values human-readable.

func (InferencePutHuggingFace) WithOpaqueID ¶ added in v8.18.0 

func (f InferencePutHuggingFace) WithOpaqueID(s string) func(*InferencePutHuggingFaceRequest)

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

func (InferencePutHuggingFace) WithPretty ¶ added in v8.18.0 

func (f InferencePutHuggingFace) WithPretty() func(*InferencePutHuggingFaceRequest)

WithPretty makes the response body pretty-printed.

type InferencePutHuggingFaceRequest ¶ added in v8.18.0 

type InferencePutHuggingFaceRequest struct {
	Body io.Reader

	HuggingfaceInferenceID string
	TaskType               string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferencePutHuggingFaceRequest configures the Inference Put Hugging Face API request.

func (InferencePutHuggingFaceRequest) Do ¶ added in v8.18.0 

func (r InferencePutHuggingFaceRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferencePutJinaai ¶ added in v8.18.0 

type InferencePutJinaai func(jinaai_inference_id string, task_type string, o ...func(*InferencePutJinaaiRequest)) (*Response, error)

InferencePutJinaai configure a JinaAI inference endpoint

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-jinaai.html.

func (InferencePutJinaai) WithBody ¶ added in v8.18.0 

func (f InferencePutJinaai) WithBody(v io.Reader) func(*InferencePutJinaaiRequest)

WithBody - The inference endpoint's task and service settings.

func (InferencePutJinaai) WithContext ¶ added in v8.18.0 

func (f InferencePutJinaai) WithContext(v context.Context) func(*InferencePutJinaaiRequest)

WithContext sets the request context.

func (InferencePutJinaai) WithErrorTrace ¶ added in v8.18.0 

func (f InferencePutJinaai) WithErrorTrace() func(*InferencePutJinaaiRequest)

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

func (InferencePutJinaai) WithFilterPath ¶ added in v8.18.0 

func (f InferencePutJinaai) WithFilterPath(v ...string) func(*InferencePutJinaaiRequest)

WithFilterPath filters the properties of the response body.

func (InferencePutJinaai) WithHeader ¶ added in v8.18.0 

func (f InferencePutJinaai) WithHeader(h map[string]string) func(*InferencePutJinaaiRequest)

WithHeader adds the headers to the HTTP request.

func (InferencePutJinaai) WithHuman ¶ added in v8.18.0 

func (f InferencePutJinaai) WithHuman() func(*InferencePutJinaaiRequest)

WithHuman makes statistical values human-readable.

func (InferencePutJinaai) WithOpaqueID ¶ added in v8.18.0 

func (f InferencePutJinaai) WithOpaqueID(s string) func(*InferencePutJinaaiRequest)

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

func (InferencePutJinaai) WithPretty ¶ added in v8.18.0 

func (f InferencePutJinaai) WithPretty() func(*InferencePutJinaaiRequest)

WithPretty makes the response body pretty-printed.

type InferencePutJinaaiRequest ¶ added in v8.18.0 

type InferencePutJinaaiRequest struct {
	Body io.Reader

	JinaaiInferenceID string
	TaskType          string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferencePutJinaaiRequest configures the Inference Put Jinaai API request.

func (InferencePutJinaaiRequest) Do ¶ added in v8.18.0 

func (r InferencePutJinaaiRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferencePutMistral ¶ added in v8.18.0 

type InferencePutMistral func(mistral_inference_id string, task_type string, o ...func(*InferencePutMistralRequest)) (*Response, error)

InferencePutMistral configure a Mistral inference endpoint

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-mistral.html.

func (InferencePutMistral) WithBody ¶ added in v8.18.0 

func (f InferencePutMistral) WithBody(v io.Reader) func(*InferencePutMistralRequest)

WithBody - The inference endpoint's task and service settings.

func (InferencePutMistral) WithContext ¶ added in v8.18.0 

func (f InferencePutMistral) WithContext(v context.Context) func(*InferencePutMistralRequest)

WithContext sets the request context.

func (InferencePutMistral) WithErrorTrace ¶ added in v8.18.0 

func (f InferencePutMistral) WithErrorTrace() func(*InferencePutMistralRequest)

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

func (InferencePutMistral) WithFilterPath ¶ added in v8.18.0 

func (f InferencePutMistral) WithFilterPath(v ...string) func(*InferencePutMistralRequest)

WithFilterPath filters the properties of the response body.

func (InferencePutMistral) WithHeader ¶ added in v8.18.0 

func (f InferencePutMistral) WithHeader(h map[string]string) func(*InferencePutMistralRequest)

WithHeader adds the headers to the HTTP request.

func (InferencePutMistral) WithHuman ¶ added in v8.18.0 

func (f InferencePutMistral) WithHuman() func(*InferencePutMistralRequest)

WithHuman makes statistical values human-readable.

func (InferencePutMistral) WithOpaqueID ¶ added in v8.18.0 

func (f InferencePutMistral) WithOpaqueID(s string) func(*InferencePutMistralRequest)

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

func (InferencePutMistral) WithPretty ¶ added in v8.18.0 

func (f InferencePutMistral) WithPretty() func(*InferencePutMistralRequest)

WithPretty makes the response body pretty-printed.

type InferencePutMistralRequest ¶ added in v8.18.0 

type InferencePutMistralRequest struct {
	Body io.Reader

	MistralInferenceID string
	TaskType           string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferencePutMistralRequest configures the Inference Put Mistral API request.

func (InferencePutMistralRequest) Do ¶ added in v8.18.0 

func (r InferencePutMistralRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferencePutOpenai ¶ added in v8.18.0 

type InferencePutOpenai func(openai_inference_id string, task_type string, o ...func(*InferencePutOpenaiRequest)) (*Response, error)

InferencePutOpenai configure an OpenAI inference endpoint

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-openai.html.

func (InferencePutOpenai) WithBody ¶ added in v8.18.0 

func (f InferencePutOpenai) WithBody(v io.Reader) func(*InferencePutOpenaiRequest)

WithBody - The inference endpoint's task and service settings.

func (InferencePutOpenai) WithContext ¶ added in v8.18.0 

func (f InferencePutOpenai) WithContext(v context.Context) func(*InferencePutOpenaiRequest)

WithContext sets the request context.

func (InferencePutOpenai) WithErrorTrace ¶ added in v8.18.0 

func (f InferencePutOpenai) WithErrorTrace() func(*InferencePutOpenaiRequest)

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

func (InferencePutOpenai) WithFilterPath ¶ added in v8.18.0 

func (f InferencePutOpenai) WithFilterPath(v ...string) func(*InferencePutOpenaiRequest)

WithFilterPath filters the properties of the response body.

func (InferencePutOpenai) WithHeader ¶ added in v8.18.0 

func (f InferencePutOpenai) WithHeader(h map[string]string) func(*InferencePutOpenaiRequest)

WithHeader adds the headers to the HTTP request.

func (InferencePutOpenai) WithHuman ¶ added in v8.18.0 

func (f InferencePutOpenai) WithHuman() func(*InferencePutOpenaiRequest)

WithHuman makes statistical values human-readable.

func (InferencePutOpenai) WithOpaqueID ¶ added in v8.18.0 

func (f InferencePutOpenai) WithOpaqueID(s string) func(*InferencePutOpenaiRequest)

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

func (InferencePutOpenai) WithPretty ¶ added in v8.18.0 

func (f InferencePutOpenai) WithPretty() func(*InferencePutOpenaiRequest)

WithPretty makes the response body pretty-printed.

type InferencePutOpenaiRequest ¶ added in v8.18.0 

type InferencePutOpenaiRequest struct {
	Body io.Reader

	OpenaiInferenceID string
	TaskType          string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferencePutOpenaiRequest configures the Inference Put Openai API request.

func (InferencePutOpenaiRequest) Do ¶ added in v8.18.0 

func (r InferencePutOpenaiRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferencePutRequest ¶ added in v8.15.0 

type InferencePutRequest struct {
	Body io.Reader

	InferenceID string
	TaskType    string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferencePutRequest configures the Inference Put API request.

func (InferencePutRequest) Do ¶ added in v8.15.0 

func (r InferencePutRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferencePutVoyageai ¶ added in v8.18.0 

type InferencePutVoyageai func(task_type string, voyageai_inference_id string, o ...func(*InferencePutVoyageaiRequest)) (*Response, error)

InferencePutVoyageai configure a VoyageAI inference endpoint

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

func (InferencePutVoyageai) WithBody ¶ added in v8.18.0 

func (f InferencePutVoyageai) WithBody(v io.Reader) func(*InferencePutVoyageaiRequest)

WithBody - The inference endpoint's task and service settings.

func (InferencePutVoyageai) WithContext ¶ added in v8.18.0 

func (f InferencePutVoyageai) WithContext(v context.Context) func(*InferencePutVoyageaiRequest)

WithContext sets the request context.

func (InferencePutVoyageai) WithErrorTrace ¶ added in v8.18.0 

func (f InferencePutVoyageai) WithErrorTrace() func(*InferencePutVoyageaiRequest)

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

func (InferencePutVoyageai) WithFilterPath ¶ added in v8.18.0 

func (f InferencePutVoyageai) WithFilterPath(v ...string) func(*InferencePutVoyageaiRequest)

WithFilterPath filters the properties of the response body.

func (InferencePutVoyageai) WithHeader ¶ added in v8.18.0 

func (f InferencePutVoyageai) WithHeader(h map[string]string) func(*InferencePutVoyageaiRequest)

WithHeader adds the headers to the HTTP request.

func (InferencePutVoyageai) WithHuman ¶ added in v8.18.0 

func (f InferencePutVoyageai) WithHuman() func(*InferencePutVoyageaiRequest)

WithHuman makes statistical values human-readable.

func (InferencePutVoyageai) WithOpaqueID ¶ added in v8.18.0 

func (f InferencePutVoyageai) WithOpaqueID(s string) func(*InferencePutVoyageaiRequest)

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

func (InferencePutVoyageai) WithPretty ¶ added in v8.18.0 

func (f InferencePutVoyageai) WithPretty() func(*InferencePutVoyageaiRequest)

WithPretty makes the response body pretty-printed.

type InferencePutVoyageaiRequest ¶ added in v8.18.0 

type InferencePutVoyageaiRequest struct {
	Body io.Reader

	TaskType            string
	VoyageaiInferenceID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferencePutVoyageaiRequest configures the Inference Put Voyageai API request.

func (InferencePutVoyageaiRequest) Do ¶ added in v8.18.0 

func (r InferencePutVoyageaiRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferencePutWatsonx ¶ added in v8.18.0 

type InferencePutWatsonx func(task_type string, watsonx_inference_id string, o ...func(*InferencePutWatsonxRequest)) (*Response, error)

InferencePutWatsonx configure a Watsonx inference endpoint

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-watsonx-ai.html.

func (InferencePutWatsonx) WithBody ¶ added in v8.18.0 

func (f InferencePutWatsonx) WithBody(v io.Reader) func(*InferencePutWatsonxRequest)

WithBody - The inference endpoint's task and service settings.

func (InferencePutWatsonx) WithContext ¶ added in v8.18.0 

func (f InferencePutWatsonx) WithContext(v context.Context) func(*InferencePutWatsonxRequest)

WithContext sets the request context.

func (InferencePutWatsonx) WithErrorTrace ¶ added in v8.18.0 

func (f InferencePutWatsonx) WithErrorTrace() func(*InferencePutWatsonxRequest)

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

func (InferencePutWatsonx) WithFilterPath ¶ added in v8.18.0 

func (f InferencePutWatsonx) WithFilterPath(v ...string) func(*InferencePutWatsonxRequest)

WithFilterPath filters the properties of the response body.

func (InferencePutWatsonx) WithHeader ¶ added in v8.18.0 

func (f InferencePutWatsonx) WithHeader(h map[string]string) func(*InferencePutWatsonxRequest)

WithHeader adds the headers to the HTTP request.

func (InferencePutWatsonx) WithHuman ¶ added in v8.18.0 

func (f InferencePutWatsonx) WithHuman() func(*InferencePutWatsonxRequest)

WithHuman makes statistical values human-readable.

func (InferencePutWatsonx) WithOpaqueID ¶ added in v8.18.0 

func (f InferencePutWatsonx) WithOpaqueID(s string) func(*InferencePutWatsonxRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (InferencePutWatsonx) WithPretty ¶ added in v8.18.0 

func (f InferencePutWatsonx) WithPretty() func(*InferencePutWatsonxRequest)

WithPretty makes the response body pretty-printed.

type InferencePutWatsonxRequest ¶ added in v8.18.0 

type InferencePutWatsonxRequest struct {
	Body io.Reader

	TaskType           string
	WatsonxInferenceID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferencePutWatsonxRequest configures the Inference Put Watsonx API request.

func (InferencePutWatsonxRequest) Do ¶ added in v8.18.0 

func (r InferencePutWatsonxRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferenceRerank ¶ added in v8.18.0 

type InferenceRerank func(inference_id string, o ...func(*InferenceRerankRequest)) (*Response, error)

InferenceRerank perform reranking inference

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html.

func (InferenceRerank) WithBody ¶ added in v8.18.0 

func (f InferenceRerank) WithBody(v io.Reader) func(*InferenceRerankRequest)

WithBody - The inference payload.

func (InferenceRerank) WithContext ¶ added in v8.18.0 

func (f InferenceRerank) WithContext(v context.Context) func(*InferenceRerankRequest)

WithContext sets the request context.

func (InferenceRerank) WithErrorTrace ¶ added in v8.18.0 

func (f InferenceRerank) WithErrorTrace() func(*InferenceRerankRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (InferenceRerank) WithFilterPath ¶ added in v8.18.0 

func (f InferenceRerank) WithFilterPath(v ...string) func(*InferenceRerankRequest)

WithFilterPath filters the properties of the response body.

func (InferenceRerank) WithHeader ¶ added in v8.18.0 

func (f InferenceRerank) WithHeader(h map[string]string) func(*InferenceRerankRequest)

WithHeader adds the headers to the HTTP request.

func (InferenceRerank) WithHuman ¶ added in v8.18.0 

func (f InferenceRerank) WithHuman() func(*InferenceRerankRequest)

WithHuman makes statistical values human-readable.

func (InferenceRerank) WithOpaqueID ¶ added in v8.18.0 

func (f InferenceRerank) WithOpaqueID(s string) func(*InferenceRerankRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (InferenceRerank) WithPretty ¶ added in v8.18.0 

func (f InferenceRerank) WithPretty() func(*InferenceRerankRequest)

WithPretty makes the response body pretty-printed.

type InferenceRerankRequest ¶ added in v8.18.0 

type InferenceRerankRequest struct {
	Body io.Reader

	InferenceID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferenceRerankRequest configures the Inference Rerank API request.

func (InferenceRerankRequest) Do ¶ added in v8.18.0 

func (r InferenceRerankRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferenceSparseEmbedding ¶ added in v8.18.0 

type InferenceSparseEmbedding func(inference_id string, o ...func(*InferenceSparseEmbeddingRequest)) (*Response, error)

InferenceSparseEmbedding perform sparse embedding inference

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html.

func (InferenceSparseEmbedding) WithBody ¶ added in v8.18.0 

func (f InferenceSparseEmbedding) WithBody(v io.Reader) func(*InferenceSparseEmbeddingRequest)

WithBody - The inference payload.

func (InferenceSparseEmbedding) WithContext ¶ added in v8.18.0 

func (f InferenceSparseEmbedding) WithContext(v context.Context) func(*InferenceSparseEmbeddingRequest)

WithContext sets the request context.

func (InferenceSparseEmbedding) WithErrorTrace ¶ added in v8.18.0 

func (f InferenceSparseEmbedding) WithErrorTrace() func(*InferenceSparseEmbeddingRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (InferenceSparseEmbedding) WithFilterPath ¶ added in v8.18.0 

func (f InferenceSparseEmbedding) WithFilterPath(v ...string) func(*InferenceSparseEmbeddingRequest)

WithFilterPath filters the properties of the response body.

func (InferenceSparseEmbedding) WithHeader ¶ added in v8.18.0 

func (f InferenceSparseEmbedding) WithHeader(h map[string]string) func(*InferenceSparseEmbeddingRequest)

WithHeader adds the headers to the HTTP request.

func (InferenceSparseEmbedding) WithHuman ¶ added in v8.18.0 

func (f InferenceSparseEmbedding) WithHuman() func(*InferenceSparseEmbeddingRequest)

WithHuman makes statistical values human-readable.

func (InferenceSparseEmbedding) WithOpaqueID ¶ added in v8.18.0 

func (f InferenceSparseEmbedding) WithOpaqueID(s string) func(*InferenceSparseEmbeddingRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (InferenceSparseEmbedding) WithPretty ¶ added in v8.18.0 

func (f InferenceSparseEmbedding) WithPretty() func(*InferenceSparseEmbeddingRequest)

WithPretty makes the response body pretty-printed.

type InferenceSparseEmbeddingRequest ¶ added in v8.18.0 

type InferenceSparseEmbeddingRequest struct {
	Body io.Reader

	InferenceID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferenceSparseEmbeddingRequest configures the Inference Sparse Embedding API request.

func (InferenceSparseEmbeddingRequest) Do ¶ added in v8.18.0 

func (r InferenceSparseEmbeddingRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferenceStreamCompletion ¶ added in v8.18.0 

type InferenceStreamCompletion func(inference_id string, o ...func(*InferenceStreamCompletionRequest)) (*Response, error)

InferenceStreamCompletion perform streaming completion inference

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/post-stream-inference-api.html.

func (InferenceStreamCompletion) WithBody ¶ added in v8.18.0 

func (f InferenceStreamCompletion) WithBody(v io.Reader) func(*InferenceStreamCompletionRequest)

WithBody - The inference payload.

func (InferenceStreamCompletion) WithContext ¶ added in v8.18.0 

func (f InferenceStreamCompletion) WithContext(v context.Context) func(*InferenceStreamCompletionRequest)

WithContext sets the request context.

func (InferenceStreamCompletion) WithErrorTrace ¶ added in v8.18.0 

func (f InferenceStreamCompletion) WithErrorTrace() func(*InferenceStreamCompletionRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (InferenceStreamCompletion) WithFilterPath ¶ added in v8.18.0 

func (f InferenceStreamCompletion) WithFilterPath(v ...string) func(*InferenceStreamCompletionRequest)

WithFilterPath filters the properties of the response body.

func (InferenceStreamCompletion) WithHeader ¶ added in v8.18.0 

func (f InferenceStreamCompletion) WithHeader(h map[string]string) func(*InferenceStreamCompletionRequest)

WithHeader adds the headers to the HTTP request.

func (InferenceStreamCompletion) WithHuman ¶ added in v8.18.0 

func (f InferenceStreamCompletion) WithHuman() func(*InferenceStreamCompletionRequest)

WithHuman makes statistical values human-readable.

func (InferenceStreamCompletion) WithOpaqueID ¶ added in v8.18.0 

func (f InferenceStreamCompletion) WithOpaqueID(s string) func(*InferenceStreamCompletionRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (InferenceStreamCompletion) WithPretty ¶ added in v8.18.0 

func (f InferenceStreamCompletion) WithPretty() func(*InferenceStreamCompletionRequest)

WithPretty makes the response body pretty-printed.

type InferenceStreamCompletionRequest ¶ added in v8.18.0 

type InferenceStreamCompletionRequest struct {
	Body io.Reader

	InferenceID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferenceStreamCompletionRequest configures the Inference Stream Completion API request.

func (InferenceStreamCompletionRequest) Do ¶ added in v8.18.0 

func (r InferenceStreamCompletionRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferenceTextEmbedding ¶ added in v8.18.0 

type InferenceTextEmbedding func(inference_id string, o ...func(*InferenceTextEmbeddingRequest)) (*Response, error)

InferenceTextEmbedding perform text embedding inference

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html.

func (InferenceTextEmbedding) WithBody ¶ added in v8.18.0 

func (f InferenceTextEmbedding) WithBody(v io.Reader) func(*InferenceTextEmbeddingRequest)

WithBody - The inference payload.

func (InferenceTextEmbedding) WithContext ¶ added in v8.18.0 

func (f InferenceTextEmbedding) WithContext(v context.Context) func(*InferenceTextEmbeddingRequest)

WithContext sets the request context.

func (InferenceTextEmbedding) WithErrorTrace ¶ added in v8.18.0 

func (f InferenceTextEmbedding) WithErrorTrace() func(*InferenceTextEmbeddingRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (InferenceTextEmbedding) WithFilterPath ¶ added in v8.18.0 

func (f InferenceTextEmbedding) WithFilterPath(v ...string) func(*InferenceTextEmbeddingRequest)

WithFilterPath filters the properties of the response body.

func (InferenceTextEmbedding) WithHeader ¶ added in v8.18.0 

func (f InferenceTextEmbedding) WithHeader(h map[string]string) func(*InferenceTextEmbeddingRequest)

WithHeader adds the headers to the HTTP request.

func (InferenceTextEmbedding) WithHuman ¶ added in v8.18.0 

func (f InferenceTextEmbedding) WithHuman() func(*InferenceTextEmbeddingRequest)

WithHuman makes statistical values human-readable.

func (InferenceTextEmbedding) WithOpaqueID ¶ added in v8.18.0 

func (f InferenceTextEmbedding) WithOpaqueID(s string) func(*InferenceTextEmbeddingRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (InferenceTextEmbedding) WithPretty ¶ added in v8.18.0 

func (f InferenceTextEmbedding) WithPretty() func(*InferenceTextEmbeddingRequest)

WithPretty makes the response body pretty-printed.

type InferenceTextEmbeddingRequest ¶ added in v8.18.0 

type InferenceTextEmbeddingRequest struct {
	Body io.Reader

	InferenceID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferenceTextEmbeddingRequest configures the Inference Text Embedding API request.

func (InferenceTextEmbeddingRequest) Do ¶ added in v8.18.0 

func (r InferenceTextEmbeddingRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type InferenceUpdate ¶ added in v8.18.0 

type InferenceUpdate func(inference_id string, o ...func(*InferenceUpdateRequest)) (*Response, error)

InferenceUpdate update inference

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/update-inference-api.html.

func (InferenceUpdate) WithBody ¶ added in v8.18.0 

func (f InferenceUpdate) WithBody(v io.Reader) func(*InferenceUpdateRequest)

WithBody - The inference endpoint's task and service settings.

func (InferenceUpdate) WithContext ¶ added in v8.18.0 

func (f InferenceUpdate) WithContext(v context.Context) func(*InferenceUpdateRequest)

WithContext sets the request context.

func (InferenceUpdate) WithErrorTrace ¶ added in v8.18.0 

func (f InferenceUpdate) WithErrorTrace() func(*InferenceUpdateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (InferenceUpdate) WithFilterPath ¶ added in v8.18.0 

func (f InferenceUpdate) WithFilterPath(v ...string) func(*InferenceUpdateRequest)

WithFilterPath filters the properties of the response body.

func (InferenceUpdate) WithHeader ¶ added in v8.18.0 

func (f InferenceUpdate) WithHeader(h map[string]string) func(*InferenceUpdateRequest)

WithHeader adds the headers to the HTTP request.

func (InferenceUpdate) WithHuman ¶ added in v8.18.0 

func (f InferenceUpdate) WithHuman() func(*InferenceUpdateRequest)

WithHuman makes statistical values human-readable.

func (InferenceUpdate) WithOpaqueID ¶ added in v8.18.0 

func (f InferenceUpdate) WithOpaqueID(s string) func(*InferenceUpdateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (InferenceUpdate) WithPretty ¶ added in v8.18.0 

func (f InferenceUpdate) WithPretty() func(*InferenceUpdateRequest)

WithPretty makes the response body pretty-printed.

func (InferenceUpdate) WithTaskType ¶ added in v8.18.0 

func (f InferenceUpdate) WithTaskType(v string) func(*InferenceUpdateRequest)

WithTaskType - the task type.

type InferenceUpdateRequest ¶ added in v8.18.0 

type InferenceUpdateRequest struct {
	Body io.Reader

	InferenceID string
	TaskType    string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InferenceUpdateRequest configures the Inference Update API request.

func (InferenceUpdateRequest) Do ¶ added in v8.18.0 

func (r InferenceUpdateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Info ¶ 

type Info func(o ...func(*InfoRequest)) (*Response, error)

Info returns basic information about the cluster.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html.

func (Info) WithContext ¶ 

func (f Info) WithContext(v context.Context) func(*InfoRequest)

WithContext sets the request context.

func (Info) WithErrorTrace ¶ 

func (f Info) WithErrorTrace() func(*InfoRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Info) WithFilterPath ¶ 

func (f Info) WithFilterPath(v ...string) func(*InfoRequest)

WithFilterPath filters the properties of the response body.

func (Info) WithHeader ¶ 

func (f Info) WithHeader(h map[string]string) func(*InfoRequest)

WithHeader adds the headers to the HTTP request.

func (Info) WithHuman ¶ 

func (f Info) WithHuman() func(*InfoRequest)

WithHuman makes statistical values human-readable.

func (Info) WithOpaqueID ¶ 

func (f Info) WithOpaqueID(s string) func(*InfoRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

type InfoRequest ¶ 

type InfoRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

InfoRequest configures the Info API request.

func (InfoRequest) Do ¶ 

func (r InfoRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Ingest ¶ 

type Ingest struct {
	DeleteGeoipDatabase      IngestDeleteGeoipDatabase
	DeleteIPLocationDatabase IngestDeleteIPLocationDatabase
	DeletePipeline           IngestDeletePipeline
	GeoIPStats               IngestGeoIPStats
	GetGeoipDatabase         IngestGetGeoipDatabase
	GetIPLocationDatabase    IngestGetIPLocationDatabase
	GetPipeline              IngestGetPipeline
	ProcessorGrok            IngestProcessorGrok
	PutGeoipDatabase         IngestPutGeoipDatabase
	PutIPLocationDatabase    IngestPutIPLocationDatabase
	PutPipeline              IngestPutPipeline
	Simulate                 IngestSimulate
}

Ingest contains the Ingest APIs

type IngestDeleteGeoipDatabase ¶ added in v8.15.0 

type IngestDeleteGeoipDatabase func(id []string, o ...func(*IngestDeleteGeoipDatabaseRequest)) (*Response, error)

IngestDeleteGeoipDatabase deletes a geoip database configuration

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-geoip-database-api.html.

func (IngestDeleteGeoipDatabase) WithContext ¶ added in v8.15.0 

func (f IngestDeleteGeoipDatabase) WithContext(v context.Context) func(*IngestDeleteGeoipDatabaseRequest)

WithContext sets the request context.

func (IngestDeleteGeoipDatabase) WithErrorTrace ¶ added in v8.15.0 

func (f IngestDeleteGeoipDatabase) WithErrorTrace() func(*IngestDeleteGeoipDatabaseRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IngestDeleteGeoipDatabase) WithFilterPath ¶ added in v8.15.0 

func (f IngestDeleteGeoipDatabase) WithFilterPath(v ...string) func(*IngestDeleteGeoipDatabaseRequest)

WithFilterPath filters the properties of the response body.

func (IngestDeleteGeoipDatabase) WithHeader ¶ added in v8.15.0 

func (f IngestDeleteGeoipDatabase) WithHeader(h map[string]string) func(*IngestDeleteGeoipDatabaseRequest)

WithHeader adds the headers to the HTTP request.

func (IngestDeleteGeoipDatabase) WithHuman ¶ added in v8.15.0 

func (f IngestDeleteGeoipDatabase) WithHuman() func(*IngestDeleteGeoipDatabaseRequest)

WithHuman makes statistical values human-readable.

func (IngestDeleteGeoipDatabase) WithOpaqueID ¶ added in v8.15.0 

func (f IngestDeleteGeoipDatabase) WithOpaqueID(s string) func(*IngestDeleteGeoipDatabaseRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IngestDeleteGeoipDatabase) WithPretty ¶ added in v8.15.0 

func (f IngestDeleteGeoipDatabase) WithPretty() func(*IngestDeleteGeoipDatabaseRequest)

WithPretty makes the response body pretty-printed.

type IngestDeleteGeoipDatabaseRequest ¶ added in v8.15.0 

type IngestDeleteGeoipDatabaseRequest struct {
	DocumentID []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IngestDeleteGeoipDatabaseRequest configures the Ingest Delete Geoip Database API request.

func (IngestDeleteGeoipDatabaseRequest) Do ¶ added in v8.15.0 

func (r IngestDeleteGeoipDatabaseRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IngestDeleteIPLocationDatabase ¶ added in v8.16.0 

type IngestDeleteIPLocationDatabase func(id []string, o ...func(*IngestDeleteIPLocationDatabaseRequest)) (*Response, error)

IngestDeleteIPLocationDatabase deletes an ip location database configuration

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-ip-location-database-api.html.

func (IngestDeleteIPLocationDatabase) WithContext ¶ added in v8.16.0 

func (f IngestDeleteIPLocationDatabase) WithContext(v context.Context) func(*IngestDeleteIPLocationDatabaseRequest)

WithContext sets the request context.

func (IngestDeleteIPLocationDatabase) WithErrorTrace ¶ added in v8.16.0 

func (f IngestDeleteIPLocationDatabase) WithErrorTrace() func(*IngestDeleteIPLocationDatabaseRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IngestDeleteIPLocationDatabase) WithFilterPath ¶ added in v8.16.0 

func (f IngestDeleteIPLocationDatabase) WithFilterPath(v ...string) func(*IngestDeleteIPLocationDatabaseRequest)

WithFilterPath filters the properties of the response body.

func (IngestDeleteIPLocationDatabase) WithHeader ¶ added in v8.16.0 

func (f IngestDeleteIPLocationDatabase) WithHeader(h map[string]string) func(*IngestDeleteIPLocationDatabaseRequest)

WithHeader adds the headers to the HTTP request.

func (IngestDeleteIPLocationDatabase) WithHuman ¶ added in v8.16.0 

func (f IngestDeleteIPLocationDatabase) WithHuman() func(*IngestDeleteIPLocationDatabaseRequest)

WithHuman makes statistical values human-readable.

func (IngestDeleteIPLocationDatabase) WithOpaqueID ¶ added in v8.16.0 

func (f IngestDeleteIPLocationDatabase) WithOpaqueID(s string) func(*IngestDeleteIPLocationDatabaseRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IngestDeleteIPLocationDatabase) WithPretty ¶ added in v8.16.0 

func (f IngestDeleteIPLocationDatabase) WithPretty() func(*IngestDeleteIPLocationDatabaseRequest)

WithPretty makes the response body pretty-printed.

type IngestDeleteIPLocationDatabaseRequest ¶ added in v8.16.0 

type IngestDeleteIPLocationDatabaseRequest struct {
	DocumentID []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IngestDeleteIPLocationDatabaseRequest configures the Ingest DeleteIP Location Database API request.

func (IngestDeleteIPLocationDatabaseRequest) Do ¶ added in v8.16.0 

func (r IngestDeleteIPLocationDatabaseRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IngestDeletePipeline ¶ 

type IngestDeletePipeline func(id string, o ...func(*IngestDeletePipelineRequest)) (*Response, error)

IngestDeletePipeline deletes a pipeline.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html.

func (IngestDeletePipeline) WithContext ¶ 

func (f IngestDeletePipeline) WithContext(v context.Context) func(*IngestDeletePipelineRequest)

WithContext sets the request context.

func (IngestDeletePipeline) WithErrorTrace ¶ 

func (f IngestDeletePipeline) WithErrorTrace() func(*IngestDeletePipelineRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IngestDeletePipeline) WithFilterPath ¶ 

func (f IngestDeletePipeline) WithFilterPath(v ...string) func(*IngestDeletePipelineRequest)

WithFilterPath filters the properties of the response body.

func (IngestDeletePipeline) WithHeader ¶ 

func (f IngestDeletePipeline) WithHeader(h map[string]string) func(*IngestDeletePipelineRequest)

WithHeader adds the headers to the HTTP request.

func (IngestDeletePipeline) WithHuman ¶ 

func (f IngestDeletePipeline) WithHuman() func(*IngestDeletePipelineRequest)

WithHuman makes statistical values human-readable.

func (IngestDeletePipeline) WithMasterTimeout ¶ 

func (f IngestDeletePipeline) WithMasterTimeout(v time.Duration) func(*IngestDeletePipelineRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (IngestDeletePipeline) WithOpaqueID ¶ 

func (f IngestDeletePipeline) WithOpaqueID(s string) func(*IngestDeletePipelineRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IngestDeletePipeline) WithPretty ¶ 

func (f IngestDeletePipeline) WithPretty() func(*IngestDeletePipelineRequest)

WithPretty makes the response body pretty-printed.

func (IngestDeletePipeline) WithTimeout ¶ 

func (f IngestDeletePipeline) WithTimeout(v time.Duration) func(*IngestDeletePipelineRequest)

WithTimeout - explicit operation timeout.

type IngestDeletePipelineRequest ¶ 

type IngestDeletePipelineRequest struct {
	PipelineID string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IngestDeletePipelineRequest configures the Ingest Delete Pipeline API request.

func (IngestDeletePipelineRequest) Do ¶ 

func (r IngestDeletePipelineRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IngestGeoIPStats ¶ 

type IngestGeoIPStats func(o ...func(*IngestGeoIPStatsRequest)) (*Response, error)

IngestGeoIPStats returns statistical information about geoip databases

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/geoip-stats-api.html.

func (IngestGeoIPStats) WithContext ¶ 

func (f IngestGeoIPStats) WithContext(v context.Context) func(*IngestGeoIPStatsRequest)

WithContext sets the request context.

func (IngestGeoIPStats) WithErrorTrace ¶ 

func (f IngestGeoIPStats) WithErrorTrace() func(*IngestGeoIPStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IngestGeoIPStats) WithFilterPath ¶ 

func (f IngestGeoIPStats) WithFilterPath(v ...string) func(*IngestGeoIPStatsRequest)

WithFilterPath filters the properties of the response body.

func (IngestGeoIPStats) WithHeader ¶ 

func (f IngestGeoIPStats) WithHeader(h map[string]string) func(*IngestGeoIPStatsRequest)

WithHeader adds the headers to the HTTP request.

func (IngestGeoIPStats) WithHuman ¶ 

func (f IngestGeoIPStats) WithHuman() func(*IngestGeoIPStatsRequest)

WithHuman makes statistical values human-readable.

func (IngestGeoIPStats) WithOpaqueID ¶ 

func (f IngestGeoIPStats) WithOpaqueID(s string) func(*IngestGeoIPStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IngestGeoIPStats) WithPretty ¶ 

func (f IngestGeoIPStats) WithPretty() func(*IngestGeoIPStatsRequest)

WithPretty makes the response body pretty-printed.

type IngestGeoIPStatsRequest ¶ 

type IngestGeoIPStatsRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IngestGeoIPStatsRequest configures the Ingest GeoIP Stats API request.

func (IngestGeoIPStatsRequest) Do ¶ 

func (r IngestGeoIPStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IngestGetGeoipDatabase ¶ added in v8.15.0 

type IngestGetGeoipDatabase func(o ...func(*IngestGetGeoipDatabaseRequest)) (*Response, error)

IngestGetGeoipDatabase returns geoip database configuration.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-geoip-database-api.html.

func (IngestGetGeoipDatabase) WithContext ¶ added in v8.15.0 

func (f IngestGetGeoipDatabase) WithContext(v context.Context) func(*IngestGetGeoipDatabaseRequest)

WithContext sets the request context.

func (IngestGetGeoipDatabase) WithDocumentID ¶ added in v8.15.0 

func (f IngestGetGeoipDatabase) WithDocumentID(v ...string) func(*IngestGetGeoipDatabaseRequest)

WithDocumentID - a list of geoip database configurations to get; use `*` to get all geoip database configurations.

func (IngestGetGeoipDatabase) WithErrorTrace ¶ added in v8.15.0 

func (f IngestGetGeoipDatabase) WithErrorTrace() func(*IngestGetGeoipDatabaseRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IngestGetGeoipDatabase) WithFilterPath ¶ added in v8.15.0 

func (f IngestGetGeoipDatabase) WithFilterPath(v ...string) func(*IngestGetGeoipDatabaseRequest)

WithFilterPath filters the properties of the response body.

func (IngestGetGeoipDatabase) WithHeader ¶ added in v8.15.0 

func (f IngestGetGeoipDatabase) WithHeader(h map[string]string) func(*IngestGetGeoipDatabaseRequest)

WithHeader adds the headers to the HTTP request.

func (IngestGetGeoipDatabase) WithHuman ¶ added in v8.15.0 

func (f IngestGetGeoipDatabase) WithHuman() func(*IngestGetGeoipDatabaseRequest)

WithHuman makes statistical values human-readable.

func (IngestGetGeoipDatabase) WithOpaqueID ¶ added in v8.15.0 

func (f IngestGetGeoipDatabase) WithOpaqueID(s string) func(*IngestGetGeoipDatabaseRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IngestGetGeoipDatabase) WithPretty ¶ added in v8.15.0 

func (f IngestGetGeoipDatabase) WithPretty() func(*IngestGetGeoipDatabaseRequest)

WithPretty makes the response body pretty-printed.

type IngestGetGeoipDatabaseRequest ¶ added in v8.15.0 

type IngestGetGeoipDatabaseRequest struct {
	DocumentID []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IngestGetGeoipDatabaseRequest configures the Ingest Get Geoip Database API request.

func (IngestGetGeoipDatabaseRequest) Do ¶ added in v8.15.0 

func (r IngestGetGeoipDatabaseRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IngestGetIPLocationDatabase ¶ added in v8.16.0 

type IngestGetIPLocationDatabase func(o ...func(*IngestGetIPLocationDatabaseRequest)) (*Response, error)

IngestGetIPLocationDatabase returns the specified ip location database configuration

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-ip-location-database-api.html.

func (IngestGetIPLocationDatabase) WithContext ¶ added in v8.16.0 

func (f IngestGetIPLocationDatabase) WithContext(v context.Context) func(*IngestGetIPLocationDatabaseRequest)

WithContext sets the request context.

func (IngestGetIPLocationDatabase) WithDocumentID ¶ added in v8.16.0 

func (f IngestGetIPLocationDatabase) WithDocumentID(v ...string) func(*IngestGetIPLocationDatabaseRequest)

WithDocumentID - a list of ip location database configurations to get; use `*` to get all ip location database configurations.

func (IngestGetIPLocationDatabase) WithErrorTrace ¶ added in v8.16.0 

func (f IngestGetIPLocationDatabase) WithErrorTrace() func(*IngestGetIPLocationDatabaseRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IngestGetIPLocationDatabase) WithFilterPath ¶ added in v8.16.0 

func (f IngestGetIPLocationDatabase) WithFilterPath(v ...string) func(*IngestGetIPLocationDatabaseRequest)

WithFilterPath filters the properties of the response body.

func (IngestGetIPLocationDatabase) WithHeader ¶ added in v8.16.0 

func (f IngestGetIPLocationDatabase) WithHeader(h map[string]string) func(*IngestGetIPLocationDatabaseRequest)

WithHeader adds the headers to the HTTP request.

func (IngestGetIPLocationDatabase) WithHuman ¶ added in v8.16.0 

func (f IngestGetIPLocationDatabase) WithHuman() func(*IngestGetIPLocationDatabaseRequest)

WithHuman makes statistical values human-readable.

func (IngestGetIPLocationDatabase) WithOpaqueID ¶ added in v8.16.0 

func (f IngestGetIPLocationDatabase) WithOpaqueID(s string) func(*IngestGetIPLocationDatabaseRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IngestGetIPLocationDatabase) WithPretty ¶ added in v8.16.0 

func (f IngestGetIPLocationDatabase) WithPretty() func(*IngestGetIPLocationDatabaseRequest)

WithPretty makes the response body pretty-printed.

type IngestGetIPLocationDatabaseRequest ¶ added in v8.16.0 

type IngestGetIPLocationDatabaseRequest struct {
	DocumentID []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IngestGetIPLocationDatabaseRequest configures the Ingest GetIP Location Database API request.

func (IngestGetIPLocationDatabaseRequest) Do ¶ added in v8.16.0 

func (r IngestGetIPLocationDatabaseRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IngestGetPipeline ¶ 

type IngestGetPipeline func(o ...func(*IngestGetPipelineRequest)) (*Response, error)

IngestGetPipeline returns a pipeline.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html.

func (IngestGetPipeline) WithContext ¶ 

func (f IngestGetPipeline) WithContext(v context.Context) func(*IngestGetPipelineRequest)

WithContext sets the request context.

func (IngestGetPipeline) WithErrorTrace ¶ 

func (f IngestGetPipeline) WithErrorTrace() func(*IngestGetPipelineRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IngestGetPipeline) WithFilterPath ¶ 

func (f IngestGetPipeline) WithFilterPath(v ...string) func(*IngestGetPipelineRequest)

WithFilterPath filters the properties of the response body.

func (IngestGetPipeline) WithHeader ¶ 

func (f IngestGetPipeline) WithHeader(h map[string]string) func(*IngestGetPipelineRequest)

WithHeader adds the headers to the HTTP request.

func (IngestGetPipeline) WithHuman ¶ 

func (f IngestGetPipeline) WithHuman() func(*IngestGetPipelineRequest)

WithHuman makes statistical values human-readable.

func (IngestGetPipeline) WithMasterTimeout ¶ 

func (f IngestGetPipeline) WithMasterTimeout(v time.Duration) func(*IngestGetPipelineRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (IngestGetPipeline) WithOpaqueID ¶ 

func (f IngestGetPipeline) WithOpaqueID(s string) func(*IngestGetPipelineRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IngestGetPipeline) WithPipelineID ¶ 

func (f IngestGetPipeline) WithPipelineID(v string) func(*IngestGetPipelineRequest)

WithPipelineID - comma separated list of pipeline ids. wildcards supported.

func (IngestGetPipeline) WithPretty ¶ 

func (f IngestGetPipeline) WithPretty() func(*IngestGetPipelineRequest)

WithPretty makes the response body pretty-printed.

func (IngestGetPipeline) WithSummary ¶ 

func (f IngestGetPipeline) WithSummary(v bool) func(*IngestGetPipelineRequest)

WithSummary - return pipelines without their definitions (default: false).

type IngestGetPipelineRequest ¶ 

type IngestGetPipelineRequest struct {
	PipelineID string

	MasterTimeout time.Duration
	Summary       *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IngestGetPipelineRequest configures the Ingest Get Pipeline API request.

func (IngestGetPipelineRequest) Do ¶ 

func (r IngestGetPipelineRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IngestProcessorGrok ¶ 

type IngestProcessorGrok func(o ...func(*IngestProcessorGrokRequest)) (*Response, error)

IngestProcessorGrok returns a list of the built-in patterns.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/grok-processor.html#grok-processor-rest-get.

func (IngestProcessorGrok) WithContext ¶ 

func (f IngestProcessorGrok) WithContext(v context.Context) func(*IngestProcessorGrokRequest)

WithContext sets the request context.

func (IngestProcessorGrok) WithErrorTrace ¶ 

func (f IngestProcessorGrok) WithErrorTrace() func(*IngestProcessorGrokRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IngestProcessorGrok) WithFilterPath ¶ 

func (f IngestProcessorGrok) WithFilterPath(v ...string) func(*IngestProcessorGrokRequest)

WithFilterPath filters the properties of the response body.

func (IngestProcessorGrok) WithHeader ¶ 

func (f IngestProcessorGrok) WithHeader(h map[string]string) func(*IngestProcessorGrokRequest)

WithHeader adds the headers to the HTTP request.

func (IngestProcessorGrok) WithHuman ¶ 

func (f IngestProcessorGrok) WithHuman() func(*IngestProcessorGrokRequest)

WithHuman makes statistical values human-readable.

func (IngestProcessorGrok) WithOpaqueID ¶ 

func (f IngestProcessorGrok) WithOpaqueID(s string) func(*IngestProcessorGrokRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IngestProcessorGrok) WithPretty ¶ 

func (f IngestProcessorGrok) WithPretty() func(*IngestProcessorGrokRequest)

WithPretty makes the response body pretty-printed.

type IngestProcessorGrokRequest ¶ 

type IngestProcessorGrokRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IngestProcessorGrokRequest configures the Ingest Processor Grok API request.

func (IngestProcessorGrokRequest) Do ¶ 

func (r IngestProcessorGrokRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IngestPutGeoipDatabase ¶ added in v8.15.0 

type IngestPutGeoipDatabase func(id string, body io.Reader, o ...func(*IngestPutGeoipDatabaseRequest)) (*Response, error)

IngestPutGeoipDatabase puts the configuration for a geoip database to be downloaded

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/put-geoip-database-api.html.

func (IngestPutGeoipDatabase) WithContext ¶ added in v8.15.0 

func (f IngestPutGeoipDatabase) WithContext(v context.Context) func(*IngestPutGeoipDatabaseRequest)

WithContext sets the request context.

func (IngestPutGeoipDatabase) WithErrorTrace ¶ added in v8.15.0 

func (f IngestPutGeoipDatabase) WithErrorTrace() func(*IngestPutGeoipDatabaseRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IngestPutGeoipDatabase) WithFilterPath ¶ added in v8.15.0 

func (f IngestPutGeoipDatabase) WithFilterPath(v ...string) func(*IngestPutGeoipDatabaseRequest)

WithFilterPath filters the properties of the response body.

func (IngestPutGeoipDatabase) WithHeader ¶ added in v8.15.0 

func (f IngestPutGeoipDatabase) WithHeader(h map[string]string) func(*IngestPutGeoipDatabaseRequest)

WithHeader adds the headers to the HTTP request.

func (IngestPutGeoipDatabase) WithHuman ¶ added in v8.15.0 

func (f IngestPutGeoipDatabase) WithHuman() func(*IngestPutGeoipDatabaseRequest)

WithHuman makes statistical values human-readable.

func (IngestPutGeoipDatabase) WithOpaqueID ¶ added in v8.15.0 

func (f IngestPutGeoipDatabase) WithOpaqueID(s string) func(*IngestPutGeoipDatabaseRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IngestPutGeoipDatabase) WithPretty ¶ added in v8.15.0 

func (f IngestPutGeoipDatabase) WithPretty() func(*IngestPutGeoipDatabaseRequest)

WithPretty makes the response body pretty-printed.

type IngestPutGeoipDatabaseRequest ¶ added in v8.15.0 

type IngestPutGeoipDatabaseRequest struct {
	DocumentID string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IngestPutGeoipDatabaseRequest configures the Ingest Put Geoip Database API request.

func (IngestPutGeoipDatabaseRequest) Do ¶ added in v8.15.0 

func (r IngestPutGeoipDatabaseRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IngestPutIPLocationDatabase ¶ added in v8.16.0 

type IngestPutIPLocationDatabase func(id string, body io.Reader, o ...func(*IngestPutIPLocationDatabaseRequest)) (*Response, error)

IngestPutIPLocationDatabase puts the configuration for a ip location database to be downloaded

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/put-ip-location-database-api.html.

func (IngestPutIPLocationDatabase) WithContext ¶ added in v8.16.0 

func (f IngestPutIPLocationDatabase) WithContext(v context.Context) func(*IngestPutIPLocationDatabaseRequest)

WithContext sets the request context.

func (IngestPutIPLocationDatabase) WithErrorTrace ¶ added in v8.16.0 

func (f IngestPutIPLocationDatabase) WithErrorTrace() func(*IngestPutIPLocationDatabaseRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IngestPutIPLocationDatabase) WithFilterPath ¶ added in v8.16.0 

func (f IngestPutIPLocationDatabase) WithFilterPath(v ...string) func(*IngestPutIPLocationDatabaseRequest)

WithFilterPath filters the properties of the response body.

func (IngestPutIPLocationDatabase) WithHeader ¶ added in v8.16.0 

func (f IngestPutIPLocationDatabase) WithHeader(h map[string]string) func(*IngestPutIPLocationDatabaseRequest)

WithHeader adds the headers to the HTTP request.

func (IngestPutIPLocationDatabase) WithHuman ¶ added in v8.16.0 

func (f IngestPutIPLocationDatabase) WithHuman() func(*IngestPutIPLocationDatabaseRequest)

WithHuman makes statistical values human-readable.

func (IngestPutIPLocationDatabase) WithOpaqueID ¶ added in v8.16.0 

func (f IngestPutIPLocationDatabase) WithOpaqueID(s string) func(*IngestPutIPLocationDatabaseRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IngestPutIPLocationDatabase) WithPretty ¶ added in v8.16.0 

func (f IngestPutIPLocationDatabase) WithPretty() func(*IngestPutIPLocationDatabaseRequest)

WithPretty makes the response body pretty-printed.

type IngestPutIPLocationDatabaseRequest ¶ added in v8.16.0 

type IngestPutIPLocationDatabaseRequest struct {
	DocumentID string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IngestPutIPLocationDatabaseRequest configures the Ingest PutIP Location Database API request.

func (IngestPutIPLocationDatabaseRequest) Do ¶ added in v8.16.0 

func (r IngestPutIPLocationDatabaseRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IngestPutPipeline ¶ 

type IngestPutPipeline func(id string, body io.Reader, o ...func(*IngestPutPipelineRequest)) (*Response, error)

IngestPutPipeline creates or updates a pipeline.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/put-pipeline-api.html.

func (IngestPutPipeline) WithContext ¶ 

func (f IngestPutPipeline) WithContext(v context.Context) func(*IngestPutPipelineRequest)

WithContext sets the request context.

func (IngestPutPipeline) WithErrorTrace ¶ 

func (f IngestPutPipeline) WithErrorTrace() func(*IngestPutPipelineRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IngestPutPipeline) WithFilterPath ¶ 

func (f IngestPutPipeline) WithFilterPath(v ...string) func(*IngestPutPipelineRequest)

WithFilterPath filters the properties of the response body.

func (IngestPutPipeline) WithHeader ¶ 

func (f IngestPutPipeline) WithHeader(h map[string]string) func(*IngestPutPipelineRequest)

WithHeader adds the headers to the HTTP request.

func (IngestPutPipeline) WithHuman ¶ 

func (f IngestPutPipeline) WithHuman() func(*IngestPutPipelineRequest)

WithHuman makes statistical values human-readable.

func (IngestPutPipeline) WithIfVersion ¶ 

func (f IngestPutPipeline) WithIfVersion(v int) func(*IngestPutPipelineRequest)

WithIfVersion - required version for optimistic concurrency control for pipeline updates.

func (IngestPutPipeline) WithMasterTimeout ¶ 

func (f IngestPutPipeline) WithMasterTimeout(v time.Duration) func(*IngestPutPipelineRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (IngestPutPipeline) WithOpaqueID ¶ 

func (f IngestPutPipeline) WithOpaqueID(s string) func(*IngestPutPipelineRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IngestPutPipeline) WithPretty ¶ 

func (f IngestPutPipeline) WithPretty() func(*IngestPutPipelineRequest)

WithPretty makes the response body pretty-printed.

func (IngestPutPipeline) WithTimeout ¶ 

func (f IngestPutPipeline) WithTimeout(v time.Duration) func(*IngestPutPipelineRequest)

WithTimeout - explicit operation timeout.

type IngestPutPipelineRequest ¶ 

type IngestPutPipelineRequest struct {
	PipelineID string

	Body io.Reader

	IfVersion     *int
	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IngestPutPipelineRequest configures the Ingest Put Pipeline API request.

func (IngestPutPipelineRequest) Do ¶ 

func (r IngestPutPipelineRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type IngestSimulate ¶ 

type IngestSimulate func(body io.Reader, o ...func(*IngestSimulateRequest)) (*Response, error)

IngestSimulate allows to simulate a pipeline with example documents.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html.

func (IngestSimulate) WithContext ¶ 

func (f IngestSimulate) WithContext(v context.Context) func(*IngestSimulateRequest)

WithContext sets the request context.

func (IngestSimulate) WithErrorTrace ¶ 

func (f IngestSimulate) WithErrorTrace() func(*IngestSimulateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (IngestSimulate) WithFilterPath ¶ 

func (f IngestSimulate) WithFilterPath(v ...string) func(*IngestSimulateRequest)

WithFilterPath filters the properties of the response body.

func (IngestSimulate) WithHeader ¶ 

func (f IngestSimulate) WithHeader(h map[string]string) func(*IngestSimulateRequest)

WithHeader adds the headers to the HTTP request.

func (IngestSimulate) WithHuman ¶ 

func (f IngestSimulate) WithHuman() func(*IngestSimulateRequest)

WithHuman makes statistical values human-readable.

func (IngestSimulate) WithOpaqueID ¶ 

func (f IngestSimulate) WithOpaqueID(s string) func(*IngestSimulateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (IngestSimulate) WithPipelineID ¶ 

func (f IngestSimulate) WithPipelineID(v string) func(*IngestSimulateRequest)

WithPipelineID - pipeline ID.

func (IngestSimulate) WithPretty ¶ 

func (f IngestSimulate) WithPretty() func(*IngestSimulateRequest)

WithPretty makes the response body pretty-printed.

func (IngestSimulate) WithVerbose ¶ 

func (f IngestSimulate) WithVerbose(v bool) func(*IngestSimulateRequest)

WithVerbose - verbose mode. display data output for each processor in executed pipeline.

type IngestSimulateRequest ¶ 

type IngestSimulateRequest struct {
	PipelineID string

	Body io.Reader

	Verbose *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

IngestSimulateRequest configures the Ingest Simulate API request.

func (IngestSimulateRequest) Do ¶ 

func (r IngestSimulateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Instrumentation ¶ added in v8.12.0 

type Instrumentation elastictransport.Instrumentation

Instrumentation defines the interface for the instrumentation API.

type Instrumented ¶ added in v8.12.0 

type Instrumented elastictransport.Instrumented

Instrumented allows to retrieve the current transport Instrumentation

type KnnSearch ¶ 

type KnnSearch func(index []string, o ...func(*KnnSearchRequest)) (*Response, error)

KnnSearch performs a kNN search.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html.

func (KnnSearch) WithBody ¶ 

func (f KnnSearch) WithBody(v io.Reader) func(*KnnSearchRequest)

WithBody - The search definition.

func (KnnSearch) WithContext ¶ 

func (f KnnSearch) WithContext(v context.Context) func(*KnnSearchRequest)

WithContext sets the request context.

func (KnnSearch) WithErrorTrace ¶ 

func (f KnnSearch) WithErrorTrace() func(*KnnSearchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (KnnSearch) WithFilterPath ¶ 

func (f KnnSearch) WithFilterPath(v ...string) func(*KnnSearchRequest)

WithFilterPath filters the properties of the response body.

func (KnnSearch) WithHeader ¶ 

func (f KnnSearch) WithHeader(h map[string]string) func(*KnnSearchRequest)

WithHeader adds the headers to the HTTP request.

func (KnnSearch) WithHuman ¶ 

func (f KnnSearch) WithHuman() func(*KnnSearchRequest)

WithHuman makes statistical values human-readable.

func (KnnSearch) WithOpaqueID ¶ 

func (f KnnSearch) WithOpaqueID(s string) func(*KnnSearchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (KnnSearch) WithPretty ¶ 

func (f KnnSearch) WithPretty() func(*KnnSearchRequest)

WithPretty makes the response body pretty-printed.

func (KnnSearch) WithRouting ¶ 

func (f KnnSearch) WithRouting(v ...string) func(*KnnSearchRequest)

WithRouting - a list of specific routing values.

type KnnSearchRequest ¶ 

type KnnSearchRequest struct {
	Index []string

	Body io.Reader

	Routing []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

KnnSearchRequest configures the Knn Search API request.

func (KnnSearchRequest) Do ¶ 

func (r KnnSearchRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type License ¶ 

type License struct {
	Delete         LicenseDelete
	GetBasicStatus LicenseGetBasicStatus
	Get            LicenseGet
	GetTrialStatus LicenseGetTrialStatus
	Post           LicensePost
	PostStartBasic LicensePostStartBasic
	PostStartTrial LicensePostStartTrial
}

License contains the License APIs

type LicenseDelete ¶ 

type LicenseDelete func(o ...func(*LicenseDeleteRequest)) (*Response, error)

LicenseDelete - Deletes licensing information for the cluster

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html.

func (LicenseDelete) WithContext ¶ 

func (f LicenseDelete) WithContext(v context.Context) func(*LicenseDeleteRequest)

WithContext sets the request context.

func (LicenseDelete) WithErrorTrace ¶ 

func (f LicenseDelete) WithErrorTrace() func(*LicenseDeleteRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (LicenseDelete) WithFilterPath ¶ 

func (f LicenseDelete) WithFilterPath(v ...string) func(*LicenseDeleteRequest)

WithFilterPath filters the properties of the response body.

func (LicenseDelete) WithHeader ¶ 

func (f LicenseDelete) WithHeader(h map[string]string) func(*LicenseDeleteRequest)

WithHeader adds the headers to the HTTP request.

func (LicenseDelete) WithHuman ¶ 

func (f LicenseDelete) WithHuman() func(*LicenseDeleteRequest)

WithHuman makes statistical values human-readable.

func (LicenseDelete) WithMasterTimeout ¶ added in v8.15.0 

func (f LicenseDelete) WithMasterTimeout(v time.Duration) func(*LicenseDeleteRequest)

WithMasterTimeout - timeout for processing on master node.

func (LicenseDelete) WithOpaqueID ¶ 

func (f LicenseDelete) WithOpaqueID(s string) func(*LicenseDeleteRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (LicenseDelete) WithPretty ¶ 

func (f LicenseDelete) WithPretty() func(*LicenseDeleteRequest)

WithPretty makes the response body pretty-printed.

func (LicenseDelete) WithTimeout ¶ added in v8.15.0 

func (f LicenseDelete) WithTimeout(v time.Duration) func(*LicenseDeleteRequest)

WithTimeout - timeout for acknowledgement of update from all nodes in cluster.

type LicenseDeleteRequest ¶ 

type LicenseDeleteRequest struct {
	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

LicenseDeleteRequest configures the License Delete API request.

func (LicenseDeleteRequest) Do ¶ 

func (r LicenseDeleteRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type LicenseGet ¶ 

type LicenseGet func(o ...func(*LicenseGetRequest)) (*Response, error)

LicenseGet - Retrieves licensing information for the cluster

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html.

func (LicenseGet) WithAcceptEnterprise ¶ 

func (f LicenseGet) WithAcceptEnterprise(v bool) func(*LicenseGetRequest)

WithAcceptEnterprise - supported for backwards compatibility with 7.x. if this param is used it must be set to true.

func (LicenseGet) WithContext ¶ 

func (f LicenseGet) WithContext(v context.Context) func(*LicenseGetRequest)

WithContext sets the request context.

func (LicenseGet) WithErrorTrace ¶ 

func (f LicenseGet) WithErrorTrace() func(*LicenseGetRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (LicenseGet) WithFilterPath ¶ 

func (f LicenseGet) WithFilterPath(v ...string) func(*LicenseGetRequest)

WithFilterPath filters the properties of the response body.

func (LicenseGet) WithHeader ¶ 

func (f LicenseGet) WithHeader(h map[string]string) func(*LicenseGetRequest)

WithHeader adds the headers to the HTTP request.

func (LicenseGet) WithHuman ¶ 

func (f LicenseGet) WithHuman() func(*LicenseGetRequest)

WithHuman makes statistical values human-readable.

func (LicenseGet) WithLocal ¶ 

func (f LicenseGet) WithLocal(v bool) func(*LicenseGetRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (LicenseGet) WithOpaqueID ¶ 

func (f LicenseGet) WithOpaqueID(s string) func(*LicenseGetRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (LicenseGet) WithPretty ¶ 

func (f LicenseGet) WithPretty() func(*LicenseGetRequest)

WithPretty makes the response body pretty-printed.

type LicenseGetBasicStatus ¶ 

type LicenseGetBasicStatus func(o ...func(*LicenseGetBasicStatusRequest)) (*Response, error)

LicenseGetBasicStatus - Retrieves information about the status of the basic license.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html.

func (LicenseGetBasicStatus) WithContext ¶ 

func (f LicenseGetBasicStatus) WithContext(v context.Context) func(*LicenseGetBasicStatusRequest)

WithContext sets the request context.

func (LicenseGetBasicStatus) WithErrorTrace ¶ 

func (f LicenseGetBasicStatus) WithErrorTrace() func(*LicenseGetBasicStatusRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (LicenseGetBasicStatus) WithFilterPath ¶ 

func (f LicenseGetBasicStatus) WithFilterPath(v ...string) func(*LicenseGetBasicStatusRequest)

WithFilterPath filters the properties of the response body.

func (LicenseGetBasicStatus) WithHeader ¶ 

func (f LicenseGetBasicStatus) WithHeader(h map[string]string) func(*LicenseGetBasicStatusRequest)

WithHeader adds the headers to the HTTP request.

func (LicenseGetBasicStatus) WithHuman ¶ 

func (f LicenseGetBasicStatus) WithHuman() func(*LicenseGetBasicStatusRequest)

WithHuman makes statistical values human-readable.

func (LicenseGetBasicStatus) WithOpaqueID ¶ 

func (f LicenseGetBasicStatus) WithOpaqueID(s string) func(*LicenseGetBasicStatusRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (LicenseGetBasicStatus) WithPretty ¶ 

func (f LicenseGetBasicStatus) WithPretty() func(*LicenseGetBasicStatusRequest)

WithPretty makes the response body pretty-printed.

type LicenseGetBasicStatusRequest ¶ 

type LicenseGetBasicStatusRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

LicenseGetBasicStatusRequest configures the License Get Basic Status API request.

func (LicenseGetBasicStatusRequest) Do ¶ 

func (r LicenseGetBasicStatusRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type LicenseGetRequest ¶ 

type LicenseGetRequest struct {
	AcceptEnterprise *bool
	Local            *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

LicenseGetRequest configures the License Get API request.

func (LicenseGetRequest) Do ¶ 

func (r LicenseGetRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type LicenseGetTrialStatus ¶ 

type LicenseGetTrialStatus func(o ...func(*LicenseGetTrialStatusRequest)) (*Response, error)

LicenseGetTrialStatus - Retrieves information about the status of the trial license.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html.

func (LicenseGetTrialStatus) WithContext ¶ 

func (f LicenseGetTrialStatus) WithContext(v context.Context) func(*LicenseGetTrialStatusRequest)

WithContext sets the request context.

func (LicenseGetTrialStatus) WithErrorTrace ¶ 

func (f LicenseGetTrialStatus) WithErrorTrace() func(*LicenseGetTrialStatusRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (LicenseGetTrialStatus) WithFilterPath ¶ 

func (f LicenseGetTrialStatus) WithFilterPath(v ...string) func(*LicenseGetTrialStatusRequest)

WithFilterPath filters the properties of the response body.

func (LicenseGetTrialStatus) WithHeader ¶ 

func (f LicenseGetTrialStatus) WithHeader(h map[string]string) func(*LicenseGetTrialStatusRequest)

WithHeader adds the headers to the HTTP request.

func (LicenseGetTrialStatus) WithHuman ¶ 

func (f LicenseGetTrialStatus) WithHuman() func(*LicenseGetTrialStatusRequest)

WithHuman makes statistical values human-readable.

func (LicenseGetTrialStatus) WithOpaqueID ¶ 

func (f LicenseGetTrialStatus) WithOpaqueID(s string) func(*LicenseGetTrialStatusRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (LicenseGetTrialStatus) WithPretty ¶ 

func (f LicenseGetTrialStatus) WithPretty() func(*LicenseGetTrialStatusRequest)

WithPretty makes the response body pretty-printed.

type LicenseGetTrialStatusRequest ¶ 

type LicenseGetTrialStatusRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

LicenseGetTrialStatusRequest configures the License Get Trial Status API request.

func (LicenseGetTrialStatusRequest) Do ¶ 

func (r LicenseGetTrialStatusRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type LicensePost ¶ 

type LicensePost func(o ...func(*LicensePostRequest)) (*Response, error)

LicensePost - Updates the license for the cluster.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html.

func (LicensePost) WithAcknowledge ¶ 

func (f LicensePost) WithAcknowledge(v bool) func(*LicensePostRequest)

WithAcknowledge - whether the user has acknowledged acknowledge messages (default: false).

func (LicensePost) WithBody ¶ 

func (f LicensePost) WithBody(v io.Reader) func(*LicensePostRequest)

WithBody - licenses to be installed.

func (LicensePost) WithContext ¶ 

func (f LicensePost) WithContext(v context.Context) func(*LicensePostRequest)

WithContext sets the request context.

func (LicensePost) WithErrorTrace ¶ 

func (f LicensePost) WithErrorTrace() func(*LicensePostRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (LicensePost) WithFilterPath ¶ 

func (f LicensePost) WithFilterPath(v ...string) func(*LicensePostRequest)

WithFilterPath filters the properties of the response body.

func (LicensePost) WithHeader ¶ 

func (f LicensePost) WithHeader(h map[string]string) func(*LicensePostRequest)

WithHeader adds the headers to the HTTP request.

func (LicensePost) WithHuman ¶ 

func (f LicensePost) WithHuman() func(*LicensePostRequest)

WithHuman makes statistical values human-readable.

func (LicensePost) WithMasterTimeout ¶ added in v8.15.0 

func (f LicensePost) WithMasterTimeout(v time.Duration) func(*LicensePostRequest)

WithMasterTimeout - timeout for processing on master node.

func (LicensePost) WithOpaqueID ¶ 

func (f LicensePost) WithOpaqueID(s string) func(*LicensePostRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (LicensePost) WithPretty ¶ 

func (f LicensePost) WithPretty() func(*LicensePostRequest)

WithPretty makes the response body pretty-printed.

func (LicensePost) WithTimeout ¶ added in v8.15.0 

func (f LicensePost) WithTimeout(v time.Duration) func(*LicensePostRequest)

WithTimeout - timeout for acknowledgement of update from all nodes in cluster.

type LicensePostRequest ¶ 

type LicensePostRequest struct {
	Body io.Reader

	Acknowledge   *bool
	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

LicensePostRequest configures the License Post API request.

func (LicensePostRequest) Do ¶ 

func (r LicensePostRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type LicensePostStartBasic ¶ 

type LicensePostStartBasic func(o ...func(*LicensePostStartBasicRequest)) (*Response, error)

LicensePostStartBasic - Starts an indefinite basic license.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html.

func (LicensePostStartBasic) WithAcknowledge ¶ 

func (f LicensePostStartBasic) WithAcknowledge(v bool) func(*LicensePostStartBasicRequest)

WithAcknowledge - whether the user has acknowledged acknowledge messages (default: false).

func (LicensePostStartBasic) WithContext ¶ 

func (f LicensePostStartBasic) WithContext(v context.Context) func(*LicensePostStartBasicRequest)

WithContext sets the request context.

func (LicensePostStartBasic) WithErrorTrace ¶ 

func (f LicensePostStartBasic) WithErrorTrace() func(*LicensePostStartBasicRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (LicensePostStartBasic) WithFilterPath ¶ 

func (f LicensePostStartBasic) WithFilterPath(v ...string) func(*LicensePostStartBasicRequest)

WithFilterPath filters the properties of the response body.

func (LicensePostStartBasic) WithHeader ¶ 

func (f LicensePostStartBasic) WithHeader(h map[string]string) func(*LicensePostStartBasicRequest)

WithHeader adds the headers to the HTTP request.

func (LicensePostStartBasic) WithHuman ¶ 

func (f LicensePostStartBasic) WithHuman() func(*LicensePostStartBasicRequest)

WithHuman makes statistical values human-readable.

func (LicensePostStartBasic) WithMasterTimeout ¶ added in v8.15.0 

func (f LicensePostStartBasic) WithMasterTimeout(v time.Duration) func(*LicensePostStartBasicRequest)

WithMasterTimeout - timeout for processing on master node.

func (LicensePostStartBasic) WithOpaqueID ¶ 

func (f LicensePostStartBasic) WithOpaqueID(s string) func(*LicensePostStartBasicRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (LicensePostStartBasic) WithPretty ¶ 

func (f LicensePostStartBasic) WithPretty() func(*LicensePostStartBasicRequest)

WithPretty makes the response body pretty-printed.

func (LicensePostStartBasic) WithTimeout ¶ added in v8.15.0 

func (f LicensePostStartBasic) WithTimeout(v time.Duration) func(*LicensePostStartBasicRequest)

WithTimeout - timeout for acknowledgement of update from all nodes in cluster.

type LicensePostStartBasicRequest ¶ 

type LicensePostStartBasicRequest struct {
	Acknowledge   *bool
	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

LicensePostStartBasicRequest configures the License Post Start Basic API request.

func (LicensePostStartBasicRequest) Do ¶ 

func (r LicensePostStartBasicRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type LicensePostStartTrial ¶ 

type LicensePostStartTrial func(o ...func(*LicensePostStartTrialRequest)) (*Response, error)

LicensePostStartTrial - starts a limited time trial license.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html.

func (LicensePostStartTrial) WithAcknowledge ¶ 

func (f LicensePostStartTrial) WithAcknowledge(v bool) func(*LicensePostStartTrialRequest)

WithAcknowledge - whether the user has acknowledged acknowledge messages (default: false).

func (LicensePostStartTrial) WithContext ¶ 

func (f LicensePostStartTrial) WithContext(v context.Context) func(*LicensePostStartTrialRequest)

WithContext sets the request context.

func (LicensePostStartTrial) WithDocumentType ¶ 

func (f LicensePostStartTrial) WithDocumentType(v string) func(*LicensePostStartTrialRequest)

WithDocumentType - the type of trial license to generate (default: "trial").

func (LicensePostStartTrial) WithErrorTrace ¶ 

func (f LicensePostStartTrial) WithErrorTrace() func(*LicensePostStartTrialRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (LicensePostStartTrial) WithFilterPath ¶ 

func (f LicensePostStartTrial) WithFilterPath(v ...string) func(*LicensePostStartTrialRequest)

WithFilterPath filters the properties of the response body.

func (LicensePostStartTrial) WithHeader ¶ 

func (f LicensePostStartTrial) WithHeader(h map[string]string) func(*LicensePostStartTrialRequest)

WithHeader adds the headers to the HTTP request.

func (LicensePostStartTrial) WithHuman ¶ 

func (f LicensePostStartTrial) WithHuman() func(*LicensePostStartTrialRequest)

WithHuman makes statistical values human-readable.

func (LicensePostStartTrial) WithMasterTimeout ¶ added in v8.15.0 

func (f LicensePostStartTrial) WithMasterTimeout(v time.Duration) func(*LicensePostStartTrialRequest)

WithMasterTimeout - timeout for processing on master node.

func (LicensePostStartTrial) WithOpaqueID ¶ 

func (f LicensePostStartTrial) WithOpaqueID(s string) func(*LicensePostStartTrialRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (LicensePostStartTrial) WithPretty ¶ 

func (f LicensePostStartTrial) WithPretty() func(*LicensePostStartTrialRequest)

WithPretty makes the response body pretty-printed.

type LicensePostStartTrialRequest ¶ 

type LicensePostStartTrialRequest struct {
	Acknowledge   *bool
	MasterTimeout time.Duration
	DocumentType  string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

LicensePostStartTrialRequest configures the License Post Start Trial API request.

func (LicensePostStartTrialRequest) Do ¶ 

func (r LicensePostStartTrialRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type LogstashDeletePipeline ¶ 

type LogstashDeletePipeline func(id string, o ...func(*LogstashDeletePipelineRequest)) (*Response, error)

LogstashDeletePipeline - Deletes Logstash Pipelines used by Central Management

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html.

func (LogstashDeletePipeline) WithContext ¶ 

func (f LogstashDeletePipeline) WithContext(v context.Context) func(*LogstashDeletePipelineRequest)

WithContext sets the request context.

func (LogstashDeletePipeline) WithErrorTrace ¶ 

func (f LogstashDeletePipeline) WithErrorTrace() func(*LogstashDeletePipelineRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (LogstashDeletePipeline) WithFilterPath ¶ 

func (f LogstashDeletePipeline) WithFilterPath(v ...string) func(*LogstashDeletePipelineRequest)

WithFilterPath filters the properties of the response body.

func (LogstashDeletePipeline) WithHeader ¶ 

func (f LogstashDeletePipeline) WithHeader(h map[string]string) func(*LogstashDeletePipelineRequest)

WithHeader adds the headers to the HTTP request.

func (LogstashDeletePipeline) WithHuman ¶ 

func (f LogstashDeletePipeline) WithHuman() func(*LogstashDeletePipelineRequest)

WithHuman makes statistical values human-readable.

func (LogstashDeletePipeline) WithOpaqueID ¶ 

func (f LogstashDeletePipeline) WithOpaqueID(s string) func(*LogstashDeletePipelineRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (LogstashDeletePipeline) WithPretty ¶ 

func (f LogstashDeletePipeline) WithPretty() func(*LogstashDeletePipelineRequest)

WithPretty makes the response body pretty-printed.

type LogstashDeletePipelineRequest ¶ 

type LogstashDeletePipelineRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

LogstashDeletePipelineRequest configures the Logstash Delete Pipeline API request.

func (LogstashDeletePipelineRequest) Do ¶ 

func (r LogstashDeletePipelineRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type LogstashGetPipeline ¶ 

type LogstashGetPipeline func(o ...func(*LogstashGetPipelineRequest)) (*Response, error)

LogstashGetPipeline - Retrieves Logstash Pipelines used by Central Management

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html.

func (LogstashGetPipeline) WithContext ¶ 

func (f LogstashGetPipeline) WithContext(v context.Context) func(*LogstashGetPipelineRequest)

WithContext sets the request context.

func (LogstashGetPipeline) WithDocumentID ¶ added in v8.7.1 

func (f LogstashGetPipeline) WithDocumentID(v string) func(*LogstashGetPipelineRequest)

WithDocumentID - a list of pipeline ids.

func (LogstashGetPipeline) WithErrorTrace ¶ 

func (f LogstashGetPipeline) WithErrorTrace() func(*LogstashGetPipelineRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (LogstashGetPipeline) WithFilterPath ¶ 

func (f LogstashGetPipeline) WithFilterPath(v ...string) func(*LogstashGetPipelineRequest)

WithFilterPath filters the properties of the response body.

func (LogstashGetPipeline) WithHeader ¶ 

func (f LogstashGetPipeline) WithHeader(h map[string]string) func(*LogstashGetPipelineRequest)

WithHeader adds the headers to the HTTP request.

func (LogstashGetPipeline) WithHuman ¶ 

func (f LogstashGetPipeline) WithHuman() func(*LogstashGetPipelineRequest)

WithHuman makes statistical values human-readable.

func (LogstashGetPipeline) WithOpaqueID ¶ 

func (f LogstashGetPipeline) WithOpaqueID(s string) func(*LogstashGetPipelineRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (LogstashGetPipeline) WithPretty ¶ 

func (f LogstashGetPipeline) WithPretty() func(*LogstashGetPipelineRequest)

WithPretty makes the response body pretty-printed.

type LogstashGetPipelineRequest ¶ 

type LogstashGetPipelineRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

LogstashGetPipelineRequest configures the Logstash Get Pipeline API request.

func (LogstashGetPipelineRequest) Do ¶ 

func (r LogstashGetPipelineRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type LogstashPutPipeline ¶ 

type LogstashPutPipeline func(id string, body io.Reader, o ...func(*LogstashPutPipelineRequest)) (*Response, error)

LogstashPutPipeline - Adds and updates Logstash Pipelines used for Central Management

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html.

func (LogstashPutPipeline) WithContext ¶ 

func (f LogstashPutPipeline) WithContext(v context.Context) func(*LogstashPutPipelineRequest)

WithContext sets the request context.

func (LogstashPutPipeline) WithErrorTrace ¶ 

func (f LogstashPutPipeline) WithErrorTrace() func(*LogstashPutPipelineRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (LogstashPutPipeline) WithFilterPath ¶ 

func (f LogstashPutPipeline) WithFilterPath(v ...string) func(*LogstashPutPipelineRequest)

WithFilterPath filters the properties of the response body.

func (LogstashPutPipeline) WithHeader ¶ 

func (f LogstashPutPipeline) WithHeader(h map[string]string) func(*LogstashPutPipelineRequest)

WithHeader adds the headers to the HTTP request.

func (LogstashPutPipeline) WithHuman ¶ 

func (f LogstashPutPipeline) WithHuman() func(*LogstashPutPipelineRequest)

WithHuman makes statistical values human-readable.

func (LogstashPutPipeline) WithOpaqueID ¶ 

func (f LogstashPutPipeline) WithOpaqueID(s string) func(*LogstashPutPipelineRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (LogstashPutPipeline) WithPretty ¶ 

func (f LogstashPutPipeline) WithPretty() func(*LogstashPutPipelineRequest)

WithPretty makes the response body pretty-printed.

type LogstashPutPipelineRequest ¶ 

type LogstashPutPipelineRequest struct {
	DocumentID string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

LogstashPutPipelineRequest configures the Logstash Put Pipeline API request.

func (LogstashPutPipelineRequest) Do ¶ 

func (r LogstashPutPipelineRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ML ¶ 

type ML struct {
	ClearTrainedModelDeploymentCache MLClearTrainedModelDeploymentCache
	CloseJob                         MLCloseJob
	DeleteCalendarEvent              MLDeleteCalendarEvent
	DeleteCalendarJob                MLDeleteCalendarJob
	DeleteCalendar                   MLDeleteCalendar
	DeleteDataFrameAnalytics         MLDeleteDataFrameAnalytics
	DeleteDatafeed                   MLDeleteDatafeed
	DeleteExpiredData                MLDeleteExpiredData
	DeleteFilter                     MLDeleteFilter
	DeleteForecast                   MLDeleteForecast
	DeleteJob                        MLDeleteJob
	DeleteModelSnapshot              MLDeleteModelSnapshot
	DeleteTrainedModelAlias          MLDeleteTrainedModelAlias
	DeleteTrainedModel               MLDeleteTrainedModel
	EstimateModelMemory              MLEstimateModelMemory
	EvaluateDataFrame                MLEvaluateDataFrame
	ExplainDataFrameAnalytics        MLExplainDataFrameAnalytics
	FlushJob                         MLFlushJob
	Forecast                         MLForecast
	GetBuckets                       MLGetBuckets
	GetCalendarEvents                MLGetCalendarEvents
	GetCalendars                     MLGetCalendars
	GetCategories                    MLGetCategories
	GetDataFrameAnalytics            MLGetDataFrameAnalytics
	GetDataFrameAnalyticsStats       MLGetDataFrameAnalyticsStats
	GetDatafeedStats                 MLGetDatafeedStats
	GetDatafeeds                     MLGetDatafeeds
	GetFilters                       MLGetFilters
	GetInfluencers                   MLGetInfluencers
	GetJobStats                      MLGetJobStats
	GetJobs                          MLGetJobs
	GetMemoryStats                   MLGetMemoryStats
	GetModelSnapshotUpgradeStats     MLGetModelSnapshotUpgradeStats
	GetModelSnapshots                MLGetModelSnapshots
	GetOverallBuckets                MLGetOverallBuckets
	GetRecords                       MLGetRecords
	GetTrainedModels                 MLGetTrainedModels
	GetTrainedModelsStats            MLGetTrainedModelsStats
	InferTrainedModel                MLInferTrainedModel
	Info                             MLInfo
	OpenJob                          MLOpenJob
	PostCalendarEvents               MLPostCalendarEvents
	PostData                         MLPostData
	PreviewDataFrameAnalytics        MLPreviewDataFrameAnalytics
	PreviewDatafeed                  MLPreviewDatafeed
	PutCalendarJob                   MLPutCalendarJob
	PutCalendar                      MLPutCalendar
	PutDataFrameAnalytics            MLPutDataFrameAnalytics
	PutDatafeed                      MLPutDatafeed
	PutFilter                        MLPutFilter
	PutJob                           MLPutJob
	PutTrainedModelAlias             MLPutTrainedModelAlias
	PutTrainedModelDefinitionPart    MLPutTrainedModelDefinitionPart
	PutTrainedModel                  MLPutTrainedModel
	PutTrainedModelVocabulary        MLPutTrainedModelVocabulary
	ResetJob                         MLResetJob
	RevertModelSnapshot              MLRevertModelSnapshot
	SetUpgradeMode                   MLSetUpgradeMode
	StartDataFrameAnalytics          MLStartDataFrameAnalytics
	StartDatafeed                    MLStartDatafeed
	StartTrainedModelDeployment      MLStartTrainedModelDeployment
	StopDataFrameAnalytics           MLStopDataFrameAnalytics
	StopDatafeed                     MLStopDatafeed
	StopTrainedModelDeployment       MLStopTrainedModelDeployment
	UpdateDataFrameAnalytics         MLUpdateDataFrameAnalytics
	UpdateDatafeed                   MLUpdateDatafeed
	UpdateFilter                     MLUpdateFilter
	UpdateJob                        MLUpdateJob
	UpdateModelSnapshot              MLUpdateModelSnapshot
	UpdateTrainedModelDeployment     MLUpdateTrainedModelDeployment
	UpgradeJobSnapshot               MLUpgradeJobSnapshot
	ValidateDetector                 MLValidateDetector
	Validate                         MLValidate
}

ML contains the ML APIs

type MLClearTrainedModelDeploymentCache ¶ added in v8.5.0 

type MLClearTrainedModelDeploymentCache func(model_id string, o ...func(*MLClearTrainedModelDeploymentCacheRequest)) (*Response, error)

MLClearTrainedModelDeploymentCache - Clear the cached results from a trained model deployment

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-trained-model-deployment-cache.html.

func (MLClearTrainedModelDeploymentCache) WithContext ¶ added in v8.5.0 

func (f MLClearTrainedModelDeploymentCache) WithContext(v context.Context) func(*MLClearTrainedModelDeploymentCacheRequest)

WithContext sets the request context.

func (MLClearTrainedModelDeploymentCache) WithErrorTrace ¶ added in v8.5.0 

func (f MLClearTrainedModelDeploymentCache) WithErrorTrace() func(*MLClearTrainedModelDeploymentCacheRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLClearTrainedModelDeploymentCache) WithFilterPath ¶ added in v8.5.0 

func (f MLClearTrainedModelDeploymentCache) WithFilterPath(v ...string) func(*MLClearTrainedModelDeploymentCacheRequest)

WithFilterPath filters the properties of the response body.

func (MLClearTrainedModelDeploymentCache) WithHeader ¶ added in v8.5.0 

func (f MLClearTrainedModelDeploymentCache) WithHeader(h map[string]string) func(*MLClearTrainedModelDeploymentCacheRequest)

WithHeader adds the headers to the HTTP request.

func (MLClearTrainedModelDeploymentCache) WithHuman ¶ added in v8.5.0 

func (f MLClearTrainedModelDeploymentCache) WithHuman() func(*MLClearTrainedModelDeploymentCacheRequest)

WithHuman makes statistical values human-readable.

func (MLClearTrainedModelDeploymentCache) WithOpaqueID ¶ added in v8.5.0 

func (f MLClearTrainedModelDeploymentCache) WithOpaqueID(s string) func(*MLClearTrainedModelDeploymentCacheRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLClearTrainedModelDeploymentCache) WithPretty ¶ added in v8.5.0 

func (f MLClearTrainedModelDeploymentCache) WithPretty() func(*MLClearTrainedModelDeploymentCacheRequest)

WithPretty makes the response body pretty-printed.

type MLClearTrainedModelDeploymentCacheRequest ¶ added in v8.5.0 

type MLClearTrainedModelDeploymentCacheRequest struct {
	ModelID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLClearTrainedModelDeploymentCacheRequest configures the ML Clear Trained Model Deployment Cache API request.

func (MLClearTrainedModelDeploymentCacheRequest) Do ¶ added in v8.5.0 

func (r MLClearTrainedModelDeploymentCacheRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLCloseJob ¶ 

type MLCloseJob func(job_id string, o ...func(*MLCloseJobRequest)) (*Response, error)

MLCloseJob - Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html.

func (MLCloseJob) WithAllowNoMatch ¶ 

func (f MLCloseJob) WithAllowNoMatch(v bool) func(*MLCloseJobRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no jobs. (this includes `_all` string or when no jobs have been specified).

func (MLCloseJob) WithBody ¶ 

func (f MLCloseJob) WithBody(v io.Reader) func(*MLCloseJobRequest)

WithBody - The URL params optionally sent in the body.

func (MLCloseJob) WithContext ¶ 

func (f MLCloseJob) WithContext(v context.Context) func(*MLCloseJobRequest)

WithContext sets the request context.

func (MLCloseJob) WithErrorTrace ¶ 

func (f MLCloseJob) WithErrorTrace() func(*MLCloseJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLCloseJob) WithFilterPath ¶ 

func (f MLCloseJob) WithFilterPath(v ...string) func(*MLCloseJobRequest)

WithFilterPath filters the properties of the response body.

func (MLCloseJob) WithForce ¶ 

func (f MLCloseJob) WithForce(v bool) func(*MLCloseJobRequest)

WithForce - true if the job should be forcefully closed.

func (MLCloseJob) WithHeader ¶ 

func (f MLCloseJob) WithHeader(h map[string]string) func(*MLCloseJobRequest)

WithHeader adds the headers to the HTTP request.

func (MLCloseJob) WithHuman ¶ 

func (f MLCloseJob) WithHuman() func(*MLCloseJobRequest)

WithHuman makes statistical values human-readable.

func (MLCloseJob) WithOpaqueID ¶ 

func (f MLCloseJob) WithOpaqueID(s string) func(*MLCloseJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLCloseJob) WithPretty ¶ 

func (f MLCloseJob) WithPretty() func(*MLCloseJobRequest)

WithPretty makes the response body pretty-printed.

func (MLCloseJob) WithTimeout ¶ 

func (f MLCloseJob) WithTimeout(v time.Duration) func(*MLCloseJobRequest)

WithTimeout - controls the time to wait until a job has closed. default to 30 minutes.

type MLCloseJobRequest ¶ 

type MLCloseJobRequest struct {
	Body io.Reader

	JobID string

	AllowNoMatch *bool
	Force        *bool
	Timeout      time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLCloseJobRequest configures the ML Close Job API request.

func (MLCloseJobRequest) Do ¶ 

func (r MLCloseJobRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLDeleteCalendar ¶ 

type MLDeleteCalendar func(calendar_id string, o ...func(*MLDeleteCalendarRequest)) (*Response, error)

MLDeleteCalendar - Deletes a calendar.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html.

func (MLDeleteCalendar) WithContext ¶ 

func (f MLDeleteCalendar) WithContext(v context.Context) func(*MLDeleteCalendarRequest)

WithContext sets the request context.

func (MLDeleteCalendar) WithErrorTrace ¶ 

func (f MLDeleteCalendar) WithErrorTrace() func(*MLDeleteCalendarRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLDeleteCalendar) WithFilterPath ¶ 

func (f MLDeleteCalendar) WithFilterPath(v ...string) func(*MLDeleteCalendarRequest)

WithFilterPath filters the properties of the response body.

func (MLDeleteCalendar) WithHeader ¶ 

func (f MLDeleteCalendar) WithHeader(h map[string]string) func(*MLDeleteCalendarRequest)

WithHeader adds the headers to the HTTP request.

func (MLDeleteCalendar) WithHuman ¶ 

func (f MLDeleteCalendar) WithHuman() func(*MLDeleteCalendarRequest)

WithHuman makes statistical values human-readable.

func (MLDeleteCalendar) WithOpaqueID ¶ 

func (f MLDeleteCalendar) WithOpaqueID(s string) func(*MLDeleteCalendarRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLDeleteCalendar) WithPretty ¶ 

func (f MLDeleteCalendar) WithPretty() func(*MLDeleteCalendarRequest)

WithPretty makes the response body pretty-printed.

type MLDeleteCalendarEvent ¶ 

type MLDeleteCalendarEvent func(calendar_id string, event_id string, o ...func(*MLDeleteCalendarEventRequest)) (*Response, error)

MLDeleteCalendarEvent - Deletes scheduled events from a calendar.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html.

func (MLDeleteCalendarEvent) WithContext ¶ 

func (f MLDeleteCalendarEvent) WithContext(v context.Context) func(*MLDeleteCalendarEventRequest)

WithContext sets the request context.

func (MLDeleteCalendarEvent) WithErrorTrace ¶ 

func (f MLDeleteCalendarEvent) WithErrorTrace() func(*MLDeleteCalendarEventRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLDeleteCalendarEvent) WithFilterPath ¶ 

func (f MLDeleteCalendarEvent) WithFilterPath(v ...string) func(*MLDeleteCalendarEventRequest)

WithFilterPath filters the properties of the response body.

func (MLDeleteCalendarEvent) WithHeader ¶ 

func (f MLDeleteCalendarEvent) WithHeader(h map[string]string) func(*MLDeleteCalendarEventRequest)

WithHeader adds the headers to the HTTP request.

func (MLDeleteCalendarEvent) WithHuman ¶ 

func (f MLDeleteCalendarEvent) WithHuman() func(*MLDeleteCalendarEventRequest)

WithHuman makes statistical values human-readable.

func (MLDeleteCalendarEvent) WithOpaqueID ¶ 

func (f MLDeleteCalendarEvent) WithOpaqueID(s string) func(*MLDeleteCalendarEventRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLDeleteCalendarEvent) WithPretty ¶ 

func (f MLDeleteCalendarEvent) WithPretty() func(*MLDeleteCalendarEventRequest)

WithPretty makes the response body pretty-printed.

type MLDeleteCalendarEventRequest ¶ 

type MLDeleteCalendarEventRequest struct {
	CalendarID string
	EventID    string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLDeleteCalendarEventRequest configures the ML Delete Calendar Event API request.

func (MLDeleteCalendarEventRequest) Do ¶ 

func (r MLDeleteCalendarEventRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLDeleteCalendarJob ¶ 

type MLDeleteCalendarJob func(calendar_id string, job_id string, o ...func(*MLDeleteCalendarJobRequest)) (*Response, error)

MLDeleteCalendarJob - Deletes anomaly detection jobs from a calendar.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html.

func (MLDeleteCalendarJob) WithContext ¶ 

func (f MLDeleteCalendarJob) WithContext(v context.Context) func(*MLDeleteCalendarJobRequest)

WithContext sets the request context.

func (MLDeleteCalendarJob) WithErrorTrace ¶ 

func (f MLDeleteCalendarJob) WithErrorTrace() func(*MLDeleteCalendarJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLDeleteCalendarJob) WithFilterPath ¶ 

func (f MLDeleteCalendarJob) WithFilterPath(v ...string) func(*MLDeleteCalendarJobRequest)

WithFilterPath filters the properties of the response body.

func (MLDeleteCalendarJob) WithHeader ¶ 

func (f MLDeleteCalendarJob) WithHeader(h map[string]string) func(*MLDeleteCalendarJobRequest)

WithHeader adds the headers to the HTTP request.

func (MLDeleteCalendarJob) WithHuman ¶ 

func (f MLDeleteCalendarJob) WithHuman() func(*MLDeleteCalendarJobRequest)

WithHuman makes statistical values human-readable.

func (MLDeleteCalendarJob) WithOpaqueID ¶ 

func (f MLDeleteCalendarJob) WithOpaqueID(s string) func(*MLDeleteCalendarJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLDeleteCalendarJob) WithPretty ¶ 

func (f MLDeleteCalendarJob) WithPretty() func(*MLDeleteCalendarJobRequest)

WithPretty makes the response body pretty-printed.

type MLDeleteCalendarJobRequest ¶ 

type MLDeleteCalendarJobRequest struct {
	CalendarID string
	JobID      string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLDeleteCalendarJobRequest configures the ML Delete Calendar Job API request.

func (MLDeleteCalendarJobRequest) Do ¶ 

func (r MLDeleteCalendarJobRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLDeleteCalendarRequest ¶ 

type MLDeleteCalendarRequest struct {
	CalendarID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLDeleteCalendarRequest configures the ML Delete Calendar API request.

func (MLDeleteCalendarRequest) Do ¶ 

func (r MLDeleteCalendarRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLDeleteDataFrameAnalytics ¶ 

type MLDeleteDataFrameAnalytics func(id string, o ...func(*MLDeleteDataFrameAnalyticsRequest)) (*Response, error)

MLDeleteDataFrameAnalytics - Deletes an existing data frame analytics job.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html.

func (MLDeleteDataFrameAnalytics) WithContext ¶ 

func (f MLDeleteDataFrameAnalytics) WithContext(v context.Context) func(*MLDeleteDataFrameAnalyticsRequest)

WithContext sets the request context.

func (MLDeleteDataFrameAnalytics) WithErrorTrace ¶ 

func (f MLDeleteDataFrameAnalytics) WithErrorTrace() func(*MLDeleteDataFrameAnalyticsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLDeleteDataFrameAnalytics) WithFilterPath ¶ 

func (f MLDeleteDataFrameAnalytics) WithFilterPath(v ...string) func(*MLDeleteDataFrameAnalyticsRequest)

WithFilterPath filters the properties of the response body.

func (MLDeleteDataFrameAnalytics) WithForce ¶ 

func (f MLDeleteDataFrameAnalytics) WithForce(v bool) func(*MLDeleteDataFrameAnalyticsRequest)

WithForce - true if the job should be forcefully deleted.

func (MLDeleteDataFrameAnalytics) WithHeader ¶ 

func (f MLDeleteDataFrameAnalytics) WithHeader(h map[string]string) func(*MLDeleteDataFrameAnalyticsRequest)

WithHeader adds the headers to the HTTP request.

func (MLDeleteDataFrameAnalytics) WithHuman ¶ 

func (f MLDeleteDataFrameAnalytics) WithHuman() func(*MLDeleteDataFrameAnalyticsRequest)

WithHuman makes statistical values human-readable.

func (MLDeleteDataFrameAnalytics) WithOpaqueID ¶ 

func (f MLDeleteDataFrameAnalytics) WithOpaqueID(s string) func(*MLDeleteDataFrameAnalyticsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLDeleteDataFrameAnalytics) WithPretty ¶ 

func (f MLDeleteDataFrameAnalytics) WithPretty() func(*MLDeleteDataFrameAnalyticsRequest)

WithPretty makes the response body pretty-printed.

func (MLDeleteDataFrameAnalytics) WithTimeout ¶ 

func (f MLDeleteDataFrameAnalytics) WithTimeout(v time.Duration) func(*MLDeleteDataFrameAnalyticsRequest)

WithTimeout - controls the time to wait until a job is deleted. defaults to 1 minute.

type MLDeleteDataFrameAnalyticsRequest ¶ 

type MLDeleteDataFrameAnalyticsRequest struct {
	ID string

	Force   *bool
	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLDeleteDataFrameAnalyticsRequest configures the ML Delete Data Frame Analytics API request.

func (MLDeleteDataFrameAnalyticsRequest) Do ¶ 

func (r MLDeleteDataFrameAnalyticsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLDeleteDatafeed ¶ 

type MLDeleteDatafeed func(datafeed_id string, o ...func(*MLDeleteDatafeedRequest)) (*Response, error)

MLDeleteDatafeed - Deletes an existing datafeed.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html.

func (MLDeleteDatafeed) WithContext ¶ 

func (f MLDeleteDatafeed) WithContext(v context.Context) func(*MLDeleteDatafeedRequest)

WithContext sets the request context.

func (MLDeleteDatafeed) WithErrorTrace ¶ 

func (f MLDeleteDatafeed) WithErrorTrace() func(*MLDeleteDatafeedRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLDeleteDatafeed) WithFilterPath ¶ 

func (f MLDeleteDatafeed) WithFilterPath(v ...string) func(*MLDeleteDatafeedRequest)

WithFilterPath filters the properties of the response body.

func (MLDeleteDatafeed) WithForce ¶ 

func (f MLDeleteDatafeed) WithForce(v bool) func(*MLDeleteDatafeedRequest)

WithForce - true if the datafeed should be forcefully deleted.

func (MLDeleteDatafeed) WithHeader ¶ 

func (f MLDeleteDatafeed) WithHeader(h map[string]string) func(*MLDeleteDatafeedRequest)

WithHeader adds the headers to the HTTP request.

func (MLDeleteDatafeed) WithHuman ¶ 

func (f MLDeleteDatafeed) WithHuman() func(*MLDeleteDatafeedRequest)

WithHuman makes statistical values human-readable.

func (MLDeleteDatafeed) WithOpaqueID ¶ 

func (f MLDeleteDatafeed) WithOpaqueID(s string) func(*MLDeleteDatafeedRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLDeleteDatafeed) WithPretty ¶ 

func (f MLDeleteDatafeed) WithPretty() func(*MLDeleteDatafeedRequest)

WithPretty makes the response body pretty-printed.

type MLDeleteDatafeedRequest ¶ 

type MLDeleteDatafeedRequest struct {
	DatafeedID string

	Force *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLDeleteDatafeedRequest configures the ML Delete Datafeed API request.

func (MLDeleteDatafeedRequest) Do ¶ 

func (r MLDeleteDatafeedRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLDeleteExpiredData ¶ 

type MLDeleteExpiredData func(o ...func(*MLDeleteExpiredDataRequest)) (*Response, error)

MLDeleteExpiredData - Deletes expired and unused machine learning data.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html.

func (MLDeleteExpiredData) WithBody ¶ 

func (f MLDeleteExpiredData) WithBody(v io.Reader) func(*MLDeleteExpiredDataRequest)

WithBody - deleting expired data parameters.

func (MLDeleteExpiredData) WithContext ¶ 

func (f MLDeleteExpiredData) WithContext(v context.Context) func(*MLDeleteExpiredDataRequest)

WithContext sets the request context.

func (MLDeleteExpiredData) WithErrorTrace ¶ 

func (f MLDeleteExpiredData) WithErrorTrace() func(*MLDeleteExpiredDataRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLDeleteExpiredData) WithFilterPath ¶ 

func (f MLDeleteExpiredData) WithFilterPath(v ...string) func(*MLDeleteExpiredDataRequest)

WithFilterPath filters the properties of the response body.

func (MLDeleteExpiredData) WithHeader ¶ 

func (f MLDeleteExpiredData) WithHeader(h map[string]string) func(*MLDeleteExpiredDataRequest)

WithHeader adds the headers to the HTTP request.

func (MLDeleteExpiredData) WithHuman ¶ 

func (f MLDeleteExpiredData) WithHuman() func(*MLDeleteExpiredDataRequest)

WithHuman makes statistical values human-readable.

func (MLDeleteExpiredData) WithJobID ¶ 

func (f MLDeleteExpiredData) WithJobID(v string) func(*MLDeleteExpiredDataRequest)

WithJobID - the ID of the job(s) to perform expired data hygiene for.

func (MLDeleteExpiredData) WithOpaqueID ¶ 

func (f MLDeleteExpiredData) WithOpaqueID(s string) func(*MLDeleteExpiredDataRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLDeleteExpiredData) WithPretty ¶ 

func (f MLDeleteExpiredData) WithPretty() func(*MLDeleteExpiredDataRequest)

WithPretty makes the response body pretty-printed.

func (MLDeleteExpiredData) WithRequestsPerSecond ¶ 

func (f MLDeleteExpiredData) WithRequestsPerSecond(v int) func(*MLDeleteExpiredDataRequest)

WithRequestsPerSecond - the desired requests per second for the deletion processes..

func (MLDeleteExpiredData) WithTimeout ¶ 

func (f MLDeleteExpiredData) WithTimeout(v time.Duration) func(*MLDeleteExpiredDataRequest)

WithTimeout - how long can the underlying delete processes run until they are canceled.

type MLDeleteExpiredDataRequest ¶ 

type MLDeleteExpiredDataRequest struct {
	Body io.Reader

	JobID string

	RequestsPerSecond *int
	Timeout           time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLDeleteExpiredDataRequest configures the ML Delete Expired Data API request.

func (MLDeleteExpiredDataRequest) Do ¶ 

func (r MLDeleteExpiredDataRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLDeleteFilter ¶ 

type MLDeleteFilter func(filter_id string, o ...func(*MLDeleteFilterRequest)) (*Response, error)

MLDeleteFilter - Deletes a filter.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html.

func (MLDeleteFilter) WithContext ¶ 

func (f MLDeleteFilter) WithContext(v context.Context) func(*MLDeleteFilterRequest)

WithContext sets the request context.

func (MLDeleteFilter) WithErrorTrace ¶ 

func (f MLDeleteFilter) WithErrorTrace() func(*MLDeleteFilterRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLDeleteFilter) WithFilterPath ¶ 

func (f MLDeleteFilter) WithFilterPath(v ...string) func(*MLDeleteFilterRequest)

WithFilterPath filters the properties of the response body.

func (MLDeleteFilter) WithHeader ¶ 

func (f MLDeleteFilter) WithHeader(h map[string]string) func(*MLDeleteFilterRequest)

WithHeader adds the headers to the HTTP request.

func (MLDeleteFilter) WithHuman ¶ 

func (f MLDeleteFilter) WithHuman() func(*MLDeleteFilterRequest)

WithHuman makes statistical values human-readable.

func (MLDeleteFilter) WithOpaqueID ¶ 

func (f MLDeleteFilter) WithOpaqueID(s string) func(*MLDeleteFilterRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLDeleteFilter) WithPretty ¶ 

func (f MLDeleteFilter) WithPretty() func(*MLDeleteFilterRequest)

WithPretty makes the response body pretty-printed.

type MLDeleteFilterRequest ¶ 

type MLDeleteFilterRequest struct {
	FilterID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLDeleteFilterRequest configures the ML Delete Filter API request.

func (MLDeleteFilterRequest) Do ¶ 

func (r MLDeleteFilterRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLDeleteForecast ¶ 

type MLDeleteForecast func(job_id string, o ...func(*MLDeleteForecastRequest)) (*Response, error)

MLDeleteForecast - Deletes forecasts from a machine learning job.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html.

func (MLDeleteForecast) WithAllowNoForecasts ¶ 

func (f MLDeleteForecast) WithAllowNoForecasts(v bool) func(*MLDeleteForecastRequest)

WithAllowNoForecasts - whether to ignore if `_all` matches no forecasts.

func (MLDeleteForecast) WithContext ¶ 

func (f MLDeleteForecast) WithContext(v context.Context) func(*MLDeleteForecastRequest)

WithContext sets the request context.

func (MLDeleteForecast) WithErrorTrace ¶ 

func (f MLDeleteForecast) WithErrorTrace() func(*MLDeleteForecastRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLDeleteForecast) WithFilterPath ¶ 

func (f MLDeleteForecast) WithFilterPath(v ...string) func(*MLDeleteForecastRequest)

WithFilterPath filters the properties of the response body.

func (MLDeleteForecast) WithForecastID ¶ 

func (f MLDeleteForecast) WithForecastID(v string) func(*MLDeleteForecastRequest)

WithForecastID - the ID of the forecast to delete, can be comma delimited list. leaving blank implies `_all`.

func (MLDeleteForecast) WithHeader ¶ 

func (f MLDeleteForecast) WithHeader(h map[string]string) func(*MLDeleteForecastRequest)

WithHeader adds the headers to the HTTP request.

func (MLDeleteForecast) WithHuman ¶ 

func (f MLDeleteForecast) WithHuman() func(*MLDeleteForecastRequest)

WithHuman makes statistical values human-readable.

func (MLDeleteForecast) WithOpaqueID ¶ 

func (f MLDeleteForecast) WithOpaqueID(s string) func(*MLDeleteForecastRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLDeleteForecast) WithPretty ¶ 

func (f MLDeleteForecast) WithPretty() func(*MLDeleteForecastRequest)

WithPretty makes the response body pretty-printed.

func (MLDeleteForecast) WithTimeout ¶ 

func (f MLDeleteForecast) WithTimeout(v time.Duration) func(*MLDeleteForecastRequest)

WithTimeout - controls the time to wait until the forecast(s) are deleted. default to 30 seconds.

type MLDeleteForecastRequest ¶ 

type MLDeleteForecastRequest struct {
	ForecastID string
	JobID      string

	AllowNoForecasts *bool
	Timeout          time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLDeleteForecastRequest configures the ML Delete Forecast API request.

func (MLDeleteForecastRequest) Do ¶ 

func (r MLDeleteForecastRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLDeleteJob ¶ 

type MLDeleteJob func(job_id string, o ...func(*MLDeleteJobRequest)) (*Response, error)

MLDeleteJob - Deletes an existing anomaly detection job.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html.

func (MLDeleteJob) WithContext ¶ 

func (f MLDeleteJob) WithContext(v context.Context) func(*MLDeleteJobRequest)

WithContext sets the request context.

func (MLDeleteJob) WithDeleteUserAnnotations ¶ added in v8.7.0 

func (f MLDeleteJob) WithDeleteUserAnnotations(v bool) func(*MLDeleteJobRequest)

WithDeleteUserAnnotations - should annotations added by the user be deleted.

func (MLDeleteJob) WithErrorTrace ¶ 

func (f MLDeleteJob) WithErrorTrace() func(*MLDeleteJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLDeleteJob) WithFilterPath ¶ 

func (f MLDeleteJob) WithFilterPath(v ...string) func(*MLDeleteJobRequest)

WithFilterPath filters the properties of the response body.

func (MLDeleteJob) WithForce ¶ 

func (f MLDeleteJob) WithForce(v bool) func(*MLDeleteJobRequest)

WithForce - true if the job should be forcefully deleted.

func (MLDeleteJob) WithHeader ¶ 

func (f MLDeleteJob) WithHeader(h map[string]string) func(*MLDeleteJobRequest)

WithHeader adds the headers to the HTTP request.

func (MLDeleteJob) WithHuman ¶ 

func (f MLDeleteJob) WithHuman() func(*MLDeleteJobRequest)

WithHuman makes statistical values human-readable.

func (MLDeleteJob) WithOpaqueID ¶ 

func (f MLDeleteJob) WithOpaqueID(s string) func(*MLDeleteJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLDeleteJob) WithPretty ¶ 

func (f MLDeleteJob) WithPretty() func(*MLDeleteJobRequest)

WithPretty makes the response body pretty-printed.

func (MLDeleteJob) WithWaitForCompletion ¶ 

func (f MLDeleteJob) WithWaitForCompletion(v bool) func(*MLDeleteJobRequest)

WithWaitForCompletion - should this request wait until the operation has completed before returning.

type MLDeleteJobRequest ¶ 

type MLDeleteJobRequest struct {
	JobID string

	DeleteUserAnnotations *bool
	Force                 *bool
	WaitForCompletion     *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLDeleteJobRequest configures the ML Delete Job API request.

func (MLDeleteJobRequest) Do ¶ 

func (r MLDeleteJobRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLDeleteModelSnapshot ¶ 

type MLDeleteModelSnapshot func(snapshot_id string, job_id string, o ...func(*MLDeleteModelSnapshotRequest)) (*Response, error)

MLDeleteModelSnapshot - Deletes an existing model snapshot.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html.

func (MLDeleteModelSnapshot) WithContext ¶ 

func (f MLDeleteModelSnapshot) WithContext(v context.Context) func(*MLDeleteModelSnapshotRequest)

WithContext sets the request context.

func (MLDeleteModelSnapshot) WithErrorTrace ¶ 

func (f MLDeleteModelSnapshot) WithErrorTrace() func(*MLDeleteModelSnapshotRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLDeleteModelSnapshot) WithFilterPath ¶ 

func (f MLDeleteModelSnapshot) WithFilterPath(v ...string) func(*MLDeleteModelSnapshotRequest)

WithFilterPath filters the properties of the response body.

func (MLDeleteModelSnapshot) WithHeader ¶ 

func (f MLDeleteModelSnapshot) WithHeader(h map[string]string) func(*MLDeleteModelSnapshotRequest)

WithHeader adds the headers to the HTTP request.

func (MLDeleteModelSnapshot) WithHuman ¶ 

func (f MLDeleteModelSnapshot) WithHuman() func(*MLDeleteModelSnapshotRequest)

WithHuman makes statistical values human-readable.

func (MLDeleteModelSnapshot) WithOpaqueID ¶ 

func (f MLDeleteModelSnapshot) WithOpaqueID(s string) func(*MLDeleteModelSnapshotRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLDeleteModelSnapshot) WithPretty ¶ 

func (f MLDeleteModelSnapshot) WithPretty() func(*MLDeleteModelSnapshotRequest)

WithPretty makes the response body pretty-printed.

type MLDeleteModelSnapshotRequest ¶ 

type MLDeleteModelSnapshotRequest struct {
	JobID      string
	SnapshotID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLDeleteModelSnapshotRequest configures the ML Delete Model Snapshot API request.

func (MLDeleteModelSnapshotRequest) Do ¶ 

func (r MLDeleteModelSnapshotRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLDeleteTrainedModel ¶ 

type MLDeleteTrainedModel func(model_id string, o ...func(*MLDeleteTrainedModelRequest)) (*Response, error)

MLDeleteTrainedModel - Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html.

func (MLDeleteTrainedModel) WithContext ¶ 

func (f MLDeleteTrainedModel) WithContext(v context.Context) func(*MLDeleteTrainedModelRequest)

WithContext sets the request context.

func (MLDeleteTrainedModel) WithErrorTrace ¶ 

func (f MLDeleteTrainedModel) WithErrorTrace() func(*MLDeleteTrainedModelRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLDeleteTrainedModel) WithFilterPath ¶ 

func (f MLDeleteTrainedModel) WithFilterPath(v ...string) func(*MLDeleteTrainedModelRequest)

WithFilterPath filters the properties of the response body.

func (MLDeleteTrainedModel) WithForce ¶ added in v8.1.0 

func (f MLDeleteTrainedModel) WithForce(v bool) func(*MLDeleteTrainedModelRequest)

WithForce - true if the model should be forcefully deleted.

func (MLDeleteTrainedModel) WithHeader ¶ 

func (f MLDeleteTrainedModel) WithHeader(h map[string]string) func(*MLDeleteTrainedModelRequest)

WithHeader adds the headers to the HTTP request.

func (MLDeleteTrainedModel) WithHuman ¶ 

func (f MLDeleteTrainedModel) WithHuman() func(*MLDeleteTrainedModelRequest)

WithHuman makes statistical values human-readable.

func (MLDeleteTrainedModel) WithOpaqueID ¶ 

func (f MLDeleteTrainedModel) WithOpaqueID(s string) func(*MLDeleteTrainedModelRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLDeleteTrainedModel) WithPretty ¶ 

func (f MLDeleteTrainedModel) WithPretty() func(*MLDeleteTrainedModelRequest)

WithPretty makes the response body pretty-printed.

func (MLDeleteTrainedModel) WithTimeout ¶ 

func (f MLDeleteTrainedModel) WithTimeout(v time.Duration) func(*MLDeleteTrainedModelRequest)

WithTimeout - controls the amount of time to wait for the model to be deleted..

type MLDeleteTrainedModelAlias ¶ 

type MLDeleteTrainedModelAlias func(model_alias string, model_id string, o ...func(*MLDeleteTrainedModelAliasRequest)) (*Response, error)

MLDeleteTrainedModelAlias - Deletes a model alias that refers to the trained model

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html.

func (MLDeleteTrainedModelAlias) WithContext ¶ 

func (f MLDeleteTrainedModelAlias) WithContext(v context.Context) func(*MLDeleteTrainedModelAliasRequest)

WithContext sets the request context.

func (MLDeleteTrainedModelAlias) WithErrorTrace ¶ 

func (f MLDeleteTrainedModelAlias) WithErrorTrace() func(*MLDeleteTrainedModelAliasRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLDeleteTrainedModelAlias) WithFilterPath ¶ 

func (f MLDeleteTrainedModelAlias) WithFilterPath(v ...string) func(*MLDeleteTrainedModelAliasRequest)

WithFilterPath filters the properties of the response body.

func (MLDeleteTrainedModelAlias) WithHeader ¶ 

func (f MLDeleteTrainedModelAlias) WithHeader(h map[string]string) func(*MLDeleteTrainedModelAliasRequest)

WithHeader adds the headers to the HTTP request.

func (MLDeleteTrainedModelAlias) WithHuman ¶ 

func (f MLDeleteTrainedModelAlias) WithHuman() func(*MLDeleteTrainedModelAliasRequest)

WithHuman makes statistical values human-readable.

func (MLDeleteTrainedModelAlias) WithOpaqueID ¶ 

func (f MLDeleteTrainedModelAlias) WithOpaqueID(s string) func(*MLDeleteTrainedModelAliasRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLDeleteTrainedModelAlias) WithPretty ¶ 

func (f MLDeleteTrainedModelAlias) WithPretty() func(*MLDeleteTrainedModelAliasRequest)

WithPretty makes the response body pretty-printed.

type MLDeleteTrainedModelAliasRequest ¶ 

type MLDeleteTrainedModelAliasRequest struct {
	ModelAlias string
	ModelID    string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLDeleteTrainedModelAliasRequest configures the ML Delete Trained Model Alias API request.

func (MLDeleteTrainedModelAliasRequest) Do ¶ 

func (r MLDeleteTrainedModelAliasRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLDeleteTrainedModelRequest ¶ 

type MLDeleteTrainedModelRequest struct {
	ModelID string

	Force   *bool
	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLDeleteTrainedModelRequest configures the ML Delete Trained Model API request.

func (MLDeleteTrainedModelRequest) Do ¶ 

func (r MLDeleteTrainedModelRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLEstimateModelMemory ¶ 

type MLEstimateModelMemory func(body io.Reader, o ...func(*MLEstimateModelMemoryRequest)) (*Response, error)

MLEstimateModelMemory - Estimates the model memory

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html.

func (MLEstimateModelMemory) WithContext ¶ 

func (f MLEstimateModelMemory) WithContext(v context.Context) func(*MLEstimateModelMemoryRequest)

WithContext sets the request context.

func (MLEstimateModelMemory) WithErrorTrace ¶ 

func (f MLEstimateModelMemory) WithErrorTrace() func(*MLEstimateModelMemoryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLEstimateModelMemory) WithFilterPath ¶ 

func (f MLEstimateModelMemory) WithFilterPath(v ...string) func(*MLEstimateModelMemoryRequest)

WithFilterPath filters the properties of the response body.

func (MLEstimateModelMemory) WithHeader ¶ 

func (f MLEstimateModelMemory) WithHeader(h map[string]string) func(*MLEstimateModelMemoryRequest)

WithHeader adds the headers to the HTTP request.

func (MLEstimateModelMemory) WithHuman ¶ 

func (f MLEstimateModelMemory) WithHuman() func(*MLEstimateModelMemoryRequest)

WithHuman makes statistical values human-readable.

func (MLEstimateModelMemory) WithOpaqueID ¶ 

func (f MLEstimateModelMemory) WithOpaqueID(s string) func(*MLEstimateModelMemoryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLEstimateModelMemory) WithPretty ¶ 

func (f MLEstimateModelMemory) WithPretty() func(*MLEstimateModelMemoryRequest)

WithPretty makes the response body pretty-printed.

type MLEstimateModelMemoryRequest ¶ 

type MLEstimateModelMemoryRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLEstimateModelMemoryRequest configures the ML Estimate Model Memory API request.

func (MLEstimateModelMemoryRequest) Do ¶ 

func (r MLEstimateModelMemoryRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLEvaluateDataFrame ¶ 

type MLEvaluateDataFrame func(body io.Reader, o ...func(*MLEvaluateDataFrameRequest)) (*Response, error)

MLEvaluateDataFrame - Evaluates the data frame analytics for an annotated index.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html.

func (MLEvaluateDataFrame) WithContext ¶ 

func (f MLEvaluateDataFrame) WithContext(v context.Context) func(*MLEvaluateDataFrameRequest)

WithContext sets the request context.

func (MLEvaluateDataFrame) WithErrorTrace ¶ 

func (f MLEvaluateDataFrame) WithErrorTrace() func(*MLEvaluateDataFrameRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLEvaluateDataFrame) WithFilterPath ¶ 

func (f MLEvaluateDataFrame) WithFilterPath(v ...string) func(*MLEvaluateDataFrameRequest)

WithFilterPath filters the properties of the response body.

func (MLEvaluateDataFrame) WithHeader ¶ 

func (f MLEvaluateDataFrame) WithHeader(h map[string]string) func(*MLEvaluateDataFrameRequest)

WithHeader adds the headers to the HTTP request.

func (MLEvaluateDataFrame) WithHuman ¶ 

func (f MLEvaluateDataFrame) WithHuman() func(*MLEvaluateDataFrameRequest)

WithHuman makes statistical values human-readable.

func (MLEvaluateDataFrame) WithOpaqueID ¶ 

func (f MLEvaluateDataFrame) WithOpaqueID(s string) func(*MLEvaluateDataFrameRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLEvaluateDataFrame) WithPretty ¶ 

func (f MLEvaluateDataFrame) WithPretty() func(*MLEvaluateDataFrameRequest)

WithPretty makes the response body pretty-printed.

type MLEvaluateDataFrameRequest ¶ 

type MLEvaluateDataFrameRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLEvaluateDataFrameRequest configures the ML Evaluate Data Frame API request.

func (MLEvaluateDataFrameRequest) Do ¶ 

func (r MLEvaluateDataFrameRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLExplainDataFrameAnalytics ¶ 

type MLExplainDataFrameAnalytics func(o ...func(*MLExplainDataFrameAnalyticsRequest)) (*Response, error)

MLExplainDataFrameAnalytics - Explains a data frame analytics config.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html.

func (MLExplainDataFrameAnalytics) WithBody ¶ 

func (f MLExplainDataFrameAnalytics) WithBody(v io.Reader) func(*MLExplainDataFrameAnalyticsRequest)

WithBody - The data frame analytics config to explain.

func (MLExplainDataFrameAnalytics) WithContext ¶ 

func (f MLExplainDataFrameAnalytics) WithContext(v context.Context) func(*MLExplainDataFrameAnalyticsRequest)

WithContext sets the request context.

func (MLExplainDataFrameAnalytics) WithDocumentID ¶ 

func (f MLExplainDataFrameAnalytics) WithDocumentID(v string) func(*MLExplainDataFrameAnalyticsRequest)

WithDocumentID - the ID of the data frame analytics to explain.

func (MLExplainDataFrameAnalytics) WithErrorTrace ¶ 

func (f MLExplainDataFrameAnalytics) WithErrorTrace() func(*MLExplainDataFrameAnalyticsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLExplainDataFrameAnalytics) WithFilterPath ¶ 

func (f MLExplainDataFrameAnalytics) WithFilterPath(v ...string) func(*MLExplainDataFrameAnalyticsRequest)

WithFilterPath filters the properties of the response body.

func (MLExplainDataFrameAnalytics) WithHeader ¶ 

func (f MLExplainDataFrameAnalytics) WithHeader(h map[string]string) func(*MLExplainDataFrameAnalyticsRequest)

WithHeader adds the headers to the HTTP request.

func (MLExplainDataFrameAnalytics) WithHuman ¶ 

func (f MLExplainDataFrameAnalytics) WithHuman() func(*MLExplainDataFrameAnalyticsRequest)

WithHuman makes statistical values human-readable.

func (MLExplainDataFrameAnalytics) WithOpaqueID ¶ 

func (f MLExplainDataFrameAnalytics) WithOpaqueID(s string) func(*MLExplainDataFrameAnalyticsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLExplainDataFrameAnalytics) WithPretty ¶ 

func (f MLExplainDataFrameAnalytics) WithPretty() func(*MLExplainDataFrameAnalyticsRequest)

WithPretty makes the response body pretty-printed.

type MLExplainDataFrameAnalyticsRequest ¶ 

type MLExplainDataFrameAnalyticsRequest struct {
	DocumentID string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLExplainDataFrameAnalyticsRequest configures the ML Explain Data Frame Analytics API request.

func (MLExplainDataFrameAnalyticsRequest) Do ¶ 

func (r MLExplainDataFrameAnalyticsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLFlushJob ¶ 

type MLFlushJob func(job_id string, o ...func(*MLFlushJobRequest)) (*Response, error)

MLFlushJob - Forces any buffered data to be processed by the job.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html.

func (MLFlushJob) WithAdvanceTime ¶ 

func (f MLFlushJob) WithAdvanceTime(v string) func(*MLFlushJobRequest)

WithAdvanceTime - advances time to the given value generating results and updating the model for the advanced interval.

func (MLFlushJob) WithBody ¶ 

func (f MLFlushJob) WithBody(v io.Reader) func(*MLFlushJobRequest)

WithBody - Flush parameters.

func (MLFlushJob) WithCalcInterim ¶ 

func (f MLFlushJob) WithCalcInterim(v bool) func(*MLFlushJobRequest)

WithCalcInterim - calculates interim results for the most recent bucket or all buckets within the latency period.

func (MLFlushJob) WithContext ¶ 

func (f MLFlushJob) WithContext(v context.Context) func(*MLFlushJobRequest)

WithContext sets the request context.

func (MLFlushJob) WithEnd ¶ 

func (f MLFlushJob) WithEnd(v string) func(*MLFlushJobRequest)

WithEnd - when used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results.

func (MLFlushJob) WithErrorTrace ¶ 

func (f MLFlushJob) WithErrorTrace() func(*MLFlushJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLFlushJob) WithFilterPath ¶ 

func (f MLFlushJob) WithFilterPath(v ...string) func(*MLFlushJobRequest)

WithFilterPath filters the properties of the response body.

func (MLFlushJob) WithHeader ¶ 

func (f MLFlushJob) WithHeader(h map[string]string) func(*MLFlushJobRequest)

WithHeader adds the headers to the HTTP request.

func (MLFlushJob) WithHuman ¶ 

func (f MLFlushJob) WithHuman() func(*MLFlushJobRequest)

WithHuman makes statistical values human-readable.

func (MLFlushJob) WithOpaqueID ¶ 

func (f MLFlushJob) WithOpaqueID(s string) func(*MLFlushJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLFlushJob) WithPretty ¶ 

func (f MLFlushJob) WithPretty() func(*MLFlushJobRequest)

WithPretty makes the response body pretty-printed.

func (MLFlushJob) WithSkipTime ¶ 

func (f MLFlushJob) WithSkipTime(v string) func(*MLFlushJobRequest)

WithSkipTime - skips time to the given value without generating results or updating the model for the skipped interval.

func (MLFlushJob) WithStart ¶ 

func (f MLFlushJob) WithStart(v string) func(*MLFlushJobRequest)

WithStart - when used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results.

type MLFlushJobRequest ¶ 

type MLFlushJobRequest struct {
	Body io.Reader

	JobID string

	AdvanceTime string
	CalcInterim *bool
	End         string
	SkipTime    string
	Start       string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLFlushJobRequest configures the ML Flush Job API request.

func (MLFlushJobRequest) Do ¶ 

func (r MLFlushJobRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLForecast ¶ 

type MLForecast func(job_id string, o ...func(*MLForecastRequest)) (*Response, error)

MLForecast - Predicts the future behavior of a time series by using its historical behavior.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html.

func (MLForecast) WithBody ¶ 

func (f MLForecast) WithBody(v io.Reader) func(*MLForecastRequest)

WithBody - Query parameters can be specified in the body.

func (MLForecast) WithContext ¶ 

func (f MLForecast) WithContext(v context.Context) func(*MLForecastRequest)

WithContext sets the request context.

func (MLForecast) WithDuration ¶ 

func (f MLForecast) WithDuration(v time.Duration) func(*MLForecastRequest)

WithDuration - the duration of the forecast.

func (MLForecast) WithErrorTrace ¶ 

func (f MLForecast) WithErrorTrace() func(*MLForecastRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLForecast) WithExpiresIn ¶ 

func (f MLForecast) WithExpiresIn(v time.Duration) func(*MLForecastRequest)

WithExpiresIn - the time interval after which the forecast expires. expired forecasts will be deleted at the first opportunity..

func (MLForecast) WithFilterPath ¶ 

func (f MLForecast) WithFilterPath(v ...string) func(*MLForecastRequest)

WithFilterPath filters the properties of the response body.

func (MLForecast) WithHeader ¶ 

func (f MLForecast) WithHeader(h map[string]string) func(*MLForecastRequest)

WithHeader adds the headers to the HTTP request.

func (MLForecast) WithHuman ¶ 

func (f MLForecast) WithHuman() func(*MLForecastRequest)

WithHuman makes statistical values human-readable.

func (MLForecast) WithMaxModelMemory ¶ 

func (f MLForecast) WithMaxModelMemory(v string) func(*MLForecastRequest)

WithMaxModelMemory - the max memory able to be used by the forecast. default is 20mb..

func (MLForecast) WithOpaqueID ¶ 

func (f MLForecast) WithOpaqueID(s string) func(*MLForecastRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLForecast) WithPretty ¶ 

func (f MLForecast) WithPretty() func(*MLForecastRequest)

WithPretty makes the response body pretty-printed.

type MLForecastRequest ¶ 

type MLForecastRequest struct {
	Body io.Reader

	JobID string

	Duration       time.Duration
	ExpiresIn      time.Duration
	MaxModelMemory string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLForecastRequest configures the ML Forecast API request.

func (MLForecastRequest) Do ¶ 

func (r MLForecastRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetBuckets ¶ 

type MLGetBuckets func(job_id string, o ...func(*MLGetBucketsRequest)) (*Response, error)

MLGetBuckets - Retrieves anomaly detection job results for one or more buckets.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html.

func (MLGetBuckets) WithAnomalyScore ¶ 

func (f MLGetBuckets) WithAnomalyScore(v interface{}) func(*MLGetBucketsRequest)

WithAnomalyScore - filter for the most anomalous buckets.

func (MLGetBuckets) WithBody ¶ 

func (f MLGetBuckets) WithBody(v io.Reader) func(*MLGetBucketsRequest)

WithBody - Bucket selection details if not provided in URI.

func (MLGetBuckets) WithContext ¶ 

func (f MLGetBuckets) WithContext(v context.Context) func(*MLGetBucketsRequest)

WithContext sets the request context.

func (MLGetBuckets) WithDesc ¶ 

func (f MLGetBuckets) WithDesc(v bool) func(*MLGetBucketsRequest)

WithDesc - set the sort direction.

func (MLGetBuckets) WithEnd ¶ 

func (f MLGetBuckets) WithEnd(v string) func(*MLGetBucketsRequest)

WithEnd - end time filter for buckets.

func (MLGetBuckets) WithErrorTrace ¶ 

func (f MLGetBuckets) WithErrorTrace() func(*MLGetBucketsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetBuckets) WithExcludeInterim ¶ 

func (f MLGetBuckets) WithExcludeInterim(v bool) func(*MLGetBucketsRequest)

WithExcludeInterim - exclude interim results.

func (MLGetBuckets) WithExpand ¶ 

func (f MLGetBuckets) WithExpand(v bool) func(*MLGetBucketsRequest)

WithExpand - include anomaly records.

func (MLGetBuckets) WithFilterPath ¶ 

func (f MLGetBuckets) WithFilterPath(v ...string) func(*MLGetBucketsRequest)

WithFilterPath filters the properties of the response body.

func (MLGetBuckets) WithFrom ¶ 

func (f MLGetBuckets) WithFrom(v int) func(*MLGetBucketsRequest)

WithFrom - skips a number of buckets.

func (MLGetBuckets) WithHeader ¶ 

func (f MLGetBuckets) WithHeader(h map[string]string) func(*MLGetBucketsRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetBuckets) WithHuman ¶ 

func (f MLGetBuckets) WithHuman() func(*MLGetBucketsRequest)

WithHuman makes statistical values human-readable.

func (MLGetBuckets) WithOpaqueID ¶ 

func (f MLGetBuckets) WithOpaqueID(s string) func(*MLGetBucketsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetBuckets) WithPretty ¶ 

func (f MLGetBuckets) WithPretty() func(*MLGetBucketsRequest)

WithPretty makes the response body pretty-printed.

func (MLGetBuckets) WithSize ¶ 

func (f MLGetBuckets) WithSize(v int) func(*MLGetBucketsRequest)

WithSize - specifies a max number of buckets to get.

func (MLGetBuckets) WithSort ¶ 

func (f MLGetBuckets) WithSort(v string) func(*MLGetBucketsRequest)

WithSort - sort buckets by a particular field.

func (MLGetBuckets) WithStart ¶ 

func (f MLGetBuckets) WithStart(v string) func(*MLGetBucketsRequest)

WithStart - start time filter for buckets.

func (MLGetBuckets) WithTimestamp ¶ 

func (f MLGetBuckets) WithTimestamp(v string) func(*MLGetBucketsRequest)

WithTimestamp - the timestamp of the desired single bucket result.

type MLGetBucketsRequest ¶ 

type MLGetBucketsRequest struct {
	Body io.Reader

	JobID     string
	Timestamp string

	AnomalyScore   interface{}
	Desc           *bool
	End            string
	ExcludeInterim *bool
	Expand         *bool
	From           *int
	Size           *int
	Sort           string
	Start          string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetBucketsRequest configures the ML Get Buckets API request.

func (MLGetBucketsRequest) Do ¶ 

func (r MLGetBucketsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetCalendarEvents ¶ 

type MLGetCalendarEvents func(calendar_id string, o ...func(*MLGetCalendarEventsRequest)) (*Response, error)

MLGetCalendarEvents - Retrieves information about the scheduled events in calendars.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html.

func (MLGetCalendarEvents) WithContext ¶ 

func (f MLGetCalendarEvents) WithContext(v context.Context) func(*MLGetCalendarEventsRequest)

WithContext sets the request context.

func (MLGetCalendarEvents) WithEnd ¶ 

func (f MLGetCalendarEvents) WithEnd(v interface{}) func(*MLGetCalendarEventsRequest)

WithEnd - get events before this time.

func (MLGetCalendarEvents) WithErrorTrace ¶ 

func (f MLGetCalendarEvents) WithErrorTrace() func(*MLGetCalendarEventsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetCalendarEvents) WithFilterPath ¶ 

func (f MLGetCalendarEvents) WithFilterPath(v ...string) func(*MLGetCalendarEventsRequest)

WithFilterPath filters the properties of the response body.

func (MLGetCalendarEvents) WithFrom ¶ 

func (f MLGetCalendarEvents) WithFrom(v int) func(*MLGetCalendarEventsRequest)

WithFrom - skips a number of events.

func (MLGetCalendarEvents) WithHeader ¶ 

func (f MLGetCalendarEvents) WithHeader(h map[string]string) func(*MLGetCalendarEventsRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetCalendarEvents) WithHuman ¶ 

func (f MLGetCalendarEvents) WithHuman() func(*MLGetCalendarEventsRequest)

WithHuman makes statistical values human-readable.

func (MLGetCalendarEvents) WithJobID ¶ 

func (f MLGetCalendarEvents) WithJobID(v string) func(*MLGetCalendarEventsRequest)

WithJobID - get events for the job. when this option is used calendar_id must be '_all'.

func (MLGetCalendarEvents) WithOpaqueID ¶ 

func (f MLGetCalendarEvents) WithOpaqueID(s string) func(*MLGetCalendarEventsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetCalendarEvents) WithPretty ¶ 

func (f MLGetCalendarEvents) WithPretty() func(*MLGetCalendarEventsRequest)

WithPretty makes the response body pretty-printed.

func (MLGetCalendarEvents) WithSize ¶ 

func (f MLGetCalendarEvents) WithSize(v int) func(*MLGetCalendarEventsRequest)

WithSize - specifies a max number of events to get.

func (MLGetCalendarEvents) WithStart ¶ 

func (f MLGetCalendarEvents) WithStart(v string) func(*MLGetCalendarEventsRequest)

WithStart - get events after this time.

type MLGetCalendarEventsRequest ¶ 

type MLGetCalendarEventsRequest struct {
	CalendarID string

	End   interface{}
	From  *int
	JobID string
	Size  *int
	Start string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetCalendarEventsRequest configures the ML Get Calendar Events API request.

func (MLGetCalendarEventsRequest) Do ¶ 

func (r MLGetCalendarEventsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetCalendars ¶ 

type MLGetCalendars func(o ...func(*MLGetCalendarsRequest)) (*Response, error)

MLGetCalendars - Retrieves configuration information for calendars.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html.

func (MLGetCalendars) WithBody ¶ 

func (f MLGetCalendars) WithBody(v io.Reader) func(*MLGetCalendarsRequest)

WithBody - The from and size parameters optionally sent in the body.

func (MLGetCalendars) WithCalendarID ¶ 

func (f MLGetCalendars) WithCalendarID(v string) func(*MLGetCalendarsRequest)

WithCalendarID - the ID of the calendar to fetch.

func (MLGetCalendars) WithContext ¶ 

func (f MLGetCalendars) WithContext(v context.Context) func(*MLGetCalendarsRequest)

WithContext sets the request context.

func (MLGetCalendars) WithErrorTrace ¶ 

func (f MLGetCalendars) WithErrorTrace() func(*MLGetCalendarsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetCalendars) WithFilterPath ¶ 

func (f MLGetCalendars) WithFilterPath(v ...string) func(*MLGetCalendarsRequest)

WithFilterPath filters the properties of the response body.

func (MLGetCalendars) WithFrom ¶ 

func (f MLGetCalendars) WithFrom(v int) func(*MLGetCalendarsRequest)

WithFrom - skips a number of calendars.

func (MLGetCalendars) WithHeader ¶ 

func (f MLGetCalendars) WithHeader(h map[string]string) func(*MLGetCalendarsRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetCalendars) WithHuman ¶ 

func (f MLGetCalendars) WithHuman() func(*MLGetCalendarsRequest)

WithHuman makes statistical values human-readable.

func (MLGetCalendars) WithOpaqueID ¶ 

func (f MLGetCalendars) WithOpaqueID(s string) func(*MLGetCalendarsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetCalendars) WithPretty ¶ 

func (f MLGetCalendars) WithPretty() func(*MLGetCalendarsRequest)

WithPretty makes the response body pretty-printed.

func (MLGetCalendars) WithSize ¶ 

func (f MLGetCalendars) WithSize(v int) func(*MLGetCalendarsRequest)

WithSize - specifies a max number of calendars to get.

type MLGetCalendarsRequest ¶ 

type MLGetCalendarsRequest struct {
	Body io.Reader

	CalendarID string

	From *int
	Size *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetCalendarsRequest configures the ML Get Calendars API request.

func (MLGetCalendarsRequest) Do ¶ 

func (r MLGetCalendarsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetCategories ¶ 

type MLGetCategories func(job_id string, o ...func(*MLGetCategoriesRequest)) (*Response, error)

MLGetCategories - Retrieves anomaly detection job results for one or more categories.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html.

func (MLGetCategories) WithBody ¶ 

func (f MLGetCategories) WithBody(v io.Reader) func(*MLGetCategoriesRequest)

WithBody - Category selection details if not provided in URI.

func (MLGetCategories) WithCategoryID ¶ 

func (f MLGetCategories) WithCategoryID(v int) func(*MLGetCategoriesRequest)

WithCategoryID - the identifier of the category definition of interest.

func (MLGetCategories) WithContext ¶ 

func (f MLGetCategories) WithContext(v context.Context) func(*MLGetCategoriesRequest)

WithContext sets the request context.

func (MLGetCategories) WithErrorTrace ¶ 

func (f MLGetCategories) WithErrorTrace() func(*MLGetCategoriesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetCategories) WithFilterPath ¶ 

func (f MLGetCategories) WithFilterPath(v ...string) func(*MLGetCategoriesRequest)

WithFilterPath filters the properties of the response body.

func (MLGetCategories) WithFrom ¶ 

func (f MLGetCategories) WithFrom(v int) func(*MLGetCategoriesRequest)

WithFrom - skips a number of categories.

func (MLGetCategories) WithHeader ¶ 

func (f MLGetCategories) WithHeader(h map[string]string) func(*MLGetCategoriesRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetCategories) WithHuman ¶ 

func (f MLGetCategories) WithHuman() func(*MLGetCategoriesRequest)

WithHuman makes statistical values human-readable.

func (MLGetCategories) WithOpaqueID ¶ 

func (f MLGetCategories) WithOpaqueID(s string) func(*MLGetCategoriesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetCategories) WithPartitionFieldValue ¶ 

func (f MLGetCategories) WithPartitionFieldValue(v string) func(*MLGetCategoriesRequest)

WithPartitionFieldValue - specifies the partition to retrieve categories for. this is optional, and should never be used for jobs where per-partition categorization is disabled..

func (MLGetCategories) WithPretty ¶ 

func (f MLGetCategories) WithPretty() func(*MLGetCategoriesRequest)

WithPretty makes the response body pretty-printed.

func (MLGetCategories) WithSize ¶ 

func (f MLGetCategories) WithSize(v int) func(*MLGetCategoriesRequest)

WithSize - specifies a max number of categories to get.

type MLGetCategoriesRequest ¶ 

type MLGetCategoriesRequest struct {
	Body io.Reader

	CategoryID *int
	JobID      string

	From                *int
	PartitionFieldValue string
	Size                *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetCategoriesRequest configures the ML Get Categories API request.

func (MLGetCategoriesRequest) Do ¶ 

func (r MLGetCategoriesRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetDataFrameAnalytics ¶ 

type MLGetDataFrameAnalytics func(o ...func(*MLGetDataFrameAnalyticsRequest)) (*Response, error)

MLGetDataFrameAnalytics - Retrieves configuration information for data frame analytics jobs.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html.

func (MLGetDataFrameAnalytics) WithAllowNoMatch ¶ 

func (f MLGetDataFrameAnalytics) WithAllowNoMatch(v bool) func(*MLGetDataFrameAnalyticsRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no data frame analytics. (this includes `_all` string or when no data frame analytics have been specified).

func (MLGetDataFrameAnalytics) WithContext ¶ 

func (f MLGetDataFrameAnalytics) WithContext(v context.Context) func(*MLGetDataFrameAnalyticsRequest)

WithContext sets the request context.

func (MLGetDataFrameAnalytics) WithErrorTrace ¶ 

func (f MLGetDataFrameAnalytics) WithErrorTrace() func(*MLGetDataFrameAnalyticsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetDataFrameAnalytics) WithExcludeGenerated ¶ 

func (f MLGetDataFrameAnalytics) WithExcludeGenerated(v bool) func(*MLGetDataFrameAnalyticsRequest)

WithExcludeGenerated - omits fields that are illegal to set on data frame analytics put.

func (MLGetDataFrameAnalytics) WithFilterPath ¶ 

func (f MLGetDataFrameAnalytics) WithFilterPath(v ...string) func(*MLGetDataFrameAnalyticsRequest)

WithFilterPath filters the properties of the response body.

func (MLGetDataFrameAnalytics) WithFrom ¶ 

func (f MLGetDataFrameAnalytics) WithFrom(v int) func(*MLGetDataFrameAnalyticsRequest)

WithFrom - skips a number of analytics.

func (MLGetDataFrameAnalytics) WithHeader ¶ 

func (f MLGetDataFrameAnalytics) WithHeader(h map[string]string) func(*MLGetDataFrameAnalyticsRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetDataFrameAnalytics) WithHuman ¶ 

func (f MLGetDataFrameAnalytics) WithHuman() func(*MLGetDataFrameAnalyticsRequest)

WithHuman makes statistical values human-readable.

func (MLGetDataFrameAnalytics) WithID ¶ 

func (f MLGetDataFrameAnalytics) WithID(v string) func(*MLGetDataFrameAnalyticsRequest)

WithID - the ID of the data frame analytics to fetch.

func (MLGetDataFrameAnalytics) WithOpaqueID ¶ 

func (f MLGetDataFrameAnalytics) WithOpaqueID(s string) func(*MLGetDataFrameAnalyticsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetDataFrameAnalytics) WithPretty ¶ 

func (f MLGetDataFrameAnalytics) WithPretty() func(*MLGetDataFrameAnalyticsRequest)

WithPretty makes the response body pretty-printed.

func (MLGetDataFrameAnalytics) WithSize ¶ 

func (f MLGetDataFrameAnalytics) WithSize(v int) func(*MLGetDataFrameAnalyticsRequest)

WithSize - specifies a max number of analytics to get.

type MLGetDataFrameAnalyticsRequest ¶ 

type MLGetDataFrameAnalyticsRequest struct {
	ID string

	AllowNoMatch     *bool
	ExcludeGenerated *bool
	From             *int
	Size             *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetDataFrameAnalyticsRequest configures the ML Get Data Frame Analytics API request.

func (MLGetDataFrameAnalyticsRequest) Do ¶ 

func (r MLGetDataFrameAnalyticsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetDataFrameAnalyticsStats ¶ 

type MLGetDataFrameAnalyticsStats func(o ...func(*MLGetDataFrameAnalyticsStatsRequest)) (*Response, error)

MLGetDataFrameAnalyticsStats - Retrieves usage information for data frame analytics jobs.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html.

func (MLGetDataFrameAnalyticsStats) WithAllowNoMatch ¶ 

func (f MLGetDataFrameAnalyticsStats) WithAllowNoMatch(v bool) func(*MLGetDataFrameAnalyticsStatsRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no data frame analytics. (this includes `_all` string or when no data frame analytics have been specified).

func (MLGetDataFrameAnalyticsStats) WithContext ¶ 

func (f MLGetDataFrameAnalyticsStats) WithContext(v context.Context) func(*MLGetDataFrameAnalyticsStatsRequest)

WithContext sets the request context.

func (MLGetDataFrameAnalyticsStats) WithErrorTrace ¶ 

func (f MLGetDataFrameAnalyticsStats) WithErrorTrace() func(*MLGetDataFrameAnalyticsStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetDataFrameAnalyticsStats) WithFilterPath ¶ 

func (f MLGetDataFrameAnalyticsStats) WithFilterPath(v ...string) func(*MLGetDataFrameAnalyticsStatsRequest)

WithFilterPath filters the properties of the response body.

func (MLGetDataFrameAnalyticsStats) WithFrom ¶ 

func (f MLGetDataFrameAnalyticsStats) WithFrom(v int) func(*MLGetDataFrameAnalyticsStatsRequest)

WithFrom - skips a number of analytics.

func (MLGetDataFrameAnalyticsStats) WithHeader ¶ 

func (f MLGetDataFrameAnalyticsStats) WithHeader(h map[string]string) func(*MLGetDataFrameAnalyticsStatsRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetDataFrameAnalyticsStats) WithHuman ¶ 

func (f MLGetDataFrameAnalyticsStats) WithHuman() func(*MLGetDataFrameAnalyticsStatsRequest)

WithHuman makes statistical values human-readable.

func (MLGetDataFrameAnalyticsStats) WithID ¶ 

func (f MLGetDataFrameAnalyticsStats) WithID(v string) func(*MLGetDataFrameAnalyticsStatsRequest)

WithID - the ID of the data frame analytics stats to fetch.

func (MLGetDataFrameAnalyticsStats) WithOpaqueID ¶ 

func (f MLGetDataFrameAnalyticsStats) WithOpaqueID(s string) func(*MLGetDataFrameAnalyticsStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetDataFrameAnalyticsStats) WithPretty ¶ 

func (f MLGetDataFrameAnalyticsStats) WithPretty() func(*MLGetDataFrameAnalyticsStatsRequest)

WithPretty makes the response body pretty-printed.

func (MLGetDataFrameAnalyticsStats) WithSize ¶ 

func (f MLGetDataFrameAnalyticsStats) WithSize(v int) func(*MLGetDataFrameAnalyticsStatsRequest)

WithSize - specifies a max number of analytics to get.

func (MLGetDataFrameAnalyticsStats) WithVerbose ¶ 

func (f MLGetDataFrameAnalyticsStats) WithVerbose(v bool) func(*MLGetDataFrameAnalyticsStatsRequest)

WithVerbose - whether the stats response should be verbose.

type MLGetDataFrameAnalyticsStatsRequest ¶ 

type MLGetDataFrameAnalyticsStatsRequest struct {
	ID string

	AllowNoMatch *bool
	From         *int
	Size         *int
	Verbose      *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetDataFrameAnalyticsStatsRequest configures the ML Get Data Frame Analytics Stats API request.

func (MLGetDataFrameAnalyticsStatsRequest) Do ¶ 

func (r MLGetDataFrameAnalyticsStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetDatafeedStats ¶ 

type MLGetDatafeedStats func(o ...func(*MLGetDatafeedStatsRequest)) (*Response, error)

MLGetDatafeedStats - Retrieves usage information for datafeeds.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html.

func (MLGetDatafeedStats) WithAllowNoMatch ¶ 

func (f MLGetDatafeedStats) WithAllowNoMatch(v bool) func(*MLGetDatafeedStatsRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no datafeeds. (this includes `_all` string or when no datafeeds have been specified).

func (MLGetDatafeedStats) WithContext ¶ 

func (f MLGetDatafeedStats) WithContext(v context.Context) func(*MLGetDatafeedStatsRequest)

WithContext sets the request context.

func (MLGetDatafeedStats) WithDatafeedID ¶ 

func (f MLGetDatafeedStats) WithDatafeedID(v string) func(*MLGetDatafeedStatsRequest)

WithDatafeedID - the ID of the datafeeds stats to fetch.

func (MLGetDatafeedStats) WithErrorTrace ¶ 

func (f MLGetDatafeedStats) WithErrorTrace() func(*MLGetDatafeedStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetDatafeedStats) WithFilterPath ¶ 

func (f MLGetDatafeedStats) WithFilterPath(v ...string) func(*MLGetDatafeedStatsRequest)

WithFilterPath filters the properties of the response body.

func (MLGetDatafeedStats) WithHeader ¶ 

func (f MLGetDatafeedStats) WithHeader(h map[string]string) func(*MLGetDatafeedStatsRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetDatafeedStats) WithHuman ¶ 

func (f MLGetDatafeedStats) WithHuman() func(*MLGetDatafeedStatsRequest)

WithHuman makes statistical values human-readable.

func (MLGetDatafeedStats) WithOpaqueID ¶ 

func (f MLGetDatafeedStats) WithOpaqueID(s string) func(*MLGetDatafeedStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetDatafeedStats) WithPretty ¶ 

func (f MLGetDatafeedStats) WithPretty() func(*MLGetDatafeedStatsRequest)

WithPretty makes the response body pretty-printed.

type MLGetDatafeedStatsRequest ¶ 

type MLGetDatafeedStatsRequest struct {
	DatafeedID string

	AllowNoMatch *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetDatafeedStatsRequest configures the ML Get Datafeed Stats API request.

func (MLGetDatafeedStatsRequest) Do ¶ 

func (r MLGetDatafeedStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetDatafeeds ¶ 

type MLGetDatafeeds func(o ...func(*MLGetDatafeedsRequest)) (*Response, error)

MLGetDatafeeds - Retrieves configuration information for datafeeds.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html.

func (MLGetDatafeeds) WithAllowNoMatch ¶ 

func (f MLGetDatafeeds) WithAllowNoMatch(v bool) func(*MLGetDatafeedsRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no datafeeds. (this includes `_all` string or when no datafeeds have been specified).

func (MLGetDatafeeds) WithContext ¶ 

func (f MLGetDatafeeds) WithContext(v context.Context) func(*MLGetDatafeedsRequest)

WithContext sets the request context.

func (MLGetDatafeeds) WithDatafeedID ¶ 

func (f MLGetDatafeeds) WithDatafeedID(v string) func(*MLGetDatafeedsRequest)

WithDatafeedID - the ID of the datafeeds to fetch.

func (MLGetDatafeeds) WithErrorTrace ¶ 

func (f MLGetDatafeeds) WithErrorTrace() func(*MLGetDatafeedsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetDatafeeds) WithExcludeGenerated ¶ 

func (f MLGetDatafeeds) WithExcludeGenerated(v bool) func(*MLGetDatafeedsRequest)

WithExcludeGenerated - omits fields that are illegal to set on datafeed put.

func (MLGetDatafeeds) WithFilterPath ¶ 

func (f MLGetDatafeeds) WithFilterPath(v ...string) func(*MLGetDatafeedsRequest)

WithFilterPath filters the properties of the response body.

func (MLGetDatafeeds) WithHeader ¶ 

func (f MLGetDatafeeds) WithHeader(h map[string]string) func(*MLGetDatafeedsRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetDatafeeds) WithHuman ¶ 

func (f MLGetDatafeeds) WithHuman() func(*MLGetDatafeedsRequest)

WithHuman makes statistical values human-readable.

func (MLGetDatafeeds) WithOpaqueID ¶ 

func (f MLGetDatafeeds) WithOpaqueID(s string) func(*MLGetDatafeedsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetDatafeeds) WithPretty ¶ 

func (f MLGetDatafeeds) WithPretty() func(*MLGetDatafeedsRequest)

WithPretty makes the response body pretty-printed.

type MLGetDatafeedsRequest ¶ 

type MLGetDatafeedsRequest struct {
	DatafeedID string

	AllowNoMatch     *bool
	ExcludeGenerated *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetDatafeedsRequest configures the ML Get Datafeeds API request.

func (MLGetDatafeedsRequest) Do ¶ 

func (r MLGetDatafeedsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetFilters ¶ 

type MLGetFilters func(o ...func(*MLGetFiltersRequest)) (*Response, error)

MLGetFilters - Retrieves filters.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html.

func (MLGetFilters) WithContext ¶ 

func (f MLGetFilters) WithContext(v context.Context) func(*MLGetFiltersRequest)

WithContext sets the request context.

func (MLGetFilters) WithErrorTrace ¶ 

func (f MLGetFilters) WithErrorTrace() func(*MLGetFiltersRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetFilters) WithFilterID ¶ 

func (f MLGetFilters) WithFilterID(v string) func(*MLGetFiltersRequest)

WithFilterID - the ID of the filter to fetch.

func (MLGetFilters) WithFilterPath ¶ 

func (f MLGetFilters) WithFilterPath(v ...string) func(*MLGetFiltersRequest)

WithFilterPath filters the properties of the response body.

func (MLGetFilters) WithFrom ¶ 

func (f MLGetFilters) WithFrom(v int) func(*MLGetFiltersRequest)

WithFrom - skips a number of filters.

func (MLGetFilters) WithHeader ¶ 

func (f MLGetFilters) WithHeader(h map[string]string) func(*MLGetFiltersRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetFilters) WithHuman ¶ 

func (f MLGetFilters) WithHuman() func(*MLGetFiltersRequest)

WithHuman makes statistical values human-readable.

func (MLGetFilters) WithOpaqueID ¶ 

func (f MLGetFilters) WithOpaqueID(s string) func(*MLGetFiltersRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetFilters) WithPretty ¶ 

func (f MLGetFilters) WithPretty() func(*MLGetFiltersRequest)

WithPretty makes the response body pretty-printed.

func (MLGetFilters) WithSize ¶ 

func (f MLGetFilters) WithSize(v int) func(*MLGetFiltersRequest)

WithSize - specifies a max number of filters to get.

type MLGetFiltersRequest ¶ 

type MLGetFiltersRequest struct {
	FilterID string

	From *int
	Size *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetFiltersRequest configures the ML Get Filters API request.

func (MLGetFiltersRequest) Do ¶ 

func (r MLGetFiltersRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetInfluencers ¶ 

type MLGetInfluencers func(job_id string, o ...func(*MLGetInfluencersRequest)) (*Response, error)

MLGetInfluencers - Retrieves anomaly detection job results for one or more influencers.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html.

func (MLGetInfluencers) WithBody ¶ 

func (f MLGetInfluencers) WithBody(v io.Reader) func(*MLGetInfluencersRequest)

WithBody - Influencer selection criteria.

func (MLGetInfluencers) WithContext ¶ 

func (f MLGetInfluencers) WithContext(v context.Context) func(*MLGetInfluencersRequest)

WithContext sets the request context.

func (MLGetInfluencers) WithDesc ¶ 

func (f MLGetInfluencers) WithDesc(v bool) func(*MLGetInfluencersRequest)

WithDesc - whether the results should be sorted in decending order.

func (MLGetInfluencers) WithEnd ¶ 

func (f MLGetInfluencers) WithEnd(v string) func(*MLGetInfluencersRequest)

WithEnd - end timestamp for the requested influencers.

func (MLGetInfluencers) WithErrorTrace ¶ 

func (f MLGetInfluencers) WithErrorTrace() func(*MLGetInfluencersRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetInfluencers) WithExcludeInterim ¶ 

func (f MLGetInfluencers) WithExcludeInterim(v bool) func(*MLGetInfluencersRequest)

WithExcludeInterim - exclude interim results.

func (MLGetInfluencers) WithFilterPath ¶ 

func (f MLGetInfluencers) WithFilterPath(v ...string) func(*MLGetInfluencersRequest)

WithFilterPath filters the properties of the response body.

func (MLGetInfluencers) WithFrom ¶ 

func (f MLGetInfluencers) WithFrom(v int) func(*MLGetInfluencersRequest)

WithFrom - skips a number of influencers.

func (MLGetInfluencers) WithHeader ¶ 

func (f MLGetInfluencers) WithHeader(h map[string]string) func(*MLGetInfluencersRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetInfluencers) WithHuman ¶ 

func (f MLGetInfluencers) WithHuman() func(*MLGetInfluencersRequest)

WithHuman makes statistical values human-readable.

func (MLGetInfluencers) WithInfluencerScore ¶ 

func (f MLGetInfluencers) WithInfluencerScore(v interface{}) func(*MLGetInfluencersRequest)

WithInfluencerScore - influencer score threshold for the requested influencers.

func (MLGetInfluencers) WithOpaqueID ¶ 

func (f MLGetInfluencers) WithOpaqueID(s string) func(*MLGetInfluencersRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetInfluencers) WithPretty ¶ 

func (f MLGetInfluencers) WithPretty() func(*MLGetInfluencersRequest)

WithPretty makes the response body pretty-printed.

func (MLGetInfluencers) WithSize ¶ 

func (f MLGetInfluencers) WithSize(v int) func(*MLGetInfluencersRequest)

WithSize - specifies a max number of influencers to get.

func (MLGetInfluencers) WithSort ¶ 

func (f MLGetInfluencers) WithSort(v string) func(*MLGetInfluencersRequest)

WithSort - sort field for the requested influencers.

func (MLGetInfluencers) WithStart ¶ 

func (f MLGetInfluencers) WithStart(v string) func(*MLGetInfluencersRequest)

WithStart - start timestamp for the requested influencers.

type MLGetInfluencersRequest ¶ 

type MLGetInfluencersRequest struct {
	Body io.Reader

	JobID string

	Desc            *bool
	End             string
	ExcludeInterim  *bool
	From            *int
	InfluencerScore interface{}
	Size            *int
	Sort            string
	Start           string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetInfluencersRequest configures the ML Get Influencers API request.

func (MLGetInfluencersRequest) Do ¶ 

func (r MLGetInfluencersRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetJobStats ¶ 

type MLGetJobStats func(o ...func(*MLGetJobStatsRequest)) (*Response, error)

MLGetJobStats - Retrieves usage information for anomaly detection jobs.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html.

func (MLGetJobStats) WithAllowNoMatch ¶ 

func (f MLGetJobStats) WithAllowNoMatch(v bool) func(*MLGetJobStatsRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no jobs. (this includes `_all` string or when no jobs have been specified).

func (MLGetJobStats) WithContext ¶ 

func (f MLGetJobStats) WithContext(v context.Context) func(*MLGetJobStatsRequest)

WithContext sets the request context.

func (MLGetJobStats) WithErrorTrace ¶ 

func (f MLGetJobStats) WithErrorTrace() func(*MLGetJobStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetJobStats) WithFilterPath ¶ 

func (f MLGetJobStats) WithFilterPath(v ...string) func(*MLGetJobStatsRequest)

WithFilterPath filters the properties of the response body.

func (MLGetJobStats) WithHeader ¶ 

func (f MLGetJobStats) WithHeader(h map[string]string) func(*MLGetJobStatsRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetJobStats) WithHuman ¶ 

func (f MLGetJobStats) WithHuman() func(*MLGetJobStatsRequest)

WithHuman makes statistical values human-readable.

func (MLGetJobStats) WithJobID ¶ 

func (f MLGetJobStats) WithJobID(v string) func(*MLGetJobStatsRequest)

WithJobID - the ID of the jobs stats to fetch.

func (MLGetJobStats) WithOpaqueID ¶ 

func (f MLGetJobStats) WithOpaqueID(s string) func(*MLGetJobStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetJobStats) WithPretty ¶ 

func (f MLGetJobStats) WithPretty() func(*MLGetJobStatsRequest)

WithPretty makes the response body pretty-printed.

type MLGetJobStatsRequest ¶ 

type MLGetJobStatsRequest struct {
	JobID string

	AllowNoMatch *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetJobStatsRequest configures the ML Get Job Stats API request.

func (MLGetJobStatsRequest) Do ¶ 

func (r MLGetJobStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetJobs ¶ 

type MLGetJobs func(o ...func(*MLGetJobsRequest)) (*Response, error)

MLGetJobs - Retrieves configuration information for anomaly detection jobs.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html.

func (MLGetJobs) WithAllowNoMatch ¶ 

func (f MLGetJobs) WithAllowNoMatch(v bool) func(*MLGetJobsRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no jobs. (this includes `_all` string or when no jobs have been specified).

func (MLGetJobs) WithContext ¶ 

func (f MLGetJobs) WithContext(v context.Context) func(*MLGetJobsRequest)

WithContext sets the request context.

func (MLGetJobs) WithErrorTrace ¶ 

func (f MLGetJobs) WithErrorTrace() func(*MLGetJobsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetJobs) WithExcludeGenerated ¶ 

func (f MLGetJobs) WithExcludeGenerated(v bool) func(*MLGetJobsRequest)

WithExcludeGenerated - omits fields that are illegal to set on job put.

func (MLGetJobs) WithFilterPath ¶ 

func (f MLGetJobs) WithFilterPath(v ...string) func(*MLGetJobsRequest)

WithFilterPath filters the properties of the response body.

func (MLGetJobs) WithHeader ¶ 

func (f MLGetJobs) WithHeader(h map[string]string) func(*MLGetJobsRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetJobs) WithHuman ¶ 

func (f MLGetJobs) WithHuman() func(*MLGetJobsRequest)

WithHuman makes statistical values human-readable.

func (MLGetJobs) WithJobID ¶ 

func (f MLGetJobs) WithJobID(v string) func(*MLGetJobsRequest)

WithJobID - the ID of the jobs to fetch.

func (MLGetJobs) WithOpaqueID ¶ 

func (f MLGetJobs) WithOpaqueID(s string) func(*MLGetJobsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetJobs) WithPretty ¶ 

func (f MLGetJobs) WithPretty() func(*MLGetJobsRequest)

WithPretty makes the response body pretty-printed.

type MLGetJobsRequest ¶ 

type MLGetJobsRequest struct {
	JobID string

	AllowNoMatch     *bool
	ExcludeGenerated *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetJobsRequest configures the ML Get Jobs API request.

func (MLGetJobsRequest) Do ¶ 

func (r MLGetJobsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetMemoryStats ¶ added in v8.2.0 

type MLGetMemoryStats func(o ...func(*MLGetMemoryStatsRequest)) (*Response, error)

MLGetMemoryStats - Returns information on how ML is using memory.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html.

func (MLGetMemoryStats) WithContext ¶ added in v8.2.0 

func (f MLGetMemoryStats) WithContext(v context.Context) func(*MLGetMemoryStatsRequest)

WithContext sets the request context.

func (MLGetMemoryStats) WithErrorTrace ¶ added in v8.2.0 

func (f MLGetMemoryStats) WithErrorTrace() func(*MLGetMemoryStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetMemoryStats) WithFilterPath ¶ added in v8.2.0 

func (f MLGetMemoryStats) WithFilterPath(v ...string) func(*MLGetMemoryStatsRequest)

WithFilterPath filters the properties of the response body.

func (MLGetMemoryStats) WithHeader ¶ added in v8.2.0 

func (f MLGetMemoryStats) WithHeader(h map[string]string) func(*MLGetMemoryStatsRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetMemoryStats) WithHuman ¶ added in v8.2.0 

func (f MLGetMemoryStats) WithHuman() func(*MLGetMemoryStatsRequest)

WithHuman makes statistical values human-readable.

func (MLGetMemoryStats) WithMasterTimeout ¶ added in v8.2.0 

func (f MLGetMemoryStats) WithMasterTimeout(v time.Duration) func(*MLGetMemoryStatsRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (MLGetMemoryStats) WithNodeID ¶ added in v8.2.0 

func (f MLGetMemoryStats) WithNodeID(v string) func(*MLGetMemoryStatsRequest)

WithNodeID - specifies the node or nodes to retrieve stats for..

func (MLGetMemoryStats) WithOpaqueID ¶ added in v8.2.0 

func (f MLGetMemoryStats) WithOpaqueID(s string) func(*MLGetMemoryStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetMemoryStats) WithPretty ¶ added in v8.2.0 

func (f MLGetMemoryStats) WithPretty() func(*MLGetMemoryStatsRequest)

WithPretty makes the response body pretty-printed.

func (MLGetMemoryStats) WithTimeout ¶ added in v8.2.0 

func (f MLGetMemoryStats) WithTimeout(v time.Duration) func(*MLGetMemoryStatsRequest)

WithTimeout - explicit operation timeout.

type MLGetMemoryStatsRequest ¶ added in v8.2.0 

type MLGetMemoryStatsRequest struct {
	NodeID string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetMemoryStatsRequest configures the ML Get Memory Stats API request.

func (MLGetMemoryStatsRequest) Do ¶ added in v8.2.0 

func (r MLGetMemoryStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetModelSnapshotUpgradeStats ¶ 

type MLGetModelSnapshotUpgradeStats func(snapshot_id string, job_id string, o ...func(*MLGetModelSnapshotUpgradeStatsRequest)) (*Response, error)

MLGetModelSnapshotUpgradeStats - Gets stats for anomaly detection job model snapshot upgrades that are in progress.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html.

func (MLGetModelSnapshotUpgradeStats) WithAllowNoMatch ¶ 

func (f MLGetModelSnapshotUpgradeStats) WithAllowNoMatch(v bool) func(*MLGetModelSnapshotUpgradeStatsRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no jobs or no snapshots. (this includes the `_all` string.).

func (MLGetModelSnapshotUpgradeStats) WithContext ¶ 

func (f MLGetModelSnapshotUpgradeStats) WithContext(v context.Context) func(*MLGetModelSnapshotUpgradeStatsRequest)

WithContext sets the request context.

func (MLGetModelSnapshotUpgradeStats) WithErrorTrace ¶ 

func (f MLGetModelSnapshotUpgradeStats) WithErrorTrace() func(*MLGetModelSnapshotUpgradeStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetModelSnapshotUpgradeStats) WithFilterPath ¶ 

func (f MLGetModelSnapshotUpgradeStats) WithFilterPath(v ...string) func(*MLGetModelSnapshotUpgradeStatsRequest)

WithFilterPath filters the properties of the response body.

func (MLGetModelSnapshotUpgradeStats) WithHeader ¶ 

func (f MLGetModelSnapshotUpgradeStats) WithHeader(h map[string]string) func(*MLGetModelSnapshotUpgradeStatsRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetModelSnapshotUpgradeStats) WithHuman ¶ 

func (f MLGetModelSnapshotUpgradeStats) WithHuman() func(*MLGetModelSnapshotUpgradeStatsRequest)

WithHuman makes statistical values human-readable.

func (MLGetModelSnapshotUpgradeStats) WithOpaqueID ¶ 

func (f MLGetModelSnapshotUpgradeStats) WithOpaqueID(s string) func(*MLGetModelSnapshotUpgradeStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetModelSnapshotUpgradeStats) WithPretty ¶ 

func (f MLGetModelSnapshotUpgradeStats) WithPretty() func(*MLGetModelSnapshotUpgradeStatsRequest)

WithPretty makes the response body pretty-printed.

type MLGetModelSnapshotUpgradeStatsRequest ¶ 

type MLGetModelSnapshotUpgradeStatsRequest struct {
	JobID      string
	SnapshotID string

	AllowNoMatch *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetModelSnapshotUpgradeStatsRequest configures the ML Get Model Snapshot Upgrade Stats API request.

func (MLGetModelSnapshotUpgradeStatsRequest) Do ¶ 

func (r MLGetModelSnapshotUpgradeStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetModelSnapshots ¶ 

type MLGetModelSnapshots func(job_id string, o ...func(*MLGetModelSnapshotsRequest)) (*Response, error)

MLGetModelSnapshots - Retrieves information about model snapshots.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html.

func (MLGetModelSnapshots) WithBody ¶ 

func (f MLGetModelSnapshots) WithBody(v io.Reader) func(*MLGetModelSnapshotsRequest)

WithBody - Model snapshot selection criteria.

func (MLGetModelSnapshots) WithContext ¶ 

func (f MLGetModelSnapshots) WithContext(v context.Context) func(*MLGetModelSnapshotsRequest)

WithContext sets the request context.

func (MLGetModelSnapshots) WithDesc ¶ 

func (f MLGetModelSnapshots) WithDesc(v bool) func(*MLGetModelSnapshotsRequest)

WithDesc - true if the results should be sorted in descending order.

func (MLGetModelSnapshots) WithEnd ¶ 

func (f MLGetModelSnapshots) WithEnd(v interface{}) func(*MLGetModelSnapshotsRequest)

WithEnd - the filter 'end' query parameter.

func (MLGetModelSnapshots) WithErrorTrace ¶ 

func (f MLGetModelSnapshots) WithErrorTrace() func(*MLGetModelSnapshotsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetModelSnapshots) WithFilterPath ¶ 

func (f MLGetModelSnapshots) WithFilterPath(v ...string) func(*MLGetModelSnapshotsRequest)

WithFilterPath filters the properties of the response body.

func (MLGetModelSnapshots) WithFrom ¶ 

func (f MLGetModelSnapshots) WithFrom(v int) func(*MLGetModelSnapshotsRequest)

WithFrom - skips a number of documents.

func (MLGetModelSnapshots) WithHeader ¶ 

func (f MLGetModelSnapshots) WithHeader(h map[string]string) func(*MLGetModelSnapshotsRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetModelSnapshots) WithHuman ¶ 

func (f MLGetModelSnapshots) WithHuman() func(*MLGetModelSnapshotsRequest)

WithHuman makes statistical values human-readable.

func (MLGetModelSnapshots) WithOpaqueID ¶ 

func (f MLGetModelSnapshots) WithOpaqueID(s string) func(*MLGetModelSnapshotsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetModelSnapshots) WithPretty ¶ 

func (f MLGetModelSnapshots) WithPretty() func(*MLGetModelSnapshotsRequest)

WithPretty makes the response body pretty-printed.

func (MLGetModelSnapshots) WithSize ¶ 

func (f MLGetModelSnapshots) WithSize(v int) func(*MLGetModelSnapshotsRequest)

WithSize - the default number of documents returned in queries as a string..

func (MLGetModelSnapshots) WithSnapshotID ¶ 

func (f MLGetModelSnapshots) WithSnapshotID(v string) func(*MLGetModelSnapshotsRequest)

WithSnapshotID - the ID of the snapshot to fetch.

func (MLGetModelSnapshots) WithSort ¶ 

func (f MLGetModelSnapshots) WithSort(v string) func(*MLGetModelSnapshotsRequest)

WithSort - name of the field to sort on.

func (MLGetModelSnapshots) WithStart ¶ 

func (f MLGetModelSnapshots) WithStart(v interface{}) func(*MLGetModelSnapshotsRequest)

WithStart - the filter 'start' query parameter.

type MLGetModelSnapshotsRequest ¶ 

type MLGetModelSnapshotsRequest struct {
	Body io.Reader

	JobID      string
	SnapshotID string

	Desc  *bool
	End   interface{}
	From  *int
	Size  *int
	Sort  string
	Start interface{}

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetModelSnapshotsRequest configures the ML Get Model Snapshots API request.

func (MLGetModelSnapshotsRequest) Do ¶ 

func (r MLGetModelSnapshotsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetOverallBuckets ¶ 

type MLGetOverallBuckets func(job_id string, o ...func(*MLGetOverallBucketsRequest)) (*Response, error)

MLGetOverallBuckets - Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html.

func (MLGetOverallBuckets) WithAllowNoMatch ¶ 

func (f MLGetOverallBuckets) WithAllowNoMatch(v bool) func(*MLGetOverallBucketsRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no jobs. (this includes `_all` string or when no jobs have been specified).

func (MLGetOverallBuckets) WithBody ¶ 

func (f MLGetOverallBuckets) WithBody(v io.Reader) func(*MLGetOverallBucketsRequest)

WithBody - Overall bucket selection details if not provided in URI.

func (MLGetOverallBuckets) WithBucketSpan ¶ 

func (f MLGetOverallBuckets) WithBucketSpan(v string) func(*MLGetOverallBucketsRequest)

WithBucketSpan - the span of the overall buckets. defaults to the longest job bucket_span.

func (MLGetOverallBuckets) WithContext ¶ 

func (f MLGetOverallBuckets) WithContext(v context.Context) func(*MLGetOverallBucketsRequest)

WithContext sets the request context.

func (MLGetOverallBuckets) WithEnd ¶ 

func (f MLGetOverallBuckets) WithEnd(v string) func(*MLGetOverallBucketsRequest)

WithEnd - returns overall buckets with timestamps earlier than this time.

func (MLGetOverallBuckets) WithErrorTrace ¶ 

func (f MLGetOverallBuckets) WithErrorTrace() func(*MLGetOverallBucketsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetOverallBuckets) WithExcludeInterim ¶ 

func (f MLGetOverallBuckets) WithExcludeInterim(v bool) func(*MLGetOverallBucketsRequest)

WithExcludeInterim - if true overall buckets that include interim buckets will be excluded.

func (MLGetOverallBuckets) WithFilterPath ¶ 

func (f MLGetOverallBuckets) WithFilterPath(v ...string) func(*MLGetOverallBucketsRequest)

WithFilterPath filters the properties of the response body.

func (MLGetOverallBuckets) WithHeader ¶ 

func (f MLGetOverallBuckets) WithHeader(h map[string]string) func(*MLGetOverallBucketsRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetOverallBuckets) WithHuman ¶ 

func (f MLGetOverallBuckets) WithHuman() func(*MLGetOverallBucketsRequest)

WithHuman makes statistical values human-readable.

func (MLGetOverallBuckets) WithOpaqueID ¶ 

func (f MLGetOverallBuckets) WithOpaqueID(s string) func(*MLGetOverallBucketsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetOverallBuckets) WithOverallScore ¶ 

func (f MLGetOverallBuckets) WithOverallScore(v interface{}) func(*MLGetOverallBucketsRequest)

WithOverallScore - returns overall buckets with overall scores higher than this value.

func (MLGetOverallBuckets) WithPretty ¶ 

func (f MLGetOverallBuckets) WithPretty() func(*MLGetOverallBucketsRequest)

WithPretty makes the response body pretty-printed.

func (MLGetOverallBuckets) WithStart ¶ 

func (f MLGetOverallBuckets) WithStart(v string) func(*MLGetOverallBucketsRequest)

WithStart - returns overall buckets with timestamps after this time.

func (MLGetOverallBuckets) WithTopN ¶ 

func (f MLGetOverallBuckets) WithTopN(v int) func(*MLGetOverallBucketsRequest)

WithTopN - the number of top job bucket scores to be used in the overall_score calculation.

type MLGetOverallBucketsRequest ¶ 

type MLGetOverallBucketsRequest struct {
	Body io.Reader

	JobID string

	AllowNoMatch   *bool
	BucketSpan     string
	End            string
	ExcludeInterim *bool
	OverallScore   interface{}
	Start          string
	TopN           *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetOverallBucketsRequest configures the ML Get Overall Buckets API request.

func (MLGetOverallBucketsRequest) Do ¶ 

func (r MLGetOverallBucketsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetRecords ¶ 

type MLGetRecords func(job_id string, o ...func(*MLGetRecordsRequest)) (*Response, error)

MLGetRecords - Retrieves anomaly records for an anomaly detection job.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html.

func (MLGetRecords) WithBody ¶ 

func (f MLGetRecords) WithBody(v io.Reader) func(*MLGetRecordsRequest)

WithBody - Record selection criteria.

func (MLGetRecords) WithContext ¶ 

func (f MLGetRecords) WithContext(v context.Context) func(*MLGetRecordsRequest)

WithContext sets the request context.

func (MLGetRecords) WithDesc ¶ 

func (f MLGetRecords) WithDesc(v bool) func(*MLGetRecordsRequest)

WithDesc - set the sort direction.

func (MLGetRecords) WithEnd ¶ 

func (f MLGetRecords) WithEnd(v string) func(*MLGetRecordsRequest)

WithEnd - end time filter for records.

func (MLGetRecords) WithErrorTrace ¶ 

func (f MLGetRecords) WithErrorTrace() func(*MLGetRecordsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetRecords) WithExcludeInterim ¶ 

func (f MLGetRecords) WithExcludeInterim(v bool) func(*MLGetRecordsRequest)

WithExcludeInterim - exclude interim results.

func (MLGetRecords) WithFilterPath ¶ 

func (f MLGetRecords) WithFilterPath(v ...string) func(*MLGetRecordsRequest)

WithFilterPath filters the properties of the response body.

func (MLGetRecords) WithFrom ¶ 

func (f MLGetRecords) WithFrom(v int) func(*MLGetRecordsRequest)

WithFrom - skips a number of records.

func (MLGetRecords) WithHeader ¶ 

func (f MLGetRecords) WithHeader(h map[string]string) func(*MLGetRecordsRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetRecords) WithHuman ¶ 

func (f MLGetRecords) WithHuman() func(*MLGetRecordsRequest)

WithHuman makes statistical values human-readable.

func (MLGetRecords) WithOpaqueID ¶ 

func (f MLGetRecords) WithOpaqueID(s string) func(*MLGetRecordsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetRecords) WithPretty ¶ 

func (f MLGetRecords) WithPretty() func(*MLGetRecordsRequest)

WithPretty makes the response body pretty-printed.

func (MLGetRecords) WithRecordScore ¶ 

func (f MLGetRecords) WithRecordScore(v interface{}) func(*MLGetRecordsRequest)

WithRecordScore - returns records with anomaly scores greater or equal than this value.

func (MLGetRecords) WithSize ¶ 

func (f MLGetRecords) WithSize(v int) func(*MLGetRecordsRequest)

WithSize - specifies a max number of records to get.

func (MLGetRecords) WithSort ¶ 

func (f MLGetRecords) WithSort(v string) func(*MLGetRecordsRequest)

WithSort - sort records by a particular field.

func (MLGetRecords) WithStart ¶ 

func (f MLGetRecords) WithStart(v string) func(*MLGetRecordsRequest)

WithStart - start time filter for records.

type MLGetRecordsRequest ¶ 

type MLGetRecordsRequest struct {
	Body io.Reader

	JobID string

	Desc           *bool
	End            string
	ExcludeInterim *bool
	From           *int
	RecordScore    interface{}
	Size           *int
	Sort           string
	Start          string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetRecordsRequest configures the ML Get Records API request.

func (MLGetRecordsRequest) Do ¶ 

func (r MLGetRecordsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetTrainedModels ¶ 

type MLGetTrainedModels func(o ...func(*MLGetTrainedModelsRequest)) (*Response, error)

MLGetTrainedModels - Retrieves configuration information for a trained inference model.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html.

func (MLGetTrainedModels) WithAllowNoMatch ¶ 

func (f MLGetTrainedModels) WithAllowNoMatch(v bool) func(*MLGetTrainedModelsRequest)

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 (MLGetTrainedModels) WithContext ¶ 

func (f MLGetTrainedModels) WithContext(v context.Context) func(*MLGetTrainedModelsRequest)

WithContext sets the request context.

func (MLGetTrainedModels) WithDecompressDefinition ¶ 

func (f MLGetTrainedModels) WithDecompressDefinition(v bool) func(*MLGetTrainedModelsRequest)

WithDecompressDefinition - should the model definition be decompressed into valid json or returned in a custom compressed format. defaults to true..

func (MLGetTrainedModels) WithErrorTrace ¶ 

func (f MLGetTrainedModels) WithErrorTrace() func(*MLGetTrainedModelsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetTrainedModels) WithExcludeGenerated ¶ 

func (f MLGetTrainedModels) WithExcludeGenerated(v bool) func(*MLGetTrainedModelsRequest)

WithExcludeGenerated - omits fields that are illegal to set on model put.

func (MLGetTrainedModels) WithFilterPath ¶ 

func (f MLGetTrainedModels) WithFilterPath(v ...string) func(*MLGetTrainedModelsRequest)

WithFilterPath filters the properties of the response body.

func (MLGetTrainedModels) WithFrom ¶ 

func (f MLGetTrainedModels) WithFrom(v int) func(*MLGetTrainedModelsRequest)

WithFrom - skips a number of trained models.

func (MLGetTrainedModels) WithHeader ¶ 

func (f MLGetTrainedModels) WithHeader(h map[string]string) func(*MLGetTrainedModelsRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetTrainedModels) WithHuman ¶ 

func (f MLGetTrainedModels) WithHuman() func(*MLGetTrainedModelsRequest)

WithHuman makes statistical values human-readable.

func (MLGetTrainedModels) WithInclude ¶ 

func (f MLGetTrainedModels) WithInclude(v string) func(*MLGetTrainedModelsRequest)

WithInclude - a comma-separate list of fields to optionally include. valid options are 'definition' and 'total_feature_importance'. default is none..

func (MLGetTrainedModels) WithIncludeModelDefinition ¶ 

func (f MLGetTrainedModels) WithIncludeModelDefinition(v bool) func(*MLGetTrainedModelsRequest)

WithIncludeModelDefinition - should the full model definition be included in the results. these definitions can be large. so be cautious when including them. defaults to false..

func (MLGetTrainedModels) WithModelID ¶ 

func (f MLGetTrainedModels) WithModelID(v string) func(*MLGetTrainedModelsRequest)

WithModelID - the ID of the trained models to fetch.

func (MLGetTrainedModels) WithOpaqueID ¶ 

func (f MLGetTrainedModels) WithOpaqueID(s string) func(*MLGetTrainedModelsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetTrainedModels) WithPretty ¶ 

func (f MLGetTrainedModels) WithPretty() func(*MLGetTrainedModelsRequest)

WithPretty makes the response body pretty-printed.

func (MLGetTrainedModels) WithSize ¶ 

func (f MLGetTrainedModels) WithSize(v int) func(*MLGetTrainedModelsRequest)

WithSize - specifies a max number of trained models to get.

func (MLGetTrainedModels) WithTags ¶ 

func (f MLGetTrainedModels) WithTags(v ...string) func(*MLGetTrainedModelsRequest)

WithTags - a list of tags that the model must have..

type MLGetTrainedModelsRequest ¶ 

type MLGetTrainedModelsRequest struct {
	ModelID string

	AllowNoMatch           *bool
	DecompressDefinition   *bool
	ExcludeGenerated       *bool
	From                   *int
	Include                string
	IncludeModelDefinition *bool
	Size                   *int
	Tags                   []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetTrainedModelsRequest configures the ML Get Trained Models API request.

func (MLGetTrainedModelsRequest) Do ¶ 

func (r MLGetTrainedModelsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLGetTrainedModelsStats ¶ 

type MLGetTrainedModelsStats func(o ...func(*MLGetTrainedModelsStatsRequest)) (*Response, error)

MLGetTrainedModelsStats - Retrieves usage information for trained inference models.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html.

func (MLGetTrainedModelsStats) WithAllowNoMatch ¶ 

func (f MLGetTrainedModelsStats) WithAllowNoMatch(v bool) func(*MLGetTrainedModelsStatsRequest)

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 (MLGetTrainedModelsStats) WithContext ¶ 

func (f MLGetTrainedModelsStats) WithContext(v context.Context) func(*MLGetTrainedModelsStatsRequest)

WithContext sets the request context.

func (MLGetTrainedModelsStats) WithErrorTrace ¶ 

func (f MLGetTrainedModelsStats) WithErrorTrace() func(*MLGetTrainedModelsStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLGetTrainedModelsStats) WithFilterPath ¶ 

func (f MLGetTrainedModelsStats) WithFilterPath(v ...string) func(*MLGetTrainedModelsStatsRequest)

WithFilterPath filters the properties of the response body.

func (MLGetTrainedModelsStats) WithFrom ¶ 

func (f MLGetTrainedModelsStats) WithFrom(v int) func(*MLGetTrainedModelsStatsRequest)

WithFrom - skips a number of trained models.

func (MLGetTrainedModelsStats) WithHeader ¶ 

func (f MLGetTrainedModelsStats) WithHeader(h map[string]string) func(*MLGetTrainedModelsStatsRequest)

WithHeader adds the headers to the HTTP request.

func (MLGetTrainedModelsStats) WithHuman ¶ 

func (f MLGetTrainedModelsStats) WithHuman() func(*MLGetTrainedModelsStatsRequest)

WithHuman makes statistical values human-readable.

func (MLGetTrainedModelsStats) WithModelID ¶ 

func (f MLGetTrainedModelsStats) WithModelID(v string) func(*MLGetTrainedModelsStatsRequest)

WithModelID - the ID of the trained models stats to fetch.

func (MLGetTrainedModelsStats) WithOpaqueID ¶ 

func (f MLGetTrainedModelsStats) WithOpaqueID(s string) func(*MLGetTrainedModelsStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLGetTrainedModelsStats) WithPretty ¶ 

func (f MLGetTrainedModelsStats) WithPretty() func(*MLGetTrainedModelsStatsRequest)

WithPretty makes the response body pretty-printed.

func (MLGetTrainedModelsStats) WithSize ¶ 

func (f MLGetTrainedModelsStats) WithSize(v int) func(*MLGetTrainedModelsStatsRequest)

WithSize - specifies a max number of trained models to get.

type MLGetTrainedModelsStatsRequest ¶ 

type MLGetTrainedModelsStatsRequest struct {
	ModelID string

	AllowNoMatch *bool
	From         *int
	Size         *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLGetTrainedModelsStatsRequest configures the ML Get Trained Models Stats API request.

func (MLGetTrainedModelsStatsRequest) Do ¶ 

func (r MLGetTrainedModelsStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLInferTrainedModel ¶ added in v8.3.0 

type MLInferTrainedModel func(body io.Reader, model_id string, o ...func(*MLInferTrainedModelRequest)) (*Response, error)

MLInferTrainedModel - Evaluate a trained model.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html.

func (MLInferTrainedModel) WithContext ¶ added in v8.3.0 

func (f MLInferTrainedModel) WithContext(v context.Context) func(*MLInferTrainedModelRequest)

WithContext sets the request context.

func (MLInferTrainedModel) WithErrorTrace ¶ added in v8.3.0 

func (f MLInferTrainedModel) WithErrorTrace() func(*MLInferTrainedModelRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLInferTrainedModel) WithFilterPath ¶ added in v8.3.0 

func (f MLInferTrainedModel) WithFilterPath(v ...string) func(*MLInferTrainedModelRequest)

WithFilterPath filters the properties of the response body.

func (MLInferTrainedModel) WithHeader ¶ added in v8.3.0 

func (f MLInferTrainedModel) WithHeader(h map[string]string) func(*MLInferTrainedModelRequest)

WithHeader adds the headers to the HTTP request.

func (MLInferTrainedModel) WithHuman ¶ added in v8.3.0 

func (f MLInferTrainedModel) WithHuman() func(*MLInferTrainedModelRequest)

WithHuman makes statistical values human-readable.

func (MLInferTrainedModel) WithOpaqueID ¶ added in v8.3.0 

func (f MLInferTrainedModel) WithOpaqueID(s string) func(*MLInferTrainedModelRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLInferTrainedModel) WithPretty ¶ added in v8.3.0 

func (f MLInferTrainedModel) WithPretty() func(*MLInferTrainedModelRequest)

WithPretty makes the response body pretty-printed.

func (MLInferTrainedModel) WithTimeout ¶ added in v8.3.0 

func (f MLInferTrainedModel) WithTimeout(v time.Duration) func(*MLInferTrainedModelRequest)

WithTimeout - controls the amount of time to wait for inference results..

type MLInferTrainedModelRequest ¶ added in v8.3.0 

type MLInferTrainedModelRequest struct {
	Body io.Reader

	ModelID string

	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLInferTrainedModelRequest configures the ML Infer Trained Model API request.

func (MLInferTrainedModelRequest) Do ¶ added in v8.3.0 

func (r MLInferTrainedModelRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLInfo ¶ 

type MLInfo func(o ...func(*MLInfoRequest)) (*Response, error)

MLInfo - Returns defaults and limits used by machine learning.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html.

func (MLInfo) WithContext ¶ 

func (f MLInfo) WithContext(v context.Context) func(*MLInfoRequest)

WithContext sets the request context.

func (MLInfo) WithErrorTrace ¶ 

func (f MLInfo) WithErrorTrace() func(*MLInfoRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLInfo) WithFilterPath ¶ 

func (f MLInfo) WithFilterPath(v ...string) func(*MLInfoRequest)

WithFilterPath filters the properties of the response body.

func (MLInfo) WithHeader ¶ 

func (f MLInfo) WithHeader(h map[string]string) func(*MLInfoRequest)

WithHeader adds the headers to the HTTP request.

func (MLInfo) WithHuman ¶ 

func (f MLInfo) WithHuman() func(*MLInfoRequest)

WithHuman makes statistical values human-readable.

func (MLInfo) WithOpaqueID ¶ 

func (f MLInfo) WithOpaqueID(s string) func(*MLInfoRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLInfo) WithPretty ¶ 

func (f MLInfo) WithPretty() func(*MLInfoRequest)

WithPretty makes the response body pretty-printed.

type MLInfoRequest ¶ 

type MLInfoRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLInfoRequest configures the ML Info API request.

func (MLInfoRequest) Do ¶ 

func (r MLInfoRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLOpenJob ¶ 

type MLOpenJob func(job_id string, o ...func(*MLOpenJobRequest)) (*Response, error)

MLOpenJob - Opens one or more anomaly detection jobs.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html.

func (MLOpenJob) WithBody ¶ 

func (f MLOpenJob) WithBody(v io.Reader) func(*MLOpenJobRequest)

WithBody - Query parameters can be specified in the body.

func (MLOpenJob) WithContext ¶ 

func (f MLOpenJob) WithContext(v context.Context) func(*MLOpenJobRequest)

WithContext sets the request context.

func (MLOpenJob) WithErrorTrace ¶ 

func (f MLOpenJob) WithErrorTrace() func(*MLOpenJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLOpenJob) WithFilterPath ¶ 

func (f MLOpenJob) WithFilterPath(v ...string) func(*MLOpenJobRequest)

WithFilterPath filters the properties of the response body.

func (MLOpenJob) WithHeader ¶ 

func (f MLOpenJob) WithHeader(h map[string]string) func(*MLOpenJobRequest)

WithHeader adds the headers to the HTTP request.

func (MLOpenJob) WithHuman ¶ 

func (f MLOpenJob) WithHuman() func(*MLOpenJobRequest)

WithHuman makes statistical values human-readable.

func (MLOpenJob) WithOpaqueID ¶ 

func (f MLOpenJob) WithOpaqueID(s string) func(*MLOpenJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLOpenJob) WithPretty ¶ 

func (f MLOpenJob) WithPretty() func(*MLOpenJobRequest)

WithPretty makes the response body pretty-printed.

type MLOpenJobRequest ¶ 

type MLOpenJobRequest struct {
	Body io.Reader

	JobID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLOpenJobRequest configures the ML Open Job API request.

func (MLOpenJobRequest) Do ¶ 

func (r MLOpenJobRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLPostCalendarEvents ¶ 

type MLPostCalendarEvents func(calendar_id string, body io.Reader, o ...func(*MLPostCalendarEventsRequest)) (*Response, error)

MLPostCalendarEvents - Posts scheduled events in a calendar.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html.

func (MLPostCalendarEvents) WithContext ¶ 

func (f MLPostCalendarEvents) WithContext(v context.Context) func(*MLPostCalendarEventsRequest)

WithContext sets the request context.

func (MLPostCalendarEvents) WithErrorTrace ¶ 

func (f MLPostCalendarEvents) WithErrorTrace() func(*MLPostCalendarEventsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLPostCalendarEvents) WithFilterPath ¶ 

func (f MLPostCalendarEvents) WithFilterPath(v ...string) func(*MLPostCalendarEventsRequest)

WithFilterPath filters the properties of the response body.

func (MLPostCalendarEvents) WithHeader ¶ 

func (f MLPostCalendarEvents) WithHeader(h map[string]string) func(*MLPostCalendarEventsRequest)

WithHeader adds the headers to the HTTP request.

func (MLPostCalendarEvents) WithHuman ¶ 

func (f MLPostCalendarEvents) WithHuman() func(*MLPostCalendarEventsRequest)

WithHuman makes statistical values human-readable.

func (MLPostCalendarEvents) WithOpaqueID ¶ 

func (f MLPostCalendarEvents) WithOpaqueID(s string) func(*MLPostCalendarEventsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLPostCalendarEvents) WithPretty ¶ 

func (f MLPostCalendarEvents) WithPretty() func(*MLPostCalendarEventsRequest)

WithPretty makes the response body pretty-printed.

type MLPostCalendarEventsRequest ¶ 

type MLPostCalendarEventsRequest struct {
	Body io.Reader

	CalendarID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLPostCalendarEventsRequest configures the ML Post Calendar Events API request.

func (MLPostCalendarEventsRequest) Do ¶ 

func (r MLPostCalendarEventsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLPostData ¶ 

type MLPostData func(job_id string, body io.Reader, o ...func(*MLPostDataRequest)) (*Response, error)

MLPostData - Sends data to an anomaly detection job for analysis.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html.

func (MLPostData) WithContext ¶ 

func (f MLPostData) WithContext(v context.Context) func(*MLPostDataRequest)

WithContext sets the request context.

func (MLPostData) WithErrorTrace ¶ 

func (f MLPostData) WithErrorTrace() func(*MLPostDataRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLPostData) WithFilterPath ¶ 

func (f MLPostData) WithFilterPath(v ...string) func(*MLPostDataRequest)

WithFilterPath filters the properties of the response body.

func (MLPostData) WithHeader ¶ 

func (f MLPostData) WithHeader(h map[string]string) func(*MLPostDataRequest)

WithHeader adds the headers to the HTTP request.

func (MLPostData) WithHuman ¶ 

func (f MLPostData) WithHuman() func(*MLPostDataRequest)

WithHuman makes statistical values human-readable.

func (MLPostData) WithOpaqueID ¶ 

func (f MLPostData) WithOpaqueID(s string) func(*MLPostDataRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLPostData) WithPretty ¶ 

func (f MLPostData) WithPretty() func(*MLPostDataRequest)

WithPretty makes the response body pretty-printed.

func (MLPostData) WithResetEnd ¶ 

func (f MLPostData) WithResetEnd(v string) func(*MLPostDataRequest)

WithResetEnd - optional parameter to specify the end of the bucket resetting range.

func (MLPostData) WithResetStart ¶ 

func (f MLPostData) WithResetStart(v string) func(*MLPostDataRequest)

WithResetStart - optional parameter to specify the start of the bucket resetting range.

type MLPostDataRequest ¶ 

type MLPostDataRequest struct {
	Body io.Reader

	JobID string

	ResetEnd   string
	ResetStart string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLPostDataRequest configures the ML Post Data API request.

func (MLPostDataRequest) Do ¶ 

func (r MLPostDataRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLPreviewDataFrameAnalytics ¶ 

type MLPreviewDataFrameAnalytics func(o ...func(*MLPreviewDataFrameAnalyticsRequest)) (*Response, error)

MLPreviewDataFrameAnalytics - Previews that will be analyzed given a data frame analytics config.

See full documentation at http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html.

func (MLPreviewDataFrameAnalytics) WithBody ¶ 

func (f MLPreviewDataFrameAnalytics) WithBody(v io.Reader) func(*MLPreviewDataFrameAnalyticsRequest)

WithBody - The data frame analytics config to preview.

func (MLPreviewDataFrameAnalytics) WithContext ¶ 

func (f MLPreviewDataFrameAnalytics) WithContext(v context.Context) func(*MLPreviewDataFrameAnalyticsRequest)

WithContext sets the request context.

func (MLPreviewDataFrameAnalytics) WithDocumentID ¶ 

func (f MLPreviewDataFrameAnalytics) WithDocumentID(v string) func(*MLPreviewDataFrameAnalyticsRequest)

WithDocumentID - the ID of the data frame analytics to preview.

func (MLPreviewDataFrameAnalytics) WithErrorTrace ¶ 

func (f MLPreviewDataFrameAnalytics) WithErrorTrace() func(*MLPreviewDataFrameAnalyticsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLPreviewDataFrameAnalytics) WithFilterPath ¶ 

func (f MLPreviewDataFrameAnalytics) WithFilterPath(v ...string) func(*MLPreviewDataFrameAnalyticsRequest)

WithFilterPath filters the properties of the response body.

func (MLPreviewDataFrameAnalytics) WithHeader ¶ 

func (f MLPreviewDataFrameAnalytics) WithHeader(h map[string]string) func(*MLPreviewDataFrameAnalyticsRequest)

WithHeader adds the headers to the HTTP request.

func (MLPreviewDataFrameAnalytics) WithHuman ¶ 

func (f MLPreviewDataFrameAnalytics) WithHuman() func(*MLPreviewDataFrameAnalyticsRequest)

WithHuman makes statistical values human-readable.

func (MLPreviewDataFrameAnalytics) WithOpaqueID ¶ 

func (f MLPreviewDataFrameAnalytics) WithOpaqueID(s string) func(*MLPreviewDataFrameAnalyticsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLPreviewDataFrameAnalytics) WithPretty ¶ 

func (f MLPreviewDataFrameAnalytics) WithPretty() func(*MLPreviewDataFrameAnalyticsRequest)

WithPretty makes the response body pretty-printed.

type MLPreviewDataFrameAnalyticsRequest ¶ 

type MLPreviewDataFrameAnalyticsRequest struct {
	DocumentID string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLPreviewDataFrameAnalyticsRequest configures the ML Preview Data Frame Analytics API request.

func (MLPreviewDataFrameAnalyticsRequest) Do ¶ 

func (r MLPreviewDataFrameAnalyticsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLPreviewDatafeed ¶ 

type MLPreviewDatafeed func(o ...func(*MLPreviewDatafeedRequest)) (*Response, error)

MLPreviewDatafeed - Previews a datafeed.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html.

func (MLPreviewDatafeed) WithBody ¶ 

func (f MLPreviewDatafeed) WithBody(v io.Reader) func(*MLPreviewDatafeedRequest)

WithBody - The datafeed config and job config with which to execute the preview.

func (MLPreviewDatafeed) WithContext ¶ 

func (f MLPreviewDatafeed) WithContext(v context.Context) func(*MLPreviewDatafeedRequest)

WithContext sets the request context.

func (MLPreviewDatafeed) WithDatafeedID ¶ 

func (f MLPreviewDatafeed) WithDatafeedID(v string) func(*MLPreviewDatafeedRequest)

WithDatafeedID - the ID of the datafeed to preview.

func (MLPreviewDatafeed) WithEnd ¶ added in v8.3.0 

func (f MLPreviewDatafeed) WithEnd(v string) func(*MLPreviewDatafeedRequest)

WithEnd - the end time when the datafeed preview should stop.

func (MLPreviewDatafeed) WithErrorTrace ¶ 

func (f MLPreviewDatafeed) WithErrorTrace() func(*MLPreviewDatafeedRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLPreviewDatafeed) WithFilterPath ¶ 

func (f MLPreviewDatafeed) WithFilterPath(v ...string) func(*MLPreviewDatafeedRequest)

WithFilterPath filters the properties of the response body.

func (MLPreviewDatafeed) WithHeader ¶ 

func (f MLPreviewDatafeed) WithHeader(h map[string]string) func(*MLPreviewDatafeedRequest)

WithHeader adds the headers to the HTTP request.

func (MLPreviewDatafeed) WithHuman ¶ 

func (f MLPreviewDatafeed) WithHuman() func(*MLPreviewDatafeedRequest)

WithHuman makes statistical values human-readable.

func (MLPreviewDatafeed) WithOpaqueID ¶ 

func (f MLPreviewDatafeed) WithOpaqueID(s string) func(*MLPreviewDatafeedRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLPreviewDatafeed) WithPretty ¶ 

func (f MLPreviewDatafeed) WithPretty() func(*MLPreviewDatafeedRequest)

WithPretty makes the response body pretty-printed.

func (MLPreviewDatafeed) WithStart ¶ added in v8.3.0 

func (f MLPreviewDatafeed) WithStart(v string) func(*MLPreviewDatafeedRequest)

WithStart - the start time from where the datafeed preview should begin.

type MLPreviewDatafeedRequest ¶ 

type MLPreviewDatafeedRequest struct {
	Body io.Reader

	DatafeedID string

	End   string
	Start string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLPreviewDatafeedRequest configures the ML Preview Datafeed API request.

func (MLPreviewDatafeedRequest) Do ¶ 

func (r MLPreviewDatafeedRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLPutCalendar ¶ 

type MLPutCalendar func(calendar_id string, o ...func(*MLPutCalendarRequest)) (*Response, error)

MLPutCalendar - Instantiates a calendar.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html.

func (MLPutCalendar) WithBody ¶ 

func (f MLPutCalendar) WithBody(v io.Reader) func(*MLPutCalendarRequest)

WithBody - The calendar details.

func (MLPutCalendar) WithContext ¶ 

func (f MLPutCalendar) WithContext(v context.Context) func(*MLPutCalendarRequest)

WithContext sets the request context.

func (MLPutCalendar) WithErrorTrace ¶ 

func (f MLPutCalendar) WithErrorTrace() func(*MLPutCalendarRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLPutCalendar) WithFilterPath ¶ 

func (f MLPutCalendar) WithFilterPath(v ...string) func(*MLPutCalendarRequest)

WithFilterPath filters the properties of the response body.

func (MLPutCalendar) WithHeader ¶ 

func (f MLPutCalendar) WithHeader(h map[string]string) func(*MLPutCalendarRequest)

WithHeader adds the headers to the HTTP request.

func (MLPutCalendar) WithHuman ¶ 

func (f MLPutCalendar) WithHuman() func(*MLPutCalendarRequest)

WithHuman makes statistical values human-readable.

func (MLPutCalendar) WithOpaqueID ¶ 

func (f MLPutCalendar) WithOpaqueID(s string) func(*MLPutCalendarRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLPutCalendar) WithPretty ¶ 

func (f MLPutCalendar) WithPretty() func(*MLPutCalendarRequest)

WithPretty makes the response body pretty-printed.

type MLPutCalendarJob ¶ 

type MLPutCalendarJob func(calendar_id string, job_id string, o ...func(*MLPutCalendarJobRequest)) (*Response, error)

MLPutCalendarJob - Adds an anomaly detection job to a calendar.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html.

func (MLPutCalendarJob) WithContext ¶ 

func (f MLPutCalendarJob) WithContext(v context.Context) func(*MLPutCalendarJobRequest)

WithContext sets the request context.

func (MLPutCalendarJob) WithErrorTrace ¶ 

func (f MLPutCalendarJob) WithErrorTrace() func(*MLPutCalendarJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLPutCalendarJob) WithFilterPath ¶ 

func (f MLPutCalendarJob) WithFilterPath(v ...string) func(*MLPutCalendarJobRequest)

WithFilterPath filters the properties of the response body.

func (MLPutCalendarJob) WithHeader ¶ 

func (f MLPutCalendarJob) WithHeader(h map[string]string) func(*MLPutCalendarJobRequest)

WithHeader adds the headers to the HTTP request.

func (MLPutCalendarJob) WithHuman ¶ 

func (f MLPutCalendarJob) WithHuman() func(*MLPutCalendarJobRequest)

WithHuman makes statistical values human-readable.

func (MLPutCalendarJob) WithOpaqueID ¶ 

func (f MLPutCalendarJob) WithOpaqueID(s string) func(*MLPutCalendarJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLPutCalendarJob) WithPretty ¶ 

func (f MLPutCalendarJob) WithPretty() func(*MLPutCalendarJobRequest)

WithPretty makes the response body pretty-printed.

type MLPutCalendarJobRequest ¶ 

type MLPutCalendarJobRequest struct {
	CalendarID string
	JobID      string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLPutCalendarJobRequest configures the ML Put Calendar Job API request.

func (MLPutCalendarJobRequest) Do ¶ 

func (r MLPutCalendarJobRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLPutCalendarRequest ¶ 

type MLPutCalendarRequest struct {
	Body io.Reader

	CalendarID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLPutCalendarRequest configures the ML Put Calendar API request.

func (MLPutCalendarRequest) Do ¶ 

func (r MLPutCalendarRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLPutDataFrameAnalytics ¶ 

type MLPutDataFrameAnalytics func(id string, body io.Reader, o ...func(*MLPutDataFrameAnalyticsRequest)) (*Response, error)

MLPutDataFrameAnalytics - Instantiates a data frame analytics job.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html.

func (MLPutDataFrameAnalytics) WithContext ¶ 

func (f MLPutDataFrameAnalytics) WithContext(v context.Context) func(*MLPutDataFrameAnalyticsRequest)

WithContext sets the request context.

func (MLPutDataFrameAnalytics) WithErrorTrace ¶ 

func (f MLPutDataFrameAnalytics) WithErrorTrace() func(*MLPutDataFrameAnalyticsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLPutDataFrameAnalytics) WithFilterPath ¶ 

func (f MLPutDataFrameAnalytics) WithFilterPath(v ...string) func(*MLPutDataFrameAnalyticsRequest)

WithFilterPath filters the properties of the response body.

func (MLPutDataFrameAnalytics) WithHeader ¶ 

func (f MLPutDataFrameAnalytics) WithHeader(h map[string]string) func(*MLPutDataFrameAnalyticsRequest)

WithHeader adds the headers to the HTTP request.

func (MLPutDataFrameAnalytics) WithHuman ¶ 

func (f MLPutDataFrameAnalytics) WithHuman() func(*MLPutDataFrameAnalyticsRequest)

WithHuman makes statistical values human-readable.

func (MLPutDataFrameAnalytics) WithOpaqueID ¶ 

func (f MLPutDataFrameAnalytics) WithOpaqueID(s string) func(*MLPutDataFrameAnalyticsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLPutDataFrameAnalytics) WithPretty ¶ 

func (f MLPutDataFrameAnalytics) WithPretty() func(*MLPutDataFrameAnalyticsRequest)

WithPretty makes the response body pretty-printed.

type MLPutDataFrameAnalyticsRequest ¶ 

type MLPutDataFrameAnalyticsRequest struct {
	ID string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLPutDataFrameAnalyticsRequest configures the ML Put Data Frame Analytics API request.

func (MLPutDataFrameAnalyticsRequest) Do ¶ 

func (r MLPutDataFrameAnalyticsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLPutDatafeed ¶ 

type MLPutDatafeed func(body io.Reader, datafeed_id string, o ...func(*MLPutDatafeedRequest)) (*Response, error)

MLPutDatafeed - Instantiates a datafeed.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html.

func (MLPutDatafeed) WithAllowNoIndices ¶ 

func (f MLPutDatafeed) WithAllowNoIndices(v bool) func(*MLPutDatafeedRequest)

WithAllowNoIndices - ignore if the source indices expressions resolves to no concrete indices (default: true).

func (MLPutDatafeed) WithContext ¶ 

func (f MLPutDatafeed) WithContext(v context.Context) func(*MLPutDatafeedRequest)

WithContext sets the request context.

func (MLPutDatafeed) WithErrorTrace ¶ 

func (f MLPutDatafeed) WithErrorTrace() func(*MLPutDatafeedRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLPutDatafeed) WithExpandWildcards ¶ 

func (f MLPutDatafeed) WithExpandWildcards(v string) func(*MLPutDatafeedRequest)

WithExpandWildcards - whether source index expressions should get expanded to open or closed indices (default: open).

func (MLPutDatafeed) WithFilterPath ¶ 

func (f MLPutDatafeed) WithFilterPath(v ...string) func(*MLPutDatafeedRequest)

WithFilterPath filters the properties of the response body.

func (MLPutDatafeed) WithHeader ¶ 

func (f MLPutDatafeed) WithHeader(h map[string]string) func(*MLPutDatafeedRequest)

WithHeader adds the headers to the HTTP request.

func (MLPutDatafeed) WithHuman ¶ 

func (f MLPutDatafeed) WithHuman() func(*MLPutDatafeedRequest)

WithHuman makes statistical values human-readable.

func (MLPutDatafeed) WithIgnoreThrottled ¶ 

func (f MLPutDatafeed) WithIgnoreThrottled(v bool) func(*MLPutDatafeedRequest)

WithIgnoreThrottled - ignore indices that are marked as throttled (default: true).

func (MLPutDatafeed) WithIgnoreUnavailable ¶ 

func (f MLPutDatafeed) WithIgnoreUnavailable(v bool) func(*MLPutDatafeedRequest)

WithIgnoreUnavailable - ignore unavailable indexes (default: false).

func (MLPutDatafeed) WithOpaqueID ¶ 

func (f MLPutDatafeed) WithOpaqueID(s string) func(*MLPutDatafeedRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLPutDatafeed) WithPretty ¶ 

func (f MLPutDatafeed) WithPretty() func(*MLPutDatafeedRequest)

WithPretty makes the response body pretty-printed.

type MLPutDatafeedRequest ¶ 

type MLPutDatafeedRequest struct {
	Body io.Reader

	DatafeedID string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreThrottled   *bool
	IgnoreUnavailable *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLPutDatafeedRequest configures the ML Put Datafeed API request.

func (MLPutDatafeedRequest) Do ¶ 

func (r MLPutDatafeedRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLPutFilter ¶ 

type MLPutFilter func(body io.Reader, filter_id string, o ...func(*MLPutFilterRequest)) (*Response, error)

MLPutFilter - Instantiates a filter.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html.

func (MLPutFilter) WithContext ¶ 

func (f MLPutFilter) WithContext(v context.Context) func(*MLPutFilterRequest)

WithContext sets the request context.

func (MLPutFilter) WithErrorTrace ¶ 

func (f MLPutFilter) WithErrorTrace() func(*MLPutFilterRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLPutFilter) WithFilterPath ¶ 

func (f MLPutFilter) WithFilterPath(v ...string) func(*MLPutFilterRequest)

WithFilterPath filters the properties of the response body.

func (MLPutFilter) WithHeader ¶ 

func (f MLPutFilter) WithHeader(h map[string]string) func(*MLPutFilterRequest)

WithHeader adds the headers to the HTTP request.

func (MLPutFilter) WithHuman ¶ 

func (f MLPutFilter) WithHuman() func(*MLPutFilterRequest)

WithHuman makes statistical values human-readable.

func (MLPutFilter) WithOpaqueID ¶ 

func (f MLPutFilter) WithOpaqueID(s string) func(*MLPutFilterRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLPutFilter) WithPretty ¶ 

func (f MLPutFilter) WithPretty() func(*MLPutFilterRequest)

WithPretty makes the response body pretty-printed.

type MLPutFilterRequest ¶ 

type MLPutFilterRequest struct {
	Body io.Reader

	FilterID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLPutFilterRequest configures the ML Put Filter API request.

func (MLPutFilterRequest) Do ¶ 

func (r MLPutFilterRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLPutJob ¶ 

type MLPutJob func(job_id string, body io.Reader, o ...func(*MLPutJobRequest)) (*Response, error)

MLPutJob - Instantiates an anomaly detection job.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html.

func (MLPutJob) WithAllowNoIndices ¶ 

func (f MLPutJob) WithAllowNoIndices(v bool) func(*MLPutJobRequest)

WithAllowNoIndices - ignore if the source indices expressions resolves to no concrete indices (default: true). only set if datafeed_config is provided..

func (MLPutJob) WithContext ¶ 

func (f MLPutJob) WithContext(v context.Context) func(*MLPutJobRequest)

WithContext sets the request context.

func (MLPutJob) WithErrorTrace ¶ 

func (f MLPutJob) WithErrorTrace() func(*MLPutJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLPutJob) WithExpandWildcards ¶ 

func (f MLPutJob) WithExpandWildcards(v string) func(*MLPutJobRequest)

WithExpandWildcards - whether source index expressions should get expanded to open or closed indices (default: open). only set if datafeed_config is provided..

func (MLPutJob) WithFilterPath ¶ 

func (f MLPutJob) WithFilterPath(v ...string) func(*MLPutJobRequest)

WithFilterPath filters the properties of the response body.

func (MLPutJob) WithHeader ¶ 

func (f MLPutJob) WithHeader(h map[string]string) func(*MLPutJobRequest)

WithHeader adds the headers to the HTTP request.

func (MLPutJob) WithHuman ¶ 

func (f MLPutJob) WithHuman() func(*MLPutJobRequest)

WithHuman makes statistical values human-readable.

func (MLPutJob) WithIgnoreThrottled ¶ 

func (f MLPutJob) WithIgnoreThrottled(v bool) func(*MLPutJobRequest)

WithIgnoreThrottled - ignore indices that are marked as throttled (default: true). only set if datafeed_config is provided..

func (MLPutJob) WithIgnoreUnavailable ¶ 

func (f MLPutJob) WithIgnoreUnavailable(v bool) func(*MLPutJobRequest)

WithIgnoreUnavailable - ignore unavailable indexes (default: false). only set if datafeed_config is provided..

func (MLPutJob) WithOpaqueID ¶ 

func (f MLPutJob) WithOpaqueID(s string) func(*MLPutJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLPutJob) WithPretty ¶ 

func (f MLPutJob) WithPretty() func(*MLPutJobRequest)

WithPretty makes the response body pretty-printed.

type MLPutJobRequest ¶ 

type MLPutJobRequest struct {
	Body io.Reader

	JobID string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreThrottled   *bool
	IgnoreUnavailable *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLPutJobRequest configures the ML Put Job API request.

func (MLPutJobRequest) Do ¶ 

func (r MLPutJobRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLPutTrainedModel ¶ 

type MLPutTrainedModel func(body io.Reader, model_id string, o ...func(*MLPutTrainedModelRequest)) (*Response, error)

MLPutTrainedModel - Creates an inference trained model.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html.

func (MLPutTrainedModel) WithContext ¶ 

func (f MLPutTrainedModel) WithContext(v context.Context) func(*MLPutTrainedModelRequest)

WithContext sets the request context.

func (MLPutTrainedModel) WithDeferDefinitionDecompression ¶ 

func (f MLPutTrainedModel) WithDeferDefinitionDecompression(v bool) func(*MLPutTrainedModelRequest)

WithDeferDefinitionDecompression - if set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations..

func (MLPutTrainedModel) WithErrorTrace ¶ 

func (f MLPutTrainedModel) WithErrorTrace() func(*MLPutTrainedModelRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLPutTrainedModel) WithFilterPath ¶ 

func (f MLPutTrainedModel) WithFilterPath(v ...string) func(*MLPutTrainedModelRequest)

WithFilterPath filters the properties of the response body.

func (MLPutTrainedModel) WithHeader ¶ 

func (f MLPutTrainedModel) WithHeader(h map[string]string) func(*MLPutTrainedModelRequest)

WithHeader adds the headers to the HTTP request.

func (MLPutTrainedModel) WithHuman ¶ 

func (f MLPutTrainedModel) WithHuman() func(*MLPutTrainedModelRequest)

WithHuman makes statistical values human-readable.

func (MLPutTrainedModel) WithOpaqueID ¶ 

func (f MLPutTrainedModel) WithOpaqueID(s string) func(*MLPutTrainedModelRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLPutTrainedModel) WithPretty ¶ 

func (f MLPutTrainedModel) WithPretty() func(*MLPutTrainedModelRequest)

WithPretty makes the response body pretty-printed.

func (MLPutTrainedModel) WithWaitForCompletion ¶ added in v8.8.0 

func (f MLPutTrainedModel) WithWaitForCompletion(v bool) func(*MLPutTrainedModelRequest)

WithWaitForCompletion - whether to wait for all child operations(e.g. model download) to complete, before returning or not. default to false.

type MLPutTrainedModelAlias ¶ 

type MLPutTrainedModelAlias func(model_alias string, model_id string, o ...func(*MLPutTrainedModelAliasRequest)) (*Response, error)

MLPutTrainedModelAlias - Creates a new model alias (or reassigns an existing one) to refer to the trained model

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html.

func (MLPutTrainedModelAlias) WithContext ¶ 

func (f MLPutTrainedModelAlias) WithContext(v context.Context) func(*MLPutTrainedModelAliasRequest)

WithContext sets the request context.

func (MLPutTrainedModelAlias) WithErrorTrace ¶ 

func (f MLPutTrainedModelAlias) WithErrorTrace() func(*MLPutTrainedModelAliasRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLPutTrainedModelAlias) WithFilterPath ¶ 

func (f MLPutTrainedModelAlias) WithFilterPath(v ...string) func(*MLPutTrainedModelAliasRequest)

WithFilterPath filters the properties of the response body.

func (MLPutTrainedModelAlias) WithHeader ¶ 

func (f MLPutTrainedModelAlias) WithHeader(h map[string]string) func(*MLPutTrainedModelAliasRequest)

WithHeader adds the headers to the HTTP request.

func (MLPutTrainedModelAlias) WithHuman ¶ 

func (f MLPutTrainedModelAlias) WithHuman() func(*MLPutTrainedModelAliasRequest)

WithHuman makes statistical values human-readable.

func (MLPutTrainedModelAlias) WithOpaqueID ¶ 

func (f MLPutTrainedModelAlias) WithOpaqueID(s string) func(*MLPutTrainedModelAliasRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLPutTrainedModelAlias) WithPretty ¶ 

func (f MLPutTrainedModelAlias) WithPretty() func(*MLPutTrainedModelAliasRequest)

WithPretty makes the response body pretty-printed.

func (MLPutTrainedModelAlias) WithReassign ¶ 

func (f MLPutTrainedModelAlias) WithReassign(v bool) func(*MLPutTrainedModelAliasRequest)

WithReassign - if the model_alias already exists and points to a separate model_id, this parameter must be true. defaults to false..

type MLPutTrainedModelAliasRequest ¶ 

type MLPutTrainedModelAliasRequest struct {
	ModelAlias string
	ModelID    string

	Reassign *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLPutTrainedModelAliasRequest configures the ML Put Trained Model Alias API request.

func (MLPutTrainedModelAliasRequest) Do ¶ 

func (r MLPutTrainedModelAliasRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLPutTrainedModelDefinitionPart ¶ 

type MLPutTrainedModelDefinitionPart func(body io.Reader, model_id string, part *int, o ...func(*MLPutTrainedModelDefinitionPartRequest)) (*Response, error)

MLPutTrainedModelDefinitionPart - Creates part of a trained model definition

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html.

func (MLPutTrainedModelDefinitionPart) WithContext ¶ 

func (f MLPutTrainedModelDefinitionPart) WithContext(v context.Context) func(*MLPutTrainedModelDefinitionPartRequest)

WithContext sets the request context.

func (MLPutTrainedModelDefinitionPart) WithErrorTrace ¶ 

func (f MLPutTrainedModelDefinitionPart) WithErrorTrace() func(*MLPutTrainedModelDefinitionPartRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLPutTrainedModelDefinitionPart) WithFilterPath ¶ 

func (f MLPutTrainedModelDefinitionPart) WithFilterPath(v ...string) func(*MLPutTrainedModelDefinitionPartRequest)

WithFilterPath filters the properties of the response body.

func (MLPutTrainedModelDefinitionPart) WithHeader ¶ 

func (f MLPutTrainedModelDefinitionPart) WithHeader(h map[string]string) func(*MLPutTrainedModelDefinitionPartRequest)

WithHeader adds the headers to the HTTP request.

func (MLPutTrainedModelDefinitionPart) WithHuman ¶ 

func (f MLPutTrainedModelDefinitionPart) WithHuman() func(*MLPutTrainedModelDefinitionPartRequest)

WithHuman makes statistical values human-readable.

func (MLPutTrainedModelDefinitionPart) WithOpaqueID ¶ 

func (f MLPutTrainedModelDefinitionPart) WithOpaqueID(s string) func(*MLPutTrainedModelDefinitionPartRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLPutTrainedModelDefinitionPart) WithPretty ¶ 

func (f MLPutTrainedModelDefinitionPart) WithPretty() func(*MLPutTrainedModelDefinitionPartRequest)

WithPretty makes the response body pretty-printed.

type MLPutTrainedModelDefinitionPartRequest ¶ 

type MLPutTrainedModelDefinitionPartRequest struct {
	Body io.Reader

	ModelID string
	Part    *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLPutTrainedModelDefinitionPartRequest configures the ML Put Trained Model Definition Part API request.

func (MLPutTrainedModelDefinitionPartRequest) Do ¶ 

func (r MLPutTrainedModelDefinitionPartRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLPutTrainedModelRequest ¶ 

type MLPutTrainedModelRequest struct {
	Body io.Reader

	ModelID string

	DeferDefinitionDecompression *bool
	WaitForCompletion            *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLPutTrainedModelRequest configures the ML Put Trained Model API request.

func (MLPutTrainedModelRequest) Do ¶ 

func (r MLPutTrainedModelRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLPutTrainedModelVocabulary ¶ 

type MLPutTrainedModelVocabulary func(body io.Reader, model_id string, o ...func(*MLPutTrainedModelVocabularyRequest)) (*Response, error)

MLPutTrainedModelVocabulary - Creates a trained model vocabulary

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html.

func (MLPutTrainedModelVocabulary) WithContext ¶ 

func (f MLPutTrainedModelVocabulary) WithContext(v context.Context) func(*MLPutTrainedModelVocabularyRequest)

WithContext sets the request context.

func (MLPutTrainedModelVocabulary) WithErrorTrace ¶ 

func (f MLPutTrainedModelVocabulary) WithErrorTrace() func(*MLPutTrainedModelVocabularyRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLPutTrainedModelVocabulary) WithFilterPath ¶ 

func (f MLPutTrainedModelVocabulary) WithFilterPath(v ...string) func(*MLPutTrainedModelVocabularyRequest)

WithFilterPath filters the properties of the response body.

func (MLPutTrainedModelVocabulary) WithHeader ¶ 

func (f MLPutTrainedModelVocabulary) WithHeader(h map[string]string) func(*MLPutTrainedModelVocabularyRequest)

WithHeader adds the headers to the HTTP request.

func (MLPutTrainedModelVocabulary) WithHuman ¶ 

func (f MLPutTrainedModelVocabulary) WithHuman() func(*MLPutTrainedModelVocabularyRequest)

WithHuman makes statistical values human-readable.

func (MLPutTrainedModelVocabulary) WithOpaqueID ¶ 

func (f MLPutTrainedModelVocabulary) WithOpaqueID(s string) func(*MLPutTrainedModelVocabularyRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLPutTrainedModelVocabulary) WithPretty ¶ 

func (f MLPutTrainedModelVocabulary) WithPretty() func(*MLPutTrainedModelVocabularyRequest)

WithPretty makes the response body pretty-printed.

type MLPutTrainedModelVocabularyRequest ¶ 

type MLPutTrainedModelVocabularyRequest struct {
	Body io.Reader

	ModelID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLPutTrainedModelVocabularyRequest configures the ML Put Trained Model Vocabulary API request.

func (MLPutTrainedModelVocabularyRequest) Do ¶ 

func (r MLPutTrainedModelVocabularyRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLResetJob ¶ 

type MLResetJob func(job_id string, o ...func(*MLResetJobRequest)) (*Response, error)

MLResetJob - Resets an existing anomaly detection job.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html.

func (MLResetJob) WithContext ¶ 

func (f MLResetJob) WithContext(v context.Context) func(*MLResetJobRequest)

WithContext sets the request context.

func (MLResetJob) WithDeleteUserAnnotations ¶ added in v8.7.0 

func (f MLResetJob) WithDeleteUserAnnotations(v bool) func(*MLResetJobRequest)

WithDeleteUserAnnotations - should annotations added by the user be deleted.

func (MLResetJob) WithErrorTrace ¶ 

func (f MLResetJob) WithErrorTrace() func(*MLResetJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLResetJob) WithFilterPath ¶ 

func (f MLResetJob) WithFilterPath(v ...string) func(*MLResetJobRequest)

WithFilterPath filters the properties of the response body.

func (MLResetJob) WithHeader ¶ 

func (f MLResetJob) WithHeader(h map[string]string) func(*MLResetJobRequest)

WithHeader adds the headers to the HTTP request.

func (MLResetJob) WithHuman ¶ 

func (f MLResetJob) WithHuman() func(*MLResetJobRequest)

WithHuman makes statistical values human-readable.

func (MLResetJob) WithOpaqueID ¶ 

func (f MLResetJob) WithOpaqueID(s string) func(*MLResetJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLResetJob) WithPretty ¶ 

func (f MLResetJob) WithPretty() func(*MLResetJobRequest)

WithPretty makes the response body pretty-printed.

func (MLResetJob) WithWaitForCompletion ¶ 

func (f MLResetJob) WithWaitForCompletion(v bool) func(*MLResetJobRequest)

WithWaitForCompletion - should this request wait until the operation has completed before returning.

type MLResetJobRequest ¶ 

type MLResetJobRequest struct {
	JobID string

	DeleteUserAnnotations *bool
	WaitForCompletion     *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLResetJobRequest configures the ML Reset Job API request.

func (MLResetJobRequest) Do ¶ 

func (r MLResetJobRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLRevertModelSnapshot ¶ 

type MLRevertModelSnapshot func(snapshot_id string, job_id string, o ...func(*MLRevertModelSnapshotRequest)) (*Response, error)

MLRevertModelSnapshot - Reverts to a specific snapshot.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html.

func (MLRevertModelSnapshot) WithBody ¶ 

func (f MLRevertModelSnapshot) WithBody(v io.Reader) func(*MLRevertModelSnapshotRequest)

WithBody - Reversion options.

func (MLRevertModelSnapshot) WithContext ¶ 

func (f MLRevertModelSnapshot) WithContext(v context.Context) func(*MLRevertModelSnapshotRequest)

WithContext sets the request context.

func (MLRevertModelSnapshot) WithDeleteInterveningResults ¶ 

func (f MLRevertModelSnapshot) WithDeleteInterveningResults(v bool) func(*MLRevertModelSnapshotRequest)

WithDeleteInterveningResults - should we reset the results back to the time of the snapshot?.

func (MLRevertModelSnapshot) WithErrorTrace ¶ 

func (f MLRevertModelSnapshot) WithErrorTrace() func(*MLRevertModelSnapshotRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLRevertModelSnapshot) WithFilterPath ¶ 

func (f MLRevertModelSnapshot) WithFilterPath(v ...string) func(*MLRevertModelSnapshotRequest)

WithFilterPath filters the properties of the response body.

func (MLRevertModelSnapshot) WithHeader ¶ 

func (f MLRevertModelSnapshot) WithHeader(h map[string]string) func(*MLRevertModelSnapshotRequest)

WithHeader adds the headers to the HTTP request.

func (MLRevertModelSnapshot) WithHuman ¶ 

func (f MLRevertModelSnapshot) WithHuman() func(*MLRevertModelSnapshotRequest)

WithHuman makes statistical values human-readable.

func (MLRevertModelSnapshot) WithOpaqueID ¶ 

func (f MLRevertModelSnapshot) WithOpaqueID(s string) func(*MLRevertModelSnapshotRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLRevertModelSnapshot) WithPretty ¶ 

func (f MLRevertModelSnapshot) WithPretty() func(*MLRevertModelSnapshotRequest)

WithPretty makes the response body pretty-printed.

type MLRevertModelSnapshotRequest ¶ 

type MLRevertModelSnapshotRequest struct {
	Body io.Reader

	JobID      string
	SnapshotID string

	DeleteInterveningResults *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLRevertModelSnapshotRequest configures the ML Revert Model Snapshot API request.

func (MLRevertModelSnapshotRequest) Do ¶ 

func (r MLRevertModelSnapshotRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLSetUpgradeMode ¶ 

type MLSetUpgradeMode func(o ...func(*MLSetUpgradeModeRequest)) (*Response, error)

MLSetUpgradeMode - Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html.

func (MLSetUpgradeMode) WithContext ¶ 

func (f MLSetUpgradeMode) WithContext(v context.Context) func(*MLSetUpgradeModeRequest)

WithContext sets the request context.

func (MLSetUpgradeMode) WithEnabled ¶ 

func (f MLSetUpgradeMode) WithEnabled(v bool) func(*MLSetUpgradeModeRequest)

WithEnabled - whether to enable upgrade_mode ml setting or not. defaults to false..

func (MLSetUpgradeMode) WithErrorTrace ¶ 

func (f MLSetUpgradeMode) WithErrorTrace() func(*MLSetUpgradeModeRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLSetUpgradeMode) WithFilterPath ¶ 

func (f MLSetUpgradeMode) WithFilterPath(v ...string) func(*MLSetUpgradeModeRequest)

WithFilterPath filters the properties of the response body.

func (MLSetUpgradeMode) WithHeader ¶ 

func (f MLSetUpgradeMode) WithHeader(h map[string]string) func(*MLSetUpgradeModeRequest)

WithHeader adds the headers to the HTTP request.

func (MLSetUpgradeMode) WithHuman ¶ 

func (f MLSetUpgradeMode) WithHuman() func(*MLSetUpgradeModeRequest)

WithHuman makes statistical values human-readable.

func (MLSetUpgradeMode) WithOpaqueID ¶ 

func (f MLSetUpgradeMode) WithOpaqueID(s string) func(*MLSetUpgradeModeRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLSetUpgradeMode) WithPretty ¶ 

func (f MLSetUpgradeMode) WithPretty() func(*MLSetUpgradeModeRequest)

WithPretty makes the response body pretty-printed.

func (MLSetUpgradeMode) WithTimeout ¶ 

func (f MLSetUpgradeMode) WithTimeout(v time.Duration) func(*MLSetUpgradeModeRequest)

WithTimeout - controls the time to wait before action times out. defaults to 30 seconds.

type MLSetUpgradeModeRequest ¶ 

type MLSetUpgradeModeRequest struct {
	Enabled *bool
	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLSetUpgradeModeRequest configures the ML Set Upgrade Mode API request.

func (MLSetUpgradeModeRequest) Do ¶ 

func (r MLSetUpgradeModeRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLStartDataFrameAnalytics ¶ 

type MLStartDataFrameAnalytics func(id string, o ...func(*MLStartDataFrameAnalyticsRequest)) (*Response, error)

MLStartDataFrameAnalytics - Starts a data frame analytics job.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html.

func (MLStartDataFrameAnalytics) WithBody ¶ 

func (f MLStartDataFrameAnalytics) WithBody(v io.Reader) func(*MLStartDataFrameAnalyticsRequest)

WithBody - The start data frame analytics parameters.

func (MLStartDataFrameAnalytics) WithContext ¶ 

func (f MLStartDataFrameAnalytics) WithContext(v context.Context) func(*MLStartDataFrameAnalyticsRequest)

WithContext sets the request context.

func (MLStartDataFrameAnalytics) WithErrorTrace ¶ 

func (f MLStartDataFrameAnalytics) WithErrorTrace() func(*MLStartDataFrameAnalyticsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLStartDataFrameAnalytics) WithFilterPath ¶ 

func (f MLStartDataFrameAnalytics) WithFilterPath(v ...string) func(*MLStartDataFrameAnalyticsRequest)

WithFilterPath filters the properties of the response body.

func (MLStartDataFrameAnalytics) WithHeader ¶ 

func (f MLStartDataFrameAnalytics) WithHeader(h map[string]string) func(*MLStartDataFrameAnalyticsRequest)

WithHeader adds the headers to the HTTP request.

func (MLStartDataFrameAnalytics) WithHuman ¶ 

func (f MLStartDataFrameAnalytics) WithHuman() func(*MLStartDataFrameAnalyticsRequest)

WithHuman makes statistical values human-readable.

func (MLStartDataFrameAnalytics) WithOpaqueID ¶ 

func (f MLStartDataFrameAnalytics) WithOpaqueID(s string) func(*MLStartDataFrameAnalyticsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLStartDataFrameAnalytics) WithPretty ¶ 

func (f MLStartDataFrameAnalytics) WithPretty() func(*MLStartDataFrameAnalyticsRequest)

WithPretty makes the response body pretty-printed.

func (MLStartDataFrameAnalytics) WithTimeout ¶ 

func (f MLStartDataFrameAnalytics) WithTimeout(v time.Duration) func(*MLStartDataFrameAnalyticsRequest)

WithTimeout - controls the time to wait until the task has started. defaults to 20 seconds.

type MLStartDataFrameAnalyticsRequest ¶ 

type MLStartDataFrameAnalyticsRequest struct {
	ID string

	Body io.Reader

	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLStartDataFrameAnalyticsRequest configures the ML Start Data Frame Analytics API request.

func (MLStartDataFrameAnalyticsRequest) Do ¶ 

func (r MLStartDataFrameAnalyticsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLStartDatafeed ¶ 

type MLStartDatafeed func(datafeed_id string, o ...func(*MLStartDatafeedRequest)) (*Response, error)

MLStartDatafeed - Starts one or more datafeeds.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html.

func (MLStartDatafeed) WithBody ¶ 

func (f MLStartDatafeed) WithBody(v io.Reader) func(*MLStartDatafeedRequest)

WithBody - The start datafeed parameters.

func (MLStartDatafeed) WithContext ¶ 

func (f MLStartDatafeed) WithContext(v context.Context) func(*MLStartDatafeedRequest)

WithContext sets the request context.

func (MLStartDatafeed) WithEnd ¶ 

func (f MLStartDatafeed) WithEnd(v string) func(*MLStartDatafeedRequest)

WithEnd - the end time when the datafeed should stop. when not set, the datafeed continues in real time.

func (MLStartDatafeed) WithErrorTrace ¶ 

func (f MLStartDatafeed) WithErrorTrace() func(*MLStartDatafeedRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLStartDatafeed) WithFilterPath ¶ 

func (f MLStartDatafeed) WithFilterPath(v ...string) func(*MLStartDatafeedRequest)

WithFilterPath filters the properties of the response body.

func (MLStartDatafeed) WithHeader ¶ 

func (f MLStartDatafeed) WithHeader(h map[string]string) func(*MLStartDatafeedRequest)

WithHeader adds the headers to the HTTP request.

func (MLStartDatafeed) WithHuman ¶ 

func (f MLStartDatafeed) WithHuman() func(*MLStartDatafeedRequest)

WithHuman makes statistical values human-readable.

func (MLStartDatafeed) WithOpaqueID ¶ 

func (f MLStartDatafeed) WithOpaqueID(s string) func(*MLStartDatafeedRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLStartDatafeed) WithPretty ¶ 

func (f MLStartDatafeed) WithPretty() func(*MLStartDatafeedRequest)

WithPretty makes the response body pretty-printed.

func (MLStartDatafeed) WithStart ¶ 

func (f MLStartDatafeed) WithStart(v string) func(*MLStartDatafeedRequest)

WithStart - the start time from where the datafeed should begin.

func (MLStartDatafeed) WithTimeout ¶ 

func (f MLStartDatafeed) WithTimeout(v time.Duration) func(*MLStartDatafeedRequest)

WithTimeout - controls the time to wait until a datafeed has started. default to 20 seconds.

type MLStartDatafeedRequest ¶ 

type MLStartDatafeedRequest struct {
	Body io.Reader

	DatafeedID string

	End     string
	Start   string
	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLStartDatafeedRequest configures the ML Start Datafeed API request.

func (MLStartDatafeedRequest) Do ¶ 

func (r MLStartDatafeedRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLStartTrainedModelDeployment ¶ 

type MLStartTrainedModelDeployment func(model_id string, o ...func(*MLStartTrainedModelDeploymentRequest)) (*Response, error)

MLStartTrainedModelDeployment - Start a trained model deployment.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html.

func (MLStartTrainedModelDeployment) WithBody ¶ added in v8.18.0 

func (f MLStartTrainedModelDeployment) WithBody(v io.Reader) func(*MLStartTrainedModelDeploymentRequest)

WithBody - The settings for the trained model deployment.

func (MLStartTrainedModelDeployment) WithCacheSize ¶ added in v8.4.0 

func (f MLStartTrainedModelDeployment) WithCacheSize(v string) func(*MLStartTrainedModelDeploymentRequest)

WithCacheSize - a byte-size value for configuring the inference cache size. for example, 20mb..

func (MLStartTrainedModelDeployment) WithContext ¶ 

func (f MLStartTrainedModelDeployment) WithContext(v context.Context) func(*MLStartTrainedModelDeploymentRequest)

WithContext sets the request context.

func (MLStartTrainedModelDeployment) WithDeploymentID ¶ added in v8.8.0 

func (f MLStartTrainedModelDeployment) WithDeploymentID(v string) func(*MLStartTrainedModelDeploymentRequest)

WithDeploymentID - the ID of the new deployment. defaults to the model_id if not set..

func (MLStartTrainedModelDeployment) WithErrorTrace ¶ 

func (f MLStartTrainedModelDeployment) WithErrorTrace() func(*MLStartTrainedModelDeploymentRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLStartTrainedModelDeployment) WithFilterPath ¶ 

func (f MLStartTrainedModelDeployment) WithFilterPath(v ...string) func(*MLStartTrainedModelDeploymentRequest)

WithFilterPath filters the properties of the response body.

func (MLStartTrainedModelDeployment) WithHeader ¶ 

func (f MLStartTrainedModelDeployment) WithHeader(h map[string]string) func(*MLStartTrainedModelDeploymentRequest)

WithHeader adds the headers to the HTTP request.

func (MLStartTrainedModelDeployment) WithHuman ¶ 

func (f MLStartTrainedModelDeployment) WithHuman() func(*MLStartTrainedModelDeploymentRequest)

WithHuman makes statistical values human-readable.

func (MLStartTrainedModelDeployment) WithNumberOfAllocations ¶ added in v8.3.0 

func (f MLStartTrainedModelDeployment) WithNumberOfAllocations(v int) func(*MLStartTrainedModelDeploymentRequest)

WithNumberOfAllocations - the total number of allocations this model is assigned across machine learning nodes..

func (MLStartTrainedModelDeployment) WithOpaqueID ¶ 

func (f MLStartTrainedModelDeployment) WithOpaqueID(s string) func(*MLStartTrainedModelDeploymentRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLStartTrainedModelDeployment) WithPretty ¶ 

func (f MLStartTrainedModelDeployment) WithPretty() func(*MLStartTrainedModelDeploymentRequest)

WithPretty makes the response body pretty-printed.

func (MLStartTrainedModelDeployment) WithPriority ¶ added in v8.6.0 

func (f MLStartTrainedModelDeployment) WithPriority(v string) func(*MLStartTrainedModelDeploymentRequest)

WithPriority - the deployment priority..

func (MLStartTrainedModelDeployment) WithQueueCapacity ¶ added in v8.3.0 

func (f MLStartTrainedModelDeployment) WithQueueCapacity(v int) func(*MLStartTrainedModelDeploymentRequest)

WithQueueCapacity - controls how many inference requests are allowed in the queue at a time..

func (MLStartTrainedModelDeployment) WithThreadsPerAllocation ¶ added in v8.3.0 

func (f MLStartTrainedModelDeployment) WithThreadsPerAllocation(v int) func(*MLStartTrainedModelDeploymentRequest)

WithThreadsPerAllocation - the number of threads used by each model allocation during inference..

func (MLStartTrainedModelDeployment) WithTimeout ¶ 

func (f MLStartTrainedModelDeployment) WithTimeout(v time.Duration) func(*MLStartTrainedModelDeploymentRequest)

WithTimeout - controls the amount of time to wait for the model to deploy..

func (MLStartTrainedModelDeployment) WithWaitFor ¶ 

func (f MLStartTrainedModelDeployment) WithWaitFor(v string) func(*MLStartTrainedModelDeploymentRequest)

WithWaitFor - the allocation status for which to wait.

type MLStartTrainedModelDeploymentRequest ¶ 

type MLStartTrainedModelDeploymentRequest struct {
	Body io.Reader

	ModelID string

	CacheSize            string
	DeploymentID         string
	NumberOfAllocations  *int
	Priority             string
	QueueCapacity        *int
	ThreadsPerAllocation *int
	Timeout              time.Duration
	WaitFor              string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLStartTrainedModelDeploymentRequest configures the ML Start Trained Model Deployment API request.

func (MLStartTrainedModelDeploymentRequest) Do ¶ 

func (r MLStartTrainedModelDeploymentRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLStopDataFrameAnalytics ¶ 

type MLStopDataFrameAnalytics func(id string, o ...func(*MLStopDataFrameAnalyticsRequest)) (*Response, error)

MLStopDataFrameAnalytics - Stops one or more data frame analytics jobs.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html.

func (MLStopDataFrameAnalytics) WithAllowNoMatch ¶ 

func (f MLStopDataFrameAnalytics) WithAllowNoMatch(v bool) func(*MLStopDataFrameAnalyticsRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no data frame analytics. (this includes `_all` string or when no data frame analytics have been specified).

func (MLStopDataFrameAnalytics) WithBody ¶ 

func (f MLStopDataFrameAnalytics) WithBody(v io.Reader) func(*MLStopDataFrameAnalyticsRequest)

WithBody - The stop data frame analytics parameters.

func (MLStopDataFrameAnalytics) WithContext ¶ 

func (f MLStopDataFrameAnalytics) WithContext(v context.Context) func(*MLStopDataFrameAnalyticsRequest)

WithContext sets the request context.

func (MLStopDataFrameAnalytics) WithErrorTrace ¶ 

func (f MLStopDataFrameAnalytics) WithErrorTrace() func(*MLStopDataFrameAnalyticsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLStopDataFrameAnalytics) WithFilterPath ¶ 

func (f MLStopDataFrameAnalytics) WithFilterPath(v ...string) func(*MLStopDataFrameAnalyticsRequest)

WithFilterPath filters the properties of the response body.

func (MLStopDataFrameAnalytics) WithForce ¶ 

func (f MLStopDataFrameAnalytics) WithForce(v bool) func(*MLStopDataFrameAnalyticsRequest)

WithForce - true if the data frame analytics should be forcefully stopped.

func (MLStopDataFrameAnalytics) WithHeader ¶ 

func (f MLStopDataFrameAnalytics) WithHeader(h map[string]string) func(*MLStopDataFrameAnalyticsRequest)

WithHeader adds the headers to the HTTP request.

func (MLStopDataFrameAnalytics) WithHuman ¶ 

func (f MLStopDataFrameAnalytics) WithHuman() func(*MLStopDataFrameAnalyticsRequest)

WithHuman makes statistical values human-readable.

func (MLStopDataFrameAnalytics) WithOpaqueID ¶ 

func (f MLStopDataFrameAnalytics) WithOpaqueID(s string) func(*MLStopDataFrameAnalyticsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLStopDataFrameAnalytics) WithPretty ¶ 

func (f MLStopDataFrameAnalytics) WithPretty() func(*MLStopDataFrameAnalyticsRequest)

WithPretty makes the response body pretty-printed.

func (MLStopDataFrameAnalytics) WithTimeout ¶ 

func (f MLStopDataFrameAnalytics) WithTimeout(v time.Duration) func(*MLStopDataFrameAnalyticsRequest)

WithTimeout - controls the time to wait until the task has stopped. defaults to 20 seconds.

type MLStopDataFrameAnalyticsRequest ¶ 

type MLStopDataFrameAnalyticsRequest struct {
	ID string

	Body io.Reader

	AllowNoMatch *bool
	Force        *bool
	Timeout      time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLStopDataFrameAnalyticsRequest configures the ML Stop Data Frame Analytics API request.

func (MLStopDataFrameAnalyticsRequest) Do ¶ 

func (r MLStopDataFrameAnalyticsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLStopDatafeed ¶ 

type MLStopDatafeed func(datafeed_id string, o ...func(*MLStopDatafeedRequest)) (*Response, error)

MLStopDatafeed - Stops one or more datafeeds.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html.

func (MLStopDatafeed) WithAllowNoDatafeeds ¶ 

func (f MLStopDatafeed) WithAllowNoDatafeeds(v bool) func(*MLStopDatafeedRequest)

WithAllowNoDatafeeds - whether to ignore if a wildcard expression matches no datafeeds. (this includes `_all` string or when no datafeeds have been specified).

func (MLStopDatafeed) WithAllowNoMatch ¶ 

func (f MLStopDatafeed) WithAllowNoMatch(v bool) func(*MLStopDatafeedRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no datafeeds. (this includes `_all` string or when no datafeeds have been specified).

func (MLStopDatafeed) WithBody ¶ 

func (f MLStopDatafeed) WithBody(v io.Reader) func(*MLStopDatafeedRequest)

WithBody - The URL params optionally sent in the body.

func (MLStopDatafeed) WithContext ¶ 

func (f MLStopDatafeed) WithContext(v context.Context) func(*MLStopDatafeedRequest)

WithContext sets the request context.

func (MLStopDatafeed) WithErrorTrace ¶ 

func (f MLStopDatafeed) WithErrorTrace() func(*MLStopDatafeedRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLStopDatafeed) WithFilterPath ¶ 

func (f MLStopDatafeed) WithFilterPath(v ...string) func(*MLStopDatafeedRequest)

WithFilterPath filters the properties of the response body.

func (MLStopDatafeed) WithForce ¶ 

func (f MLStopDatafeed) WithForce(v bool) func(*MLStopDatafeedRequest)

WithForce - true if the datafeed should be forcefully stopped..

func (MLStopDatafeed) WithHeader ¶ 

func (f MLStopDatafeed) WithHeader(h map[string]string) func(*MLStopDatafeedRequest)

WithHeader adds the headers to the HTTP request.

func (MLStopDatafeed) WithHuman ¶ 

func (f MLStopDatafeed) WithHuman() func(*MLStopDatafeedRequest)

WithHuman makes statistical values human-readable.

func (MLStopDatafeed) WithOpaqueID ¶ 

func (f MLStopDatafeed) WithOpaqueID(s string) func(*MLStopDatafeedRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLStopDatafeed) WithPretty ¶ 

func (f MLStopDatafeed) WithPretty() func(*MLStopDatafeedRequest)

WithPretty makes the response body pretty-printed.

func (MLStopDatafeed) WithTimeout ¶ 

func (f MLStopDatafeed) WithTimeout(v time.Duration) func(*MLStopDatafeedRequest)

WithTimeout - controls the time to wait until a datafeed has stopped. default to 20 seconds.

type MLStopDatafeedRequest ¶ 

type MLStopDatafeedRequest struct {
	Body io.Reader

	DatafeedID string

	AllowNoDatafeeds *bool
	AllowNoMatch     *bool
	Force            *bool
	Timeout          time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLStopDatafeedRequest configures the ML Stop Datafeed API request.

func (MLStopDatafeedRequest) Do ¶ 

func (r MLStopDatafeedRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLStopTrainedModelDeployment ¶ 

type MLStopTrainedModelDeployment func(model_id string, o ...func(*MLStopTrainedModelDeploymentRequest)) (*Response, error)

MLStopTrainedModelDeployment - Stop a trained model deployment.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-trained-model-deployment.html.

func (MLStopTrainedModelDeployment) WithAllowNoMatch ¶ 

func (f MLStopTrainedModelDeployment) WithAllowNoMatch(v bool) func(*MLStopTrainedModelDeploymentRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no deployments. (this includes `_all` string or when no deployments have been specified).

func (MLStopTrainedModelDeployment) WithBody ¶ 

func (f MLStopTrainedModelDeployment) WithBody(v io.Reader) func(*MLStopTrainedModelDeploymentRequest)

WithBody - The stop deployment parameters.

func (MLStopTrainedModelDeployment) WithContext ¶ 

func (f MLStopTrainedModelDeployment) WithContext(v context.Context) func(*MLStopTrainedModelDeploymentRequest)

WithContext sets the request context.

func (MLStopTrainedModelDeployment) WithErrorTrace ¶ 

func (f MLStopTrainedModelDeployment) WithErrorTrace() func(*MLStopTrainedModelDeploymentRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLStopTrainedModelDeployment) WithFilterPath ¶ 

func (f MLStopTrainedModelDeployment) WithFilterPath(v ...string) func(*MLStopTrainedModelDeploymentRequest)

WithFilterPath filters the properties of the response body.

func (MLStopTrainedModelDeployment) WithForce ¶ 

func (f MLStopTrainedModelDeployment) WithForce(v bool) func(*MLStopTrainedModelDeploymentRequest)

WithForce - true if the deployment should be forcefully stopped.

func (MLStopTrainedModelDeployment) WithHeader ¶ 

func (f MLStopTrainedModelDeployment) WithHeader(h map[string]string) func(*MLStopTrainedModelDeploymentRequest)

WithHeader adds the headers to the HTTP request.

func (MLStopTrainedModelDeployment) WithHuman ¶ 

func (f MLStopTrainedModelDeployment) WithHuman() func(*MLStopTrainedModelDeploymentRequest)

WithHuman makes statistical values human-readable.

func (MLStopTrainedModelDeployment) WithOpaqueID ¶ 

func (f MLStopTrainedModelDeployment) WithOpaqueID(s string) func(*MLStopTrainedModelDeploymentRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLStopTrainedModelDeployment) WithPretty ¶ 

func (f MLStopTrainedModelDeployment) WithPretty() func(*MLStopTrainedModelDeploymentRequest)

WithPretty makes the response body pretty-printed.

type MLStopTrainedModelDeploymentRequest ¶ 

type MLStopTrainedModelDeploymentRequest struct {
	Body io.Reader

	ModelID string

	AllowNoMatch *bool
	Force        *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLStopTrainedModelDeploymentRequest configures the ML Stop Trained Model Deployment API request.

func (MLStopTrainedModelDeploymentRequest) Do ¶ 

func (r MLStopTrainedModelDeploymentRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLUpdateDataFrameAnalytics ¶ 

type MLUpdateDataFrameAnalytics func(id string, body io.Reader, o ...func(*MLUpdateDataFrameAnalyticsRequest)) (*Response, error)

MLUpdateDataFrameAnalytics - Updates certain properties of a data frame analytics job.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html.

func (MLUpdateDataFrameAnalytics) WithContext ¶ 

func (f MLUpdateDataFrameAnalytics) WithContext(v context.Context) func(*MLUpdateDataFrameAnalyticsRequest)

WithContext sets the request context.

func (MLUpdateDataFrameAnalytics) WithErrorTrace ¶ 

func (f MLUpdateDataFrameAnalytics) WithErrorTrace() func(*MLUpdateDataFrameAnalyticsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLUpdateDataFrameAnalytics) WithFilterPath ¶ 

func (f MLUpdateDataFrameAnalytics) WithFilterPath(v ...string) func(*MLUpdateDataFrameAnalyticsRequest)

WithFilterPath filters the properties of the response body.

func (MLUpdateDataFrameAnalytics) WithHeader ¶ 

func (f MLUpdateDataFrameAnalytics) WithHeader(h map[string]string) func(*MLUpdateDataFrameAnalyticsRequest)

WithHeader adds the headers to the HTTP request.

func (MLUpdateDataFrameAnalytics) WithHuman ¶ 

func (f MLUpdateDataFrameAnalytics) WithHuman() func(*MLUpdateDataFrameAnalyticsRequest)

WithHuman makes statistical values human-readable.

func (MLUpdateDataFrameAnalytics) WithOpaqueID ¶ 

func (f MLUpdateDataFrameAnalytics) WithOpaqueID(s string) func(*MLUpdateDataFrameAnalyticsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLUpdateDataFrameAnalytics) WithPretty ¶ 

func (f MLUpdateDataFrameAnalytics) WithPretty() func(*MLUpdateDataFrameAnalyticsRequest)

WithPretty makes the response body pretty-printed.

type MLUpdateDataFrameAnalyticsRequest ¶ 

type MLUpdateDataFrameAnalyticsRequest struct {
	DocumentID string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLUpdateDataFrameAnalyticsRequest configures the ML Update Data Frame Analytics API request.

func (MLUpdateDataFrameAnalyticsRequest) Do ¶ 

func (r MLUpdateDataFrameAnalyticsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLUpdateDatafeed ¶ 

type MLUpdateDatafeed func(body io.Reader, datafeed_id string, o ...func(*MLUpdateDatafeedRequest)) (*Response, error)

MLUpdateDatafeed - Updates certain properties of a datafeed.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html.

func (MLUpdateDatafeed) WithAllowNoIndices ¶ 

func (f MLUpdateDatafeed) WithAllowNoIndices(v bool) func(*MLUpdateDatafeedRequest)

WithAllowNoIndices - ignore if the source indices expressions resolves to no concrete indices (default: true).

func (MLUpdateDatafeed) WithContext ¶ 

func (f MLUpdateDatafeed) WithContext(v context.Context) func(*MLUpdateDatafeedRequest)

WithContext sets the request context.

func (MLUpdateDatafeed) WithErrorTrace ¶ 

func (f MLUpdateDatafeed) WithErrorTrace() func(*MLUpdateDatafeedRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLUpdateDatafeed) WithExpandWildcards ¶ 

func (f MLUpdateDatafeed) WithExpandWildcards(v string) func(*MLUpdateDatafeedRequest)

WithExpandWildcards - whether source index expressions should get expanded to open or closed indices (default: open).

func (MLUpdateDatafeed) WithFilterPath ¶ 

func (f MLUpdateDatafeed) WithFilterPath(v ...string) func(*MLUpdateDatafeedRequest)

WithFilterPath filters the properties of the response body.

func (MLUpdateDatafeed) WithHeader ¶ 

func (f MLUpdateDatafeed) WithHeader(h map[string]string) func(*MLUpdateDatafeedRequest)

WithHeader adds the headers to the HTTP request.

func (MLUpdateDatafeed) WithHuman ¶ 

func (f MLUpdateDatafeed) WithHuman() func(*MLUpdateDatafeedRequest)

WithHuman makes statistical values human-readable.

func (MLUpdateDatafeed) WithIgnoreThrottled ¶ 

func (f MLUpdateDatafeed) WithIgnoreThrottled(v bool) func(*MLUpdateDatafeedRequest)

WithIgnoreThrottled - ignore indices that are marked as throttled (default: true).

func (MLUpdateDatafeed) WithIgnoreUnavailable ¶ 

func (f MLUpdateDatafeed) WithIgnoreUnavailable(v bool) func(*MLUpdateDatafeedRequest)

WithIgnoreUnavailable - ignore unavailable indexes (default: false).

func (MLUpdateDatafeed) WithOpaqueID ¶ 

func (f MLUpdateDatafeed) WithOpaqueID(s string) func(*MLUpdateDatafeedRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLUpdateDatafeed) WithPretty ¶ 

func (f MLUpdateDatafeed) WithPretty() func(*MLUpdateDatafeedRequest)

WithPretty makes the response body pretty-printed.

type MLUpdateDatafeedRequest ¶ 

type MLUpdateDatafeedRequest struct {
	Body io.Reader

	DatafeedID string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreThrottled   *bool
	IgnoreUnavailable *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLUpdateDatafeedRequest configures the ML Update Datafeed API request.

func (MLUpdateDatafeedRequest) Do ¶ 

func (r MLUpdateDatafeedRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLUpdateFilter ¶ 

type MLUpdateFilter func(body io.Reader, filter_id string, o ...func(*MLUpdateFilterRequest)) (*Response, error)

MLUpdateFilter - Updates the description of a filter, adds items, or removes items.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html.

func (MLUpdateFilter) WithContext ¶ 

func (f MLUpdateFilter) WithContext(v context.Context) func(*MLUpdateFilterRequest)

WithContext sets the request context.

func (MLUpdateFilter) WithErrorTrace ¶ 

func (f MLUpdateFilter) WithErrorTrace() func(*MLUpdateFilterRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLUpdateFilter) WithFilterPath ¶ 

func (f MLUpdateFilter) WithFilterPath(v ...string) func(*MLUpdateFilterRequest)

WithFilterPath filters the properties of the response body.

func (MLUpdateFilter) WithHeader ¶ 

func (f MLUpdateFilter) WithHeader(h map[string]string) func(*MLUpdateFilterRequest)

WithHeader adds the headers to the HTTP request.

func (MLUpdateFilter) WithHuman ¶ 

func (f MLUpdateFilter) WithHuman() func(*MLUpdateFilterRequest)

WithHuman makes statistical values human-readable.

func (MLUpdateFilter) WithOpaqueID ¶ 

func (f MLUpdateFilter) WithOpaqueID(s string) func(*MLUpdateFilterRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLUpdateFilter) WithPretty ¶ 

func (f MLUpdateFilter) WithPretty() func(*MLUpdateFilterRequest)

WithPretty makes the response body pretty-printed.

type MLUpdateFilterRequest ¶ 

type MLUpdateFilterRequest struct {
	Body io.Reader

	FilterID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLUpdateFilterRequest configures the ML Update Filter API request.

func (MLUpdateFilterRequest) Do ¶ 

func (r MLUpdateFilterRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLUpdateJob ¶ 

type MLUpdateJob func(job_id string, body io.Reader, o ...func(*MLUpdateJobRequest)) (*Response, error)

MLUpdateJob - Updates certain properties of an anomaly detection job.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html.

func (MLUpdateJob) WithContext ¶ 

func (f MLUpdateJob) WithContext(v context.Context) func(*MLUpdateJobRequest)

WithContext sets the request context.

func (MLUpdateJob) WithErrorTrace ¶ 

func (f MLUpdateJob) WithErrorTrace() func(*MLUpdateJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLUpdateJob) WithFilterPath ¶ 

func (f MLUpdateJob) WithFilterPath(v ...string) func(*MLUpdateJobRequest)

WithFilterPath filters the properties of the response body.

func (MLUpdateJob) WithHeader ¶ 

func (f MLUpdateJob) WithHeader(h map[string]string) func(*MLUpdateJobRequest)

WithHeader adds the headers to the HTTP request.

func (MLUpdateJob) WithHuman ¶ 

func (f MLUpdateJob) WithHuman() func(*MLUpdateJobRequest)

WithHuman makes statistical values human-readable.

func (MLUpdateJob) WithOpaqueID ¶ 

func (f MLUpdateJob) WithOpaqueID(s string) func(*MLUpdateJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLUpdateJob) WithPretty ¶ 

func (f MLUpdateJob) WithPretty() func(*MLUpdateJobRequest)

WithPretty makes the response body pretty-printed.

type MLUpdateJobRequest ¶ 

type MLUpdateJobRequest struct {
	Body io.Reader

	JobID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLUpdateJobRequest configures the ML Update Job API request.

func (MLUpdateJobRequest) Do ¶ 

func (r MLUpdateJobRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLUpdateModelSnapshot ¶ 

type MLUpdateModelSnapshot func(snapshot_id string, job_id string, body io.Reader, o ...func(*MLUpdateModelSnapshotRequest)) (*Response, error)

MLUpdateModelSnapshot - Updates certain properties of a snapshot.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html.

func (MLUpdateModelSnapshot) WithContext ¶ 

func (f MLUpdateModelSnapshot) WithContext(v context.Context) func(*MLUpdateModelSnapshotRequest)

WithContext sets the request context.

func (MLUpdateModelSnapshot) WithErrorTrace ¶ 

func (f MLUpdateModelSnapshot) WithErrorTrace() func(*MLUpdateModelSnapshotRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLUpdateModelSnapshot) WithFilterPath ¶ 

func (f MLUpdateModelSnapshot) WithFilterPath(v ...string) func(*MLUpdateModelSnapshotRequest)

WithFilterPath filters the properties of the response body.

func (MLUpdateModelSnapshot) WithHeader ¶ 

func (f MLUpdateModelSnapshot) WithHeader(h map[string]string) func(*MLUpdateModelSnapshotRequest)

WithHeader adds the headers to the HTTP request.

func (MLUpdateModelSnapshot) WithHuman ¶ 

func (f MLUpdateModelSnapshot) WithHuman() func(*MLUpdateModelSnapshotRequest)

WithHuman makes statistical values human-readable.

func (MLUpdateModelSnapshot) WithOpaqueID ¶ 

func (f MLUpdateModelSnapshot) WithOpaqueID(s string) func(*MLUpdateModelSnapshotRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLUpdateModelSnapshot) WithPretty ¶ 

func (f MLUpdateModelSnapshot) WithPretty() func(*MLUpdateModelSnapshotRequest)

WithPretty makes the response body pretty-printed.

type MLUpdateModelSnapshotRequest ¶ 

type MLUpdateModelSnapshotRequest struct {
	Body io.Reader

	JobID      string
	SnapshotID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLUpdateModelSnapshotRequest configures the ML Update Model Snapshot API request.

func (MLUpdateModelSnapshotRequest) Do ¶ 

func (r MLUpdateModelSnapshotRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLUpdateTrainedModelDeployment ¶ added in v8.6.0 

type MLUpdateTrainedModelDeployment func(model_id string, o ...func(*MLUpdateTrainedModelDeploymentRequest)) (*Response, error)

MLUpdateTrainedModelDeployment - Updates certain properties of trained model deployment.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html.

func (MLUpdateTrainedModelDeployment) WithBody ¶ added in v8.15.0 

func (f MLUpdateTrainedModelDeployment) WithBody(v io.Reader) func(*MLUpdateTrainedModelDeploymentRequest)

WithBody - The updated trained model deployment settings.

func (MLUpdateTrainedModelDeployment) WithContext ¶ added in v8.6.0 

func (f MLUpdateTrainedModelDeployment) WithContext(v context.Context) func(*MLUpdateTrainedModelDeploymentRequest)

WithContext sets the request context.

func (MLUpdateTrainedModelDeployment) WithErrorTrace ¶ added in v8.6.0 

func (f MLUpdateTrainedModelDeployment) WithErrorTrace() func(*MLUpdateTrainedModelDeploymentRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLUpdateTrainedModelDeployment) WithFilterPath ¶ added in v8.6.0 

func (f MLUpdateTrainedModelDeployment) WithFilterPath(v ...string) func(*MLUpdateTrainedModelDeploymentRequest)

WithFilterPath filters the properties of the response body.

func (MLUpdateTrainedModelDeployment) WithHeader ¶ added in v8.6.0 

func (f MLUpdateTrainedModelDeployment) WithHeader(h map[string]string) func(*MLUpdateTrainedModelDeploymentRequest)

WithHeader adds the headers to the HTTP request.

func (MLUpdateTrainedModelDeployment) WithHuman ¶ added in v8.6.0 

func (f MLUpdateTrainedModelDeployment) WithHuman() func(*MLUpdateTrainedModelDeploymentRequest)

WithHuman makes statistical values human-readable.

func (MLUpdateTrainedModelDeployment) WithNumberOfAllocations ¶ added in v8.15.0 

func (f MLUpdateTrainedModelDeployment) WithNumberOfAllocations(v int) func(*MLUpdateTrainedModelDeploymentRequest)

WithNumberOfAllocations - update the model deployment to this number of allocations..

func (MLUpdateTrainedModelDeployment) WithOpaqueID ¶ added in v8.6.0 

func (f MLUpdateTrainedModelDeployment) WithOpaqueID(s string) func(*MLUpdateTrainedModelDeploymentRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLUpdateTrainedModelDeployment) WithPretty ¶ added in v8.6.0 

func (f MLUpdateTrainedModelDeployment) WithPretty() func(*MLUpdateTrainedModelDeploymentRequest)

WithPretty makes the response body pretty-printed.

type MLUpdateTrainedModelDeploymentRequest ¶ added in v8.6.0 

type MLUpdateTrainedModelDeploymentRequest struct {
	Body io.Reader

	ModelID string

	NumberOfAllocations *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLUpdateTrainedModelDeploymentRequest configures the ML Update Trained Model Deployment API request.

func (MLUpdateTrainedModelDeploymentRequest) Do ¶ added in v8.6.0 

func (r MLUpdateTrainedModelDeploymentRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLUpgradeJobSnapshot ¶ 

type MLUpgradeJobSnapshot func(snapshot_id string, job_id string, o ...func(*MLUpgradeJobSnapshotRequest)) (*Response, error)

MLUpgradeJobSnapshot - Upgrades a given job snapshot to the current major version.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html.

func (MLUpgradeJobSnapshot) WithContext ¶ 

func (f MLUpgradeJobSnapshot) WithContext(v context.Context) func(*MLUpgradeJobSnapshotRequest)

WithContext sets the request context.

func (MLUpgradeJobSnapshot) WithErrorTrace ¶ 

func (f MLUpgradeJobSnapshot) WithErrorTrace() func(*MLUpgradeJobSnapshotRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLUpgradeJobSnapshot) WithFilterPath ¶ 

func (f MLUpgradeJobSnapshot) WithFilterPath(v ...string) func(*MLUpgradeJobSnapshotRequest)

WithFilterPath filters the properties of the response body.

func (MLUpgradeJobSnapshot) WithHeader ¶ 

func (f MLUpgradeJobSnapshot) WithHeader(h map[string]string) func(*MLUpgradeJobSnapshotRequest)

WithHeader adds the headers to the HTTP request.

func (MLUpgradeJobSnapshot) WithHuman ¶ 

func (f MLUpgradeJobSnapshot) WithHuman() func(*MLUpgradeJobSnapshotRequest)

WithHuman makes statistical values human-readable.

func (MLUpgradeJobSnapshot) WithOpaqueID ¶ 

func (f MLUpgradeJobSnapshot) WithOpaqueID(s string) func(*MLUpgradeJobSnapshotRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLUpgradeJobSnapshot) WithPretty ¶ 

func (f MLUpgradeJobSnapshot) WithPretty() func(*MLUpgradeJobSnapshotRequest)

WithPretty makes the response body pretty-printed.

func (MLUpgradeJobSnapshot) WithTimeout ¶ 

func (f MLUpgradeJobSnapshot) WithTimeout(v time.Duration) func(*MLUpgradeJobSnapshotRequest)

WithTimeout - how long should the api wait for the job to be opened and the old snapshot to be loaded..

func (MLUpgradeJobSnapshot) WithWaitForCompletion ¶ 

func (f MLUpgradeJobSnapshot) WithWaitForCompletion(v bool) func(*MLUpgradeJobSnapshotRequest)

WithWaitForCompletion - should the request wait until the task is complete before responding to the caller. default is false..

type MLUpgradeJobSnapshotRequest ¶ 

type MLUpgradeJobSnapshotRequest struct {
	JobID      string
	SnapshotID string

	Timeout           time.Duration
	WaitForCompletion *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLUpgradeJobSnapshotRequest configures the ML Upgrade Job Snapshot API request.

func (MLUpgradeJobSnapshotRequest) Do ¶ 

func (r MLUpgradeJobSnapshotRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLValidate ¶ 

type MLValidate func(body io.Reader, o ...func(*MLValidateRequest)) (*Response, error)

MLValidate - Validates an anomaly detection job.

See full documentation at https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html.

func (MLValidate) WithContext ¶ 

func (f MLValidate) WithContext(v context.Context) func(*MLValidateRequest)

WithContext sets the request context.

func (MLValidate) WithErrorTrace ¶ 

func (f MLValidate) WithErrorTrace() func(*MLValidateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLValidate) WithFilterPath ¶ 

func (f MLValidate) WithFilterPath(v ...string) func(*MLValidateRequest)

WithFilterPath filters the properties of the response body.

func (MLValidate) WithHeader ¶ 

func (f MLValidate) WithHeader(h map[string]string) func(*MLValidateRequest)

WithHeader adds the headers to the HTTP request.

func (MLValidate) WithHuman ¶ 

func (f MLValidate) WithHuman() func(*MLValidateRequest)

WithHuman makes statistical values human-readable.

func (MLValidate) WithOpaqueID ¶ 

func (f MLValidate) WithOpaqueID(s string) func(*MLValidateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLValidate) WithPretty ¶ 

func (f MLValidate) WithPretty() func(*MLValidateRequest)

WithPretty makes the response body pretty-printed.

type MLValidateDetector ¶ 

type MLValidateDetector func(body io.Reader, o ...func(*MLValidateDetectorRequest)) (*Response, error)

MLValidateDetector - Validates an anomaly detection detector.

See full documentation at https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html.

func (MLValidateDetector) WithContext ¶ 

func (f MLValidateDetector) WithContext(v context.Context) func(*MLValidateDetectorRequest)

WithContext sets the request context.

func (MLValidateDetector) WithErrorTrace ¶ 

func (f MLValidateDetector) WithErrorTrace() func(*MLValidateDetectorRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MLValidateDetector) WithFilterPath ¶ 

func (f MLValidateDetector) WithFilterPath(v ...string) func(*MLValidateDetectorRequest)

WithFilterPath filters the properties of the response body.

func (MLValidateDetector) WithHeader ¶ 

func (f MLValidateDetector) WithHeader(h map[string]string) func(*MLValidateDetectorRequest)

WithHeader adds the headers to the HTTP request.

func (MLValidateDetector) WithHuman ¶ 

func (f MLValidateDetector) WithHuman() func(*MLValidateDetectorRequest)

WithHuman makes statistical values human-readable.

func (MLValidateDetector) WithOpaqueID ¶ 

func (f MLValidateDetector) WithOpaqueID(s string) func(*MLValidateDetectorRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MLValidateDetector) WithPretty ¶ 

func (f MLValidateDetector) WithPretty() func(*MLValidateDetectorRequest)

WithPretty makes the response body pretty-printed.

type MLValidateDetectorRequest ¶ 

type MLValidateDetectorRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLValidateDetectorRequest configures the ML Validate Detector API request.

func (MLValidateDetectorRequest) Do ¶ 

func (r MLValidateDetectorRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MLValidateRequest ¶ 

type MLValidateRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MLValidateRequest configures the ML Validate API request.

func (MLValidateRequest) Do ¶ 

func (r MLValidateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Mget ¶ 

type Mget func(body io.Reader, o ...func(*MgetRequest)) (*Response, error)

Mget allows to get multiple documents in one request.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html.

func (Mget) WithContext ¶ 

func (f Mget) WithContext(v context.Context) func(*MgetRequest)

WithContext sets the request context.

func (Mget) WithErrorTrace ¶ 

func (f Mget) WithErrorTrace() func(*MgetRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Mget) WithFilterPath ¶ 

func (f Mget) WithFilterPath(v ...string) func(*MgetRequest)

WithFilterPath filters the properties of the response body.

func (Mget) WithForceSyntheticSource ¶ added in v8.4.0 

func (f Mget) WithForceSyntheticSource(v bool) func(*MgetRequest)

WithForceSyntheticSource - should this request force synthetic _source? use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. fetches with this enabled will be slower the enabling synthetic source natively in the index..

func (Mget) WithHeader ¶ 

func (f Mget) WithHeader(h map[string]string) func(*MgetRequest)

WithHeader adds the headers to the HTTP request.

func (Mget) WithHuman ¶ 

func (f Mget) WithHuman() func(*MgetRequest)

WithHuman makes statistical values human-readable.

func (Mget) WithIndex ¶ 

func (f Mget) WithIndex(v string) func(*MgetRequest)

WithIndex - the name of the index.

func (Mget) WithOpaqueID ¶ 

func (f Mget) WithOpaqueID(s string) func(*MgetRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Mget) WithPreference ¶ 

func (f Mget) WithPreference(v string) func(*MgetRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (Mget) WithPretty ¶ 

func (f Mget) WithPretty() func(*MgetRequest)

WithPretty makes the response body pretty-printed.

func (Mget) WithRealtime ¶ 

func (f Mget) WithRealtime(v bool) func(*MgetRequest)

WithRealtime - specify whether to perform the operation in realtime or search mode.

func (Mget) WithRefresh ¶ 

func (f Mget) WithRefresh(v bool) func(*MgetRequest)

WithRefresh - refresh the shard containing the document before performing the operation.

func (Mget) WithRouting ¶ 

func (f Mget) WithRouting(v string) func(*MgetRequest)

WithRouting - specific routing value.

func (Mget) WithSource ¶ 

func (f Mget) WithSource(v ...string) func(*MgetRequest)

WithSource - true or false to return the _source field or not, or a list of fields to return.

func (Mget) WithSourceExcludes ¶ 

func (f Mget) WithSourceExcludes(v ...string) func(*MgetRequest)

WithSourceExcludes - a list of fields to exclude from the returned _source field.

func (Mget) WithSourceIncludes ¶ 

func (f Mget) WithSourceIncludes(v ...string) func(*MgetRequest)

WithSourceIncludes - a list of fields to extract and return from the _source field.

func (Mget) WithStoredFields ¶ 

func (f Mget) WithStoredFields(v ...string) func(*MgetRequest)

WithStoredFields - a list of stored fields to return in the response.

type MgetRequest ¶ 

type MgetRequest struct {
	Index string

	Body io.Reader

	ForceSyntheticSource *bool
	Preference           string
	Realtime             *bool
	Refresh              *bool
	Routing              string
	Source               []string
	SourceExcludes       []string
	SourceIncludes       []string
	StoredFields         []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MgetRequest configures the Mget API request.

func (MgetRequest) Do ¶ 

func (r MgetRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Migration ¶ 

type Migration struct {
	Deprecations            MigrationDeprecations
	GetFeatureUpgradeStatus MigrationGetFeatureUpgradeStatus
	PostFeatureUpgrade      MigrationPostFeatureUpgrade
}

Migration contains the Migration APIs

type MigrationDeprecations ¶ 

type MigrationDeprecations func(o ...func(*MigrationDeprecationsRequest)) (*Response, error)

MigrationDeprecations - Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html.

func (MigrationDeprecations) WithContext ¶ 

func (f MigrationDeprecations) WithContext(v context.Context) func(*MigrationDeprecationsRequest)

WithContext sets the request context.

func (MigrationDeprecations) WithErrorTrace ¶ 

func (f MigrationDeprecations) WithErrorTrace() func(*MigrationDeprecationsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MigrationDeprecations) WithFilterPath ¶ 

func (f MigrationDeprecations) WithFilterPath(v ...string) func(*MigrationDeprecationsRequest)

WithFilterPath filters the properties of the response body.

func (MigrationDeprecations) WithHeader ¶ 

func (f MigrationDeprecations) WithHeader(h map[string]string) func(*MigrationDeprecationsRequest)

WithHeader adds the headers to the HTTP request.

func (MigrationDeprecations) WithHuman ¶ 

func (f MigrationDeprecations) WithHuman() func(*MigrationDeprecationsRequest)

WithHuman makes statistical values human-readable.

func (MigrationDeprecations) WithIndex ¶ 

func (f MigrationDeprecations) WithIndex(v string) func(*MigrationDeprecationsRequest)

WithIndex - index pattern.

func (MigrationDeprecations) WithOpaqueID ¶ 

func (f MigrationDeprecations) WithOpaqueID(s string) func(*MigrationDeprecationsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MigrationDeprecations) WithPretty ¶ 

func (f MigrationDeprecations) WithPretty() func(*MigrationDeprecationsRequest)

WithPretty makes the response body pretty-printed.

type MigrationDeprecationsRequest ¶ 

type MigrationDeprecationsRequest struct {
	Index string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MigrationDeprecationsRequest configures the Migration Deprecations API request.

func (MigrationDeprecationsRequest) Do ¶ 

func (r MigrationDeprecationsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MigrationGetFeatureUpgradeStatus ¶ 

type MigrationGetFeatureUpgradeStatus func(o ...func(*MigrationGetFeatureUpgradeStatusRequest)) (*Response, error)

MigrationGetFeatureUpgradeStatus - Find out whether system features need to be upgraded or not

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html.

func (MigrationGetFeatureUpgradeStatus) WithContext ¶ 

func (f MigrationGetFeatureUpgradeStatus) WithContext(v context.Context) func(*MigrationGetFeatureUpgradeStatusRequest)

WithContext sets the request context.

func (MigrationGetFeatureUpgradeStatus) WithErrorTrace ¶ 

func (f MigrationGetFeatureUpgradeStatus) WithErrorTrace() func(*MigrationGetFeatureUpgradeStatusRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MigrationGetFeatureUpgradeStatus) WithFilterPath ¶ 

func (f MigrationGetFeatureUpgradeStatus) WithFilterPath(v ...string) func(*MigrationGetFeatureUpgradeStatusRequest)

WithFilterPath filters the properties of the response body.

func (MigrationGetFeatureUpgradeStatus) WithHeader ¶ 

func (f MigrationGetFeatureUpgradeStatus) WithHeader(h map[string]string) func(*MigrationGetFeatureUpgradeStatusRequest)

WithHeader adds the headers to the HTTP request.

func (MigrationGetFeatureUpgradeStatus) WithHuman ¶ 

func (f MigrationGetFeatureUpgradeStatus) WithHuman() func(*MigrationGetFeatureUpgradeStatusRequest)

WithHuman makes statistical values human-readable.

func (MigrationGetFeatureUpgradeStatus) WithOpaqueID ¶ 

func (f MigrationGetFeatureUpgradeStatus) WithOpaqueID(s string) func(*MigrationGetFeatureUpgradeStatusRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MigrationGetFeatureUpgradeStatus) WithPretty ¶ 

func (f MigrationGetFeatureUpgradeStatus) WithPretty() func(*MigrationGetFeatureUpgradeStatusRequest)

WithPretty makes the response body pretty-printed.

type MigrationGetFeatureUpgradeStatusRequest ¶ 

type MigrationGetFeatureUpgradeStatusRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MigrationGetFeatureUpgradeStatusRequest configures the Migration Get Feature Upgrade Status API request.

func (MigrationGetFeatureUpgradeStatusRequest) Do ¶ 

func (r MigrationGetFeatureUpgradeStatusRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MigrationPostFeatureUpgrade ¶ 

type MigrationPostFeatureUpgrade func(o ...func(*MigrationPostFeatureUpgradeRequest)) (*Response, error)

MigrationPostFeatureUpgrade - Begin upgrades for system features

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html.

func (MigrationPostFeatureUpgrade) WithContext ¶ 

func (f MigrationPostFeatureUpgrade) WithContext(v context.Context) func(*MigrationPostFeatureUpgradeRequest)

WithContext sets the request context.

func (MigrationPostFeatureUpgrade) WithErrorTrace ¶ 

func (f MigrationPostFeatureUpgrade) WithErrorTrace() func(*MigrationPostFeatureUpgradeRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MigrationPostFeatureUpgrade) WithFilterPath ¶ 

func (f MigrationPostFeatureUpgrade) WithFilterPath(v ...string) func(*MigrationPostFeatureUpgradeRequest)

WithFilterPath filters the properties of the response body.

func (MigrationPostFeatureUpgrade) WithHeader ¶ 

func (f MigrationPostFeatureUpgrade) WithHeader(h map[string]string) func(*MigrationPostFeatureUpgradeRequest)

WithHeader adds the headers to the HTTP request.

func (MigrationPostFeatureUpgrade) WithHuman ¶ 

func (f MigrationPostFeatureUpgrade) WithHuman() func(*MigrationPostFeatureUpgradeRequest)

WithHuman makes statistical values human-readable.

func (MigrationPostFeatureUpgrade) WithOpaqueID ¶ 

func (f MigrationPostFeatureUpgrade) WithOpaqueID(s string) func(*MigrationPostFeatureUpgradeRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MigrationPostFeatureUpgrade) WithPretty ¶ 

func (f MigrationPostFeatureUpgrade) WithPretty() func(*MigrationPostFeatureUpgradeRequest)

WithPretty makes the response body pretty-printed.

type MigrationPostFeatureUpgradeRequest ¶ 

type MigrationPostFeatureUpgradeRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MigrationPostFeatureUpgradeRequest configures the Migration Post Feature Upgrade API request.

func (MigrationPostFeatureUpgradeRequest) Do ¶ 

func (r MigrationPostFeatureUpgradeRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Monitoring ¶ 

type Monitoring struct {
	Bulk MonitoringBulk
}

Monitoring contains the Monitoring APIs

type MonitoringBulk ¶ 

type MonitoringBulk func(body io.Reader, o ...func(*MonitoringBulkRequest)) (*Response, error)

MonitoringBulk - Used by the monitoring features to send monitoring data.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/monitor-elasticsearch-cluster.html.

func (MonitoringBulk) WithContext ¶ 

func (f MonitoringBulk) WithContext(v context.Context) func(*MonitoringBulkRequest)

WithContext sets the request context.

func (MonitoringBulk) WithDocumentType ¶ 

func (f MonitoringBulk) WithDocumentType(v string) func(*MonitoringBulkRequest)

WithDocumentType - default document type for items which don't provide one.

func (MonitoringBulk) WithErrorTrace ¶ 

func (f MonitoringBulk) WithErrorTrace() func(*MonitoringBulkRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MonitoringBulk) WithFilterPath ¶ 

func (f MonitoringBulk) WithFilterPath(v ...string) func(*MonitoringBulkRequest)

WithFilterPath filters the properties of the response body.

func (MonitoringBulk) WithHeader ¶ 

func (f MonitoringBulk) WithHeader(h map[string]string) func(*MonitoringBulkRequest)

WithHeader adds the headers to the HTTP request.

func (MonitoringBulk) WithHuman ¶ 

func (f MonitoringBulk) WithHuman() func(*MonitoringBulkRequest)

WithHuman makes statistical values human-readable.

func (MonitoringBulk) WithInterval ¶ 

func (f MonitoringBulk) WithInterval(v string) func(*MonitoringBulkRequest)

WithInterval - collection interval (e.g., '10s' or '10000ms') of the payload.

func (MonitoringBulk) WithOpaqueID ¶ 

func (f MonitoringBulk) WithOpaqueID(s string) func(*MonitoringBulkRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MonitoringBulk) WithPretty ¶ 

func (f MonitoringBulk) WithPretty() func(*MonitoringBulkRequest)

WithPretty makes the response body pretty-printed.

func (MonitoringBulk) WithSystemAPIVersion ¶ 

func (f MonitoringBulk) WithSystemAPIVersion(v string) func(*MonitoringBulkRequest)

WithSystemAPIVersion - api version of the monitored system.

func (MonitoringBulk) WithSystemID ¶ 

func (f MonitoringBulk) WithSystemID(v string) func(*MonitoringBulkRequest)

WithSystemID - identifier of the monitored system.

type MonitoringBulkRequest ¶ 

type MonitoringBulkRequest struct {
	Body io.Reader

	DocumentType string

	Interval         string
	SystemAPIVersion string
	SystemID         string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MonitoringBulkRequest configures the Monitoring Bulk API request.

func (MonitoringBulkRequest) Do ¶ 

func (r MonitoringBulkRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Msearch ¶ 

type Msearch func(body io.Reader, o ...func(*MsearchRequest)) (*Response, error)

Msearch allows to execute several search operations in one request.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html.

func (Msearch) WithCcsMinimizeRoundtrips ¶ 

func (f Msearch) WithCcsMinimizeRoundtrips(v bool) func(*MsearchRequest)

WithCcsMinimizeRoundtrips - indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.

func (Msearch) WithContext ¶ 

func (f Msearch) WithContext(v context.Context) func(*MsearchRequest)

WithContext sets the request context.

func (Msearch) WithErrorTrace ¶ 

func (f Msearch) WithErrorTrace() func(*MsearchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Msearch) WithFilterPath ¶ 

func (f Msearch) WithFilterPath(v ...string) func(*MsearchRequest)

WithFilterPath filters the properties of the response body.

func (Msearch) WithHeader ¶ 

func (f Msearch) WithHeader(h map[string]string) func(*MsearchRequest)

WithHeader adds the headers to the HTTP request.

func (Msearch) WithHuman ¶ 

func (f Msearch) WithHuman() func(*MsearchRequest)

WithHuman makes statistical values human-readable.

func (Msearch) WithIndex ¶ 

func (f Msearch) WithIndex(v ...string) func(*MsearchRequest)

WithIndex - a list of index names to use as default.

func (Msearch) WithMaxConcurrentSearches ¶ 

func (f Msearch) WithMaxConcurrentSearches(v int) func(*MsearchRequest)

WithMaxConcurrentSearches - controls the maximum number of concurrent searches the multi search api will execute.

func (Msearch) WithMaxConcurrentShardRequests ¶ 

func (f Msearch) WithMaxConcurrentShardRequests(v int) func(*MsearchRequest)

WithMaxConcurrentShardRequests - the number of concurrent shard requests each sub search executes concurrently per node. this value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.

func (Msearch) WithOpaqueID ¶ 

func (f Msearch) WithOpaqueID(s string) func(*MsearchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Msearch) WithPreFilterShardSize ¶ 

func (f Msearch) WithPreFilterShardSize(v int) func(*MsearchRequest)

WithPreFilterShardSize - a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. this filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint..

func (Msearch) WithPretty ¶ 

func (f Msearch) WithPretty() func(*MsearchRequest)

WithPretty makes the response body pretty-printed.

func (Msearch) WithRestTotalHitsAsInt ¶ 

func (f Msearch) WithRestTotalHitsAsInt(v bool) func(*MsearchRequest)

WithRestTotalHitsAsInt - indicates whether hits.total should be rendered as an integer or an object in the rest search response.

func (Msearch) WithSearchType ¶ 

func (f Msearch) WithSearchType(v string) func(*MsearchRequest)

WithSearchType - search operation type.

func (Msearch) WithTypedKeys ¶ 

func (f Msearch) WithTypedKeys(v bool) func(*MsearchRequest)

WithTypedKeys - specify whether aggregation and suggester names should be prefixed by their respective types in the response.

type MsearchRequest ¶ 

type MsearchRequest struct {
	Index []string

	Body io.Reader

	CcsMinimizeRoundtrips      *bool
	MaxConcurrentSearches      *int
	MaxConcurrentShardRequests *int
	PreFilterShardSize         *int
	RestTotalHitsAsInt         *bool
	SearchType                 string
	TypedKeys                  *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MsearchRequest configures the Msearch API request.

func (MsearchRequest) Do ¶ 

func (r MsearchRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type MsearchTemplate ¶ 

type MsearchTemplate func(body io.Reader, o ...func(*MsearchTemplateRequest)) (*Response, error)

MsearchTemplate allows to execute several search template operations in one request.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html.

func (MsearchTemplate) WithCcsMinimizeRoundtrips ¶ 

func (f MsearchTemplate) WithCcsMinimizeRoundtrips(v bool) func(*MsearchTemplateRequest)

WithCcsMinimizeRoundtrips - indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.

func (MsearchTemplate) WithContext ¶ 

func (f MsearchTemplate) WithContext(v context.Context) func(*MsearchTemplateRequest)

WithContext sets the request context.

func (MsearchTemplate) WithErrorTrace ¶ 

func (f MsearchTemplate) WithErrorTrace() func(*MsearchTemplateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (MsearchTemplate) WithFilterPath ¶ 

func (f MsearchTemplate) WithFilterPath(v ...string) func(*MsearchTemplateRequest)

WithFilterPath filters the properties of the response body.

func (MsearchTemplate) WithHeader ¶ 

func (f MsearchTemplate) WithHeader(h map[string]string) func(*MsearchTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (MsearchTemplate) WithHuman ¶ 

func (f MsearchTemplate) WithHuman() func(*MsearchTemplateRequest)

WithHuman makes statistical values human-readable.

func (MsearchTemplate) WithIndex ¶ 

func (f MsearchTemplate) WithIndex(v ...string) func(*MsearchTemplateRequest)

WithIndex - a list of index names to use as default.

func (MsearchTemplate) WithMaxConcurrentSearches ¶ 

func (f MsearchTemplate) WithMaxConcurrentSearches(v int) func(*MsearchTemplateRequest)

WithMaxConcurrentSearches - controls the maximum number of concurrent searches the multi search api will execute.

func (MsearchTemplate) WithOpaqueID ¶ 

func (f MsearchTemplate) WithOpaqueID(s string) func(*MsearchTemplateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (MsearchTemplate) WithPretty ¶ 

func (f MsearchTemplate) WithPretty() func(*MsearchTemplateRequest)

WithPretty makes the response body pretty-printed.

func (MsearchTemplate) WithRestTotalHitsAsInt ¶ 

func (f MsearchTemplate) WithRestTotalHitsAsInt(v bool) func(*MsearchTemplateRequest)

WithRestTotalHitsAsInt - indicates whether hits.total should be rendered as an integer or an object in the rest search response.

func (MsearchTemplate) WithSearchType ¶ 

func (f MsearchTemplate) WithSearchType(v string) func(*MsearchTemplateRequest)

WithSearchType - search operation type.

func (MsearchTemplate) WithTypedKeys ¶ 

func (f MsearchTemplate) WithTypedKeys(v bool) func(*MsearchTemplateRequest)

WithTypedKeys - specify whether aggregation and suggester names should be prefixed by their respective types in the response.

type MsearchTemplateRequest ¶ 

type MsearchTemplateRequest struct {
	Index []string

	Body io.Reader

	CcsMinimizeRoundtrips *bool
	MaxConcurrentSearches *int
	RestTotalHitsAsInt    *bool
	SearchType            string
	TypedKeys             *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MsearchTemplateRequest configures the Msearch Template API request.

func (MsearchTemplateRequest) Do ¶ 

func (r MsearchTemplateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Mtermvectors ¶ 

type Mtermvectors func(o ...func(*MtermvectorsRequest)) (*Response, error)

Mtermvectors returns multiple termvectors in one request.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html.

func (Mtermvectors) WithBody ¶ 

func (f Mtermvectors) WithBody(v io.Reader) func(*MtermvectorsRequest)

WithBody - Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation..

func (Mtermvectors) WithContext ¶ 

func (f Mtermvectors) WithContext(v context.Context) func(*MtermvectorsRequest)

WithContext sets the request context.

func (Mtermvectors) WithErrorTrace ¶ 

func (f Mtermvectors) WithErrorTrace() func(*MtermvectorsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Mtermvectors) WithFieldStatistics ¶ 

func (f Mtermvectors) WithFieldStatistics(v bool) func(*MtermvectorsRequest)

WithFieldStatistics - specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. applies to all returned documents unless otherwise specified in body "params" or "docs"..

func (Mtermvectors) WithFields ¶ 

func (f Mtermvectors) WithFields(v ...string) func(*MtermvectorsRequest)

WithFields - a list of fields to return. applies to all returned documents unless otherwise specified in body "params" or "docs"..

func (Mtermvectors) WithFilterPath ¶ 

func (f Mtermvectors) WithFilterPath(v ...string) func(*MtermvectorsRequest)

WithFilterPath filters the properties of the response body.

func (Mtermvectors) WithHeader ¶ 

func (f Mtermvectors) WithHeader(h map[string]string) func(*MtermvectorsRequest)

WithHeader adds the headers to the HTTP request.

func (Mtermvectors) WithHuman ¶ 

func (f Mtermvectors) WithHuman() func(*MtermvectorsRequest)

WithHuman makes statistical values human-readable.

func (Mtermvectors) WithIds ¶ 

func (f Mtermvectors) WithIds(v ...string) func(*MtermvectorsRequest)

WithIds - a list of documents ids. you must define ids as parameter or set "ids" or "docs" in the request body.

func (Mtermvectors) WithIndex ¶ 

func (f Mtermvectors) WithIndex(v string) func(*MtermvectorsRequest)

WithIndex - the index in which the document resides..

func (Mtermvectors) WithOffsets ¶ 

func (f Mtermvectors) WithOffsets(v bool) func(*MtermvectorsRequest)

WithOffsets - specifies if term offsets should be returned. applies to all returned documents unless otherwise specified in body "params" or "docs"..

func (Mtermvectors) WithOpaqueID ¶ 

func (f Mtermvectors) WithOpaqueID(s string) func(*MtermvectorsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Mtermvectors) WithPayloads ¶ 

func (f Mtermvectors) WithPayloads(v bool) func(*MtermvectorsRequest)

WithPayloads - specifies if term payloads should be returned. applies to all returned documents unless otherwise specified in body "params" or "docs"..

func (Mtermvectors) WithPositions ¶ 

func (f Mtermvectors) WithPositions(v bool) func(*MtermvectorsRequest)

WithPositions - specifies if term positions should be returned. applies to all returned documents unless otherwise specified in body "params" or "docs"..

func (Mtermvectors) WithPreference ¶ 

func (f Mtermvectors) WithPreference(v string) func(*MtermvectorsRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random) .applies to all returned documents unless otherwise specified in body "params" or "docs"..

func (Mtermvectors) WithPretty ¶ 

func (f Mtermvectors) WithPretty() func(*MtermvectorsRequest)

WithPretty makes the response body pretty-printed.

func (Mtermvectors) WithRealtime ¶ 

func (f Mtermvectors) WithRealtime(v bool) func(*MtermvectorsRequest)

WithRealtime - specifies if requests are real-time as opposed to near-real-time (default: true)..

func (Mtermvectors) WithRouting ¶ 

func (f Mtermvectors) WithRouting(v string) func(*MtermvectorsRequest)

WithRouting - specific routing value. applies to all returned documents unless otherwise specified in body "params" or "docs"..

func (Mtermvectors) WithTermStatistics ¶ 

func (f Mtermvectors) WithTermStatistics(v bool) func(*MtermvectorsRequest)

WithTermStatistics - specifies if total term frequency and document frequency should be returned. applies to all returned documents unless otherwise specified in body "params" or "docs"..

func (Mtermvectors) WithVersion ¶ 

func (f Mtermvectors) WithVersion(v int) func(*MtermvectorsRequest)

WithVersion - explicit version number for concurrency control.

func (Mtermvectors) WithVersionType ¶ 

func (f Mtermvectors) WithVersionType(v string) func(*MtermvectorsRequest)

WithVersionType - specific version type.

type MtermvectorsRequest ¶ 

type MtermvectorsRequest struct {
	Index string

	Body io.Reader

	Fields          []string
	FieldStatistics *bool
	Ids             []string
	Offsets         *bool
	Payloads        *bool
	Positions       *bool
	Preference      string
	Realtime        *bool
	Routing         string
	TermStatistics  *bool
	Version         *int
	VersionType     string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

MtermvectorsRequest configures the Mtermvectors API request.

func (MtermvectorsRequest) Do ¶ 

func (r MtermvectorsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Nodes ¶ 

type Nodes struct {
	ClearRepositoriesMeteringArchive NodesClearRepositoriesMeteringArchive
	GetRepositoriesMeteringInfo      NodesGetRepositoriesMeteringInfo
	HotThreads                       NodesHotThreads
	Info                             NodesInfo
	ReloadSecureSettings             NodesReloadSecureSettings
	Stats                            NodesStats
	Usage                            NodesUsage
}

Nodes contains the Nodes APIs

type NodesClearRepositoriesMeteringArchive ¶ 

type NodesClearRepositoriesMeteringArchive func(max_archive_version *int, node_id []string, o ...func(*NodesClearRepositoriesMeteringArchiveRequest)) (*Response, error)

NodesClearRepositoriesMeteringArchive removes the archived repositories metering information present in the cluster.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html.

func (NodesClearRepositoriesMeteringArchive) WithContext ¶ 

func (f NodesClearRepositoriesMeteringArchive) WithContext(v context.Context) func(*NodesClearRepositoriesMeteringArchiveRequest)

WithContext sets the request context.

func (NodesClearRepositoriesMeteringArchive) WithErrorTrace ¶ 

func (f NodesClearRepositoriesMeteringArchive) WithErrorTrace() func(*NodesClearRepositoriesMeteringArchiveRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (NodesClearRepositoriesMeteringArchive) WithFilterPath ¶ 

func (f NodesClearRepositoriesMeteringArchive) WithFilterPath(v ...string) func(*NodesClearRepositoriesMeteringArchiveRequest)

WithFilterPath filters the properties of the response body.

func (NodesClearRepositoriesMeteringArchive) WithHeader ¶ 

func (f NodesClearRepositoriesMeteringArchive) WithHeader(h map[string]string) func(*NodesClearRepositoriesMeteringArchiveRequest)

WithHeader adds the headers to the HTTP request.

func (NodesClearRepositoriesMeteringArchive) WithHuman ¶ 

func (f NodesClearRepositoriesMeteringArchive) WithHuman() func(*NodesClearRepositoriesMeteringArchiveRequest)

WithHuman makes statistical values human-readable.

func (NodesClearRepositoriesMeteringArchive) WithOpaqueID ¶ 

func (f NodesClearRepositoriesMeteringArchive) WithOpaqueID(s string) func(*NodesClearRepositoriesMeteringArchiveRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (NodesClearRepositoriesMeteringArchive) WithPretty ¶ 

func (f NodesClearRepositoriesMeteringArchive) WithPretty() func(*NodesClearRepositoriesMeteringArchiveRequest)

WithPretty makes the response body pretty-printed.

type NodesClearRepositoriesMeteringArchiveRequest ¶ 

type NodesClearRepositoriesMeteringArchiveRequest struct {
	MaxArchiveVersion *int
	NodeID            []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

NodesClearRepositoriesMeteringArchiveRequest configures the Nodes Clear Repositories Metering Archive API request.

func (NodesClearRepositoriesMeteringArchiveRequest) Do ¶ 

func (r NodesClearRepositoriesMeteringArchiveRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type NodesGetRepositoriesMeteringInfo ¶ 

type NodesGetRepositoriesMeteringInfo func(node_id []string, o ...func(*NodesGetRepositoriesMeteringInfoRequest)) (*Response, error)

NodesGetRepositoriesMeteringInfo returns cluster repositories metering information.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html.

func (NodesGetRepositoriesMeteringInfo) WithContext ¶ 

func (f NodesGetRepositoriesMeteringInfo) WithContext(v context.Context) func(*NodesGetRepositoriesMeteringInfoRequest)

WithContext sets the request context.

func (NodesGetRepositoriesMeteringInfo) WithErrorTrace ¶ 

func (f NodesGetRepositoriesMeteringInfo) WithErrorTrace() func(*NodesGetRepositoriesMeteringInfoRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (NodesGetRepositoriesMeteringInfo) WithFilterPath ¶ 

func (f NodesGetRepositoriesMeteringInfo) WithFilterPath(v ...string) func(*NodesGetRepositoriesMeteringInfoRequest)

WithFilterPath filters the properties of the response body.

func (NodesGetRepositoriesMeteringInfo) WithHeader ¶ 

func (f NodesGetRepositoriesMeteringInfo) WithHeader(h map[string]string) func(*NodesGetRepositoriesMeteringInfoRequest)

WithHeader adds the headers to the HTTP request.

func (NodesGetRepositoriesMeteringInfo) WithHuman ¶ 

func (f NodesGetRepositoriesMeteringInfo) WithHuman() func(*NodesGetRepositoriesMeteringInfoRequest)

WithHuman makes statistical values human-readable.

func (NodesGetRepositoriesMeteringInfo) WithOpaqueID ¶ 

func (f NodesGetRepositoriesMeteringInfo) WithOpaqueID(s string) func(*NodesGetRepositoriesMeteringInfoRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (NodesGetRepositoriesMeteringInfo) WithPretty ¶ 

func (f NodesGetRepositoriesMeteringInfo) WithPretty() func(*NodesGetRepositoriesMeteringInfoRequest)

WithPretty makes the response body pretty-printed.

type NodesGetRepositoriesMeteringInfoRequest ¶ 

type NodesGetRepositoriesMeteringInfoRequest struct {
	NodeID []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

NodesGetRepositoriesMeteringInfoRequest configures the Nodes Get Repositories Metering Info API request.

func (NodesGetRepositoriesMeteringInfoRequest) Do ¶ 

func (r NodesGetRepositoriesMeteringInfoRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type NodesHotThreads ¶ 

type NodesHotThreads func(o ...func(*NodesHotThreadsRequest)) (*Response, error)

NodesHotThreads returns information about hot threads on each node in the cluster.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html.

func (NodesHotThreads) WithContext ¶ 

func (f NodesHotThreads) WithContext(v context.Context) func(*NodesHotThreadsRequest)

WithContext sets the request context.

func (NodesHotThreads) WithDocumentType ¶ 

func (f NodesHotThreads) WithDocumentType(v string) func(*NodesHotThreadsRequest)

WithDocumentType - the type to sample (default: cpu).

func (NodesHotThreads) WithErrorTrace ¶ 

func (f NodesHotThreads) WithErrorTrace() func(*NodesHotThreadsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (NodesHotThreads) WithFilterPath ¶ 

func (f NodesHotThreads) WithFilterPath(v ...string) func(*NodesHotThreadsRequest)

WithFilterPath filters the properties of the response body.

func (NodesHotThreads) WithHeader ¶ 

func (f NodesHotThreads) WithHeader(h map[string]string) func(*NodesHotThreadsRequest)

WithHeader adds the headers to the HTTP request.

func (NodesHotThreads) WithHuman ¶ 

func (f NodesHotThreads) WithHuman() func(*NodesHotThreadsRequest)

WithHuman makes statistical values human-readable.

func (NodesHotThreads) WithIgnoreIdleThreads ¶ 

func (f NodesHotThreads) WithIgnoreIdleThreads(v bool) func(*NodesHotThreadsRequest)

WithIgnoreIdleThreads - don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true).

func (NodesHotThreads) WithInterval ¶ 

func (f NodesHotThreads) WithInterval(v time.Duration) func(*NodesHotThreadsRequest)

WithInterval - the interval for the second sampling of threads.

func (NodesHotThreads) WithNodeID ¶ 

func (f NodesHotThreads) WithNodeID(v ...string) func(*NodesHotThreadsRequest)

WithNodeID - a list of node ids or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.

func (NodesHotThreads) WithOpaqueID ¶ 

func (f NodesHotThreads) WithOpaqueID(s string) func(*NodesHotThreadsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (NodesHotThreads) WithPretty ¶ 

func (f NodesHotThreads) WithPretty() func(*NodesHotThreadsRequest)

WithPretty makes the response body pretty-printed.

func (NodesHotThreads) WithSnapshots ¶ 

func (f NodesHotThreads) WithSnapshots(v int) func(*NodesHotThreadsRequest)

WithSnapshots - number of samples of thread stacktrace (default: 10).

func (NodesHotThreads) WithSort ¶ 

func (f NodesHotThreads) WithSort(v string) func(*NodesHotThreadsRequest)

WithSort - the sort order for 'cpu' type (default: total).

func (NodesHotThreads) WithThreads ¶ 

func (f NodesHotThreads) WithThreads(v int) func(*NodesHotThreadsRequest)

WithThreads - specify the number of threads to provide information for (default: 3).

func (NodesHotThreads) WithTimeout ¶ 

func (f NodesHotThreads) WithTimeout(v time.Duration) func(*NodesHotThreadsRequest)

WithTimeout - explicit operation timeout.

type NodesHotThreadsRequest ¶ 

type NodesHotThreadsRequest struct {
	NodeID []string

	IgnoreIdleThreads *bool
	Interval          time.Duration
	Snapshots         *int
	Sort              string
	Threads           *int
	Timeout           time.Duration
	DocumentType      string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

NodesHotThreadsRequest configures the Nodes Hot Threads API request.

func (NodesHotThreadsRequest) Do ¶ 

func (r NodesHotThreadsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type NodesInfo ¶ 

type NodesInfo func(o ...func(*NodesInfoRequest)) (*Response, error)

NodesInfo returns information about nodes in the cluster.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html.

func (NodesInfo) WithContext ¶ 

func (f NodesInfo) WithContext(v context.Context) func(*NodesInfoRequest)

WithContext sets the request context.

func (NodesInfo) WithErrorTrace ¶ 

func (f NodesInfo) WithErrorTrace() func(*NodesInfoRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (NodesInfo) WithFilterPath ¶ 

func (f NodesInfo) WithFilterPath(v ...string) func(*NodesInfoRequest)

WithFilterPath filters the properties of the response body.

func (NodesInfo) WithFlatSettings ¶ 

func (f NodesInfo) WithFlatSettings(v bool) func(*NodesInfoRequest)

WithFlatSettings - return settings in flat format (default: false).

func (NodesInfo) WithHeader ¶ 

func (f NodesInfo) WithHeader(h map[string]string) func(*NodesInfoRequest)

WithHeader adds the headers to the HTTP request.

func (NodesInfo) WithHuman ¶ 

func (f NodesInfo) WithHuman() func(*NodesInfoRequest)

WithHuman makes statistical values human-readable.

func (NodesInfo) WithMetric ¶ 

func (f NodesInfo) WithMetric(v ...string) func(*NodesInfoRequest)

WithMetric - a list of metrics you wish returned. leave empty to return all metrics..

func (NodesInfo) WithNodeID ¶ 

func (f NodesInfo) WithNodeID(v ...string) func(*NodesInfoRequest)

WithNodeID - a list of node ids or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.

func (NodesInfo) WithOpaqueID ¶ 

func (f NodesInfo) WithOpaqueID(s string) func(*NodesInfoRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (NodesInfo) WithPretty ¶ 

func (f NodesInfo) WithPretty() func(*NodesInfoRequest)

WithPretty makes the response body pretty-printed.

func (NodesInfo) WithTimeout ¶ 

func (f NodesInfo) WithTimeout(v time.Duration) func(*NodesInfoRequest)

WithTimeout - explicit operation timeout.

type NodesInfoRequest ¶ 

type NodesInfoRequest struct {
	Metric []string
	NodeID []string

	FlatSettings *bool
	Timeout      time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

NodesInfoRequest configures the Nodes Info API request.

func (NodesInfoRequest) Do ¶ 

func (r NodesInfoRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type NodesReloadSecureSettings ¶ 

type NodesReloadSecureSettings func(o ...func(*NodesReloadSecureSettingsRequest)) (*Response, error)

NodesReloadSecureSettings reloads secure settings.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings.

func (NodesReloadSecureSettings) WithBody ¶ 

func (f NodesReloadSecureSettings) WithBody(v io.Reader) func(*NodesReloadSecureSettingsRequest)

WithBody - An object containing the password for the elasticsearch keystore.

func (NodesReloadSecureSettings) WithContext ¶ 

func (f NodesReloadSecureSettings) WithContext(v context.Context) func(*NodesReloadSecureSettingsRequest)

WithContext sets the request context.

func (NodesReloadSecureSettings) WithErrorTrace ¶ 

func (f NodesReloadSecureSettings) WithErrorTrace() func(*NodesReloadSecureSettingsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (NodesReloadSecureSettings) WithFilterPath ¶ 

func (f NodesReloadSecureSettings) WithFilterPath(v ...string) func(*NodesReloadSecureSettingsRequest)

WithFilterPath filters the properties of the response body.

func (NodesReloadSecureSettings) WithHeader ¶ 

func (f NodesReloadSecureSettings) WithHeader(h map[string]string) func(*NodesReloadSecureSettingsRequest)

WithHeader adds the headers to the HTTP request.

func (NodesReloadSecureSettings) WithHuman ¶ 

func (f NodesReloadSecureSettings) WithHuman() func(*NodesReloadSecureSettingsRequest)

WithHuman makes statistical values human-readable.

func (NodesReloadSecureSettings) WithNodeID ¶ 

func (f NodesReloadSecureSettings) WithNodeID(v ...string) func(*NodesReloadSecureSettingsRequest)

WithNodeID - a list of node ids to span the reload/reinit call. should stay empty because reloading usually involves all cluster nodes..

func (NodesReloadSecureSettings) WithOpaqueID ¶ 

func (f NodesReloadSecureSettings) WithOpaqueID(s string) func(*NodesReloadSecureSettingsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (NodesReloadSecureSettings) WithPretty ¶ 

func (f NodesReloadSecureSettings) WithPretty() func(*NodesReloadSecureSettingsRequest)

WithPretty makes the response body pretty-printed.

func (NodesReloadSecureSettings) WithTimeout ¶ 

func (f NodesReloadSecureSettings) WithTimeout(v time.Duration) func(*NodesReloadSecureSettingsRequest)

WithTimeout - explicit operation timeout.

type NodesReloadSecureSettingsRequest ¶ 

type NodesReloadSecureSettingsRequest struct {
	Body io.Reader

	NodeID []string

	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

NodesReloadSecureSettingsRequest configures the Nodes Reload Secure Settings API request.

func (NodesReloadSecureSettingsRequest) Do ¶ 

func (r NodesReloadSecureSettingsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type NodesStats ¶ 

type NodesStats func(o ...func(*NodesStatsRequest)) (*Response, error)

NodesStats returns statistical information about nodes in the cluster.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html.

func (NodesStats) WithCompletionFields ¶ 

func (f NodesStats) WithCompletionFields(v ...string) func(*NodesStatsRequest)

WithCompletionFields - a list of fields for the `completion` index metric (supports wildcards).

func (NodesStats) WithContext ¶ 

func (f NodesStats) WithContext(v context.Context) func(*NodesStatsRequest)

WithContext sets the request context.

func (NodesStats) WithErrorTrace ¶ 

func (f NodesStats) WithErrorTrace() func(*NodesStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (NodesStats) WithFielddataFields ¶ 

func (f NodesStats) WithFielddataFields(v ...string) func(*NodesStatsRequest)

WithFielddataFields - a list of fields for the `fielddata` index metric (supports wildcards).

func (NodesStats) WithFields ¶ 

func (f NodesStats) WithFields(v ...string) func(*NodesStatsRequest)

WithFields - a list of fields for `fielddata` and `completion` index metric (supports wildcards).

func (NodesStats) WithFilterPath ¶ 

func (f NodesStats) WithFilterPath(v ...string) func(*NodesStatsRequest)

WithFilterPath filters the properties of the response body.

func (NodesStats) WithGroups ¶ 

func (f NodesStats) WithGroups(v bool) func(*NodesStatsRequest)

WithGroups - a list of search groups for `search` index metric.

func (NodesStats) WithHeader ¶ 

func (f NodesStats) WithHeader(h map[string]string) func(*NodesStatsRequest)

WithHeader adds the headers to the HTTP request.

func (NodesStats) WithHuman ¶ 

func (f NodesStats) WithHuman() func(*NodesStatsRequest)

WithHuman makes statistical values human-readable.

func (NodesStats) WithIncludeSegmentFileSizes ¶ 

func (f NodesStats) WithIncludeSegmentFileSizes(v bool) func(*NodesStatsRequest)

WithIncludeSegmentFileSizes - whether to report the aggregated disk usage of each one of the lucene index files (only applies if segment stats are requested).

func (NodesStats) WithIncludeUnloadedSegments ¶ 

func (f NodesStats) WithIncludeUnloadedSegments(v bool) func(*NodesStatsRequest)

WithIncludeUnloadedSegments - if set to true segment stats will include stats for segments that are not currently loaded into memory.

func (NodesStats) WithIndexMetric ¶ 

func (f NodesStats) WithIndexMetric(v ...string) func(*NodesStatsRequest)

WithIndexMetric - limit the information returned for `indices` metric to the specific index metrics. isn't used if `indices` (or `all`) metric isn't specified..

func (NodesStats) WithLevel ¶ 

func (f NodesStats) WithLevel(v string) func(*NodesStatsRequest)

WithLevel - return indices stats aggregated at index, node or shard level.

func (NodesStats) WithMetric ¶ 

func (f NodesStats) WithMetric(v ...string) func(*NodesStatsRequest)

WithMetric - limit the information returned to the specified metrics.

func (NodesStats) WithNodeID ¶ 

func (f NodesStats) WithNodeID(v ...string) func(*NodesStatsRequest)

WithNodeID - a list of node ids or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.

func (NodesStats) WithOpaqueID ¶ 

func (f NodesStats) WithOpaqueID(s string) func(*NodesStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (NodesStats) WithPretty ¶ 

func (f NodesStats) WithPretty() func(*NodesStatsRequest)

WithPretty makes the response body pretty-printed.

func (NodesStats) WithTimeout ¶ 

func (f NodesStats) WithTimeout(v time.Duration) func(*NodesStatsRequest)

WithTimeout - explicit operation timeout.

func (NodesStats) WithTypes ¶ 

func (f NodesStats) WithTypes(v ...string) func(*NodesStatsRequest)

WithTypes - a list of document types for the `indexing` index metric.

type NodesStatsRequest ¶ 

type NodesStatsRequest struct {
	IndexMetric []string
	Metric      []string
	NodeID      []string

	CompletionFields        []string
	FielddataFields         []string
	Fields                  []string
	Groups                  *bool
	IncludeSegmentFileSizes *bool
	IncludeUnloadedSegments *bool
	Level                   string
	Timeout                 time.Duration
	Types                   []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

NodesStatsRequest configures the Nodes Stats API request.

func (NodesStatsRequest) Do ¶ 

func (r NodesStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type NodesUsage ¶ 

type NodesUsage func(o ...func(*NodesUsageRequest)) (*Response, error)

NodesUsage returns low-level information about REST actions usage on nodes.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-usage.html.

func (NodesUsage) WithContext ¶ 

func (f NodesUsage) WithContext(v context.Context) func(*NodesUsageRequest)

WithContext sets the request context.

func (NodesUsage) WithErrorTrace ¶ 

func (f NodesUsage) WithErrorTrace() func(*NodesUsageRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (NodesUsage) WithFilterPath ¶ 

func (f NodesUsage) WithFilterPath(v ...string) func(*NodesUsageRequest)

WithFilterPath filters the properties of the response body.

func (NodesUsage) WithHeader ¶ 

func (f NodesUsage) WithHeader(h map[string]string) func(*NodesUsageRequest)

WithHeader adds the headers to the HTTP request.

func (NodesUsage) WithHuman ¶ 

func (f NodesUsage) WithHuman() func(*NodesUsageRequest)

WithHuman makes statistical values human-readable.

func (NodesUsage) WithMetric ¶ 

func (f NodesUsage) WithMetric(v ...string) func(*NodesUsageRequest)

WithMetric - limit the information returned to the specified metrics.

func (NodesUsage) WithNodeID ¶ 

func (f NodesUsage) WithNodeID(v ...string) func(*NodesUsageRequest)

WithNodeID - a list of node ids or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.

func (NodesUsage) WithOpaqueID ¶ 

func (f NodesUsage) WithOpaqueID(s string) func(*NodesUsageRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (NodesUsage) WithPretty ¶ 

func (f NodesUsage) WithPretty() func(*NodesUsageRequest)

WithPretty makes the response body pretty-printed.

func (NodesUsage) WithTimeout ¶ 

func (f NodesUsage) WithTimeout(v time.Duration) func(*NodesUsageRequest)

WithTimeout - explicit operation timeout.

type NodesUsageRequest ¶ 

type NodesUsageRequest struct {
	Metric []string
	NodeID []string

	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

NodesUsageRequest configures the Nodes Usage API request.

func (NodesUsageRequest) Do ¶ 

func (r NodesUsageRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type OpenPointInTime ¶ 

type OpenPointInTime func(index []string, keep_alive string, o ...func(*OpenPointInTimeRequest)) (*Response, error)

OpenPointInTime - Open a point in time that can be used in subsequent searches

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html.

func (OpenPointInTime) WithAllowPartialSearchResults ¶ added in v8.17.0 

func (f OpenPointInTime) WithAllowPartialSearchResults(v bool) func(*OpenPointInTimeRequest)

WithAllowPartialSearchResults - specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception. (default: false).

func (OpenPointInTime) WithBody ¶ added in v8.12.0 

func (f OpenPointInTime) WithBody(v io.Reader) func(*OpenPointInTimeRequest)

WithBody - An index_filter specified with the Query DSL.

func (OpenPointInTime) WithContext ¶ 

func (f OpenPointInTime) WithContext(v context.Context) func(*OpenPointInTimeRequest)

WithContext sets the request context.

func (OpenPointInTime) WithErrorTrace ¶ 

func (f OpenPointInTime) WithErrorTrace() func(*OpenPointInTimeRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (OpenPointInTime) WithExpandWildcards ¶ 

func (f OpenPointInTime) WithExpandWildcards(v string) func(*OpenPointInTimeRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (OpenPointInTime) WithFilterPath ¶ 

func (f OpenPointInTime) WithFilterPath(v ...string) func(*OpenPointInTimeRequest)

WithFilterPath filters the properties of the response body.

func (OpenPointInTime) WithHeader ¶ 

func (f OpenPointInTime) WithHeader(h map[string]string) func(*OpenPointInTimeRequest)

WithHeader adds the headers to the HTTP request.

func (OpenPointInTime) WithHuman ¶ 

func (f OpenPointInTime) WithHuman() func(*OpenPointInTimeRequest)

WithHuman makes statistical values human-readable.

func (OpenPointInTime) WithIgnoreUnavailable ¶ 

func (f OpenPointInTime) WithIgnoreUnavailable(v bool) func(*OpenPointInTimeRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (OpenPointInTime) WithKeepAlive ¶ 

func (f OpenPointInTime) WithKeepAlive(v string) func(*OpenPointInTimeRequest)

WithKeepAlive - specific the time to live for the point in time.

func (OpenPointInTime) WithOpaqueID ¶ 

func (f OpenPointInTime) WithOpaqueID(s string) func(*OpenPointInTimeRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (OpenPointInTime) WithPreference ¶ 

func (f OpenPointInTime) WithPreference(v string) func(*OpenPointInTimeRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (OpenPointInTime) WithPretty ¶ 

func (f OpenPointInTime) WithPretty() func(*OpenPointInTimeRequest)

WithPretty makes the response body pretty-printed.

func (OpenPointInTime) WithRouting ¶ 

func (f OpenPointInTime) WithRouting(v string) func(*OpenPointInTimeRequest)

WithRouting - specific routing value.

type OpenPointInTimeRequest ¶ 

type OpenPointInTimeRequest struct {
	Index []string

	Body io.Reader

	AllowPartialSearchResults *bool
	ExpandWildcards           string
	IgnoreUnavailable         *bool
	KeepAlive                 string
	Preference                string
	Routing                   string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

OpenPointInTimeRequest configures the Open Point In Time API request.

func (OpenPointInTimeRequest) Do ¶ 

func (r OpenPointInTimeRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Ping ¶ 

type Ping func(o ...func(*PingRequest)) (*Response, error)

Ping returns whether the cluster is running.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html.

func (Ping) WithContext ¶ 

func (f Ping) WithContext(v context.Context) func(*PingRequest)

WithContext sets the request context.

func (Ping) WithErrorTrace ¶ 

func (f Ping) WithErrorTrace() func(*PingRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Ping) WithFilterPath ¶ 

func (f Ping) WithFilterPath(v ...string) func(*PingRequest)

WithFilterPath filters the properties of the response body.

func (Ping) WithHeader ¶ 

func (f Ping) WithHeader(h map[string]string) func(*PingRequest)

WithHeader adds the headers to the HTTP request.

func (Ping) WithHuman ¶ 

func (f Ping) WithHuman() func(*PingRequest)

WithHuman makes statistical values human-readable.

func (Ping) WithOpaqueID ¶ 

func (f Ping) WithOpaqueID(s string) func(*PingRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Ping) WithPretty ¶ 

func (f Ping) WithPretty() func(*PingRequest)

WithPretty makes the response body pretty-printed.

type PingRequest ¶ 

type PingRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

PingRequest configures the Ping API request.

func (PingRequest) Do ¶ 

func (r PingRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ProfilingFlamegraph ¶ added in v8.13.0 

type ProfilingFlamegraph func(body io.Reader, o ...func(*ProfilingFlamegraphRequest)) (*Response, error)

ProfilingFlamegraph - Extracts a UI-optimized structure to render flamegraphs from Universal Profiling.

See full documentation at https://www.elastic.co/guide/en/observability/current/universal-profiling.html.

func (ProfilingFlamegraph) WithContext ¶ added in v8.13.0 

func (f ProfilingFlamegraph) WithContext(v context.Context) func(*ProfilingFlamegraphRequest)

WithContext sets the request context.

func (ProfilingFlamegraph) WithErrorTrace ¶ added in v8.13.0 

func (f ProfilingFlamegraph) WithErrorTrace() func(*ProfilingFlamegraphRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ProfilingFlamegraph) WithFilterPath ¶ added in v8.13.0 

func (f ProfilingFlamegraph) WithFilterPath(v ...string) func(*ProfilingFlamegraphRequest)

WithFilterPath filters the properties of the response body.

func (ProfilingFlamegraph) WithHeader ¶ added in v8.13.0 

func (f ProfilingFlamegraph) WithHeader(h map[string]string) func(*ProfilingFlamegraphRequest)

WithHeader adds the headers to the HTTP request.

func (ProfilingFlamegraph) WithHuman ¶ added in v8.13.0 

func (f ProfilingFlamegraph) WithHuman() func(*ProfilingFlamegraphRequest)

WithHuman makes statistical values human-readable.

func (ProfilingFlamegraph) WithOpaqueID ¶ added in v8.13.0 

func (f ProfilingFlamegraph) WithOpaqueID(s string) func(*ProfilingFlamegraphRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ProfilingFlamegraph) WithPretty ¶ added in v8.13.0 

func (f ProfilingFlamegraph) WithPretty() func(*ProfilingFlamegraphRequest)

WithPretty makes the response body pretty-printed.

type ProfilingFlamegraphRequest ¶ added in v8.13.0 

type ProfilingFlamegraphRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ProfilingFlamegraphRequest configures the Profiling Flamegraph API request.

func (ProfilingFlamegraphRequest) Do ¶ added in v8.13.0 

func (r ProfilingFlamegraphRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ProfilingStacktraces ¶ added in v8.13.0 

type ProfilingStacktraces func(body io.Reader, o ...func(*ProfilingStacktracesRequest)) (*Response, error)

ProfilingStacktraces extracts raw stacktrace information from Universal Profiling.

See full documentation at https://www.elastic.co/guide/en/observability/current/universal-profiling.html.

func (ProfilingStacktraces) WithContext ¶ added in v8.13.0 

func (f ProfilingStacktraces) WithContext(v context.Context) func(*ProfilingStacktracesRequest)

WithContext sets the request context.

func (ProfilingStacktraces) WithErrorTrace ¶ added in v8.13.0 

func (f ProfilingStacktraces) WithErrorTrace() func(*ProfilingStacktracesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ProfilingStacktraces) WithFilterPath ¶ added in v8.13.0 

func (f ProfilingStacktraces) WithFilterPath(v ...string) func(*ProfilingStacktracesRequest)

WithFilterPath filters the properties of the response body.

func (ProfilingStacktraces) WithHeader ¶ added in v8.13.0 

func (f ProfilingStacktraces) WithHeader(h map[string]string) func(*ProfilingStacktracesRequest)

WithHeader adds the headers to the HTTP request.

func (ProfilingStacktraces) WithHuman ¶ added in v8.13.0 

func (f ProfilingStacktraces) WithHuman() func(*ProfilingStacktracesRequest)

WithHuman makes statistical values human-readable.

func (ProfilingStacktraces) WithOpaqueID ¶ added in v8.13.0 

func (f ProfilingStacktraces) WithOpaqueID(s string) func(*ProfilingStacktracesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ProfilingStacktraces) WithPretty ¶ added in v8.13.0 

func (f ProfilingStacktraces) WithPretty() func(*ProfilingStacktracesRequest)

WithPretty makes the response body pretty-printed.

type ProfilingStacktracesRequest ¶ added in v8.13.0 

type ProfilingStacktracesRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ProfilingStacktracesRequest configures the Profiling Stacktraces API request.

func (ProfilingStacktracesRequest) Do ¶ added in v8.13.0 

func (r ProfilingStacktracesRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ProfilingStatus ¶ added in v8.12.0 

type ProfilingStatus func(o ...func(*ProfilingStatusRequest)) (*Response, error)

ProfilingStatus returns basic information about the status of Universal Profiling.

See full documentation at https://www.elastic.co/guide/en/observability/current/universal-profiling.html.

func (ProfilingStatus) WithContext ¶ added in v8.12.0 

func (f ProfilingStatus) WithContext(v context.Context) func(*ProfilingStatusRequest)

WithContext sets the request context.

func (ProfilingStatus) WithErrorTrace ¶ added in v8.12.0 

func (f ProfilingStatus) WithErrorTrace() func(*ProfilingStatusRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ProfilingStatus) WithFilterPath ¶ added in v8.12.0 

func (f ProfilingStatus) WithFilterPath(v ...string) func(*ProfilingStatusRequest)

WithFilterPath filters the properties of the response body.

func (ProfilingStatus) WithHeader ¶ added in v8.12.0 

func (f ProfilingStatus) WithHeader(h map[string]string) func(*ProfilingStatusRequest)

WithHeader adds the headers to the HTTP request.

func (ProfilingStatus) WithHuman ¶ added in v8.12.0 

func (f ProfilingStatus) WithHuman() func(*ProfilingStatusRequest)

WithHuman makes statistical values human-readable.

func (ProfilingStatus) WithMasterTimeout ¶ added in v8.12.0 

func (f ProfilingStatus) WithMasterTimeout(v time.Duration) func(*ProfilingStatusRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (ProfilingStatus) WithOpaqueID ¶ added in v8.12.0 

func (f ProfilingStatus) WithOpaqueID(s string) func(*ProfilingStatusRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ProfilingStatus) WithPretty ¶ added in v8.12.0 

func (f ProfilingStatus) WithPretty() func(*ProfilingStatusRequest)

WithPretty makes the response body pretty-printed.

func (ProfilingStatus) WithTimeout ¶ added in v8.12.0 

func (f ProfilingStatus) WithTimeout(v time.Duration) func(*ProfilingStatusRequest)

WithTimeout - explicit operation timeout.

func (ProfilingStatus) WithWaitForResourcesCreated ¶ added in v8.12.0 

func (f ProfilingStatus) WithWaitForResourcesCreated(v bool) func(*ProfilingStatusRequest)

WithWaitForResourcesCreated - whether to return immediately or wait until resources have been created.

type ProfilingStatusRequest ¶ added in v8.12.0 

type ProfilingStatusRequest struct {
	MasterTimeout           time.Duration
	Timeout                 time.Duration
	WaitForResourcesCreated *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ProfilingStatusRequest configures the Profiling Status API request.

func (ProfilingStatusRequest) Do ¶ added in v8.12.0 

func (r ProfilingStatusRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ProfilingTopnFunctions ¶ added in v8.14.0 

type ProfilingTopnFunctions func(body io.Reader, o ...func(*ProfilingTopnFunctionsRequest)) (*Response, error)

ProfilingTopnFunctions extracts a list of topN functions from Universal Profiling.

See full documentation at https://www.elastic.co/guide/en/observability/current/universal-profiling.html.

func (ProfilingTopnFunctions) WithContext ¶ added in v8.14.0 

func (f ProfilingTopnFunctions) WithContext(v context.Context) func(*ProfilingTopnFunctionsRequest)

WithContext sets the request context.

func (ProfilingTopnFunctions) WithErrorTrace ¶ added in v8.14.0 

func (f ProfilingTopnFunctions) WithErrorTrace() func(*ProfilingTopnFunctionsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ProfilingTopnFunctions) WithFilterPath ¶ added in v8.14.0 

func (f ProfilingTopnFunctions) WithFilterPath(v ...string) func(*ProfilingTopnFunctionsRequest)

WithFilterPath filters the properties of the response body.

func (ProfilingTopnFunctions) WithHeader ¶ added in v8.14.0 

func (f ProfilingTopnFunctions) WithHeader(h map[string]string) func(*ProfilingTopnFunctionsRequest)

WithHeader adds the headers to the HTTP request.

func (ProfilingTopnFunctions) WithHuman ¶ added in v8.14.0 

func (f ProfilingTopnFunctions) WithHuman() func(*ProfilingTopnFunctionsRequest)

WithHuman makes statistical values human-readable.

func (ProfilingTopnFunctions) WithOpaqueID ¶ added in v8.14.0 

func (f ProfilingTopnFunctions) WithOpaqueID(s string) func(*ProfilingTopnFunctionsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ProfilingTopnFunctions) WithPretty ¶ added in v8.14.0 

func (f ProfilingTopnFunctions) WithPretty() func(*ProfilingTopnFunctionsRequest)

WithPretty makes the response body pretty-printed.

type ProfilingTopnFunctionsRequest ¶ added in v8.14.0 

type ProfilingTopnFunctionsRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ProfilingTopnFunctionsRequest configures the Profiling Topn Functions API request.

func (ProfilingTopnFunctionsRequest) Do ¶ added in v8.14.0 

func (r ProfilingTopnFunctionsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type PutScript ¶ 

type PutScript func(id string, body io.Reader, o ...func(*PutScriptRequest)) (*Response, error)

PutScript creates or updates a script.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html.

func (PutScript) WithContext ¶ 

func (f PutScript) WithContext(v context.Context) func(*PutScriptRequest)

WithContext sets the request context.

func (PutScript) WithErrorTrace ¶ 

func (f PutScript) WithErrorTrace() func(*PutScriptRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (PutScript) WithFilterPath ¶ 

func (f PutScript) WithFilterPath(v ...string) func(*PutScriptRequest)

WithFilterPath filters the properties of the response body.

func (PutScript) WithHeader ¶ 

func (f PutScript) WithHeader(h map[string]string) func(*PutScriptRequest)

WithHeader adds the headers to the HTTP request.

func (PutScript) WithHuman ¶ 

func (f PutScript) WithHuman() func(*PutScriptRequest)

WithHuman makes statistical values human-readable.

func (PutScript) WithMasterTimeout ¶ 

func (f PutScript) WithMasterTimeout(v time.Duration) func(*PutScriptRequest)

WithMasterTimeout - specify timeout for connection to master.

func (PutScript) WithOpaqueID ¶ 

func (f PutScript) WithOpaqueID(s string) func(*PutScriptRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (PutScript) WithPretty ¶ 

func (f PutScript) WithPretty() func(*PutScriptRequest)

WithPretty makes the response body pretty-printed.

func (PutScript) WithScriptContext ¶ 

func (f PutScript) WithScriptContext(v string) func(*PutScriptRequest)

WithScriptContext - script context.

func (PutScript) WithTimeout ¶ 

func (f PutScript) WithTimeout(v time.Duration) func(*PutScriptRequest)

WithTimeout - explicit operation timeout.

type PutScriptRequest ¶ 

type PutScriptRequest struct {
	ScriptID string

	Body io.Reader

	ScriptContext string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

PutScriptRequest configures the Put Script API request.

func (PutScriptRequest) Do ¶ 

func (r PutScriptRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type QueryRulesDeleteRule ¶ added in v8.15.0 

type QueryRulesDeleteRule func(rule_id string, ruleset_id string, o ...func(*QueryRulesDeleteRuleRequest)) (*Response, error)

QueryRulesDeleteRule deletes an individual query rule within a ruleset.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-rule.html.

func (QueryRulesDeleteRule) WithContext ¶ added in v8.15.0 

func (f QueryRulesDeleteRule) WithContext(v context.Context) func(*QueryRulesDeleteRuleRequest)

WithContext sets the request context.

func (QueryRulesDeleteRule) WithErrorTrace ¶ added in v8.15.0 

func (f QueryRulesDeleteRule) WithErrorTrace() func(*QueryRulesDeleteRuleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (QueryRulesDeleteRule) WithFilterPath ¶ added in v8.15.0 

func (f QueryRulesDeleteRule) WithFilterPath(v ...string) func(*QueryRulesDeleteRuleRequest)

WithFilterPath filters the properties of the response body.

func (QueryRulesDeleteRule) WithHeader ¶ added in v8.15.0 

func (f QueryRulesDeleteRule) WithHeader(h map[string]string) func(*QueryRulesDeleteRuleRequest)

WithHeader adds the headers to the HTTP request.

func (QueryRulesDeleteRule) WithHuman ¶ added in v8.15.0 

func (f QueryRulesDeleteRule) WithHuman() func(*QueryRulesDeleteRuleRequest)

WithHuman makes statistical values human-readable.

func (QueryRulesDeleteRule) WithOpaqueID ¶ added in v8.15.0 

func (f QueryRulesDeleteRule) WithOpaqueID(s string) func(*QueryRulesDeleteRuleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (QueryRulesDeleteRule) WithPretty ¶ added in v8.15.0 

func (f QueryRulesDeleteRule) WithPretty() func(*QueryRulesDeleteRuleRequest)

WithPretty makes the response body pretty-printed.

type QueryRulesDeleteRuleRequest ¶ added in v8.15.0 

type QueryRulesDeleteRuleRequest struct {
	RuleID    string
	RulesetID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

QueryRulesDeleteRuleRequest configures the Query Rules Delete Rule API request.

func (QueryRulesDeleteRuleRequest) Do ¶ added in v8.15.0 

func (r QueryRulesDeleteRuleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type QueryRulesDeleteRuleset ¶ added in v8.15.0 

type QueryRulesDeleteRuleset func(ruleset_id string, o ...func(*QueryRulesDeleteRulesetRequest)) (*Response, error)

QueryRulesDeleteRuleset deletes a query ruleset.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-ruleset.html.

func (QueryRulesDeleteRuleset) WithContext ¶ added in v8.15.0 

func (f QueryRulesDeleteRuleset) WithContext(v context.Context) func(*QueryRulesDeleteRulesetRequest)

WithContext sets the request context.

func (QueryRulesDeleteRuleset) WithErrorTrace ¶ added in v8.15.0 

func (f QueryRulesDeleteRuleset) WithErrorTrace() func(*QueryRulesDeleteRulesetRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (QueryRulesDeleteRuleset) WithFilterPath ¶ added in v8.15.0 

func (f QueryRulesDeleteRuleset) WithFilterPath(v ...string) func(*QueryRulesDeleteRulesetRequest)

WithFilterPath filters the properties of the response body.

func (QueryRulesDeleteRuleset) WithHeader ¶ added in v8.15.0 

func (f QueryRulesDeleteRuleset) WithHeader(h map[string]string) func(*QueryRulesDeleteRulesetRequest)

WithHeader adds the headers to the HTTP request.

func (QueryRulesDeleteRuleset) WithHuman ¶ added in v8.15.0 

func (f QueryRulesDeleteRuleset) WithHuman() func(*QueryRulesDeleteRulesetRequest)

WithHuman makes statistical values human-readable.

func (QueryRulesDeleteRuleset) WithOpaqueID ¶ added in v8.15.0 

func (f QueryRulesDeleteRuleset) WithOpaqueID(s string) func(*QueryRulesDeleteRulesetRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (QueryRulesDeleteRuleset) WithPretty ¶ added in v8.15.0 

func (f QueryRulesDeleteRuleset) WithPretty() func(*QueryRulesDeleteRulesetRequest)

WithPretty makes the response body pretty-printed.

type QueryRulesDeleteRulesetRequest ¶ added in v8.15.0 

type QueryRulesDeleteRulesetRequest struct {
	RulesetID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

QueryRulesDeleteRulesetRequest configures the Query Rules Delete Ruleset API request.

func (QueryRulesDeleteRulesetRequest) Do ¶ added in v8.15.0 

func (r QueryRulesDeleteRulesetRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type QueryRulesGetRule ¶ added in v8.15.0 

type QueryRulesGetRule func(rule_id string, ruleset_id string, o ...func(*QueryRulesGetRuleRequest)) (*Response, error)

QueryRulesGetRule returns the details about an individual query rule within a ruleset.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-rule.html.

func (QueryRulesGetRule) WithContext ¶ added in v8.15.0 

func (f QueryRulesGetRule) WithContext(v context.Context) func(*QueryRulesGetRuleRequest)

WithContext sets the request context.

func (QueryRulesGetRule) WithErrorTrace ¶ added in v8.15.0 

func (f QueryRulesGetRule) WithErrorTrace() func(*QueryRulesGetRuleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (QueryRulesGetRule) WithFilterPath ¶ added in v8.15.0 

func (f QueryRulesGetRule) WithFilterPath(v ...string) func(*QueryRulesGetRuleRequest)

WithFilterPath filters the properties of the response body.

func (QueryRulesGetRule) WithHeader ¶ added in v8.15.0 

func (f QueryRulesGetRule) WithHeader(h map[string]string) func(*QueryRulesGetRuleRequest)

WithHeader adds the headers to the HTTP request.

func (QueryRulesGetRule) WithHuman ¶ added in v8.15.0 

func (f QueryRulesGetRule) WithHuman() func(*QueryRulesGetRuleRequest)

WithHuman makes statistical values human-readable.

func (QueryRulesGetRule) WithOpaqueID ¶ added in v8.15.0 

func (f QueryRulesGetRule) WithOpaqueID(s string) func(*QueryRulesGetRuleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (QueryRulesGetRule) WithPretty ¶ added in v8.15.0 

func (f QueryRulesGetRule) WithPretty() func(*QueryRulesGetRuleRequest)

WithPretty makes the response body pretty-printed.

type QueryRulesGetRuleRequest ¶ added in v8.15.0 

type QueryRulesGetRuleRequest struct {
	RuleID    string
	RulesetID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

QueryRulesGetRuleRequest configures the Query Rules Get Rule API request.

func (QueryRulesGetRuleRequest) Do ¶ added in v8.15.0 

func (r QueryRulesGetRuleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type QueryRulesGetRuleset ¶ added in v8.15.0 

type QueryRulesGetRuleset func(ruleset_id string, o ...func(*QueryRulesGetRulesetRequest)) (*Response, error)

QueryRulesGetRuleset returns the details about a query ruleset.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-ruleset.html.

func (QueryRulesGetRuleset) WithContext ¶ added in v8.15.0 

func (f QueryRulesGetRuleset) WithContext(v context.Context) func(*QueryRulesGetRulesetRequest)

WithContext sets the request context.

func (QueryRulesGetRuleset) WithErrorTrace ¶ added in v8.15.0 

func (f QueryRulesGetRuleset) WithErrorTrace() func(*QueryRulesGetRulesetRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (QueryRulesGetRuleset) WithFilterPath ¶ added in v8.15.0 

func (f QueryRulesGetRuleset) WithFilterPath(v ...string) func(*QueryRulesGetRulesetRequest)

WithFilterPath filters the properties of the response body.

func (QueryRulesGetRuleset) WithHeader ¶ added in v8.15.0 

func (f QueryRulesGetRuleset) WithHeader(h map[string]string) func(*QueryRulesGetRulesetRequest)

WithHeader adds the headers to the HTTP request.

func (QueryRulesGetRuleset) WithHuman ¶ added in v8.15.0 

func (f QueryRulesGetRuleset) WithHuman() func(*QueryRulesGetRulesetRequest)

WithHuman makes statistical values human-readable.

func (QueryRulesGetRuleset) WithOpaqueID ¶ added in v8.15.0 

func (f QueryRulesGetRuleset) WithOpaqueID(s string) func(*QueryRulesGetRulesetRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (QueryRulesGetRuleset) WithPretty ¶ added in v8.15.0 

func (f QueryRulesGetRuleset) WithPretty() func(*QueryRulesGetRulesetRequest)

WithPretty makes the response body pretty-printed.

type QueryRulesGetRulesetRequest ¶ added in v8.15.0 

type QueryRulesGetRulesetRequest struct {
	RulesetID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

QueryRulesGetRulesetRequest configures the Query Rules Get Ruleset API request.

func (QueryRulesGetRulesetRequest) Do ¶ added in v8.15.0 

func (r QueryRulesGetRulesetRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type QueryRulesListRulesets ¶ added in v8.15.0 

type QueryRulesListRulesets func(o ...func(*QueryRulesListRulesetsRequest)) (*Response, error)

QueryRulesListRulesets lists query rulesets.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/list-query-rulesets.html.

func (QueryRulesListRulesets) WithContext ¶ added in v8.15.0 

func (f QueryRulesListRulesets) WithContext(v context.Context) func(*QueryRulesListRulesetsRequest)

WithContext sets the request context.

func (QueryRulesListRulesets) WithErrorTrace ¶ added in v8.15.0 

func (f QueryRulesListRulesets) WithErrorTrace() func(*QueryRulesListRulesetsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (QueryRulesListRulesets) WithFilterPath ¶ added in v8.15.0 

func (f QueryRulesListRulesets) WithFilterPath(v ...string) func(*QueryRulesListRulesetsRequest)

WithFilterPath filters the properties of the response body.

func (QueryRulesListRulesets) WithFrom ¶ added in v8.15.0 

func (f QueryRulesListRulesets) WithFrom(v int) func(*QueryRulesListRulesetsRequest)

WithFrom - starting offset (default: 0).

func (QueryRulesListRulesets) WithHeader ¶ added in v8.15.0 

func (f QueryRulesListRulesets) WithHeader(h map[string]string) func(*QueryRulesListRulesetsRequest)

WithHeader adds the headers to the HTTP request.

func (QueryRulesListRulesets) WithHuman ¶ added in v8.15.0 

func (f QueryRulesListRulesets) WithHuman() func(*QueryRulesListRulesetsRequest)

WithHuman makes statistical values human-readable.

func (QueryRulesListRulesets) WithOpaqueID ¶ added in v8.15.0 

func (f QueryRulesListRulesets) WithOpaqueID(s string) func(*QueryRulesListRulesetsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (QueryRulesListRulesets) WithPretty ¶ added in v8.15.0 

func (f QueryRulesListRulesets) WithPretty() func(*QueryRulesListRulesetsRequest)

WithPretty makes the response body pretty-printed.

func (QueryRulesListRulesets) WithSize ¶ added in v8.15.0 

func (f QueryRulesListRulesets) WithSize(v int) func(*QueryRulesListRulesetsRequest)

WithSize - specifies a max number of results to get (default: 100).

type QueryRulesListRulesetsRequest ¶ added in v8.15.0 

type QueryRulesListRulesetsRequest struct {
	From *int
	Size *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

QueryRulesListRulesetsRequest configures the Query Rules List Rulesets API request.

func (QueryRulesListRulesetsRequest) Do ¶ added in v8.15.0 

func (r QueryRulesListRulesetsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type QueryRulesPutRule ¶ added in v8.15.0 

type QueryRulesPutRule func(body io.Reader, rule_id string, ruleset_id string, o ...func(*QueryRulesPutRuleRequest)) (*Response, error)

QueryRulesPutRule creates or updates a query rule within a ruleset.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-rule.html.

func (QueryRulesPutRule) WithContext ¶ added in v8.15.0 

func (f QueryRulesPutRule) WithContext(v context.Context) func(*QueryRulesPutRuleRequest)

WithContext sets the request context.

func (QueryRulesPutRule) WithErrorTrace ¶ added in v8.15.0 

func (f QueryRulesPutRule) WithErrorTrace() func(*QueryRulesPutRuleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (QueryRulesPutRule) WithFilterPath ¶ added in v8.15.0 

func (f QueryRulesPutRule) WithFilterPath(v ...string) func(*QueryRulesPutRuleRequest)

WithFilterPath filters the properties of the response body.

func (QueryRulesPutRule) WithHeader ¶ added in v8.15.0 

func (f QueryRulesPutRule) WithHeader(h map[string]string) func(*QueryRulesPutRuleRequest)

WithHeader adds the headers to the HTTP request.

func (QueryRulesPutRule) WithHuman ¶ added in v8.15.0 

func (f QueryRulesPutRule) WithHuman() func(*QueryRulesPutRuleRequest)

WithHuman makes statistical values human-readable.

func (QueryRulesPutRule) WithOpaqueID ¶ added in v8.15.0 

func (f QueryRulesPutRule) WithOpaqueID(s string) func(*QueryRulesPutRuleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (QueryRulesPutRule) WithPretty ¶ added in v8.15.0 

func (f QueryRulesPutRule) WithPretty() func(*QueryRulesPutRuleRequest)

WithPretty makes the response body pretty-printed.

type QueryRulesPutRuleRequest ¶ added in v8.15.0 

type QueryRulesPutRuleRequest struct {
	Body io.Reader

	RuleID    string
	RulesetID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

QueryRulesPutRuleRequest configures the Query Rules Put Rule API request.

func (QueryRulesPutRuleRequest) Do ¶ added in v8.15.0 

func (r QueryRulesPutRuleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type QueryRulesPutRuleset ¶ added in v8.15.0 

type QueryRulesPutRuleset func(body io.Reader, ruleset_id string, o ...func(*QueryRulesPutRulesetRequest)) (*Response, error)

QueryRulesPutRuleset creates or updates a query ruleset.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-ruleset.html.

func (QueryRulesPutRuleset) WithContext ¶ added in v8.15.0 

func (f QueryRulesPutRuleset) WithContext(v context.Context) func(*QueryRulesPutRulesetRequest)

WithContext sets the request context.

func (QueryRulesPutRuleset) WithErrorTrace ¶ added in v8.15.0 

func (f QueryRulesPutRuleset) WithErrorTrace() func(*QueryRulesPutRulesetRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (QueryRulesPutRuleset) WithFilterPath ¶ added in v8.15.0 

func (f QueryRulesPutRuleset) WithFilterPath(v ...string) func(*QueryRulesPutRulesetRequest)

WithFilterPath filters the properties of the response body.

func (QueryRulesPutRuleset) WithHeader ¶ added in v8.15.0 

func (f QueryRulesPutRuleset) WithHeader(h map[string]string) func(*QueryRulesPutRulesetRequest)

WithHeader adds the headers to the HTTP request.

func (QueryRulesPutRuleset) WithHuman ¶ added in v8.15.0 

func (f QueryRulesPutRuleset) WithHuman() func(*QueryRulesPutRulesetRequest)

WithHuman makes statistical values human-readable.

func (QueryRulesPutRuleset) WithOpaqueID ¶ added in v8.15.0 

func (f QueryRulesPutRuleset) WithOpaqueID(s string) func(*QueryRulesPutRulesetRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (QueryRulesPutRuleset) WithPretty ¶ added in v8.15.0 

func (f QueryRulesPutRuleset) WithPretty() func(*QueryRulesPutRulesetRequest)

WithPretty makes the response body pretty-printed.

type QueryRulesPutRulesetRequest ¶ added in v8.15.0 

type QueryRulesPutRulesetRequest struct {
	Body io.Reader

	RulesetID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

QueryRulesPutRulesetRequest configures the Query Rules Put Ruleset API request.

func (QueryRulesPutRulesetRequest) Do ¶ added in v8.15.0 

func (r QueryRulesPutRulesetRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type QueryRulesTest ¶ added in v8.16.0 

type QueryRulesTest func(body io.Reader, ruleset_id string, o ...func(*QueryRulesTestRequest)) (*Response, error)

QueryRulesTest tests a query ruleset to identify the rules that would match input criteria

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/test-query-ruleset.html.

func (QueryRulesTest) WithContext ¶ added in v8.16.0 

func (f QueryRulesTest) WithContext(v context.Context) func(*QueryRulesTestRequest)

WithContext sets the request context.

func (QueryRulesTest) WithErrorTrace ¶ added in v8.16.0 

func (f QueryRulesTest) WithErrorTrace() func(*QueryRulesTestRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (QueryRulesTest) WithFilterPath ¶ added in v8.16.0 

func (f QueryRulesTest) WithFilterPath(v ...string) func(*QueryRulesTestRequest)

WithFilterPath filters the properties of the response body.

func (QueryRulesTest) WithHeader ¶ added in v8.16.0 

func (f QueryRulesTest) WithHeader(h map[string]string) func(*QueryRulesTestRequest)

WithHeader adds the headers to the HTTP request.

func (QueryRulesTest) WithHuman ¶ added in v8.16.0 

func (f QueryRulesTest) WithHuman() func(*QueryRulesTestRequest)

WithHuman makes statistical values human-readable.

func (QueryRulesTest) WithOpaqueID ¶ added in v8.16.0 

func (f QueryRulesTest) WithOpaqueID(s string) func(*QueryRulesTestRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (QueryRulesTest) WithPretty ¶ added in v8.16.0 

func (f QueryRulesTest) WithPretty() func(*QueryRulesTestRequest)

WithPretty makes the response body pretty-printed.

type QueryRulesTestRequest ¶ added in v8.16.0 

type QueryRulesTestRequest struct {
	Body io.Reader

	RulesetID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

QueryRulesTestRequest configures the Query Rules Test API request.

func (QueryRulesTestRequest) Do ¶ added in v8.16.0 

func (r QueryRulesTestRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type RankEval ¶ 

type RankEval func(body io.Reader, o ...func(*RankEvalRequest)) (*Response, error)

RankEval allows to evaluate the quality of ranked search results over a set of typical search queries

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html.

func (RankEval) WithAllowNoIndices ¶ 

func (f RankEval) WithAllowNoIndices(v bool) func(*RankEvalRequest)

WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).

func (RankEval) WithContext ¶ 

func (f RankEval) WithContext(v context.Context) func(*RankEvalRequest)

WithContext sets the request context.

func (RankEval) WithErrorTrace ¶ 

func (f RankEval) WithErrorTrace() func(*RankEvalRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (RankEval) WithExpandWildcards ¶ 

func (f RankEval) WithExpandWildcards(v string) func(*RankEvalRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (RankEval) WithFilterPath ¶ 

func (f RankEval) WithFilterPath(v ...string) func(*RankEvalRequest)

WithFilterPath filters the properties of the response body.

func (RankEval) WithHeader ¶ 

func (f RankEval) WithHeader(h map[string]string) func(*RankEvalRequest)

WithHeader adds the headers to the HTTP request.

func (RankEval) WithHuman ¶ 

func (f RankEval) WithHuman() func(*RankEvalRequest)

WithHuman makes statistical values human-readable.

func (RankEval) WithIgnoreUnavailable ¶ 

func (f RankEval) WithIgnoreUnavailable(v bool) func(*RankEvalRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (RankEval) WithIndex ¶ 

func (f RankEval) WithIndex(v ...string) func(*RankEvalRequest)

WithIndex - a list of index names to search; use _all to perform the operation on all indices.

func (RankEval) WithOpaqueID ¶ 

func (f RankEval) WithOpaqueID(s string) func(*RankEvalRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (RankEval) WithPretty ¶ 

func (f RankEval) WithPretty() func(*RankEvalRequest)

WithPretty makes the response body pretty-printed.

func (RankEval) WithSearchType ¶ 

func (f RankEval) WithSearchType(v string) func(*RankEvalRequest)

WithSearchType - search operation type.

type RankEvalRequest ¶ 

type RankEvalRequest struct {
	Index []string

	Body io.Reader

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *bool
	SearchType        string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

RankEvalRequest configures the Rank Eval API request.

func (RankEvalRequest) Do ¶ 

func (r RankEvalRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Reindex ¶ 

type Reindex func(body io.Reader, o ...func(*ReindexRequest)) (*Response, error)

Reindex allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html.

func (Reindex) WithContext ¶ 

func (f Reindex) WithContext(v context.Context) func(*ReindexRequest)

WithContext sets the request context.

func (Reindex) WithErrorTrace ¶ 

func (f Reindex) WithErrorTrace() func(*ReindexRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Reindex) WithFilterPath ¶ 

func (f Reindex) WithFilterPath(v ...string) func(*ReindexRequest)

WithFilterPath filters the properties of the response body.

func (Reindex) WithHeader ¶ 

func (f Reindex) WithHeader(h map[string]string) func(*ReindexRequest)

WithHeader adds the headers to the HTTP request.

func (Reindex) WithHuman ¶ 

func (f Reindex) WithHuman() func(*ReindexRequest)

WithHuman makes statistical values human-readable.

func (Reindex) WithMaxDocs ¶ 

func (f Reindex) WithMaxDocs(v int) func(*ReindexRequest)

WithMaxDocs - maximum number of documents to process (default: all documents).

func (Reindex) WithOpaqueID ¶ 

func (f Reindex) WithOpaqueID(s string) func(*ReindexRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Reindex) WithPretty ¶ 

func (f Reindex) WithPretty() func(*ReindexRequest)

WithPretty makes the response body pretty-printed.

func (Reindex) WithRefresh ¶ 

func (f Reindex) WithRefresh(v bool) func(*ReindexRequest)

WithRefresh - should the affected indexes be refreshed?.

func (Reindex) WithRequestsPerSecond ¶ 

func (f Reindex) WithRequestsPerSecond(v int) func(*ReindexRequest)

WithRequestsPerSecond - the throttle to set on this request in sub-requests per second. -1 means no throttle..

func (Reindex) WithScroll ¶ 

func (f Reindex) WithScroll(v time.Duration) func(*ReindexRequest)

WithScroll - control how long to keep the search context alive.

func (Reindex) WithSlices ¶ 

func (f Reindex) WithSlices(v interface{}) func(*ReindexRequest)

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 (Reindex) WithTimeout ¶ 

func (f Reindex) WithTimeout(v time.Duration) func(*ReindexRequest)

WithTimeout - time each individual bulk request should wait for shards that are unavailable..

func (Reindex) WithWaitForActiveShards ¶ 

func (f Reindex) WithWaitForActiveShards(v string) func(*ReindexRequest)

WithWaitForActiveShards - sets the number of shard copies that must be active before proceeding with the reindex operation. defaults to 1, meaning the primary shard only. set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).

func (Reindex) WithWaitForCompletion ¶ 

func (f Reindex) WithWaitForCompletion(v bool) func(*ReindexRequest)

WithWaitForCompletion - should the request should block until the reindex is complete..

type ReindexRequest ¶ 

type ReindexRequest struct {
	Body io.Reader

	MaxDocs             *int
	Refresh             *bool
	RequestsPerSecond   *int
	Scroll              time.Duration
	Slices              interface{}
	Timeout             time.Duration
	WaitForActiveShards string
	WaitForCompletion   *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ReindexRequest configures the Reindex API request.

func (ReindexRequest) Do ¶ 

func (r ReindexRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ReindexRethrottle ¶ 

type ReindexRethrottle func(task_id string, requests_per_second *int, o ...func(*ReindexRethrottleRequest)) (*Response, error)

ReindexRethrottle changes the number of requests per second for a particular Reindex operation.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html.

func (ReindexRethrottle) WithContext ¶ 

func (f ReindexRethrottle) WithContext(v context.Context) func(*ReindexRethrottleRequest)

WithContext sets the request context.

func (ReindexRethrottle) WithErrorTrace ¶ 

func (f ReindexRethrottle) WithErrorTrace() func(*ReindexRethrottleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ReindexRethrottle) WithFilterPath ¶ 

func (f ReindexRethrottle) WithFilterPath(v ...string) func(*ReindexRethrottleRequest)

WithFilterPath filters the properties of the response body.

func (ReindexRethrottle) WithHeader ¶ 

func (f ReindexRethrottle) WithHeader(h map[string]string) func(*ReindexRethrottleRequest)

WithHeader adds the headers to the HTTP request.

func (ReindexRethrottle) WithHuman ¶ 

func (f ReindexRethrottle) WithHuman() func(*ReindexRethrottleRequest)

WithHuman makes statistical values human-readable.

func (ReindexRethrottle) WithOpaqueID ¶ 

func (f ReindexRethrottle) WithOpaqueID(s string) func(*ReindexRethrottleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ReindexRethrottle) WithPretty ¶ 

func (f ReindexRethrottle) WithPretty() func(*ReindexRethrottleRequest)

WithPretty makes the response body pretty-printed.

func (ReindexRethrottle) WithRequestsPerSecond ¶ 

func (f ReindexRethrottle) WithRequestsPerSecond(v int) func(*ReindexRethrottleRequest)

WithRequestsPerSecond - the throttle to set on this request in floating sub-requests per second. -1 means set no throttle..

type ReindexRethrottleRequest ¶ 

type ReindexRethrottleRequest struct {
	TaskID string

	RequestsPerSecond *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ReindexRethrottleRequest configures the Reindex Rethrottle API request.

func (ReindexRethrottleRequest) Do ¶ 

func (r ReindexRethrottleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Remote ¶ 

type Remote struct {
}

Remote contains the Remote APIs

type RenderSearchTemplate ¶ 

type RenderSearchTemplate func(o ...func(*RenderSearchTemplateRequest)) (*Response, error)

RenderSearchTemplate allows to use the Mustache language to pre-render a search definition.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html.

func (RenderSearchTemplate) WithBody ¶ 

func (f RenderSearchTemplate) WithBody(v io.Reader) func(*RenderSearchTemplateRequest)

WithBody - The search definition template and its params.

func (RenderSearchTemplate) WithContext ¶ 

func (f RenderSearchTemplate) WithContext(v context.Context) func(*RenderSearchTemplateRequest)

WithContext sets the request context.

func (RenderSearchTemplate) WithErrorTrace ¶ 

func (f RenderSearchTemplate) WithErrorTrace() func(*RenderSearchTemplateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (RenderSearchTemplate) WithFilterPath ¶ 

func (f RenderSearchTemplate) WithFilterPath(v ...string) func(*RenderSearchTemplateRequest)

WithFilterPath filters the properties of the response body.

func (RenderSearchTemplate) WithHeader ¶ 

func (f RenderSearchTemplate) WithHeader(h map[string]string) func(*RenderSearchTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (RenderSearchTemplate) WithHuman ¶ 

func (f RenderSearchTemplate) WithHuman() func(*RenderSearchTemplateRequest)

WithHuman makes statistical values human-readable.

func (RenderSearchTemplate) WithOpaqueID ¶ 

func (f RenderSearchTemplate) WithOpaqueID(s string) func(*RenderSearchTemplateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (RenderSearchTemplate) WithPretty ¶ 

func (f RenderSearchTemplate) WithPretty() func(*RenderSearchTemplateRequest)

WithPretty makes the response body pretty-printed.

func (RenderSearchTemplate) WithTemplateID ¶ 

func (f RenderSearchTemplate) WithTemplateID(v string) func(*RenderSearchTemplateRequest)

WithTemplateID - the ID of the stored search template.

type RenderSearchTemplateRequest ¶ 

type RenderSearchTemplateRequest struct {
	TemplateID string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

RenderSearchTemplateRequest configures the Render Search Template API request.

func (RenderSearchTemplateRequest) Do ¶ 

func (r RenderSearchTemplateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Request ¶ 

type Request interface {
	Do(ctx context.Context, transport Transport) (*Response, error)
}

Request defines the API request.

type Response ¶ 

type Response struct {
	StatusCode int
	Header     http.Header
	Body       io.ReadCloser
}

Response represents the API response.

func (*Response) HasWarnings ¶ 

func (r *Response) HasWarnings() bool

HasWarnings returns true when the response headers contain deprecation warnings.

func (*Response) IsError ¶ 

func (r *Response) IsError() bool

IsError returns true when the response status indicates failure.

Example ¶ 
es, _ := elasticsearch.NewDefaultClient()

res, err := es.Info()

// Handle connection errors
//
if err != nil {
	log.Fatalf("ERROR: %v", err)
}
defer res.Body.Close()

// Handle error response (3xx, 4xx, 5xx)
//
if res.IsError() {
	log.Fatalf("ERROR: %s", res.Status())
}

// Handle successful response (2xx)
//
log.Println(res)

func (*Response) Status ¶ 

func (r *Response) Status() string

Status returns the response status as a string.

Example ¶ 
es, _ := elasticsearch.NewDefaultClient()

res, _ := es.Info()
log.Println(res.Status())

// 200 OK

func (*Response) String ¶ 

func (r *Response) String() string

String returns the response as a string.

The intended usage is for testing or debugging only.

Example ¶ 
es, _ := elasticsearch.NewDefaultClient()

res, _ := es.Info()
log.Println(res.String())

// [200 OK] {
// "name" : "es1",
// "cluster_name" : "go-elasticsearch",
// ...
// }

func (*Response) Warnings ¶ 

func (r *Response) Warnings() []string

Warnings returns the deprecation warnings from response headers.

type Rollup ¶ 

type Rollup struct {
	DeleteJob    RollupDeleteJob
	GetJobs      RollupGetJobs
	GetCaps      RollupGetRollupCaps
	GetIndexCaps RollupGetRollupIndexCaps
	PutJob       RollupPutJob
	Search       RollupRollupSearch
	StartJob     RollupStartJob
	StopJob      RollupStopJob
}

Rollup contains the Rollup APIs

type RollupDeleteJob ¶ 

type RollupDeleteJob func(id string, o ...func(*RollupDeleteJobRequest)) (*Response, error)

RollupDeleteJob - Deletes an existing rollup job.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-delete-job.html.

func (RollupDeleteJob) WithContext ¶ 

func (f RollupDeleteJob) WithContext(v context.Context) func(*RollupDeleteJobRequest)

WithContext sets the request context.

func (RollupDeleteJob) WithErrorTrace ¶ 

func (f RollupDeleteJob) WithErrorTrace() func(*RollupDeleteJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (RollupDeleteJob) WithFilterPath ¶ 

func (f RollupDeleteJob) WithFilterPath(v ...string) func(*RollupDeleteJobRequest)

WithFilterPath filters the properties of the response body.

func (RollupDeleteJob) WithHeader ¶ 

func (f RollupDeleteJob) WithHeader(h map[string]string) func(*RollupDeleteJobRequest)

WithHeader adds the headers to the HTTP request.

func (RollupDeleteJob) WithHuman ¶ 

func (f RollupDeleteJob) WithHuman() func(*RollupDeleteJobRequest)

WithHuman makes statistical values human-readable.

func (RollupDeleteJob) WithOpaqueID ¶ 

func (f RollupDeleteJob) WithOpaqueID(s string) func(*RollupDeleteJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (RollupDeleteJob) WithPretty ¶ 

func (f RollupDeleteJob) WithPretty() func(*RollupDeleteJobRequest)

WithPretty makes the response body pretty-printed.

type RollupDeleteJobRequest ¶ 

type RollupDeleteJobRequest struct {
	JobID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

RollupDeleteJobRequest configures the Rollup Delete Job API request.

func (RollupDeleteJobRequest) Do ¶ 

func (r RollupDeleteJobRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type RollupGetJobs ¶ 

type RollupGetJobs func(o ...func(*RollupGetJobsRequest)) (*Response, error)

RollupGetJobs - Retrieves the configuration, stats, and status of rollup jobs.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-job.html.

func (RollupGetJobs) WithContext ¶ 

func (f RollupGetJobs) WithContext(v context.Context) func(*RollupGetJobsRequest)

WithContext sets the request context.

func (RollupGetJobs) WithErrorTrace ¶ 

func (f RollupGetJobs) WithErrorTrace() func(*RollupGetJobsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (RollupGetJobs) WithFilterPath ¶ 

func (f RollupGetJobs) WithFilterPath(v ...string) func(*RollupGetJobsRequest)

WithFilterPath filters the properties of the response body.

func (RollupGetJobs) WithHeader ¶ 

func (f RollupGetJobs) WithHeader(h map[string]string) func(*RollupGetJobsRequest)

WithHeader adds the headers to the HTTP request.

func (RollupGetJobs) WithHuman ¶ 

func (f RollupGetJobs) WithHuman() func(*RollupGetJobsRequest)

WithHuman makes statistical values human-readable.

func (RollupGetJobs) WithJobID ¶ 

func (f RollupGetJobs) WithJobID(v string) func(*RollupGetJobsRequest)

WithJobID - the ID of the job(s) to fetch. accepts glob patterns, or left blank for all jobs.

func (RollupGetJobs) WithOpaqueID ¶ 

func (f RollupGetJobs) WithOpaqueID(s string) func(*RollupGetJobsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (RollupGetJobs) WithPretty ¶ 

func (f RollupGetJobs) WithPretty() func(*RollupGetJobsRequest)

WithPretty makes the response body pretty-printed.

type RollupGetJobsRequest ¶ 

type RollupGetJobsRequest struct {
	JobID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

RollupGetJobsRequest configures the Rollup Get Jobs API request.

func (RollupGetJobsRequest) Do ¶ 

func (r RollupGetJobsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type RollupGetRollupCaps ¶ 

type RollupGetRollupCaps func(o ...func(*RollupGetRollupCapsRequest)) (*Response, error)

RollupGetRollupCaps - Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-caps.html.

func (RollupGetRollupCaps) WithContext ¶ 

func (f RollupGetRollupCaps) WithContext(v context.Context) func(*RollupGetRollupCapsRequest)

WithContext sets the request context.

func (RollupGetRollupCaps) WithErrorTrace ¶ 

func (f RollupGetRollupCaps) WithErrorTrace() func(*RollupGetRollupCapsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (RollupGetRollupCaps) WithFilterPath ¶ 

func (f RollupGetRollupCaps) WithFilterPath(v ...string) func(*RollupGetRollupCapsRequest)

WithFilterPath filters the properties of the response body.

func (RollupGetRollupCaps) WithHeader ¶ 

func (f RollupGetRollupCaps) WithHeader(h map[string]string) func(*RollupGetRollupCapsRequest)

WithHeader adds the headers to the HTTP request.

func (RollupGetRollupCaps) WithHuman ¶ 

func (f RollupGetRollupCaps) WithHuman() func(*RollupGetRollupCapsRequest)

WithHuman makes statistical values human-readable.

func (RollupGetRollupCaps) WithIndex ¶ 

func (f RollupGetRollupCaps) WithIndex(v string) func(*RollupGetRollupCapsRequest)

WithIndex - the ID of the index to check rollup capabilities on, or left blank for all jobs.

func (RollupGetRollupCaps) WithOpaqueID ¶ 

func (f RollupGetRollupCaps) WithOpaqueID(s string) func(*RollupGetRollupCapsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (RollupGetRollupCaps) WithPretty ¶ 

func (f RollupGetRollupCaps) WithPretty() func(*RollupGetRollupCapsRequest)

WithPretty makes the response body pretty-printed.

type RollupGetRollupCapsRequest ¶ 

type RollupGetRollupCapsRequest struct {
	Index string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

RollupGetRollupCapsRequest configures the Rollup Get Rollup Caps API request.

func (RollupGetRollupCapsRequest) Do ¶ 

func (r RollupGetRollupCapsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type RollupGetRollupIndexCaps ¶ 

type RollupGetRollupIndexCaps func(index string, o ...func(*RollupGetRollupIndexCapsRequest)) (*Response, error)

RollupGetRollupIndexCaps - Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored).

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-index-caps.html.

func (RollupGetRollupIndexCaps) WithContext ¶ 

func (f RollupGetRollupIndexCaps) WithContext(v context.Context) func(*RollupGetRollupIndexCapsRequest)

WithContext sets the request context.

func (RollupGetRollupIndexCaps) WithErrorTrace ¶ 

func (f RollupGetRollupIndexCaps) WithErrorTrace() func(*RollupGetRollupIndexCapsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (RollupGetRollupIndexCaps) WithFilterPath ¶ 

func (f RollupGetRollupIndexCaps) WithFilterPath(v ...string) func(*RollupGetRollupIndexCapsRequest)

WithFilterPath filters the properties of the response body.

func (RollupGetRollupIndexCaps) WithHeader ¶ 

func (f RollupGetRollupIndexCaps) WithHeader(h map[string]string) func(*RollupGetRollupIndexCapsRequest)

WithHeader adds the headers to the HTTP request.

func (RollupGetRollupIndexCaps) WithHuman ¶ 

func (f RollupGetRollupIndexCaps) WithHuman() func(*RollupGetRollupIndexCapsRequest)

WithHuman makes statistical values human-readable.

func (RollupGetRollupIndexCaps) WithOpaqueID ¶ 

func (f RollupGetRollupIndexCaps) WithOpaqueID(s string) func(*RollupGetRollupIndexCapsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (RollupGetRollupIndexCaps) WithPretty ¶ 

func (f RollupGetRollupIndexCaps) WithPretty() func(*RollupGetRollupIndexCapsRequest)

WithPretty makes the response body pretty-printed.

type RollupGetRollupIndexCapsRequest ¶ 

type RollupGetRollupIndexCapsRequest struct {
	Index string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

RollupGetRollupIndexCapsRequest configures the Rollup Get Rollup Index Caps API request.

func (RollupGetRollupIndexCapsRequest) Do ¶ 

func (r RollupGetRollupIndexCapsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type RollupPutJob ¶ 

type RollupPutJob func(id string, body io.Reader, o ...func(*RollupPutJobRequest)) (*Response, error)

RollupPutJob - Creates a rollup job.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-put-job.html.

func (RollupPutJob) WithContext ¶ 

func (f RollupPutJob) WithContext(v context.Context) func(*RollupPutJobRequest)

WithContext sets the request context.

func (RollupPutJob) WithErrorTrace ¶ 

func (f RollupPutJob) WithErrorTrace() func(*RollupPutJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (RollupPutJob) WithFilterPath ¶ 

func (f RollupPutJob) WithFilterPath(v ...string) func(*RollupPutJobRequest)

WithFilterPath filters the properties of the response body.

func (RollupPutJob) WithHeader ¶ 

func (f RollupPutJob) WithHeader(h map[string]string) func(*RollupPutJobRequest)

WithHeader adds the headers to the HTTP request.

func (RollupPutJob) WithHuman ¶ 

func (f RollupPutJob) WithHuman() func(*RollupPutJobRequest)

WithHuman makes statistical values human-readable.

func (RollupPutJob) WithOpaqueID ¶ 

func (f RollupPutJob) WithOpaqueID(s string) func(*RollupPutJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (RollupPutJob) WithPretty ¶ 

func (f RollupPutJob) WithPretty() func(*RollupPutJobRequest)

WithPretty makes the response body pretty-printed.

type RollupPutJobRequest ¶ 

type RollupPutJobRequest struct {
	JobID string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

RollupPutJobRequest configures the Rollup Put Job API request.

func (RollupPutJobRequest) Do ¶ 

func (r RollupPutJobRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type RollupRollupSearch ¶ 

type RollupRollupSearch func(index []string, body io.Reader, o ...func(*RollupRollupSearchRequest)) (*Response, error)

RollupRollupSearch - Enables searching rolled-up data using the standard query DSL.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-search.html.

func (RollupRollupSearch) WithContext ¶ 

func (f RollupRollupSearch) WithContext(v context.Context) func(*RollupRollupSearchRequest)

WithContext sets the request context.

func (RollupRollupSearch) WithErrorTrace ¶ 

func (f RollupRollupSearch) WithErrorTrace() func(*RollupRollupSearchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (RollupRollupSearch) WithFilterPath ¶ 

func (f RollupRollupSearch) WithFilterPath(v ...string) func(*RollupRollupSearchRequest)

WithFilterPath filters the properties of the response body.

func (RollupRollupSearch) WithHeader ¶ 

func (f RollupRollupSearch) WithHeader(h map[string]string) func(*RollupRollupSearchRequest)

WithHeader adds the headers to the HTTP request.

func (RollupRollupSearch) WithHuman ¶ 

func (f RollupRollupSearch) WithHuman() func(*RollupRollupSearchRequest)

WithHuman makes statistical values human-readable.

func (RollupRollupSearch) WithOpaqueID ¶ 

func (f RollupRollupSearch) WithOpaqueID(s string) func(*RollupRollupSearchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (RollupRollupSearch) WithPretty ¶ 

func (f RollupRollupSearch) WithPretty() func(*RollupRollupSearchRequest)

WithPretty makes the response body pretty-printed.

func (RollupRollupSearch) WithRestTotalHitsAsInt ¶ 

func (f RollupRollupSearch) WithRestTotalHitsAsInt(v bool) func(*RollupRollupSearchRequest)

WithRestTotalHitsAsInt - indicates whether hits.total should be rendered as an integer or an object in the rest search response.

func (RollupRollupSearch) WithTypedKeys ¶ 

func (f RollupRollupSearch) WithTypedKeys(v bool) func(*RollupRollupSearchRequest)

WithTypedKeys - specify whether aggregation and suggester names should be prefixed by their respective types in the response.

type RollupRollupSearchRequest ¶ 

type RollupRollupSearchRequest struct {
	Index []string

	Body io.Reader

	RestTotalHitsAsInt *bool
	TypedKeys          *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

RollupRollupSearchRequest configures the Rollup Rollup Search API request.

func (RollupRollupSearchRequest) Do ¶ 

func (r RollupRollupSearchRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type RollupStartJob ¶ 

type RollupStartJob func(id string, o ...func(*RollupStartJobRequest)) (*Response, error)

RollupStartJob - Starts an existing, stopped rollup job.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-start-job.html.

func (RollupStartJob) WithContext ¶ 

func (f RollupStartJob) WithContext(v context.Context) func(*RollupStartJobRequest)

WithContext sets the request context.

func (RollupStartJob) WithErrorTrace ¶ 

func (f RollupStartJob) WithErrorTrace() func(*RollupStartJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (RollupStartJob) WithFilterPath ¶ 

func (f RollupStartJob) WithFilterPath(v ...string) func(*RollupStartJobRequest)

WithFilterPath filters the properties of the response body.

func (RollupStartJob) WithHeader ¶ 

func (f RollupStartJob) WithHeader(h map[string]string) func(*RollupStartJobRequest)

WithHeader adds the headers to the HTTP request.

func (RollupStartJob) WithHuman ¶ 

func (f RollupStartJob) WithHuman() func(*RollupStartJobRequest)

WithHuman makes statistical values human-readable.

func (RollupStartJob) WithOpaqueID ¶ 

func (f RollupStartJob) WithOpaqueID(s string) func(*RollupStartJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (RollupStartJob) WithPretty ¶ 

func (f RollupStartJob) WithPretty() func(*RollupStartJobRequest)

WithPretty makes the response body pretty-printed.

type RollupStartJobRequest ¶ 

type RollupStartJobRequest struct {
	JobID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

RollupStartJobRequest configures the Rollup Start Job API request.

func (RollupStartJobRequest) Do ¶ 

func (r RollupStartJobRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type RollupStopJob ¶ 

type RollupStopJob func(id string, o ...func(*RollupStopJobRequest)) (*Response, error)

RollupStopJob - Stops an existing, started rollup job.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-stop-job.html.

func (RollupStopJob) WithContext ¶ 

func (f RollupStopJob) WithContext(v context.Context) func(*RollupStopJobRequest)

WithContext sets the request context.

func (RollupStopJob) WithErrorTrace ¶ 

func (f RollupStopJob) WithErrorTrace() func(*RollupStopJobRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (RollupStopJob) WithFilterPath ¶ 

func (f RollupStopJob) WithFilterPath(v ...string) func(*RollupStopJobRequest)

WithFilterPath filters the properties of the response body.

func (RollupStopJob) WithHeader ¶ 

func (f RollupStopJob) WithHeader(h map[string]string) func(*RollupStopJobRequest)

WithHeader adds the headers to the HTTP request.

func (RollupStopJob) WithHuman ¶ 

func (f RollupStopJob) WithHuman() func(*RollupStopJobRequest)

WithHuman makes statistical values human-readable.

func (RollupStopJob) WithOpaqueID ¶ 

func (f RollupStopJob) WithOpaqueID(s string) func(*RollupStopJobRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (RollupStopJob) WithPretty ¶ 

func (f RollupStopJob) WithPretty() func(*RollupStopJobRequest)

WithPretty makes the response body pretty-printed.

func (RollupStopJob) WithTimeout ¶ 

func (f RollupStopJob) WithTimeout(v time.Duration) func(*RollupStopJobRequest)

WithTimeout - block for (at maximum) the specified duration while waiting for the job to stop. defaults to 30s..

func (RollupStopJob) WithWaitForCompletion ¶ 

func (f RollupStopJob) WithWaitForCompletion(v bool) func(*RollupStopJobRequest)

WithWaitForCompletion - true if the api should block until the job has fully stopped, false if should be executed async. defaults to false..

type RollupStopJobRequest ¶ 

type RollupStopJobRequest struct {
	JobID string

	Timeout           time.Duration
	WaitForCompletion *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

RollupStopJobRequest configures the Rollup Stop Job API request.

func (RollupStopJobRequest) Do ¶ 

func (r RollupStopJobRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SQL ¶ 

type SQL struct {
	ClearCursor    SQLClearCursor
	DeleteAsync    SQLDeleteAsync
	GetAsync       SQLGetAsync
	GetAsyncStatus SQLGetAsyncStatus
	Query          SQLQuery
	Translate      SQLTranslate
}

SQL contains the SQL APIs

type SQLClearCursor ¶ 

type SQLClearCursor func(body io.Reader, o ...func(*SQLClearCursorRequest)) (*Response, error)

SQLClearCursor - Clears the SQL cursor

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html.

func (SQLClearCursor) WithContext ¶ 

func (f SQLClearCursor) WithContext(v context.Context) func(*SQLClearCursorRequest)

WithContext sets the request context.

func (SQLClearCursor) WithErrorTrace ¶ 

func (f SQLClearCursor) WithErrorTrace() func(*SQLClearCursorRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SQLClearCursor) WithFilterPath ¶ 

func (f SQLClearCursor) WithFilterPath(v ...string) func(*SQLClearCursorRequest)

WithFilterPath filters the properties of the response body.

func (SQLClearCursor) WithHeader ¶ 

func (f SQLClearCursor) WithHeader(h map[string]string) func(*SQLClearCursorRequest)

WithHeader adds the headers to the HTTP request.

func (SQLClearCursor) WithHuman ¶ 

func (f SQLClearCursor) WithHuman() func(*SQLClearCursorRequest)

WithHuman makes statistical values human-readable.

func (SQLClearCursor) WithOpaqueID ¶ 

func (f SQLClearCursor) WithOpaqueID(s string) func(*SQLClearCursorRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SQLClearCursor) WithPretty ¶ 

func (f SQLClearCursor) WithPretty() func(*SQLClearCursorRequest)

WithPretty makes the response body pretty-printed.

type SQLClearCursorRequest ¶ 

type SQLClearCursorRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SQLClearCursorRequest configures the SQL Clear Cursor API request.

func (SQLClearCursorRequest) Do ¶ 

func (r SQLClearCursorRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SQLDeleteAsync ¶ 

type SQLDeleteAsync func(id string, o ...func(*SQLDeleteAsyncRequest)) (*Response, error)

SQLDeleteAsync - Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-async-sql-search-api.html.

func (SQLDeleteAsync) WithContext ¶ 

func (f SQLDeleteAsync) WithContext(v context.Context) func(*SQLDeleteAsyncRequest)

WithContext sets the request context.

func (SQLDeleteAsync) WithErrorTrace ¶ 

func (f SQLDeleteAsync) WithErrorTrace() func(*SQLDeleteAsyncRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SQLDeleteAsync) WithFilterPath ¶ 

func (f SQLDeleteAsync) WithFilterPath(v ...string) func(*SQLDeleteAsyncRequest)

WithFilterPath filters the properties of the response body.

func (SQLDeleteAsync) WithHeader ¶ 

func (f SQLDeleteAsync) WithHeader(h map[string]string) func(*SQLDeleteAsyncRequest)

WithHeader adds the headers to the HTTP request.

func (SQLDeleteAsync) WithHuman ¶ 

func (f SQLDeleteAsync) WithHuman() func(*SQLDeleteAsyncRequest)

WithHuman makes statistical values human-readable.

func (SQLDeleteAsync) WithOpaqueID ¶ 

func (f SQLDeleteAsync) WithOpaqueID(s string) func(*SQLDeleteAsyncRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SQLDeleteAsync) WithPretty ¶ 

func (f SQLDeleteAsync) WithPretty() func(*SQLDeleteAsyncRequest)

WithPretty makes the response body pretty-printed.

type SQLDeleteAsyncRequest ¶ 

type SQLDeleteAsyncRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SQLDeleteAsyncRequest configures the SQL Delete Async API request.

func (SQLDeleteAsyncRequest) Do ¶ 

func (r SQLDeleteAsyncRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SQLGetAsync ¶ 

type SQLGetAsync func(id string, o ...func(*SQLGetAsyncRequest)) (*Response, error)

SQLGetAsync - Returns the current status and available results for an async SQL search or stored synchronous SQL search

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-api.html.

func (SQLGetAsync) WithContext ¶ 

func (f SQLGetAsync) WithContext(v context.Context) func(*SQLGetAsyncRequest)

WithContext sets the request context.

func (SQLGetAsync) WithDelimiter ¶ 

func (f SQLGetAsync) WithDelimiter(v string) func(*SQLGetAsyncRequest)

WithDelimiter - separator for csv results.

func (SQLGetAsync) WithErrorTrace ¶ 

func (f SQLGetAsync) WithErrorTrace() func(*SQLGetAsyncRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SQLGetAsync) WithFilterPath ¶ 

func (f SQLGetAsync) WithFilterPath(v ...string) func(*SQLGetAsyncRequest)

WithFilterPath filters the properties of the response body.

func (SQLGetAsync) WithFormat ¶ 

func (f SQLGetAsync) WithFormat(v string) func(*SQLGetAsyncRequest)

WithFormat - short version of the accept header, e.g. json, yaml.

func (SQLGetAsync) WithHeader ¶ 

func (f SQLGetAsync) WithHeader(h map[string]string) func(*SQLGetAsyncRequest)

WithHeader adds the headers to the HTTP request.

func (SQLGetAsync) WithHuman ¶ 

func (f SQLGetAsync) WithHuman() func(*SQLGetAsyncRequest)

WithHuman makes statistical values human-readable.

func (SQLGetAsync) WithKeepAlive ¶ 

func (f SQLGetAsync) WithKeepAlive(v time.Duration) func(*SQLGetAsyncRequest)

WithKeepAlive - retention period for the search and its results.

func (SQLGetAsync) WithOpaqueID ¶ 

func (f SQLGetAsync) WithOpaqueID(s string) func(*SQLGetAsyncRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SQLGetAsync) WithPretty ¶ 

func (f SQLGetAsync) WithPretty() func(*SQLGetAsyncRequest)

WithPretty makes the response body pretty-printed.

func (SQLGetAsync) WithWaitForCompletionTimeout ¶ 

func (f SQLGetAsync) WithWaitForCompletionTimeout(v time.Duration) func(*SQLGetAsyncRequest)

WithWaitForCompletionTimeout - duration to wait for complete results.

type SQLGetAsyncRequest ¶ 

type SQLGetAsyncRequest struct {
	DocumentID string

	Delimiter                string
	Format                   string
	KeepAlive                time.Duration
	WaitForCompletionTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SQLGetAsyncRequest configures the SQL Get Async API request.

func (SQLGetAsyncRequest) Do ¶ 

func (r SQLGetAsyncRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SQLGetAsyncStatus ¶ 

type SQLGetAsyncStatus func(id string, o ...func(*SQLGetAsyncStatusRequest)) (*Response, error)

SQLGetAsyncStatus - Returns the current status of an async SQL search or a stored synchronous SQL search

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-status-api.html.

func (SQLGetAsyncStatus) WithContext ¶ 

func (f SQLGetAsyncStatus) WithContext(v context.Context) func(*SQLGetAsyncStatusRequest)

WithContext sets the request context.

func (SQLGetAsyncStatus) WithErrorTrace ¶ 

func (f SQLGetAsyncStatus) WithErrorTrace() func(*SQLGetAsyncStatusRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SQLGetAsyncStatus) WithFilterPath ¶ 

func (f SQLGetAsyncStatus) WithFilterPath(v ...string) func(*SQLGetAsyncStatusRequest)

WithFilterPath filters the properties of the response body.

func (SQLGetAsyncStatus) WithHeader ¶ 

func (f SQLGetAsyncStatus) WithHeader(h map[string]string) func(*SQLGetAsyncStatusRequest)

WithHeader adds the headers to the HTTP request.

func (SQLGetAsyncStatus) WithHuman ¶ 

func (f SQLGetAsyncStatus) WithHuman() func(*SQLGetAsyncStatusRequest)

WithHuman makes statistical values human-readable.

func (SQLGetAsyncStatus) WithOpaqueID ¶ 

func (f SQLGetAsyncStatus) WithOpaqueID(s string) func(*SQLGetAsyncStatusRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SQLGetAsyncStatus) WithPretty ¶ 

func (f SQLGetAsyncStatus) WithPretty() func(*SQLGetAsyncStatusRequest)

WithPretty makes the response body pretty-printed.

type SQLGetAsyncStatusRequest ¶ 

type SQLGetAsyncStatusRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SQLGetAsyncStatusRequest configures the SQL Get Async Status API request.

func (SQLGetAsyncStatusRequest) Do ¶ 

func (r SQLGetAsyncStatusRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SQLQuery ¶ 

type SQLQuery func(body io.Reader, o ...func(*SQLQueryRequest)) (*Response, error)

SQLQuery - Executes a SQL request

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html.

func (SQLQuery) WithContext ¶ 

func (f SQLQuery) WithContext(v context.Context) func(*SQLQueryRequest)

WithContext sets the request context.

func (SQLQuery) WithErrorTrace ¶ 

func (f SQLQuery) WithErrorTrace() func(*SQLQueryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SQLQuery) WithFilterPath ¶ 

func (f SQLQuery) WithFilterPath(v ...string) func(*SQLQueryRequest)

WithFilterPath filters the properties of the response body.

func (SQLQuery) WithFormat ¶ 

func (f SQLQuery) WithFormat(v string) func(*SQLQueryRequest)

WithFormat - a short version of the accept header, e.g. json, yaml.

func (SQLQuery) WithHeader ¶ 

func (f SQLQuery) WithHeader(h map[string]string) func(*SQLQueryRequest)

WithHeader adds the headers to the HTTP request.

func (SQLQuery) WithHuman ¶ 

func (f SQLQuery) WithHuman() func(*SQLQueryRequest)

WithHuman makes statistical values human-readable.

func (SQLQuery) WithOpaqueID ¶ 

func (f SQLQuery) WithOpaqueID(s string) func(*SQLQueryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SQLQuery) WithPretty ¶ 

func (f SQLQuery) WithPretty() func(*SQLQueryRequest)

WithPretty makes the response body pretty-printed.

type SQLQueryRequest ¶ 

type SQLQueryRequest struct {
	Body io.Reader

	Format string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SQLQueryRequest configures the SQL Query API request.

func (SQLQueryRequest) Do ¶ 

func (r SQLQueryRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SQLTranslate ¶ 

type SQLTranslate func(body io.Reader, o ...func(*SQLTranslateRequest)) (*Response, error)

SQLTranslate - Translates SQL into Elasticsearch queries

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html.

func (SQLTranslate) WithContext ¶ 

func (f SQLTranslate) WithContext(v context.Context) func(*SQLTranslateRequest)

WithContext sets the request context.

func (SQLTranslate) WithErrorTrace ¶ 

func (f SQLTranslate) WithErrorTrace() func(*SQLTranslateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SQLTranslate) WithFilterPath ¶ 

func (f SQLTranslate) WithFilterPath(v ...string) func(*SQLTranslateRequest)

WithFilterPath filters the properties of the response body.

func (SQLTranslate) WithHeader ¶ 

func (f SQLTranslate) WithHeader(h map[string]string) func(*SQLTranslateRequest)

WithHeader adds the headers to the HTTP request.

func (SQLTranslate) WithHuman ¶ 

func (f SQLTranslate) WithHuman() func(*SQLTranslateRequest)

WithHuman makes statistical values human-readable.

func (SQLTranslate) WithOpaqueID ¶ 

func (f SQLTranslate) WithOpaqueID(s string) func(*SQLTranslateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SQLTranslate) WithPretty ¶ 

func (f SQLTranslate) WithPretty() func(*SQLTranslateRequest)

WithPretty makes the response body pretty-printed.

type SQLTranslateRequest ¶ 

type SQLTranslateRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SQLTranslateRequest configures the SQL Translate API request.

func (SQLTranslateRequest) Do ¶ 

func (r SQLTranslateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SSL ¶ 

type SSL struct {
	Certificates SSLCertificates
}

SSL contains the SSL APIs

type SSLCertificates ¶ 

type SSLCertificates func(o ...func(*SSLCertificatesRequest)) (*Response, error)

SSLCertificates - Retrieves information about the X.509 certificates used to encrypt communications in the cluster.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html.

func (SSLCertificates) WithContext ¶ 

func (f SSLCertificates) WithContext(v context.Context) func(*SSLCertificatesRequest)

WithContext sets the request context.

func (SSLCertificates) WithErrorTrace ¶ 

func (f SSLCertificates) WithErrorTrace() func(*SSLCertificatesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SSLCertificates) WithFilterPath ¶ 

func (f SSLCertificates) WithFilterPath(v ...string) func(*SSLCertificatesRequest)

WithFilterPath filters the properties of the response body.

func (SSLCertificates) WithHeader ¶ 

func (f SSLCertificates) WithHeader(h map[string]string) func(*SSLCertificatesRequest)

WithHeader adds the headers to the HTTP request.

func (SSLCertificates) WithHuman ¶ 

func (f SSLCertificates) WithHuman() func(*SSLCertificatesRequest)

WithHuman makes statistical values human-readable.

func (SSLCertificates) WithOpaqueID ¶ 

func (f SSLCertificates) WithOpaqueID(s string) func(*SSLCertificatesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SSLCertificates) WithPretty ¶ 

func (f SSLCertificates) WithPretty() func(*SSLCertificatesRequest)

WithPretty makes the response body pretty-printed.

type SSLCertificatesRequest ¶ 

type SSLCertificatesRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SSLCertificatesRequest configures the SSL Certificates API request.

func (SSLCertificatesRequest) Do ¶ 

func (r SSLCertificatesRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ScriptsPainlessExecute ¶ 

type ScriptsPainlessExecute func(o ...func(*ScriptsPainlessExecuteRequest)) (*Response, error)

ScriptsPainlessExecute allows an arbitrary script to be executed and a result to be returned

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html.

func (ScriptsPainlessExecute) WithBody ¶ 

func (f ScriptsPainlessExecute) WithBody(v io.Reader) func(*ScriptsPainlessExecuteRequest)

WithBody - The script to execute.

func (ScriptsPainlessExecute) WithContext ¶ 

func (f ScriptsPainlessExecute) WithContext(v context.Context) func(*ScriptsPainlessExecuteRequest)

WithContext sets the request context.

func (ScriptsPainlessExecute) WithErrorTrace ¶ 

func (f ScriptsPainlessExecute) WithErrorTrace() func(*ScriptsPainlessExecuteRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ScriptsPainlessExecute) WithFilterPath ¶ 

func (f ScriptsPainlessExecute) WithFilterPath(v ...string) func(*ScriptsPainlessExecuteRequest)

WithFilterPath filters the properties of the response body.

func (ScriptsPainlessExecute) WithHeader ¶ 

func (f ScriptsPainlessExecute) WithHeader(h map[string]string) func(*ScriptsPainlessExecuteRequest)

WithHeader adds the headers to the HTTP request.

func (ScriptsPainlessExecute) WithHuman ¶ 

func (f ScriptsPainlessExecute) WithHuman() func(*ScriptsPainlessExecuteRequest)

WithHuman makes statistical values human-readable.

func (ScriptsPainlessExecute) WithOpaqueID ¶ 

func (f ScriptsPainlessExecute) WithOpaqueID(s string) func(*ScriptsPainlessExecuteRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ScriptsPainlessExecute) WithPretty ¶ 

func (f ScriptsPainlessExecute) WithPretty() func(*ScriptsPainlessExecuteRequest)

WithPretty makes the response body pretty-printed.

type ScriptsPainlessExecuteRequest ¶ 

type ScriptsPainlessExecuteRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ScriptsPainlessExecuteRequest configures the Scripts Painless Execute API request.

func (ScriptsPainlessExecuteRequest) Do ¶ 

func (r ScriptsPainlessExecuteRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Scroll ¶ 

type Scroll func(o ...func(*ScrollRequest)) (*Response, error)

Scroll allows to retrieve a large numbers of results from a single search request.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll.

func (Scroll) WithBody ¶ 

func (f Scroll) WithBody(v io.Reader) func(*ScrollRequest)

WithBody - The scroll ID if not passed by URL or query parameter..

func (Scroll) WithContext ¶ 

func (f Scroll) WithContext(v context.Context) func(*ScrollRequest)

WithContext sets the request context.

func (Scroll) WithErrorTrace ¶ 

func (f Scroll) WithErrorTrace() func(*ScrollRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Scroll) WithFilterPath ¶ 

func (f Scroll) WithFilterPath(v ...string) func(*ScrollRequest)

WithFilterPath filters the properties of the response body.

func (Scroll) WithHeader ¶ 

func (f Scroll) WithHeader(h map[string]string) func(*ScrollRequest)

WithHeader adds the headers to the HTTP request.

func (Scroll) WithHuman ¶ 

func (f Scroll) WithHuman() func(*ScrollRequest)

WithHuman makes statistical values human-readable.

func (Scroll) WithOpaqueID ¶ 

func (f Scroll) WithOpaqueID(s string) func(*ScrollRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Scroll) WithPretty ¶ 

func (f Scroll) WithPretty() func(*ScrollRequest)

WithPretty makes the response body pretty-printed.

func (Scroll) WithRestTotalHitsAsInt ¶ 

func (f Scroll) WithRestTotalHitsAsInt(v bool) func(*ScrollRequest)

WithRestTotalHitsAsInt - indicates whether hits.total should be rendered as an integer or an object in the rest search response.

func (Scroll) WithScroll ¶ 

func (f Scroll) WithScroll(v time.Duration) func(*ScrollRequest)

WithScroll - specify how long a consistent view of the index should be maintained for scrolled search.

func (Scroll) WithScrollID ¶ 

func (f Scroll) WithScrollID(v string) func(*ScrollRequest)

WithScrollID - the scroll ID.

type ScrollRequest ¶ 

type ScrollRequest struct {
	Body io.Reader

	ScrollID string

	RestTotalHitsAsInt *bool
	Scroll             time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ScrollRequest configures the Scroll API request.

func (ScrollRequest) Do ¶ 

func (r ScrollRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error. 

type Search func(o ...func(*SearchRequest)) (*Response, error)

Search returns results matching a query.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html.

func (Search) WithAllowNoIndices ¶ 

func (f Search) WithAllowNoIndices(v bool) func(*SearchRequest)

WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).

func (Search) WithAllowPartialSearchResults ¶ 

func (f Search) WithAllowPartialSearchResults(v bool) func(*SearchRequest)

WithAllowPartialSearchResults - indicate if an error should be returned if there is a partial search failure or timeout.

func (Search) WithAnalyzeWildcard ¶ 

func (f Search) WithAnalyzeWildcard(v bool) func(*SearchRequest)

WithAnalyzeWildcard - specify whether wildcard and prefix queries should be analyzed (default: false).

func (Search) WithAnalyzer ¶ 

func (f Search) WithAnalyzer(v string) func(*SearchRequest)

WithAnalyzer - the analyzer to use for the query string.

func (Search) WithBatchedReduceSize ¶ 

func (f Search) WithBatchedReduceSize(v int) func(*SearchRequest)

WithBatchedReduceSize - the number of shard results that should be reduced at once on the coordinating node. this value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large..

func (Search) WithBody ¶ 

func (f Search) WithBody(v io.Reader) func(*SearchRequest)

WithBody - The search definition using the Query DSL.

func (Search) WithCcsMinimizeRoundtrips ¶ 

func (f Search) WithCcsMinimizeRoundtrips(v bool) func(*SearchRequest)

WithCcsMinimizeRoundtrips - indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.

func (Search) WithContext ¶ 

func (f Search) WithContext(v context.Context) func(*SearchRequest)

WithContext sets the request context.

func (Search) WithDefaultOperator ¶ 

func (f Search) WithDefaultOperator(v string) func(*SearchRequest)

WithDefaultOperator - the default operator for query string query (and or or).

func (Search) WithDf ¶ 

func (f Search) WithDf(v string) func(*SearchRequest)

WithDf - the field to use as default where no field prefix is given in the query string.

func (Search) WithDocvalueFields ¶ 

func (f Search) WithDocvalueFields(v ...string) func(*SearchRequest)

WithDocvalueFields - a list of fields to return as the docvalue representation of a field for each hit.

func (Search) WithErrorTrace ¶ 

func (f Search) WithErrorTrace() func(*SearchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Search) WithExpandWildcards ¶ 

func (f Search) WithExpandWildcards(v string) func(*SearchRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (Search) WithExplain ¶ 

func (f Search) WithExplain(v bool) func(*SearchRequest)

WithExplain - specify whether to return detailed information about score computation as part of a hit.

func (Search) WithFilterPath ¶ 

func (f Search) WithFilterPath(v ...string) func(*SearchRequest)

WithFilterPath filters the properties of the response body.

func (Search) WithForceSyntheticSource ¶ added in v8.4.0 

func (f Search) WithForceSyntheticSource(v bool) func(*SearchRequest)

WithForceSyntheticSource - should this request force synthetic _source? use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. fetches with this enabled will be slower the enabling synthetic source natively in the index..

func (Search) WithFrom ¶ 

func (f Search) WithFrom(v int) func(*SearchRequest)

WithFrom - starting offset (default: 0).

func (Search) WithHeader ¶ 

func (f Search) WithHeader(h map[string]string) func(*SearchRequest)

WithHeader adds the headers to the HTTP request.

func (Search) WithHuman ¶ 

func (f Search) WithHuman() func(*SearchRequest)

WithHuman makes statistical values human-readable.

func (Search) WithIgnoreThrottled ¶ 

func (f Search) WithIgnoreThrottled(v bool) func(*SearchRequest)

WithIgnoreThrottled - whether specified concrete, expanded or aliased indices should be ignored when throttled.

func (Search) WithIgnoreUnavailable ¶ 

func (f Search) WithIgnoreUnavailable(v bool) func(*SearchRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (Search) WithIncludeNamedQueriesScore ¶ added in v8.8.0 

func (f Search) WithIncludeNamedQueriesScore(v bool) func(*SearchRequest)

WithIncludeNamedQueriesScore - indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false).

func (Search) WithIndex ¶ 

func (f Search) WithIndex(v ...string) func(*SearchRequest)

WithIndex - a list of index names to search; use _all to perform the operation on all indices.

func (Search) WithLenient ¶ 

func (f Search) WithLenient(v bool) func(*SearchRequest)

WithLenient - specify whether format-based query failures (such as providing text to a numeric field) should be ignored.

func (Search) WithMaxConcurrentShardRequests ¶ 

func (f Search) WithMaxConcurrentShardRequests(v int) func(*SearchRequest)

WithMaxConcurrentShardRequests - the number of concurrent shard requests 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 (Search) WithMinCompatibleShardNode ¶ 

func (f Search) WithMinCompatibleShardNode(v string) func(*SearchRequest)

WithMinCompatibleShardNode - the minimum compatible version that all shards involved in search should have for this request to be successful.

func (Search) WithOpaqueID ¶ 

func (f Search) WithOpaqueID(s string) func(*SearchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Search) WithPreFilterShardSize ¶ 

func (f Search) WithPreFilterShardSize(v int) func(*SearchRequest)

WithPreFilterShardSize - a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. this filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint..

func (Search) WithPreference ¶ 

func (f Search) WithPreference(v string) func(*SearchRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (Search) WithPretty ¶ 

func (f Search) WithPretty() func(*SearchRequest)

WithPretty makes the response body pretty-printed.

func (Search) WithQuery ¶ 

func (f Search) WithQuery(v string) func(*SearchRequest)

WithQuery - query in the lucene query string syntax.

func (Search) WithRequestCache ¶ 

func (f Search) WithRequestCache(v bool) func(*SearchRequest)

WithRequestCache - specify if request cache should be used for this request or not, defaults to index level setting.

func (Search) WithRestTotalHitsAsInt ¶ 

func (f Search) WithRestTotalHitsAsInt(v bool) func(*SearchRequest)

WithRestTotalHitsAsInt - indicates whether hits.total should be rendered as an integer or an object in the rest search response.

func (Search) WithRouting ¶ 

func (f Search) WithRouting(v ...string) func(*SearchRequest)

WithRouting - a list of specific routing values.

func (Search) WithScroll ¶ 

func (f Search) WithScroll(v time.Duration) func(*SearchRequest)

WithScroll - specify how long a consistent view of the index should be maintained for scrolled search.

func (Search) WithSearchType ¶ 

func (f Search) WithSearchType(v string) func(*SearchRequest)

WithSearchType - search operation type.

func (Search) WithSeqNoPrimaryTerm ¶ 

func (f Search) WithSeqNoPrimaryTerm(v bool) func(*SearchRequest)

WithSeqNoPrimaryTerm - specify whether to return sequence number and primary term of the last modification of each hit.

func (Search) WithSize ¶ 

func (f Search) WithSize(v int) func(*SearchRequest)

WithSize - number of hits to return (default: 10).

func (Search) WithSort ¶ 

func (f Search) WithSort(v ...string) func(*SearchRequest)

WithSort - a list of <field>:<direction> pairs.

func (Search) WithSource ¶ 

func (f Search) WithSource(v ...string) func(*SearchRequest)

WithSource - true or false to return the _source field or not, or a list of fields to return.

func (Search) WithSourceExcludes ¶ 

func (f Search) WithSourceExcludes(v ...string) func(*SearchRequest)

WithSourceExcludes - a list of fields to exclude from the returned _source field.

func (Search) WithSourceIncludes ¶ 

func (f Search) WithSourceIncludes(v ...string) func(*SearchRequest)

WithSourceIncludes - a list of fields to extract and return from the _source field.

func (Search) WithStats ¶ 

func (f Search) WithStats(v ...string) func(*SearchRequest)

WithStats - specific 'tag' of the request for logging and statistical purposes.

func (Search) WithStoredFields ¶ 

func (f Search) WithStoredFields(v ...string) func(*SearchRequest)

WithStoredFields - a list of stored fields to return as part of a hit.

func (Search) WithSuggestField ¶ 

func (f Search) WithSuggestField(v string) func(*SearchRequest)

WithSuggestField - specify which field to use for suggestions.

func (Search) WithSuggestMode ¶ 

func (f Search) WithSuggestMode(v string) func(*SearchRequest)

WithSuggestMode - specify suggest mode.

func (Search) WithSuggestSize ¶ 

func (f Search) WithSuggestSize(v int) func(*SearchRequest)

WithSuggestSize - how many suggestions to return in response.

func (Search) WithSuggestText ¶ 

func (f Search) WithSuggestText(v string) func(*SearchRequest)

WithSuggestText - the source text for which the suggestions should be returned.

func (Search) WithTerminateAfter ¶ 

func (f Search) WithTerminateAfter(v int) func(*SearchRequest)

WithTerminateAfter - the maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early..

func (Search) WithTimeout ¶ 

func (f Search) WithTimeout(v time.Duration) func(*SearchRequest)

WithTimeout - explicit operation timeout.

func (Search) WithTrackScores ¶ 

func (f Search) WithTrackScores(v bool) func(*SearchRequest)

WithTrackScores - whether to calculate and return scores even if they are not used for sorting.

func (Search) WithTrackTotalHits ¶ 

func (f Search) WithTrackTotalHits(v interface{}) func(*SearchRequest)

WithTrackTotalHits - indicate if the number of documents that match the query should be tracked. a number can also be specified, to accurately track the total hit count up to the number..

func (Search) WithTypedKeys ¶ 

func (f Search) WithTypedKeys(v bool) func(*SearchRequest)

WithTypedKeys - specify whether aggregation and suggester names should be prefixed by their respective types in the response.

func (Search) WithVersion ¶ 

func (f Search) WithVersion(v bool) func(*SearchRequest)

WithVersion - specify whether to return document version as part of a hit.

type SearchApplicationDelete ¶ added in v8.8.0 

type SearchApplicationDelete func(name string, o ...func(*SearchApplicationDeleteRequest)) (*Response, error)

SearchApplicationDelete deletes a search application.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html.

func (SearchApplicationDelete) WithContext ¶ added in v8.8.0 

func (f SearchApplicationDelete) WithContext(v context.Context) func(*SearchApplicationDeleteRequest)

WithContext sets the request context.

func (SearchApplicationDelete) WithErrorTrace ¶ added in v8.8.0 

func (f SearchApplicationDelete) WithErrorTrace() func(*SearchApplicationDeleteRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchApplicationDelete) WithFilterPath ¶ added in v8.8.0 

func (f SearchApplicationDelete) WithFilterPath(v ...string) func(*SearchApplicationDeleteRequest)

WithFilterPath filters the properties of the response body.

func (SearchApplicationDelete) WithHeader ¶ added in v8.8.0 

func (f SearchApplicationDelete) WithHeader(h map[string]string) func(*SearchApplicationDeleteRequest)

WithHeader adds the headers to the HTTP request.

func (SearchApplicationDelete) WithHuman ¶ added in v8.8.0 

func (f SearchApplicationDelete) WithHuman() func(*SearchApplicationDeleteRequest)

WithHuman makes statistical values human-readable.

func (SearchApplicationDelete) WithOpaqueID ¶ added in v8.8.0 

func (f SearchApplicationDelete) WithOpaqueID(s string) func(*SearchApplicationDeleteRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchApplicationDelete) WithPretty ¶ added in v8.8.0 

func (f SearchApplicationDelete) WithPretty() func(*SearchApplicationDeleteRequest)

WithPretty makes the response body pretty-printed.

type SearchApplicationDeleteBehavioralAnalytics ¶ added in v8.8.0 

type SearchApplicationDeleteBehavioralAnalytics func(name string, o ...func(*SearchApplicationDeleteBehavioralAnalyticsRequest)) (*Response, error)

SearchApplicationDeleteBehavioralAnalytics delete a behavioral analytics collection.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-analytics-collection.html.

func (SearchApplicationDeleteBehavioralAnalytics) WithContext ¶ added in v8.8.0 

func (f SearchApplicationDeleteBehavioralAnalytics) WithContext(v context.Context) func(*SearchApplicationDeleteBehavioralAnalyticsRequest)

WithContext sets the request context.

func (SearchApplicationDeleteBehavioralAnalytics) WithErrorTrace ¶ added in v8.8.0 

func (f SearchApplicationDeleteBehavioralAnalytics) WithErrorTrace() func(*SearchApplicationDeleteBehavioralAnalyticsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchApplicationDeleteBehavioralAnalytics) WithFilterPath ¶ added in v8.8.0 

func (f SearchApplicationDeleteBehavioralAnalytics) WithFilterPath(v ...string) func(*SearchApplicationDeleteBehavioralAnalyticsRequest)

WithFilterPath filters the properties of the response body.

func (SearchApplicationDeleteBehavioralAnalytics) WithHeader ¶ added in v8.8.0 

func (f SearchApplicationDeleteBehavioralAnalytics) WithHeader(h map[string]string) func(*SearchApplicationDeleteBehavioralAnalyticsRequest)

WithHeader adds the headers to the HTTP request.

func (SearchApplicationDeleteBehavioralAnalytics) WithHuman ¶ added in v8.8.0 

func (f SearchApplicationDeleteBehavioralAnalytics) WithHuman() func(*SearchApplicationDeleteBehavioralAnalyticsRequest)

WithHuman makes statistical values human-readable.

func (SearchApplicationDeleteBehavioralAnalytics) WithOpaqueID ¶ added in v8.8.0 

func (f SearchApplicationDeleteBehavioralAnalytics) WithOpaqueID(s string) func(*SearchApplicationDeleteBehavioralAnalyticsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchApplicationDeleteBehavioralAnalytics) WithPretty ¶ added in v8.8.0 

func (f SearchApplicationDeleteBehavioralAnalytics) WithPretty() func(*SearchApplicationDeleteBehavioralAnalyticsRequest)

WithPretty makes the response body pretty-printed.

type SearchApplicationDeleteBehavioralAnalyticsRequest ¶ added in v8.8.0 

type SearchApplicationDeleteBehavioralAnalyticsRequest struct {
	Name string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchApplicationDeleteBehavioralAnalyticsRequest configures the Search Application Delete Behavioral Analytics API request.

func (SearchApplicationDeleteBehavioralAnalyticsRequest) Do ¶ added in v8.8.0 

func (r SearchApplicationDeleteBehavioralAnalyticsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchApplicationDeleteRequest ¶ added in v8.8.0 

type SearchApplicationDeleteRequest struct {
	Name string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchApplicationDeleteRequest configures the Search Application Delete API request.

func (SearchApplicationDeleteRequest) Do ¶ added in v8.8.0 

func (r SearchApplicationDeleteRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchApplicationGet ¶ added in v8.8.0 

type SearchApplicationGet func(name string, o ...func(*SearchApplicationGetRequest)) (*Response, error)

SearchApplicationGet returns the details about a search application.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-search-application.html.

func (SearchApplicationGet) WithContext ¶ added in v8.8.0 

func (f SearchApplicationGet) WithContext(v context.Context) func(*SearchApplicationGetRequest)

WithContext sets the request context.

func (SearchApplicationGet) WithErrorTrace ¶ added in v8.8.0 

func (f SearchApplicationGet) WithErrorTrace() func(*SearchApplicationGetRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchApplicationGet) WithFilterPath ¶ added in v8.8.0 

func (f SearchApplicationGet) WithFilterPath(v ...string) func(*SearchApplicationGetRequest)

WithFilterPath filters the properties of the response body.

func (SearchApplicationGet) WithHeader ¶ added in v8.8.0 

func (f SearchApplicationGet) WithHeader(h map[string]string) func(*SearchApplicationGetRequest)

WithHeader adds the headers to the HTTP request.

func (SearchApplicationGet) WithHuman ¶ added in v8.8.0 

func (f SearchApplicationGet) WithHuman() func(*SearchApplicationGetRequest)

WithHuman makes statistical values human-readable.

func (SearchApplicationGet) WithOpaqueID ¶ added in v8.8.0 

func (f SearchApplicationGet) WithOpaqueID(s string) func(*SearchApplicationGetRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchApplicationGet) WithPretty ¶ added in v8.8.0 

func (f SearchApplicationGet) WithPretty() func(*SearchApplicationGetRequest)

WithPretty makes the response body pretty-printed.

type SearchApplicationGetBehavioralAnalytics ¶ added in v8.8.0 

type SearchApplicationGetBehavioralAnalytics func(o ...func(*SearchApplicationGetBehavioralAnalyticsRequest)) (*Response, error)

SearchApplicationGetBehavioralAnalytics returns the existing behavioral analytics collections.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html.

func (SearchApplicationGetBehavioralAnalytics) WithContext ¶ added in v8.8.0 

func (f SearchApplicationGetBehavioralAnalytics) WithContext(v context.Context) func(*SearchApplicationGetBehavioralAnalyticsRequest)

WithContext sets the request context.

func (SearchApplicationGetBehavioralAnalytics) WithErrorTrace ¶ added in v8.8.0 

func (f SearchApplicationGetBehavioralAnalytics) WithErrorTrace() func(*SearchApplicationGetBehavioralAnalyticsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchApplicationGetBehavioralAnalytics) WithFilterPath ¶ added in v8.8.0 

func (f SearchApplicationGetBehavioralAnalytics) WithFilterPath(v ...string) func(*SearchApplicationGetBehavioralAnalyticsRequest)

WithFilterPath filters the properties of the response body.

func (SearchApplicationGetBehavioralAnalytics) WithHeader ¶ added in v8.8.0 

func (f SearchApplicationGetBehavioralAnalytics) WithHeader(h map[string]string) func(*SearchApplicationGetBehavioralAnalyticsRequest)

WithHeader adds the headers to the HTTP request.

func (SearchApplicationGetBehavioralAnalytics) WithHuman ¶ added in v8.8.0 

func (f SearchApplicationGetBehavioralAnalytics) WithHuman() func(*SearchApplicationGetBehavioralAnalyticsRequest)

WithHuman makes statistical values human-readable.

func (SearchApplicationGetBehavioralAnalytics) WithName ¶ added in v8.8.0 

func (f SearchApplicationGetBehavioralAnalytics) WithName(v ...string) func(*SearchApplicationGetBehavioralAnalyticsRequest)

WithName - a list of analytics collections to limit the returned information.

func (SearchApplicationGetBehavioralAnalytics) WithOpaqueID ¶ added in v8.8.0 

func (f SearchApplicationGetBehavioralAnalytics) WithOpaqueID(s string) func(*SearchApplicationGetBehavioralAnalyticsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchApplicationGetBehavioralAnalytics) WithPretty ¶ added in v8.8.0 

func (f SearchApplicationGetBehavioralAnalytics) WithPretty() func(*SearchApplicationGetBehavioralAnalyticsRequest)

WithPretty makes the response body pretty-printed.

type SearchApplicationGetBehavioralAnalyticsRequest ¶ added in v8.8.0 

type SearchApplicationGetBehavioralAnalyticsRequest struct {
	Name []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchApplicationGetBehavioralAnalyticsRequest configures the Search Application Get Behavioral Analytics API request.

func (SearchApplicationGetBehavioralAnalyticsRequest) Do ¶ added in v8.8.0 

func (r SearchApplicationGetBehavioralAnalyticsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchApplicationGetRequest ¶ added in v8.8.0 

type SearchApplicationGetRequest struct {
	Name string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchApplicationGetRequest configures the Search Application Get API request.

func (SearchApplicationGetRequest) Do ¶ added in v8.8.0 

func (r SearchApplicationGetRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchApplicationList ¶ added in v8.8.0 

type SearchApplicationList func(o ...func(*SearchApplicationListRequest)) (*Response, error)

SearchApplicationList returns the existing search applications.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/list-search-applications.html.

func (SearchApplicationList) WithContext ¶ added in v8.8.0 

func (f SearchApplicationList) WithContext(v context.Context) func(*SearchApplicationListRequest)

WithContext sets the request context.

func (SearchApplicationList) WithErrorTrace ¶ added in v8.8.0 

func (f SearchApplicationList) WithErrorTrace() func(*SearchApplicationListRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchApplicationList) WithFilterPath ¶ added in v8.8.0 

func (f SearchApplicationList) WithFilterPath(v ...string) func(*SearchApplicationListRequest)

WithFilterPath filters the properties of the response body.

func (SearchApplicationList) WithFrom ¶ added in v8.8.0 

func (f SearchApplicationList) WithFrom(v int) func(*SearchApplicationListRequest)

WithFrom - starting offset (default: 0).

func (SearchApplicationList) WithHeader ¶ added in v8.8.0 

func (f SearchApplicationList) WithHeader(h map[string]string) func(*SearchApplicationListRequest)

WithHeader adds the headers to the HTTP request.

func (SearchApplicationList) WithHuman ¶ added in v8.8.0 

func (f SearchApplicationList) WithHuman() func(*SearchApplicationListRequest)

WithHuman makes statistical values human-readable.

func (SearchApplicationList) WithOpaqueID ¶ added in v8.8.0 

func (f SearchApplicationList) WithOpaqueID(s string) func(*SearchApplicationListRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchApplicationList) WithPretty ¶ added in v8.8.0 

func (f SearchApplicationList) WithPretty() func(*SearchApplicationListRequest)

WithPretty makes the response body pretty-printed.

func (SearchApplicationList) WithQuery ¶ added in v8.8.0 

func (f SearchApplicationList) WithQuery(v string) func(*SearchApplicationListRequest)

WithQuery - query in the lucene query string syntax.

func (SearchApplicationList) WithSize ¶ added in v8.8.0 

func (f SearchApplicationList) WithSize(v int) func(*SearchApplicationListRequest)

WithSize - specifies a max number of results to get.

type SearchApplicationListRequest ¶ added in v8.8.0 

type SearchApplicationListRequest struct {
	From  *int
	Query string
	Size  *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchApplicationListRequest configures the Search Application List API request.

func (SearchApplicationListRequest) Do ¶ added in v8.8.0 

func (r SearchApplicationListRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchApplicationPostBehavioralAnalyticsEvent ¶ added in v8.8.0 

type SearchApplicationPostBehavioralAnalyticsEvent func(body io.Reader, collection_name string, event_type string, o ...func(*SearchApplicationPostBehavioralAnalyticsEventRequest)) (*Response, error)

SearchApplicationPostBehavioralAnalyticsEvent creates a behavioral analytics event for existing collection.

This API is experimental.

See full documentation at http://todo.com/tbd.

func (SearchApplicationPostBehavioralAnalyticsEvent) WithContext ¶ added in v8.8.0 

func (f SearchApplicationPostBehavioralAnalyticsEvent) WithContext(v context.Context) func(*SearchApplicationPostBehavioralAnalyticsEventRequest)

WithContext sets the request context.

func (SearchApplicationPostBehavioralAnalyticsEvent) WithDebug ¶ added in v8.8.0 

func (f SearchApplicationPostBehavioralAnalyticsEvent) WithDebug(v bool) func(*SearchApplicationPostBehavioralAnalyticsEventRequest)

WithDebug - if true, returns event information that will be stored.

func (SearchApplicationPostBehavioralAnalyticsEvent) WithErrorTrace ¶ added in v8.8.0 

func (f SearchApplicationPostBehavioralAnalyticsEvent) WithErrorTrace() func(*SearchApplicationPostBehavioralAnalyticsEventRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchApplicationPostBehavioralAnalyticsEvent) WithFilterPath ¶ added in v8.8.0 

func (f SearchApplicationPostBehavioralAnalyticsEvent) WithFilterPath(v ...string) func(*SearchApplicationPostBehavioralAnalyticsEventRequest)

WithFilterPath filters the properties of the response body.

func (SearchApplicationPostBehavioralAnalyticsEvent) WithHeader ¶ added in v8.8.0 

func (f SearchApplicationPostBehavioralAnalyticsEvent) WithHeader(h map[string]string) func(*SearchApplicationPostBehavioralAnalyticsEventRequest)

WithHeader adds the headers to the HTTP request.

func (SearchApplicationPostBehavioralAnalyticsEvent) WithHuman ¶ added in v8.8.0 

func (f SearchApplicationPostBehavioralAnalyticsEvent) WithHuman() func(*SearchApplicationPostBehavioralAnalyticsEventRequest)

WithHuman makes statistical values human-readable.

func (SearchApplicationPostBehavioralAnalyticsEvent) WithOpaqueID ¶ added in v8.8.0 

func (f SearchApplicationPostBehavioralAnalyticsEvent) WithOpaqueID(s string) func(*SearchApplicationPostBehavioralAnalyticsEventRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchApplicationPostBehavioralAnalyticsEvent) WithPretty ¶ added in v8.8.0 

func (f SearchApplicationPostBehavioralAnalyticsEvent) WithPretty() func(*SearchApplicationPostBehavioralAnalyticsEventRequest)

WithPretty makes the response body pretty-printed.

type SearchApplicationPostBehavioralAnalyticsEventRequest ¶ added in v8.8.0 

type SearchApplicationPostBehavioralAnalyticsEventRequest struct {
	Body io.Reader

	CollectionName string
	EventType      string

	Debug *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchApplicationPostBehavioralAnalyticsEventRequest configures the Search Application Post Behavioral Analytics Event API request.

func (SearchApplicationPostBehavioralAnalyticsEventRequest) Do ¶ added in v8.8.0 

func (r SearchApplicationPostBehavioralAnalyticsEventRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchApplicationPut ¶ added in v8.8.0 

type SearchApplicationPut func(name string, body io.Reader, o ...func(*SearchApplicationPutRequest)) (*Response, error)

SearchApplicationPut creates or updates a search application.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html.

func (SearchApplicationPut) WithContext ¶ added in v8.8.0 

func (f SearchApplicationPut) WithContext(v context.Context) func(*SearchApplicationPutRequest)

WithContext sets the request context.

func (SearchApplicationPut) WithCreate ¶ added in v8.8.0 

func (f SearchApplicationPut) WithCreate(v bool) func(*SearchApplicationPutRequest)

WithCreate - if true, requires that a search application with the specified resource_id does not already exist. (default: false).

func (SearchApplicationPut) WithErrorTrace ¶ added in v8.8.0 

func (f SearchApplicationPut) WithErrorTrace() func(*SearchApplicationPutRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchApplicationPut) WithFilterPath ¶ added in v8.8.0 

func (f SearchApplicationPut) WithFilterPath(v ...string) func(*SearchApplicationPutRequest)

WithFilterPath filters the properties of the response body.

func (SearchApplicationPut) WithHeader ¶ added in v8.8.0 

func (f SearchApplicationPut) WithHeader(h map[string]string) func(*SearchApplicationPutRequest)

WithHeader adds the headers to the HTTP request.

func (SearchApplicationPut) WithHuman ¶ added in v8.8.0 

func (f SearchApplicationPut) WithHuman() func(*SearchApplicationPutRequest)

WithHuman makes statistical values human-readable.

func (SearchApplicationPut) WithOpaqueID ¶ added in v8.8.0 

func (f SearchApplicationPut) WithOpaqueID(s string) func(*SearchApplicationPutRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchApplicationPut) WithPretty ¶ added in v8.8.0 

func (f SearchApplicationPut) WithPretty() func(*SearchApplicationPutRequest)

WithPretty makes the response body pretty-printed.

type SearchApplicationPutBehavioralAnalytics ¶ added in v8.8.0 

type SearchApplicationPutBehavioralAnalytics func(name string, o ...func(*SearchApplicationPutBehavioralAnalyticsRequest)) (*Response, error)

SearchApplicationPutBehavioralAnalytics creates a behavioral analytics collection.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/put-analytics-collection.html.

func (SearchApplicationPutBehavioralAnalytics) WithContext ¶ added in v8.8.0 

func (f SearchApplicationPutBehavioralAnalytics) WithContext(v context.Context) func(*SearchApplicationPutBehavioralAnalyticsRequest)

WithContext sets the request context.

func (SearchApplicationPutBehavioralAnalytics) WithErrorTrace ¶ added in v8.8.0 

func (f SearchApplicationPutBehavioralAnalytics) WithErrorTrace() func(*SearchApplicationPutBehavioralAnalyticsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchApplicationPutBehavioralAnalytics) WithFilterPath ¶ added in v8.8.0 

func (f SearchApplicationPutBehavioralAnalytics) WithFilterPath(v ...string) func(*SearchApplicationPutBehavioralAnalyticsRequest)

WithFilterPath filters the properties of the response body.

func (SearchApplicationPutBehavioralAnalytics) WithHeader ¶ added in v8.8.0 

func (f SearchApplicationPutBehavioralAnalytics) WithHeader(h map[string]string) func(*SearchApplicationPutBehavioralAnalyticsRequest)

WithHeader adds the headers to the HTTP request.

func (SearchApplicationPutBehavioralAnalytics) WithHuman ¶ added in v8.8.0 

func (f SearchApplicationPutBehavioralAnalytics) WithHuman() func(*SearchApplicationPutBehavioralAnalyticsRequest)

WithHuman makes statistical values human-readable.

func (SearchApplicationPutBehavioralAnalytics) WithOpaqueID ¶ added in v8.8.0 

func (f SearchApplicationPutBehavioralAnalytics) WithOpaqueID(s string) func(*SearchApplicationPutBehavioralAnalyticsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchApplicationPutBehavioralAnalytics) WithPretty ¶ added in v8.8.0 

func (f SearchApplicationPutBehavioralAnalytics) WithPretty() func(*SearchApplicationPutBehavioralAnalyticsRequest)

WithPretty makes the response body pretty-printed.

type SearchApplicationPutBehavioralAnalyticsRequest ¶ added in v8.8.0 

type SearchApplicationPutBehavioralAnalyticsRequest struct {
	Name string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchApplicationPutBehavioralAnalyticsRequest configures the Search Application Put Behavioral Analytics API request.

func (SearchApplicationPutBehavioralAnalyticsRequest) Do ¶ added in v8.8.0 

func (r SearchApplicationPutBehavioralAnalyticsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchApplicationPutRequest ¶ added in v8.8.0 

type SearchApplicationPutRequest struct {
	Body io.Reader

	Name string

	Create *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchApplicationPutRequest configures the Search Application Put API request.

func (SearchApplicationPutRequest) Do ¶ added in v8.8.0 

func (r SearchApplicationPutRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchApplicationRenderQuery ¶ added in v8.9.0 

type SearchApplicationRenderQuery func(name string, o ...func(*SearchApplicationRenderQueryRequest)) (*Response, error)

SearchApplicationRenderQuery renders a query for given search application search parameters

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-render-query.html.

func (SearchApplicationRenderQuery) WithBody ¶ added in v8.9.0 

func (f SearchApplicationRenderQuery) WithBody(v io.Reader) func(*SearchApplicationRenderQueryRequest)

WithBody - Search parameters, which will override any default search parameters defined in the search application template.

func (SearchApplicationRenderQuery) WithContext ¶ added in v8.9.0 

func (f SearchApplicationRenderQuery) WithContext(v context.Context) func(*SearchApplicationRenderQueryRequest)

WithContext sets the request context.

func (SearchApplicationRenderQuery) WithErrorTrace ¶ added in v8.9.0 

func (f SearchApplicationRenderQuery) WithErrorTrace() func(*SearchApplicationRenderQueryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchApplicationRenderQuery) WithFilterPath ¶ added in v8.9.0 

func (f SearchApplicationRenderQuery) WithFilterPath(v ...string) func(*SearchApplicationRenderQueryRequest)

WithFilterPath filters the properties of the response body.

func (SearchApplicationRenderQuery) WithHeader ¶ added in v8.9.0 

func (f SearchApplicationRenderQuery) WithHeader(h map[string]string) func(*SearchApplicationRenderQueryRequest)

WithHeader adds the headers to the HTTP request.

func (SearchApplicationRenderQuery) WithHuman ¶ added in v8.9.0 

func (f SearchApplicationRenderQuery) WithHuman() func(*SearchApplicationRenderQueryRequest)

WithHuman makes statistical values human-readable.

func (SearchApplicationRenderQuery) WithOpaqueID ¶ added in v8.9.0 

func (f SearchApplicationRenderQuery) WithOpaqueID(s string) func(*SearchApplicationRenderQueryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchApplicationRenderQuery) WithPretty ¶ added in v8.9.0 

func (f SearchApplicationRenderQuery) WithPretty() func(*SearchApplicationRenderQueryRequest)

WithPretty makes the response body pretty-printed.

type SearchApplicationRenderQueryRequest ¶ added in v8.9.0 

type SearchApplicationRenderQueryRequest struct {
	Body io.Reader

	Name string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchApplicationRenderQueryRequest configures the Search Application Render Query API request.

func (SearchApplicationRenderQueryRequest) Do ¶ added in v8.9.0 

func (r SearchApplicationRenderQueryRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchApplicationSearch ¶ added in v8.8.0 

type SearchApplicationSearch func(name string, o ...func(*SearchApplicationSearchRequest)) (*Response, error)

SearchApplicationSearch perform a search against a search application

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html.

func (SearchApplicationSearch) WithBody ¶ added in v8.8.0 

func (f SearchApplicationSearch) WithBody(v io.Reader) func(*SearchApplicationSearchRequest)

WithBody - Search parameters, including template parameters that override defaults.

func (SearchApplicationSearch) WithContext ¶ added in v8.8.0 

func (f SearchApplicationSearch) WithContext(v context.Context) func(*SearchApplicationSearchRequest)

WithContext sets the request context.

func (SearchApplicationSearch) WithErrorTrace ¶ added in v8.8.0 

func (f SearchApplicationSearch) WithErrorTrace() func(*SearchApplicationSearchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchApplicationSearch) WithFilterPath ¶ added in v8.8.0 

func (f SearchApplicationSearch) WithFilterPath(v ...string) func(*SearchApplicationSearchRequest)

WithFilterPath filters the properties of the response body.

func (SearchApplicationSearch) WithHeader ¶ added in v8.8.0 

func (f SearchApplicationSearch) WithHeader(h map[string]string) func(*SearchApplicationSearchRequest)

WithHeader adds the headers to the HTTP request.

func (SearchApplicationSearch) WithHuman ¶ added in v8.8.0 

func (f SearchApplicationSearch) WithHuman() func(*SearchApplicationSearchRequest)

WithHuman makes statistical values human-readable.

func (SearchApplicationSearch) WithOpaqueID ¶ added in v8.8.0 

func (f SearchApplicationSearch) WithOpaqueID(s string) func(*SearchApplicationSearchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchApplicationSearch) WithPretty ¶ added in v8.8.0 

func (f SearchApplicationSearch) WithPretty() func(*SearchApplicationSearchRequest)

WithPretty makes the response body pretty-printed.

func (SearchApplicationSearch) WithTypedKeys ¶ added in v8.14.0 

func (f SearchApplicationSearch) WithTypedKeys(v bool) func(*SearchApplicationSearchRequest)

WithTypedKeys - specify whether aggregation and suggester names should be prefixed by their respective types in the response.

type SearchApplicationSearchRequest ¶ added in v8.8.0 

type SearchApplicationSearchRequest struct {
	Body io.Reader

	Name string

	TypedKeys *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchApplicationSearchRequest configures the Search Application Search API request.

func (SearchApplicationSearchRequest) Do ¶ added in v8.8.0 

func (r SearchApplicationSearchRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchMvt ¶ 

type SearchMvt func(index []string, field string, x *int, y *int, zoom *int, o ...func(*SearchMvtRequest)) (*Response, error)

SearchMvt searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html.

func (SearchMvt) WithBody ¶ 

func (f SearchMvt) WithBody(v io.Reader) func(*SearchMvtRequest)

WithBody - Search request body..

func (SearchMvt) WithContext ¶ 

func (f SearchMvt) WithContext(v context.Context) func(*SearchMvtRequest)

WithContext sets the request context.

func (SearchMvt) WithErrorTrace ¶ 

func (f SearchMvt) WithErrorTrace() func(*SearchMvtRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchMvt) WithExactBounds ¶ 

func (f SearchMvt) WithExactBounds(v bool) func(*SearchMvtRequest)

WithExactBounds - if false, the meta layer's feature is the bounding box of the tile. if true, the meta layer's feature is a bounding box resulting from a `geo_bounds` aggregation..

func (SearchMvt) WithExtent ¶ 

func (f SearchMvt) WithExtent(v int) func(*SearchMvtRequest)

WithExtent - size, in pixels, of a side of the vector tile..

func (SearchMvt) WithFilterPath ¶ 

func (f SearchMvt) WithFilterPath(v ...string) func(*SearchMvtRequest)

WithFilterPath filters the properties of the response body.

func (SearchMvt) WithGridPrecision ¶ 

func (f SearchMvt) WithGridPrecision(v int) func(*SearchMvtRequest)

WithGridPrecision - additional zoom levels available through the aggs layer. accepts 0-8..

func (SearchMvt) WithGridType ¶ 

func (f SearchMvt) WithGridType(v string) func(*SearchMvtRequest)

WithGridType - determines the geometry type for features in the aggs layer..

func (SearchMvt) WithHeader ¶ 

func (f SearchMvt) WithHeader(h map[string]string) func(*SearchMvtRequest)

WithHeader adds the headers to the HTTP request.

func (SearchMvt) WithHuman ¶ 

func (f SearchMvt) WithHuman() func(*SearchMvtRequest)

WithHuman makes statistical values human-readable.

func (SearchMvt) WithOpaqueID ¶ 

func (f SearchMvt) WithOpaqueID(s string) func(*SearchMvtRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchMvt) WithPretty ¶ 

func (f SearchMvt) WithPretty() func(*SearchMvtRequest)

WithPretty makes the response body pretty-printed.

func (SearchMvt) WithSize ¶ 

func (f SearchMvt) WithSize(v int) func(*SearchMvtRequest)

WithSize - maximum number of features to return in the hits layer. accepts 0-10000..

func (SearchMvt) WithTrackTotalHits ¶ 

func (f SearchMvt) WithTrackTotalHits(v interface{}) func(*SearchMvtRequest)

WithTrackTotalHits - indicate if the number of documents that match the query should be tracked. a number can also be specified, to accurately track the total hit count up to the number..

func (SearchMvt) WithWithLabels ¶ added in v8.3.0 

func (f SearchMvt) WithWithLabels(v bool) func(*SearchMvtRequest)

WithWithLabels - if true, the hits and aggs layers will contain additional point features with suggested label positions for the original features..

type SearchMvtRequest ¶ 

type SearchMvtRequest struct {
	Index []string

	Body io.Reader

	Field string
	X     *int
	Y     *int
	Zoom  *int

	ExactBounds    *bool
	Extent         *int
	GridPrecision  *int
	GridType       string
	Size           *int
	TrackTotalHits interface{}
	WithLabels     *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchMvtRequest configures the Search Mvt API request.

func (SearchMvtRequest) Do ¶ 

func (r SearchMvtRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchRequest ¶ 

type SearchRequest struct {
	Index []string

	Body io.Reader

	AllowNoIndices             *bool
	AllowPartialSearchResults  *bool
	Analyzer                   string
	AnalyzeWildcard            *bool
	BatchedReduceSize          *int
	CcsMinimizeRoundtrips      *bool
	DefaultOperator            string
	Df                         string
	DocvalueFields             []string
	ExpandWildcards            string
	Explain                    *bool
	ForceSyntheticSource       *bool
	From                       *int
	IgnoreThrottled            *bool
	IgnoreUnavailable          *bool
	IncludeNamedQueriesScore   *bool
	Lenient                    *bool
	MaxConcurrentShardRequests *int
	MinCompatibleShardNode     string
	Preference                 string
	PreFilterShardSize         *int
	Query                      string
	RequestCache               *bool
	RestTotalHitsAsInt         *bool
	Routing                    []string
	Scroll                     time.Duration
	SearchType                 string
	SeqNoPrimaryTerm           *bool
	Size                       *int
	Sort                       []string
	Source                     []string
	SourceExcludes             []string
	SourceIncludes             []string
	Stats                      []string
	StoredFields               []string
	SuggestField               string
	SuggestMode                string
	SuggestSize                *int
	SuggestText                string
	TerminateAfter             *int
	Timeout                    time.Duration
	TrackScores                *bool
	TrackTotalHits             interface{}
	TypedKeys                  *bool
	Version                    *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchRequest configures the Search API request.

func (SearchRequest) Do ¶ 

func (r SearchRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchShards ¶ 

type SearchShards func(o ...func(*SearchShardsRequest)) (*Response, error)

SearchShards returns information about the indices and shards that a search request would be executed against.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html.

func (SearchShards) WithAllowNoIndices ¶ 

func (f SearchShards) WithAllowNoIndices(v bool) func(*SearchShardsRequest)

WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).

func (SearchShards) WithContext ¶ 

func (f SearchShards) WithContext(v context.Context) func(*SearchShardsRequest)

WithContext sets the request context.

func (SearchShards) WithErrorTrace ¶ 

func (f SearchShards) WithErrorTrace() func(*SearchShardsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchShards) WithExpandWildcards ¶ 

func (f SearchShards) WithExpandWildcards(v string) func(*SearchShardsRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (SearchShards) WithFilterPath ¶ 

func (f SearchShards) WithFilterPath(v ...string) func(*SearchShardsRequest)

WithFilterPath filters the properties of the response body.

func (SearchShards) WithHeader ¶ 

func (f SearchShards) WithHeader(h map[string]string) func(*SearchShardsRequest)

WithHeader adds the headers to the HTTP request.

func (SearchShards) WithHuman ¶ 

func (f SearchShards) WithHuman() func(*SearchShardsRequest)

WithHuman makes statistical values human-readable.

func (SearchShards) WithIgnoreUnavailable ¶ 

func (f SearchShards) WithIgnoreUnavailable(v bool) func(*SearchShardsRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (SearchShards) WithIndex ¶ 

func (f SearchShards) WithIndex(v ...string) func(*SearchShardsRequest)

WithIndex - a list of index names to search; use _all to perform the operation on all indices.

func (SearchShards) WithLocal ¶ 

func (f SearchShards) WithLocal(v bool) func(*SearchShardsRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (SearchShards) WithMasterTimeout ¶ added in v8.16.0 

func (f SearchShards) WithMasterTimeout(v time.Duration) func(*SearchShardsRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SearchShards) WithOpaqueID ¶ 

func (f SearchShards) WithOpaqueID(s string) func(*SearchShardsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchShards) WithPreference ¶ 

func (f SearchShards) WithPreference(v string) func(*SearchShardsRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (SearchShards) WithPretty ¶ 

func (f SearchShards) WithPretty() func(*SearchShardsRequest)

WithPretty makes the response body pretty-printed.

func (SearchShards) WithRouting ¶ 

func (f SearchShards) WithRouting(v string) func(*SearchShardsRequest)

WithRouting - specific routing value.

type SearchShardsRequest ¶ 

type SearchShardsRequest struct {
	Index []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *bool
	Local             *bool
	MasterTimeout     time.Duration
	Preference        string
	Routing           string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchShardsRequest configures the Search Shards API request.

func (SearchShardsRequest) Do ¶ 

func (r SearchShardsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchTemplate ¶ 

type SearchTemplate func(body io.Reader, o ...func(*SearchTemplateRequest)) (*Response, error)

SearchTemplate allows to use the Mustache language to pre-render a search definition.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html.

func (SearchTemplate) WithAllowNoIndices ¶ 

func (f SearchTemplate) WithAllowNoIndices(v bool) func(*SearchTemplateRequest)

WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).

func (SearchTemplate) WithCcsMinimizeRoundtrips ¶ 

func (f SearchTemplate) WithCcsMinimizeRoundtrips(v bool) func(*SearchTemplateRequest)

WithCcsMinimizeRoundtrips - indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.

func (SearchTemplate) WithContext ¶ 

func (f SearchTemplate) WithContext(v context.Context) func(*SearchTemplateRequest)

WithContext sets the request context.

func (SearchTemplate) WithErrorTrace ¶ 

func (f SearchTemplate) WithErrorTrace() func(*SearchTemplateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchTemplate) WithExpandWildcards ¶ 

func (f SearchTemplate) WithExpandWildcards(v string) func(*SearchTemplateRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (SearchTemplate) WithExplain ¶ 

func (f SearchTemplate) WithExplain(v bool) func(*SearchTemplateRequest)

WithExplain - specify whether to return detailed information about score computation as part of a hit.

func (SearchTemplate) WithFilterPath ¶ 

func (f SearchTemplate) WithFilterPath(v ...string) func(*SearchTemplateRequest)

WithFilterPath filters the properties of the response body.

func (SearchTemplate) WithHeader ¶ 

func (f SearchTemplate) WithHeader(h map[string]string) func(*SearchTemplateRequest)

WithHeader adds the headers to the HTTP request.

func (SearchTemplate) WithHuman ¶ 

func (f SearchTemplate) WithHuman() func(*SearchTemplateRequest)

WithHuman makes statistical values human-readable.

func (SearchTemplate) WithIgnoreThrottled ¶ 

func (f SearchTemplate) WithIgnoreThrottled(v bool) func(*SearchTemplateRequest)

WithIgnoreThrottled - whether specified concrete, expanded or aliased indices should be ignored when throttled.

func (SearchTemplate) WithIgnoreUnavailable ¶ 

func (f SearchTemplate) WithIgnoreUnavailable(v bool) func(*SearchTemplateRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (SearchTemplate) WithIndex ¶ 

func (f SearchTemplate) WithIndex(v ...string) func(*SearchTemplateRequest)

WithIndex - a list of index names to search; use _all to perform the operation on all indices.

func (SearchTemplate) WithOpaqueID ¶ 

func (f SearchTemplate) WithOpaqueID(s string) func(*SearchTemplateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchTemplate) WithPreference ¶ 

func (f SearchTemplate) WithPreference(v string) func(*SearchTemplateRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (SearchTemplate) WithPretty ¶ 

func (f SearchTemplate) WithPretty() func(*SearchTemplateRequest)

WithPretty makes the response body pretty-printed.

func (SearchTemplate) WithProfile ¶ 

func (f SearchTemplate) WithProfile(v bool) func(*SearchTemplateRequest)

WithProfile - specify whether to profile the query execution.

func (SearchTemplate) WithRestTotalHitsAsInt ¶ 

func (f SearchTemplate) WithRestTotalHitsAsInt(v bool) func(*SearchTemplateRequest)

WithRestTotalHitsAsInt - indicates whether hits.total should be rendered as an integer or an object in the rest search response.

func (SearchTemplate) WithRouting ¶ 

func (f SearchTemplate) WithRouting(v ...string) func(*SearchTemplateRequest)

WithRouting - a list of specific routing values.

func (SearchTemplate) WithScroll ¶ 

func (f SearchTemplate) WithScroll(v time.Duration) func(*SearchTemplateRequest)

WithScroll - specify how long a consistent view of the index should be maintained for scrolled search.

func (SearchTemplate) WithSearchType ¶ 

func (f SearchTemplate) WithSearchType(v string) func(*SearchTemplateRequest)

WithSearchType - search operation type.

func (SearchTemplate) WithTypedKeys ¶ 

func (f SearchTemplate) WithTypedKeys(v bool) func(*SearchTemplateRequest)

WithTypedKeys - specify whether aggregation and suggester names should be prefixed by their respective types in the response.

type SearchTemplateRequest ¶ 

type SearchTemplateRequest struct {
	Index []string

	Body io.Reader

	AllowNoIndices        *bool
	CcsMinimizeRoundtrips *bool
	ExpandWildcards       string
	Explain               *bool
	IgnoreThrottled       *bool
	IgnoreUnavailable     *bool
	Preference            string
	Profile               *bool
	RestTotalHitsAsInt    *bool
	Routing               []string
	Scroll                time.Duration
	SearchType            string
	TypedKeys             *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchTemplateRequest configures the Search Template API request.

func (SearchTemplateRequest) Do ¶ 

func (r SearchTemplateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchableSnapshotsCacheStats ¶ 

type SearchableSnapshotsCacheStats func(o ...func(*SearchableSnapshotsCacheStatsRequest)) (*Response, error)

SearchableSnapshotsCacheStats - Retrieve node-level cache statistics about searchable snapshots.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html.

func (SearchableSnapshotsCacheStats) WithContext ¶ 

func (f SearchableSnapshotsCacheStats) WithContext(v context.Context) func(*SearchableSnapshotsCacheStatsRequest)

WithContext sets the request context.

func (SearchableSnapshotsCacheStats) WithErrorTrace ¶ 

func (f SearchableSnapshotsCacheStats) WithErrorTrace() func(*SearchableSnapshotsCacheStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchableSnapshotsCacheStats) WithFilterPath ¶ 

func (f SearchableSnapshotsCacheStats) WithFilterPath(v ...string) func(*SearchableSnapshotsCacheStatsRequest)

WithFilterPath filters the properties of the response body.

func (SearchableSnapshotsCacheStats) WithHeader ¶ 

func (f SearchableSnapshotsCacheStats) WithHeader(h map[string]string) func(*SearchableSnapshotsCacheStatsRequest)

WithHeader adds the headers to the HTTP request.

func (SearchableSnapshotsCacheStats) WithHuman ¶ 

func (f SearchableSnapshotsCacheStats) WithHuman() func(*SearchableSnapshotsCacheStatsRequest)

WithHuman makes statistical values human-readable.

func (SearchableSnapshotsCacheStats) WithNodeID ¶ 

func (f SearchableSnapshotsCacheStats) WithNodeID(v ...string) func(*SearchableSnapshotsCacheStatsRequest)

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 (SearchableSnapshotsCacheStats) WithOpaqueID ¶ 

func (f SearchableSnapshotsCacheStats) WithOpaqueID(s string) func(*SearchableSnapshotsCacheStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchableSnapshotsCacheStats) WithPretty ¶ 

func (f SearchableSnapshotsCacheStats) WithPretty() func(*SearchableSnapshotsCacheStatsRequest)

WithPretty makes the response body pretty-printed.

type SearchableSnapshotsCacheStatsRequest ¶ 

type SearchableSnapshotsCacheStatsRequest struct {
	NodeID []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchableSnapshotsCacheStatsRequest configures the Searchable Snapshots Cache Stats API request.

func (SearchableSnapshotsCacheStatsRequest) Do ¶ 

func (r SearchableSnapshotsCacheStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchableSnapshotsClearCache ¶ 

type SearchableSnapshotsClearCache func(o ...func(*SearchableSnapshotsClearCacheRequest)) (*Response, error)

SearchableSnapshotsClearCache - Clear the cache of searchable snapshots.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html.

func (SearchableSnapshotsClearCache) WithAllowNoIndices ¶ 

func (f SearchableSnapshotsClearCache) WithAllowNoIndices(v bool) func(*SearchableSnapshotsClearCacheRequest)

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 (SearchableSnapshotsClearCache) WithContext ¶ 

func (f SearchableSnapshotsClearCache) WithContext(v context.Context) func(*SearchableSnapshotsClearCacheRequest)

WithContext sets the request context.

func (SearchableSnapshotsClearCache) WithErrorTrace ¶ 

func (f SearchableSnapshotsClearCache) WithErrorTrace() func(*SearchableSnapshotsClearCacheRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchableSnapshotsClearCache) WithExpandWildcards ¶ 

func (f SearchableSnapshotsClearCache) WithExpandWildcards(v string) func(*SearchableSnapshotsClearCacheRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (SearchableSnapshotsClearCache) WithFilterPath ¶ 

func (f SearchableSnapshotsClearCache) WithFilterPath(v ...string) func(*SearchableSnapshotsClearCacheRequest)

WithFilterPath filters the properties of the response body.

func (SearchableSnapshotsClearCache) WithHeader ¶ 

func (f SearchableSnapshotsClearCache) WithHeader(h map[string]string) func(*SearchableSnapshotsClearCacheRequest)

WithHeader adds the headers to the HTTP request.

func (SearchableSnapshotsClearCache) WithHuman ¶ 

func (f SearchableSnapshotsClearCache) WithHuman() func(*SearchableSnapshotsClearCacheRequest)

WithHuman makes statistical values human-readable.

func (SearchableSnapshotsClearCache) WithIgnoreUnavailable ¶ 

func (f SearchableSnapshotsClearCache) WithIgnoreUnavailable(v bool) func(*SearchableSnapshotsClearCacheRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (SearchableSnapshotsClearCache) WithIndex ¶ 

func (f SearchableSnapshotsClearCache) WithIndex(v ...string) func(*SearchableSnapshotsClearCacheRequest)

WithIndex - a list of index names.

func (SearchableSnapshotsClearCache) WithOpaqueID ¶ 

func (f SearchableSnapshotsClearCache) WithOpaqueID(s string) func(*SearchableSnapshotsClearCacheRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchableSnapshotsClearCache) WithPretty ¶ 

func (f SearchableSnapshotsClearCache) WithPretty() func(*SearchableSnapshotsClearCacheRequest)

WithPretty makes the response body pretty-printed.

type SearchableSnapshotsClearCacheRequest ¶ 

type SearchableSnapshotsClearCacheRequest struct {
	Index []string

	AllowNoIndices    *bool
	ExpandWildcards   string
	IgnoreUnavailable *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchableSnapshotsClearCacheRequest configures the Searchable Snapshots Clear Cache API request.

func (SearchableSnapshotsClearCacheRequest) Do ¶ 

func (r SearchableSnapshotsClearCacheRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchableSnapshotsMount ¶ 

type SearchableSnapshotsMount func(repository string, snapshot string, body io.Reader, o ...func(*SearchableSnapshotsMountRequest)) (*Response, error)

SearchableSnapshotsMount - Mount a snapshot as a searchable index.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-api-mount-snapshot.html.

func (SearchableSnapshotsMount) WithContext ¶ 

func (f SearchableSnapshotsMount) WithContext(v context.Context) func(*SearchableSnapshotsMountRequest)

WithContext sets the request context.

func (SearchableSnapshotsMount) WithErrorTrace ¶ 

func (f SearchableSnapshotsMount) WithErrorTrace() func(*SearchableSnapshotsMountRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchableSnapshotsMount) WithFilterPath ¶ 

func (f SearchableSnapshotsMount) WithFilterPath(v ...string) func(*SearchableSnapshotsMountRequest)

WithFilterPath filters the properties of the response body.

func (SearchableSnapshotsMount) WithHeader ¶ 

func (f SearchableSnapshotsMount) WithHeader(h map[string]string) func(*SearchableSnapshotsMountRequest)

WithHeader adds the headers to the HTTP request.

func (SearchableSnapshotsMount) WithHuman ¶ 

func (f SearchableSnapshotsMount) WithHuman() func(*SearchableSnapshotsMountRequest)

WithHuman makes statistical values human-readable.

func (SearchableSnapshotsMount) WithMasterTimeout ¶ 

func (f SearchableSnapshotsMount) WithMasterTimeout(v time.Duration) func(*SearchableSnapshotsMountRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SearchableSnapshotsMount) WithOpaqueID ¶ 

func (f SearchableSnapshotsMount) WithOpaqueID(s string) func(*SearchableSnapshotsMountRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchableSnapshotsMount) WithPretty ¶ 

func (f SearchableSnapshotsMount) WithPretty() func(*SearchableSnapshotsMountRequest)

WithPretty makes the response body pretty-printed.

func (SearchableSnapshotsMount) WithStorage ¶ 

func (f SearchableSnapshotsMount) WithStorage(v string) func(*SearchableSnapshotsMountRequest)

WithStorage - selects the kind of local storage used to accelerate searches. experimental, and defaults to `full_copy`.

func (SearchableSnapshotsMount) WithWaitForCompletion ¶ 

func (f SearchableSnapshotsMount) WithWaitForCompletion(v bool) func(*SearchableSnapshotsMountRequest)

WithWaitForCompletion - should this request wait until the operation has completed before returning.

type SearchableSnapshotsMountRequest ¶ 

type SearchableSnapshotsMountRequest struct {
	Body io.Reader

	Repository string
	Snapshot   string

	MasterTimeout     time.Duration
	Storage           string
	WaitForCompletion *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchableSnapshotsMountRequest configures the Searchable Snapshots Mount API request.

func (SearchableSnapshotsMountRequest) Do ¶ 

func (r SearchableSnapshotsMountRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SearchableSnapshotsStats ¶ 

type SearchableSnapshotsStats func(o ...func(*SearchableSnapshotsStatsRequest)) (*Response, error)

SearchableSnapshotsStats - Retrieve shard-level statistics about searchable snapshots.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html.

func (SearchableSnapshotsStats) WithContext ¶ 

func (f SearchableSnapshotsStats) WithContext(v context.Context) func(*SearchableSnapshotsStatsRequest)

WithContext sets the request context.

func (SearchableSnapshotsStats) WithErrorTrace ¶ 

func (f SearchableSnapshotsStats) WithErrorTrace() func(*SearchableSnapshotsStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SearchableSnapshotsStats) WithFilterPath ¶ 

func (f SearchableSnapshotsStats) WithFilterPath(v ...string) func(*SearchableSnapshotsStatsRequest)

WithFilterPath filters the properties of the response body.

func (SearchableSnapshotsStats) WithHeader ¶ 

func (f SearchableSnapshotsStats) WithHeader(h map[string]string) func(*SearchableSnapshotsStatsRequest)

WithHeader adds the headers to the HTTP request.

func (SearchableSnapshotsStats) WithHuman ¶ 

func (f SearchableSnapshotsStats) WithHuman() func(*SearchableSnapshotsStatsRequest)

WithHuman makes statistical values human-readable.

func (SearchableSnapshotsStats) WithIndex ¶ 

func (f SearchableSnapshotsStats) WithIndex(v ...string) func(*SearchableSnapshotsStatsRequest)

WithIndex - a list of index names.

func (SearchableSnapshotsStats) WithLevel ¶ 

func (f SearchableSnapshotsStats) WithLevel(v string) func(*SearchableSnapshotsStatsRequest)

WithLevel - return stats aggregated at cluster, index or shard level.

func (SearchableSnapshotsStats) WithOpaqueID ¶ 

func (f SearchableSnapshotsStats) WithOpaqueID(s string) func(*SearchableSnapshotsStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SearchableSnapshotsStats) WithPretty ¶ 

func (f SearchableSnapshotsStats) WithPretty() func(*SearchableSnapshotsStatsRequest)

WithPretty makes the response body pretty-printed.

type SearchableSnapshotsStatsRequest ¶ 

type SearchableSnapshotsStatsRequest struct {
	Index []string

	Level string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SearchableSnapshotsStatsRequest configures the Searchable Snapshots Stats API request.

func (SearchableSnapshotsStatsRequest) Do ¶ 

func (r SearchableSnapshotsStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Security ¶ 

type Security struct {
	ActivateUserProfile         SecurityActivateUserProfile
	Authenticate                SecurityAuthenticate
	BulkDeleteRole              SecurityBulkDeleteRole
	BulkPutRole                 SecurityBulkPutRole
	BulkUpdateAPIKeys           SecurityBulkUpdateAPIKeys
	ChangePassword              SecurityChangePassword
	ClearAPIKeyCache            SecurityClearAPIKeyCache
	ClearCachedPrivileges       SecurityClearCachedPrivileges
	ClearCachedRealms           SecurityClearCachedRealms
	ClearCachedRoles            SecurityClearCachedRoles
	ClearCachedServiceTokens    SecurityClearCachedServiceTokens
	CreateAPIKey                SecurityCreateAPIKey
	CreateCrossClusterAPIKey    SecurityCreateCrossClusterAPIKey
	CreateServiceToken          SecurityCreateServiceToken
	DelegatePki                 SecurityDelegatePki
	DeletePrivileges            SecurityDeletePrivileges
	DeleteRoleMapping           SecurityDeleteRoleMapping
	DeleteRole                  SecurityDeleteRole
	DeleteServiceToken          SecurityDeleteServiceToken
	DeleteUser                  SecurityDeleteUser
	DisableUserProfile          SecurityDisableUserProfile
	DisableUser                 SecurityDisableUser
	EnableUserProfile           SecurityEnableUserProfile
	EnableUser                  SecurityEnableUser
	EnrollKibana                SecurityEnrollKibana
	EnrollNode                  SecurityEnrollNode
	GetAPIKey                   SecurityGetAPIKey
	GetBuiltinPrivileges        SecurityGetBuiltinPrivileges
	GetPrivileges               SecurityGetPrivileges
	GetRoleMapping              SecurityGetRoleMapping
	GetRole                     SecurityGetRole
	GetServiceAccounts          SecurityGetServiceAccounts
	GetServiceCredentials       SecurityGetServiceCredentials
	GetSettings                 SecurityGetSettings
	GetToken                    SecurityGetToken
	GetUserPrivileges           SecurityGetUserPrivileges
	GetUserProfile              SecurityGetUserProfile
	GetUser                     SecurityGetUser
	GrantAPIKey                 SecurityGrantAPIKey
	HasPrivileges               SecurityHasPrivileges
	HasPrivilegesUserProfile    SecurityHasPrivilegesUserProfile
	InvalidateAPIKey            SecurityInvalidateAPIKey
	InvalidateToken             SecurityInvalidateToken
	OidcAuthenticate            SecurityOidcAuthenticate
	OidcLogout                  SecurityOidcLogout
	OidcPrepareAuthentication   SecurityOidcPrepareAuthentication
	PutPrivileges               SecurityPutPrivileges
	PutRoleMapping              SecurityPutRoleMapping
	PutRole                     SecurityPutRole
	PutUser                     SecurityPutUser
	QueryAPIKeys                SecurityQueryAPIKeys
	QueryRole                   SecurityQueryRole
	QueryUser                   SecurityQueryUser
	SamlAuthenticate            SecuritySamlAuthenticate
	SamlCompleteLogout          SecuritySamlCompleteLogout
	SamlInvalidate              SecuritySamlInvalidate
	SamlLogout                  SecuritySamlLogout
	SamlPrepareAuthentication   SecuritySamlPrepareAuthentication
	SamlServiceProviderMetadata SecuritySamlServiceProviderMetadata
	SuggestUserProfiles         SecuritySuggestUserProfiles
	UpdateAPIKey                SecurityUpdateAPIKey
	UpdateCrossClusterAPIKey    SecurityUpdateCrossClusterAPIKey
	UpdateSettings              SecurityUpdateSettings
	UpdateUserProfileData       SecurityUpdateUserProfileData
}

Security contains the Security APIs

type SecurityActivateUserProfile ¶ added in v8.2.0 

type SecurityActivateUserProfile func(body io.Reader, o ...func(*SecurityActivateUserProfileRequest)) (*Response, error)

SecurityActivateUserProfile - Creates or updates the user profile on behalf of another user.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-activate-user-profile.html.

func (SecurityActivateUserProfile) WithContext ¶ added in v8.2.0 

func (f SecurityActivateUserProfile) WithContext(v context.Context) func(*SecurityActivateUserProfileRequest)

WithContext sets the request context.

func (SecurityActivateUserProfile) WithErrorTrace ¶ added in v8.2.0 

func (f SecurityActivateUserProfile) WithErrorTrace() func(*SecurityActivateUserProfileRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityActivateUserProfile) WithFilterPath ¶ added in v8.2.0 

func (f SecurityActivateUserProfile) WithFilterPath(v ...string) func(*SecurityActivateUserProfileRequest)

WithFilterPath filters the properties of the response body.

func (SecurityActivateUserProfile) WithHeader ¶ added in v8.2.0 

func (f SecurityActivateUserProfile) WithHeader(h map[string]string) func(*SecurityActivateUserProfileRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityActivateUserProfile) WithHuman ¶ added in v8.2.0 

func (f SecurityActivateUserProfile) WithHuman() func(*SecurityActivateUserProfileRequest)

WithHuman makes statistical values human-readable.

func (SecurityActivateUserProfile) WithOpaqueID ¶ added in v8.2.0 

func (f SecurityActivateUserProfile) WithOpaqueID(s string) func(*SecurityActivateUserProfileRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityActivateUserProfile) WithPretty ¶ added in v8.2.0 

func (f SecurityActivateUserProfile) WithPretty() func(*SecurityActivateUserProfileRequest)

WithPretty makes the response body pretty-printed.

type SecurityActivateUserProfileRequest ¶ added in v8.2.0 

type SecurityActivateUserProfileRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityActivateUserProfileRequest configures the Security Activate User Profile API request.

func (SecurityActivateUserProfileRequest) Do ¶ added in v8.2.0 

func (r SecurityActivateUserProfileRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityAuthenticate ¶ 

type SecurityAuthenticate func(o ...func(*SecurityAuthenticateRequest)) (*Response, error)

SecurityAuthenticate - Enables authentication as a user and retrieve information about the authenticated user.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html.

func (SecurityAuthenticate) WithContext ¶ 

func (f SecurityAuthenticate) WithContext(v context.Context) func(*SecurityAuthenticateRequest)

WithContext sets the request context.

func (SecurityAuthenticate) WithErrorTrace ¶ 

func (f SecurityAuthenticate) WithErrorTrace() func(*SecurityAuthenticateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityAuthenticate) WithFilterPath ¶ 

func (f SecurityAuthenticate) WithFilterPath(v ...string) func(*SecurityAuthenticateRequest)

WithFilterPath filters the properties of the response body.

func (SecurityAuthenticate) WithHeader ¶ 

func (f SecurityAuthenticate) WithHeader(h map[string]string) func(*SecurityAuthenticateRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityAuthenticate) WithHuman ¶ 

func (f SecurityAuthenticate) WithHuman() func(*SecurityAuthenticateRequest)

WithHuman makes statistical values human-readable.

func (SecurityAuthenticate) WithOpaqueID ¶ 

func (f SecurityAuthenticate) WithOpaqueID(s string) func(*SecurityAuthenticateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityAuthenticate) WithPretty ¶ 

func (f SecurityAuthenticate) WithPretty() func(*SecurityAuthenticateRequest)

WithPretty makes the response body pretty-printed.

type SecurityAuthenticateRequest ¶ 

type SecurityAuthenticateRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityAuthenticateRequest configures the Security Authenticate API request.

func (SecurityAuthenticateRequest) Do ¶ 

func (r SecurityAuthenticateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityBulkDeleteRole ¶ added in v8.15.0 

type SecurityBulkDeleteRole func(body io.Reader, o ...func(*SecurityBulkDeleteRoleRequest)) (*Response, error)

SecurityBulkDeleteRole - Bulk delete roles in the native realm.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-delete-role.html.

func (SecurityBulkDeleteRole) WithContext ¶ added in v8.15.0 

func (f SecurityBulkDeleteRole) WithContext(v context.Context) func(*SecurityBulkDeleteRoleRequest)

WithContext sets the request context.

func (SecurityBulkDeleteRole) WithErrorTrace ¶ added in v8.15.0 

func (f SecurityBulkDeleteRole) WithErrorTrace() func(*SecurityBulkDeleteRoleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityBulkDeleteRole) WithFilterPath ¶ added in v8.15.0 

func (f SecurityBulkDeleteRole) WithFilterPath(v ...string) func(*SecurityBulkDeleteRoleRequest)

WithFilterPath filters the properties of the response body.

func (SecurityBulkDeleteRole) WithHeader ¶ added in v8.15.0 

func (f SecurityBulkDeleteRole) WithHeader(h map[string]string) func(*SecurityBulkDeleteRoleRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityBulkDeleteRole) WithHuman ¶ added in v8.15.0 

func (f SecurityBulkDeleteRole) WithHuman() func(*SecurityBulkDeleteRoleRequest)

WithHuman makes statistical values human-readable.

func (SecurityBulkDeleteRole) WithOpaqueID ¶ added in v8.15.0 

func (f SecurityBulkDeleteRole) WithOpaqueID(s string) func(*SecurityBulkDeleteRoleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityBulkDeleteRole) WithPretty ¶ added in v8.15.0 

func (f SecurityBulkDeleteRole) WithPretty() func(*SecurityBulkDeleteRoleRequest)

WithPretty makes the response body pretty-printed.

func (SecurityBulkDeleteRole) WithRefresh ¶ added in v8.15.0 

func (f SecurityBulkDeleteRole) WithRefresh(v string) func(*SecurityBulkDeleteRoleRequest)

WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityBulkDeleteRoleRequest ¶ added in v8.15.0 

type SecurityBulkDeleteRoleRequest struct {
	Body io.Reader

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityBulkDeleteRoleRequest configures the Security Bulk Delete Role API request.

func (SecurityBulkDeleteRoleRequest) Do ¶ added in v8.15.0 

func (r SecurityBulkDeleteRoleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityBulkPutRole ¶ added in v8.15.0 

type SecurityBulkPutRole func(body io.Reader, o ...func(*SecurityBulkPutRoleRequest)) (*Response, error)

SecurityBulkPutRole - Bulk adds and updates roles in the native realm.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-put-role.html.

func (SecurityBulkPutRole) WithContext ¶ added in v8.15.0 

func (f SecurityBulkPutRole) WithContext(v context.Context) func(*SecurityBulkPutRoleRequest)

WithContext sets the request context.

func (SecurityBulkPutRole) WithErrorTrace ¶ added in v8.15.0 

func (f SecurityBulkPutRole) WithErrorTrace() func(*SecurityBulkPutRoleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityBulkPutRole) WithFilterPath ¶ added in v8.15.0 

func (f SecurityBulkPutRole) WithFilterPath(v ...string) func(*SecurityBulkPutRoleRequest)

WithFilterPath filters the properties of the response body.

func (SecurityBulkPutRole) WithHeader ¶ added in v8.15.0 

func (f SecurityBulkPutRole) WithHeader(h map[string]string) func(*SecurityBulkPutRoleRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityBulkPutRole) WithHuman ¶ added in v8.15.0 

func (f SecurityBulkPutRole) WithHuman() func(*SecurityBulkPutRoleRequest)

WithHuman makes statistical values human-readable.

func (SecurityBulkPutRole) WithOpaqueID ¶ added in v8.15.0 

func (f SecurityBulkPutRole) WithOpaqueID(s string) func(*SecurityBulkPutRoleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityBulkPutRole) WithPretty ¶ added in v8.15.0 

func (f SecurityBulkPutRole) WithPretty() func(*SecurityBulkPutRoleRequest)

WithPretty makes the response body pretty-printed.

func (SecurityBulkPutRole) WithRefresh ¶ added in v8.15.0 

func (f SecurityBulkPutRole) WithRefresh(v string) func(*SecurityBulkPutRoleRequest)

WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityBulkPutRoleRequest ¶ added in v8.15.0 

type SecurityBulkPutRoleRequest struct {
	Body io.Reader

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityBulkPutRoleRequest configures the Security Bulk Put Role API request.

func (SecurityBulkPutRoleRequest) Do ¶ added in v8.15.0 

func (r SecurityBulkPutRoleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityBulkUpdateAPIKeys ¶ added in v8.5.0 

type SecurityBulkUpdateAPIKeys func(body io.Reader, o ...func(*SecurityBulkUpdateAPIKeysRequest)) (*Response, error)

SecurityBulkUpdateAPIKeys - Updates the attributes of multiple existing API keys.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-update-api-keys.html.

func (SecurityBulkUpdateAPIKeys) WithContext ¶ added in v8.5.0 

func (f SecurityBulkUpdateAPIKeys) WithContext(v context.Context) func(*SecurityBulkUpdateAPIKeysRequest)

WithContext sets the request context.

func (SecurityBulkUpdateAPIKeys) WithErrorTrace ¶ added in v8.5.0 

func (f SecurityBulkUpdateAPIKeys) WithErrorTrace() func(*SecurityBulkUpdateAPIKeysRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityBulkUpdateAPIKeys) WithFilterPath ¶ added in v8.5.0 

func (f SecurityBulkUpdateAPIKeys) WithFilterPath(v ...string) func(*SecurityBulkUpdateAPIKeysRequest)

WithFilterPath filters the properties of the response body.

func (SecurityBulkUpdateAPIKeys) WithHeader ¶ added in v8.5.0 

func (f SecurityBulkUpdateAPIKeys) WithHeader(h map[string]string) func(*SecurityBulkUpdateAPIKeysRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityBulkUpdateAPIKeys) WithHuman ¶ added in v8.5.0 

func (f SecurityBulkUpdateAPIKeys) WithHuman() func(*SecurityBulkUpdateAPIKeysRequest)

WithHuman makes statistical values human-readable.

func (SecurityBulkUpdateAPIKeys) WithOpaqueID ¶ added in v8.5.0 

func (f SecurityBulkUpdateAPIKeys) WithOpaqueID(s string) func(*SecurityBulkUpdateAPIKeysRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityBulkUpdateAPIKeys) WithPretty ¶ added in v8.5.0 

func (f SecurityBulkUpdateAPIKeys) WithPretty() func(*SecurityBulkUpdateAPIKeysRequest)

WithPretty makes the response body pretty-printed.

type SecurityBulkUpdateAPIKeysRequest ¶ added in v8.5.0 

type SecurityBulkUpdateAPIKeysRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityBulkUpdateAPIKeysRequest configures the Security Bulk UpdateAPI Keys API request.

func (SecurityBulkUpdateAPIKeysRequest) Do ¶ added in v8.5.0 

func (r SecurityBulkUpdateAPIKeysRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityChangePassword ¶ 

type SecurityChangePassword func(body io.Reader, o ...func(*SecurityChangePasswordRequest)) (*Response, error)

SecurityChangePassword - Changes the passwords of users in the native realm and built-in users.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html.

func (SecurityChangePassword) WithContext ¶ 

func (f SecurityChangePassword) WithContext(v context.Context) func(*SecurityChangePasswordRequest)

WithContext sets the request context.

func (SecurityChangePassword) WithErrorTrace ¶ 

func (f SecurityChangePassword) WithErrorTrace() func(*SecurityChangePasswordRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityChangePassword) WithFilterPath ¶ 

func (f SecurityChangePassword) WithFilterPath(v ...string) func(*SecurityChangePasswordRequest)

WithFilterPath filters the properties of the response body.

func (SecurityChangePassword) WithHeader ¶ 

func (f SecurityChangePassword) WithHeader(h map[string]string) func(*SecurityChangePasswordRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityChangePassword) WithHuman ¶ 

func (f SecurityChangePassword) WithHuman() func(*SecurityChangePasswordRequest)

WithHuman makes statistical values human-readable.

func (SecurityChangePassword) WithOpaqueID ¶ 

func (f SecurityChangePassword) WithOpaqueID(s string) func(*SecurityChangePasswordRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityChangePassword) WithPretty ¶ 

func (f SecurityChangePassword) WithPretty() func(*SecurityChangePasswordRequest)

WithPretty makes the response body pretty-printed.

func (SecurityChangePassword) WithRefresh ¶ 

func (f SecurityChangePassword) WithRefresh(v string) func(*SecurityChangePasswordRequest)

WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

func (SecurityChangePassword) WithUsername ¶ 

func (f SecurityChangePassword) WithUsername(v string) func(*SecurityChangePasswordRequest)

WithUsername - the username of the user to change the password for.

type SecurityChangePasswordRequest ¶ 

type SecurityChangePasswordRequest struct {
	Body io.Reader

	Username string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityChangePasswordRequest configures the Security Change Password API request.

func (SecurityChangePasswordRequest) Do ¶ 

func (r SecurityChangePasswordRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityClearAPIKeyCache ¶ 

type SecurityClearAPIKeyCache func(ids []string, o ...func(*SecurityClearAPIKeyCacheRequest)) (*Response, error)

SecurityClearAPIKeyCache - Clear a subset or all entries from the API key cache.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html.

func (SecurityClearAPIKeyCache) WithContext ¶ 

func (f SecurityClearAPIKeyCache) WithContext(v context.Context) func(*SecurityClearAPIKeyCacheRequest)

WithContext sets the request context.

func (SecurityClearAPIKeyCache) WithErrorTrace ¶ 

func (f SecurityClearAPIKeyCache) WithErrorTrace() func(*SecurityClearAPIKeyCacheRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityClearAPIKeyCache) WithFilterPath ¶ 

func (f SecurityClearAPIKeyCache) WithFilterPath(v ...string) func(*SecurityClearAPIKeyCacheRequest)

WithFilterPath filters the properties of the response body.

func (SecurityClearAPIKeyCache) WithHeader ¶ 

func (f SecurityClearAPIKeyCache) WithHeader(h map[string]string) func(*SecurityClearAPIKeyCacheRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityClearAPIKeyCache) WithHuman ¶ 

func (f SecurityClearAPIKeyCache) WithHuman() func(*SecurityClearAPIKeyCacheRequest)

WithHuman makes statistical values human-readable.

func (SecurityClearAPIKeyCache) WithOpaqueID ¶ 

func (f SecurityClearAPIKeyCache) WithOpaqueID(s string) func(*SecurityClearAPIKeyCacheRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityClearAPIKeyCache) WithPretty ¶ 

func (f SecurityClearAPIKeyCache) WithPretty() func(*SecurityClearAPIKeyCacheRequest)

WithPretty makes the response body pretty-printed.

type SecurityClearAPIKeyCacheRequest ¶ 

type SecurityClearAPIKeyCacheRequest struct {
	Ids []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityClearAPIKeyCacheRequest configures the Security ClearAPI Key Cache API request.

func (SecurityClearAPIKeyCacheRequest) Do ¶ 

func (r SecurityClearAPIKeyCacheRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityClearCachedPrivileges ¶ 

type SecurityClearCachedPrivileges func(application []string, o ...func(*SecurityClearCachedPrivilegesRequest)) (*Response, error)

SecurityClearCachedPrivileges - Evicts application privileges from the native application privileges cache.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html.

func (SecurityClearCachedPrivileges) WithContext ¶ 

func (f SecurityClearCachedPrivileges) WithContext(v context.Context) func(*SecurityClearCachedPrivilegesRequest)

WithContext sets the request context.

func (SecurityClearCachedPrivileges) WithErrorTrace ¶ 

func (f SecurityClearCachedPrivileges) WithErrorTrace() func(*SecurityClearCachedPrivilegesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityClearCachedPrivileges) WithFilterPath ¶ 

func (f SecurityClearCachedPrivileges) WithFilterPath(v ...string) func(*SecurityClearCachedPrivilegesRequest)

WithFilterPath filters the properties of the response body.

func (SecurityClearCachedPrivileges) WithHeader ¶ 

func (f SecurityClearCachedPrivileges) WithHeader(h map[string]string) func(*SecurityClearCachedPrivilegesRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityClearCachedPrivileges) WithHuman ¶ 

func (f SecurityClearCachedPrivileges) WithHuman() func(*SecurityClearCachedPrivilegesRequest)

WithHuman makes statistical values human-readable.

func (SecurityClearCachedPrivileges) WithOpaqueID ¶ 

func (f SecurityClearCachedPrivileges) WithOpaqueID(s string) func(*SecurityClearCachedPrivilegesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityClearCachedPrivileges) WithPretty ¶ 

func (f SecurityClearCachedPrivileges) WithPretty() func(*SecurityClearCachedPrivilegesRequest)

WithPretty makes the response body pretty-printed.

type SecurityClearCachedPrivilegesRequest ¶ 

type SecurityClearCachedPrivilegesRequest struct {
	Application []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityClearCachedPrivilegesRequest configures the Security Clear Cached Privileges API request.

func (SecurityClearCachedPrivilegesRequest) Do ¶ 

func (r SecurityClearCachedPrivilegesRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityClearCachedRealms ¶ 

type SecurityClearCachedRealms func(realms []string, o ...func(*SecurityClearCachedRealmsRequest)) (*Response, error)

SecurityClearCachedRealms - Evicts users from the user cache. Can completely clear the cache or evict specific users.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html.

func (SecurityClearCachedRealms) WithContext ¶ 

func (f SecurityClearCachedRealms) WithContext(v context.Context) func(*SecurityClearCachedRealmsRequest)

WithContext sets the request context.

func (SecurityClearCachedRealms) WithErrorTrace ¶ 

func (f SecurityClearCachedRealms) WithErrorTrace() func(*SecurityClearCachedRealmsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityClearCachedRealms) WithFilterPath ¶ 

func (f SecurityClearCachedRealms) WithFilterPath(v ...string) func(*SecurityClearCachedRealmsRequest)

WithFilterPath filters the properties of the response body.

func (SecurityClearCachedRealms) WithHeader ¶ 

func (f SecurityClearCachedRealms) WithHeader(h map[string]string) func(*SecurityClearCachedRealmsRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityClearCachedRealms) WithHuman ¶ 

func (f SecurityClearCachedRealms) WithHuman() func(*SecurityClearCachedRealmsRequest)

WithHuman makes statistical values human-readable.

func (SecurityClearCachedRealms) WithOpaqueID ¶ 

func (f SecurityClearCachedRealms) WithOpaqueID(s string) func(*SecurityClearCachedRealmsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityClearCachedRealms) WithPretty ¶ 

func (f SecurityClearCachedRealms) WithPretty() func(*SecurityClearCachedRealmsRequest)

WithPretty makes the response body pretty-printed.

func (SecurityClearCachedRealms) WithUsernames ¶ 

func (f SecurityClearCachedRealms) WithUsernames(v ...string) func(*SecurityClearCachedRealmsRequest)

WithUsernames - comma-separated list of usernames to clear from the cache.

type SecurityClearCachedRealmsRequest ¶ 

type SecurityClearCachedRealmsRequest struct {
	Realms []string

	Usernames []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityClearCachedRealmsRequest configures the Security Clear Cached Realms API request.

func (SecurityClearCachedRealmsRequest) Do ¶ 

func (r SecurityClearCachedRealmsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityClearCachedRoles ¶ 

type SecurityClearCachedRoles func(name []string, o ...func(*SecurityClearCachedRolesRequest)) (*Response, error)

SecurityClearCachedRoles - Evicts roles from the native role cache.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html.

func (SecurityClearCachedRoles) WithContext ¶ 

func (f SecurityClearCachedRoles) WithContext(v context.Context) func(*SecurityClearCachedRolesRequest)

WithContext sets the request context.

func (SecurityClearCachedRoles) WithErrorTrace ¶ 

func (f SecurityClearCachedRoles) WithErrorTrace() func(*SecurityClearCachedRolesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityClearCachedRoles) WithFilterPath ¶ 

func (f SecurityClearCachedRoles) WithFilterPath(v ...string) func(*SecurityClearCachedRolesRequest)

WithFilterPath filters the properties of the response body.

func (SecurityClearCachedRoles) WithHeader ¶ 

func (f SecurityClearCachedRoles) WithHeader(h map[string]string) func(*SecurityClearCachedRolesRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityClearCachedRoles) WithHuman ¶ 

func (f SecurityClearCachedRoles) WithHuman() func(*SecurityClearCachedRolesRequest)

WithHuman makes statistical values human-readable.

func (SecurityClearCachedRoles) WithOpaqueID ¶ 

func (f SecurityClearCachedRoles) WithOpaqueID(s string) func(*SecurityClearCachedRolesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityClearCachedRoles) WithPretty ¶ 

func (f SecurityClearCachedRoles) WithPretty() func(*SecurityClearCachedRolesRequest)

WithPretty makes the response body pretty-printed.

type SecurityClearCachedRolesRequest ¶ 

type SecurityClearCachedRolesRequest struct {
	Name []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityClearCachedRolesRequest configures the Security Clear Cached Roles API request.

func (SecurityClearCachedRolesRequest) Do ¶ 

func (r SecurityClearCachedRolesRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityClearCachedServiceTokens ¶ 

type SecurityClearCachedServiceTokens func(name []string, namespace string, service string, o ...func(*SecurityClearCachedServiceTokensRequest)) (*Response, error)

SecurityClearCachedServiceTokens - Evicts tokens from the service account token caches.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html.

func (SecurityClearCachedServiceTokens) WithContext ¶ 

func (f SecurityClearCachedServiceTokens) WithContext(v context.Context) func(*SecurityClearCachedServiceTokensRequest)

WithContext sets the request context.

func (SecurityClearCachedServiceTokens) WithErrorTrace ¶ 

func (f SecurityClearCachedServiceTokens) WithErrorTrace() func(*SecurityClearCachedServiceTokensRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityClearCachedServiceTokens) WithFilterPath ¶ 

func (f SecurityClearCachedServiceTokens) WithFilterPath(v ...string) func(*SecurityClearCachedServiceTokensRequest)

WithFilterPath filters the properties of the response body.

func (SecurityClearCachedServiceTokens) WithHeader ¶ 

func (f SecurityClearCachedServiceTokens) WithHeader(h map[string]string) func(*SecurityClearCachedServiceTokensRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityClearCachedServiceTokens) WithHuman ¶ 

func (f SecurityClearCachedServiceTokens) WithHuman() func(*SecurityClearCachedServiceTokensRequest)

WithHuman makes statistical values human-readable.

func (SecurityClearCachedServiceTokens) WithOpaqueID ¶ 

func (f SecurityClearCachedServiceTokens) WithOpaqueID(s string) func(*SecurityClearCachedServiceTokensRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityClearCachedServiceTokens) WithPretty ¶ 

func (f SecurityClearCachedServiceTokens) WithPretty() func(*SecurityClearCachedServiceTokensRequest)

WithPretty makes the response body pretty-printed.

type SecurityClearCachedServiceTokensRequest ¶ 

type SecurityClearCachedServiceTokensRequest struct {
	Name      []string
	Namespace string
	Service   string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityClearCachedServiceTokensRequest configures the Security Clear Cached Service Tokens API request.

func (SecurityClearCachedServiceTokensRequest) Do ¶ 

func (r SecurityClearCachedServiceTokensRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityCreateAPIKey ¶ 

type SecurityCreateAPIKey func(body io.Reader, o ...func(*SecurityCreateAPIKeyRequest)) (*Response, error)

SecurityCreateAPIKey - Creates an API key for access without requiring basic authentication.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html.

func (SecurityCreateAPIKey) WithContext ¶ 

func (f SecurityCreateAPIKey) WithContext(v context.Context) func(*SecurityCreateAPIKeyRequest)

WithContext sets the request context.

func (SecurityCreateAPIKey) WithErrorTrace ¶ 

func (f SecurityCreateAPIKey) WithErrorTrace() func(*SecurityCreateAPIKeyRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityCreateAPIKey) WithFilterPath ¶ 

func (f SecurityCreateAPIKey) WithFilterPath(v ...string) func(*SecurityCreateAPIKeyRequest)

WithFilterPath filters the properties of the response body.

func (SecurityCreateAPIKey) WithHeader ¶ 

func (f SecurityCreateAPIKey) WithHeader(h map[string]string) func(*SecurityCreateAPIKeyRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityCreateAPIKey) WithHuman ¶ 

func (f SecurityCreateAPIKey) WithHuman() func(*SecurityCreateAPIKeyRequest)

WithHuman makes statistical values human-readable.

func (SecurityCreateAPIKey) WithOpaqueID ¶ 

func (f SecurityCreateAPIKey) WithOpaqueID(s string) func(*SecurityCreateAPIKeyRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityCreateAPIKey) WithPretty ¶ 

func (f SecurityCreateAPIKey) WithPretty() func(*SecurityCreateAPIKeyRequest)

WithPretty makes the response body pretty-printed.

func (SecurityCreateAPIKey) WithRefresh ¶ 

func (f SecurityCreateAPIKey) WithRefresh(v string) func(*SecurityCreateAPIKeyRequest)

WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityCreateAPIKeyRequest ¶ 

type SecurityCreateAPIKeyRequest struct {
	Body io.Reader

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityCreateAPIKeyRequest configures the Security CreateAPI Key API request.

func (SecurityCreateAPIKeyRequest) Do ¶ 

func (r SecurityCreateAPIKeyRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityCreateCrossClusterAPIKey ¶ added in v8.9.0 

type SecurityCreateCrossClusterAPIKey func(body io.Reader, o ...func(*SecurityCreateCrossClusterAPIKeyRequest)) (*Response, error)

SecurityCreateCrossClusterAPIKey - Creates a cross-cluster API key for API key based remote cluster access.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html.

func (SecurityCreateCrossClusterAPIKey) WithContext ¶ added in v8.9.0 

func (f SecurityCreateCrossClusterAPIKey) WithContext(v context.Context) func(*SecurityCreateCrossClusterAPIKeyRequest)

WithContext sets the request context.

func (SecurityCreateCrossClusterAPIKey) WithErrorTrace ¶ added in v8.9.0 

func (f SecurityCreateCrossClusterAPIKey) WithErrorTrace() func(*SecurityCreateCrossClusterAPIKeyRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityCreateCrossClusterAPIKey) WithFilterPath ¶ added in v8.9.0 

func (f SecurityCreateCrossClusterAPIKey) WithFilterPath(v ...string) func(*SecurityCreateCrossClusterAPIKeyRequest)

WithFilterPath filters the properties of the response body.

func (SecurityCreateCrossClusterAPIKey) WithHeader ¶ added in v8.9.0 

func (f SecurityCreateCrossClusterAPIKey) WithHeader(h map[string]string) func(*SecurityCreateCrossClusterAPIKeyRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityCreateCrossClusterAPIKey) WithHuman ¶ added in v8.9.0 

func (f SecurityCreateCrossClusterAPIKey) WithHuman() func(*SecurityCreateCrossClusterAPIKeyRequest)

WithHuman makes statistical values human-readable.

func (SecurityCreateCrossClusterAPIKey) WithOpaqueID ¶ added in v8.9.0 

func (f SecurityCreateCrossClusterAPIKey) WithOpaqueID(s string) func(*SecurityCreateCrossClusterAPIKeyRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityCreateCrossClusterAPIKey) WithPretty ¶ added in v8.9.0 

func (f SecurityCreateCrossClusterAPIKey) WithPretty() func(*SecurityCreateCrossClusterAPIKeyRequest)

WithPretty makes the response body pretty-printed.

type SecurityCreateCrossClusterAPIKeyRequest ¶ added in v8.9.0 

type SecurityCreateCrossClusterAPIKeyRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityCreateCrossClusterAPIKeyRequest configures the Security Create Cross ClusterAPI Key API request.

func (SecurityCreateCrossClusterAPIKeyRequest) Do ¶ added in v8.9.0 

func (r SecurityCreateCrossClusterAPIKeyRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityCreateServiceToken ¶ 

type SecurityCreateServiceToken func(namespace string, service string, o ...func(*SecurityCreateServiceTokenRequest)) (*Response, error)

SecurityCreateServiceToken - Creates a service account token for access without requiring basic authentication.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html.

func (SecurityCreateServiceToken) WithContext ¶ 

func (f SecurityCreateServiceToken) WithContext(v context.Context) func(*SecurityCreateServiceTokenRequest)

WithContext sets the request context.

func (SecurityCreateServiceToken) WithErrorTrace ¶ 

func (f SecurityCreateServiceToken) WithErrorTrace() func(*SecurityCreateServiceTokenRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityCreateServiceToken) WithFilterPath ¶ 

func (f SecurityCreateServiceToken) WithFilterPath(v ...string) func(*SecurityCreateServiceTokenRequest)

WithFilterPath filters the properties of the response body.

func (SecurityCreateServiceToken) WithHeader ¶ 

func (f SecurityCreateServiceToken) WithHeader(h map[string]string) func(*SecurityCreateServiceTokenRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityCreateServiceToken) WithHuman ¶ 

func (f SecurityCreateServiceToken) WithHuman() func(*SecurityCreateServiceTokenRequest)

WithHuman makes statistical values human-readable.

func (SecurityCreateServiceToken) WithName ¶ 

func (f SecurityCreateServiceToken) WithName(v string) func(*SecurityCreateServiceTokenRequest)

WithName - an identifier for the token name.

func (SecurityCreateServiceToken) WithOpaqueID ¶ 

func (f SecurityCreateServiceToken) WithOpaqueID(s string) func(*SecurityCreateServiceTokenRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityCreateServiceToken) WithPretty ¶ 

func (f SecurityCreateServiceToken) WithPretty() func(*SecurityCreateServiceTokenRequest)

WithPretty makes the response body pretty-printed.

func (SecurityCreateServiceToken) WithRefresh ¶ 

func (f SecurityCreateServiceToken) WithRefresh(v string) func(*SecurityCreateServiceTokenRequest)

WithRefresh - if `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityCreateServiceTokenRequest ¶ 

type SecurityCreateServiceTokenRequest struct {
	Name      string
	Namespace string
	Service   string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityCreateServiceTokenRequest configures the Security Create Service Token API request.

func (SecurityCreateServiceTokenRequest) Do ¶ 

func (r SecurityCreateServiceTokenRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityDelegatePki ¶ added in v8.18.0 

type SecurityDelegatePki func(body io.Reader, o ...func(*SecurityDelegatePkiRequest)) (*Response, error)

SecurityDelegatePki - Delegate PKI authentication.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-delegate-pki-authentication.html.

func (SecurityDelegatePki) WithContext ¶ added in v8.18.0 

func (f SecurityDelegatePki) WithContext(v context.Context) func(*SecurityDelegatePkiRequest)

WithContext sets the request context.

func (SecurityDelegatePki) WithErrorTrace ¶ added in v8.18.0 

func (f SecurityDelegatePki) WithErrorTrace() func(*SecurityDelegatePkiRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityDelegatePki) WithFilterPath ¶ added in v8.18.0 

func (f SecurityDelegatePki) WithFilterPath(v ...string) func(*SecurityDelegatePkiRequest)

WithFilterPath filters the properties of the response body.

func (SecurityDelegatePki) WithHeader ¶ added in v8.18.0 

func (f SecurityDelegatePki) WithHeader(h map[string]string) func(*SecurityDelegatePkiRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityDelegatePki) WithHuman ¶ added in v8.18.0 

func (f SecurityDelegatePki) WithHuman() func(*SecurityDelegatePkiRequest)

WithHuman makes statistical values human-readable.

func (SecurityDelegatePki) WithOpaqueID ¶ added in v8.18.0 

func (f SecurityDelegatePki) WithOpaqueID(s string) func(*SecurityDelegatePkiRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityDelegatePki) WithPretty ¶ added in v8.18.0 

func (f SecurityDelegatePki) WithPretty() func(*SecurityDelegatePkiRequest)

WithPretty makes the response body pretty-printed.

type SecurityDelegatePkiRequest ¶ added in v8.18.0 

type SecurityDelegatePkiRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityDelegatePkiRequest configures the Security Delegate Pki API request.

func (SecurityDelegatePkiRequest) Do ¶ added in v8.18.0 

func (r SecurityDelegatePkiRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityDeletePrivileges ¶ 

type SecurityDeletePrivileges func(name string, application string, o ...func(*SecurityDeletePrivilegesRequest)) (*Response, error)

SecurityDeletePrivileges - Removes application privileges.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html.

func (SecurityDeletePrivileges) WithContext ¶ 

func (f SecurityDeletePrivileges) WithContext(v context.Context) func(*SecurityDeletePrivilegesRequest)

WithContext sets the request context.

func (SecurityDeletePrivileges) WithErrorTrace ¶ 

func (f SecurityDeletePrivileges) WithErrorTrace() func(*SecurityDeletePrivilegesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityDeletePrivileges) WithFilterPath ¶ 

func (f SecurityDeletePrivileges) WithFilterPath(v ...string) func(*SecurityDeletePrivilegesRequest)

WithFilterPath filters the properties of the response body.

func (SecurityDeletePrivileges) WithHeader ¶ 

func (f SecurityDeletePrivileges) WithHeader(h map[string]string) func(*SecurityDeletePrivilegesRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityDeletePrivileges) WithHuman ¶ 

func (f SecurityDeletePrivileges) WithHuman() func(*SecurityDeletePrivilegesRequest)

WithHuman makes statistical values human-readable.

func (SecurityDeletePrivileges) WithOpaqueID ¶ 

func (f SecurityDeletePrivileges) WithOpaqueID(s string) func(*SecurityDeletePrivilegesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityDeletePrivileges) WithPretty ¶ 

func (f SecurityDeletePrivileges) WithPretty() func(*SecurityDeletePrivilegesRequest)

WithPretty makes the response body pretty-printed.

func (SecurityDeletePrivileges) WithRefresh ¶ 

func (f SecurityDeletePrivileges) WithRefresh(v string) func(*SecurityDeletePrivilegesRequest)

WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityDeletePrivilegesRequest ¶ 

type SecurityDeletePrivilegesRequest struct {
	Application string
	Name        string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityDeletePrivilegesRequest configures the Security Delete Privileges API request.

func (SecurityDeletePrivilegesRequest) Do ¶ 

func (r SecurityDeletePrivilegesRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityDeleteRole ¶ 

type SecurityDeleteRole func(name string, o ...func(*SecurityDeleteRoleRequest)) (*Response, error)

SecurityDeleteRole - Removes roles in the native realm.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html.

func (SecurityDeleteRole) WithContext ¶ 

func (f SecurityDeleteRole) WithContext(v context.Context) func(*SecurityDeleteRoleRequest)

WithContext sets the request context.

func (SecurityDeleteRole) WithErrorTrace ¶ 

func (f SecurityDeleteRole) WithErrorTrace() func(*SecurityDeleteRoleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityDeleteRole) WithFilterPath ¶ 

func (f SecurityDeleteRole) WithFilterPath(v ...string) func(*SecurityDeleteRoleRequest)

WithFilterPath filters the properties of the response body.

func (SecurityDeleteRole) WithHeader ¶ 

func (f SecurityDeleteRole) WithHeader(h map[string]string) func(*SecurityDeleteRoleRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityDeleteRole) WithHuman ¶ 

func (f SecurityDeleteRole) WithHuman() func(*SecurityDeleteRoleRequest)

WithHuman makes statistical values human-readable.

func (SecurityDeleteRole) WithOpaqueID ¶ 

func (f SecurityDeleteRole) WithOpaqueID(s string) func(*SecurityDeleteRoleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityDeleteRole) WithPretty ¶ 

func (f SecurityDeleteRole) WithPretty() func(*SecurityDeleteRoleRequest)

WithPretty makes the response body pretty-printed.

func (SecurityDeleteRole) WithRefresh ¶ 

func (f SecurityDeleteRole) WithRefresh(v string) func(*SecurityDeleteRoleRequest)

WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityDeleteRoleMapping ¶ 

type SecurityDeleteRoleMapping func(name string, o ...func(*SecurityDeleteRoleMappingRequest)) (*Response, error)

SecurityDeleteRoleMapping - Removes role mappings.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html.

func (SecurityDeleteRoleMapping) WithContext ¶ 

func (f SecurityDeleteRoleMapping) WithContext(v context.Context) func(*SecurityDeleteRoleMappingRequest)

WithContext sets the request context.

func (SecurityDeleteRoleMapping) WithErrorTrace ¶ 

func (f SecurityDeleteRoleMapping) WithErrorTrace() func(*SecurityDeleteRoleMappingRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityDeleteRoleMapping) WithFilterPath ¶ 

func (f SecurityDeleteRoleMapping) WithFilterPath(v ...string) func(*SecurityDeleteRoleMappingRequest)

WithFilterPath filters the properties of the response body.

func (SecurityDeleteRoleMapping) WithHeader ¶ 

func (f SecurityDeleteRoleMapping) WithHeader(h map[string]string) func(*SecurityDeleteRoleMappingRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityDeleteRoleMapping) WithHuman ¶ 

func (f SecurityDeleteRoleMapping) WithHuman() func(*SecurityDeleteRoleMappingRequest)

WithHuman makes statistical values human-readable.

func (SecurityDeleteRoleMapping) WithOpaqueID ¶ 

func (f SecurityDeleteRoleMapping) WithOpaqueID(s string) func(*SecurityDeleteRoleMappingRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityDeleteRoleMapping) WithPretty ¶ 

func (f SecurityDeleteRoleMapping) WithPretty() func(*SecurityDeleteRoleMappingRequest)

WithPretty makes the response body pretty-printed.

func (SecurityDeleteRoleMapping) WithRefresh ¶ 

func (f SecurityDeleteRoleMapping) WithRefresh(v string) func(*SecurityDeleteRoleMappingRequest)

WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityDeleteRoleMappingRequest ¶ 

type SecurityDeleteRoleMappingRequest struct {
	Name string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityDeleteRoleMappingRequest configures the Security Delete Role Mapping API request.

func (SecurityDeleteRoleMappingRequest) Do ¶ 

func (r SecurityDeleteRoleMappingRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityDeleteRoleRequest ¶ 

type SecurityDeleteRoleRequest struct {
	Name string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityDeleteRoleRequest configures the Security Delete Role API request.

func (SecurityDeleteRoleRequest) Do ¶ 

func (r SecurityDeleteRoleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityDeleteServiceToken ¶ 

type SecurityDeleteServiceToken func(name string, namespace string, service string, o ...func(*SecurityDeleteServiceTokenRequest)) (*Response, error)

SecurityDeleteServiceToken - Deletes a service account token.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html.

func (SecurityDeleteServiceToken) WithContext ¶ 

func (f SecurityDeleteServiceToken) WithContext(v context.Context) func(*SecurityDeleteServiceTokenRequest)

WithContext sets the request context.

func (SecurityDeleteServiceToken) WithErrorTrace ¶ 

func (f SecurityDeleteServiceToken) WithErrorTrace() func(*SecurityDeleteServiceTokenRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityDeleteServiceToken) WithFilterPath ¶ 

func (f SecurityDeleteServiceToken) WithFilterPath(v ...string) func(*SecurityDeleteServiceTokenRequest)

WithFilterPath filters the properties of the response body.

func (SecurityDeleteServiceToken) WithHeader ¶ 

func (f SecurityDeleteServiceToken) WithHeader(h map[string]string) func(*SecurityDeleteServiceTokenRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityDeleteServiceToken) WithHuman ¶ 

func (f SecurityDeleteServiceToken) WithHuman() func(*SecurityDeleteServiceTokenRequest)

WithHuman makes statistical values human-readable.

func (SecurityDeleteServiceToken) WithOpaqueID ¶ 

func (f SecurityDeleteServiceToken) WithOpaqueID(s string) func(*SecurityDeleteServiceTokenRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityDeleteServiceToken) WithPretty ¶ 

func (f SecurityDeleteServiceToken) WithPretty() func(*SecurityDeleteServiceTokenRequest)

WithPretty makes the response body pretty-printed.

func (SecurityDeleteServiceToken) WithRefresh ¶ 

func (f SecurityDeleteServiceToken) WithRefresh(v string) func(*SecurityDeleteServiceTokenRequest)

WithRefresh - if `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityDeleteServiceTokenRequest ¶ 

type SecurityDeleteServiceTokenRequest struct {
	Name      string
	Namespace string
	Service   string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityDeleteServiceTokenRequest configures the Security Delete Service Token API request.

func (SecurityDeleteServiceTokenRequest) Do ¶ 

func (r SecurityDeleteServiceTokenRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityDeleteUser ¶ 

type SecurityDeleteUser func(username string, o ...func(*SecurityDeleteUserRequest)) (*Response, error)

SecurityDeleteUser - Deletes users from the native realm.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html.

func (SecurityDeleteUser) WithContext ¶ 

func (f SecurityDeleteUser) WithContext(v context.Context) func(*SecurityDeleteUserRequest)

WithContext sets the request context.

func (SecurityDeleteUser) WithErrorTrace ¶ 

func (f SecurityDeleteUser) WithErrorTrace() func(*SecurityDeleteUserRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityDeleteUser) WithFilterPath ¶ 

func (f SecurityDeleteUser) WithFilterPath(v ...string) func(*SecurityDeleteUserRequest)

WithFilterPath filters the properties of the response body.

func (SecurityDeleteUser) WithHeader ¶ 

func (f SecurityDeleteUser) WithHeader(h map[string]string) func(*SecurityDeleteUserRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityDeleteUser) WithHuman ¶ 

func (f SecurityDeleteUser) WithHuman() func(*SecurityDeleteUserRequest)

WithHuman makes statistical values human-readable.

func (SecurityDeleteUser) WithOpaqueID ¶ 

func (f SecurityDeleteUser) WithOpaqueID(s string) func(*SecurityDeleteUserRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityDeleteUser) WithPretty ¶ 

func (f SecurityDeleteUser) WithPretty() func(*SecurityDeleteUserRequest)

WithPretty makes the response body pretty-printed.

func (SecurityDeleteUser) WithRefresh ¶ 

func (f SecurityDeleteUser) WithRefresh(v string) func(*SecurityDeleteUserRequest)

WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityDeleteUserRequest ¶ 

type SecurityDeleteUserRequest struct {
	Username string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityDeleteUserRequest configures the Security Delete User API request.

func (SecurityDeleteUserRequest) Do ¶ 

func (r SecurityDeleteUserRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityDisableUser ¶ 

type SecurityDisableUser func(username string, o ...func(*SecurityDisableUserRequest)) (*Response, error)

SecurityDisableUser - Disables users in the native realm.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html.

func (SecurityDisableUser) WithContext ¶ 

func (f SecurityDisableUser) WithContext(v context.Context) func(*SecurityDisableUserRequest)

WithContext sets the request context.

func (SecurityDisableUser) WithErrorTrace ¶ 

func (f SecurityDisableUser) WithErrorTrace() func(*SecurityDisableUserRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityDisableUser) WithFilterPath ¶ 

func (f SecurityDisableUser) WithFilterPath(v ...string) func(*SecurityDisableUserRequest)

WithFilterPath filters the properties of the response body.

func (SecurityDisableUser) WithHeader ¶ 

func (f SecurityDisableUser) WithHeader(h map[string]string) func(*SecurityDisableUserRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityDisableUser) WithHuman ¶ 

func (f SecurityDisableUser) WithHuman() func(*SecurityDisableUserRequest)

WithHuman makes statistical values human-readable.

func (SecurityDisableUser) WithOpaqueID ¶ 

func (f SecurityDisableUser) WithOpaqueID(s string) func(*SecurityDisableUserRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityDisableUser) WithPretty ¶ 

func (f SecurityDisableUser) WithPretty() func(*SecurityDisableUserRequest)

WithPretty makes the response body pretty-printed.

func (SecurityDisableUser) WithRefresh ¶ 

func (f SecurityDisableUser) WithRefresh(v string) func(*SecurityDisableUserRequest)

WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityDisableUserProfile ¶ added in v8.2.0 

type SecurityDisableUserProfile func(uid string, o ...func(*SecurityDisableUserProfileRequest)) (*Response, error)

SecurityDisableUserProfile - Disables a user profile so it's not visible in user profile searches.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-disable-user-profile.html.

func (SecurityDisableUserProfile) WithContext ¶ added in v8.2.0 

func (f SecurityDisableUserProfile) WithContext(v context.Context) func(*SecurityDisableUserProfileRequest)

WithContext sets the request context.

func (SecurityDisableUserProfile) WithErrorTrace ¶ added in v8.2.0 

func (f SecurityDisableUserProfile) WithErrorTrace() func(*SecurityDisableUserProfileRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityDisableUserProfile) WithFilterPath ¶ added in v8.2.0 

func (f SecurityDisableUserProfile) WithFilterPath(v ...string) func(*SecurityDisableUserProfileRequest)

WithFilterPath filters the properties of the response body.

func (SecurityDisableUserProfile) WithHeader ¶ added in v8.2.0 

func (f SecurityDisableUserProfile) WithHeader(h map[string]string) func(*SecurityDisableUserProfileRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityDisableUserProfile) WithHuman ¶ added in v8.2.0 

func (f SecurityDisableUserProfile) WithHuman() func(*SecurityDisableUserProfileRequest)

WithHuman makes statistical values human-readable.

func (SecurityDisableUserProfile) WithOpaqueID ¶ added in v8.2.0 

func (f SecurityDisableUserProfile) WithOpaqueID(s string) func(*SecurityDisableUserProfileRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityDisableUserProfile) WithPretty ¶ added in v8.2.0 

func (f SecurityDisableUserProfile) WithPretty() func(*SecurityDisableUserProfileRequest)

WithPretty makes the response body pretty-printed.

func (SecurityDisableUserProfile) WithRefresh ¶ added in v8.2.0 

func (f SecurityDisableUserProfile) WithRefresh(v string) func(*SecurityDisableUserProfileRequest)

WithRefresh - if `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityDisableUserProfileRequest ¶ added in v8.2.0 

type SecurityDisableUserProfileRequest struct {
	UID string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityDisableUserProfileRequest configures the Security Disable User Profile API request.

func (SecurityDisableUserProfileRequest) Do ¶ added in v8.2.0 

func (r SecurityDisableUserProfileRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityDisableUserRequest ¶ 

type SecurityDisableUserRequest struct {
	Username string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityDisableUserRequest configures the Security Disable User API request.

func (SecurityDisableUserRequest) Do ¶ 

func (r SecurityDisableUserRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityEnableUser ¶ 

type SecurityEnableUser func(username string, o ...func(*SecurityEnableUserRequest)) (*Response, error)

SecurityEnableUser - Enables users in the native realm.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html.

func (SecurityEnableUser) WithContext ¶ 

func (f SecurityEnableUser) WithContext(v context.Context) func(*SecurityEnableUserRequest)

WithContext sets the request context.

func (SecurityEnableUser) WithErrorTrace ¶ 

func (f SecurityEnableUser) WithErrorTrace() func(*SecurityEnableUserRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityEnableUser) WithFilterPath ¶ 

func (f SecurityEnableUser) WithFilterPath(v ...string) func(*SecurityEnableUserRequest)

WithFilterPath filters the properties of the response body.

func (SecurityEnableUser) WithHeader ¶ 

func (f SecurityEnableUser) WithHeader(h map[string]string) func(*SecurityEnableUserRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityEnableUser) WithHuman ¶ 

func (f SecurityEnableUser) WithHuman() func(*SecurityEnableUserRequest)

WithHuman makes statistical values human-readable.

func (SecurityEnableUser) WithOpaqueID ¶ 

func (f SecurityEnableUser) WithOpaqueID(s string) func(*SecurityEnableUserRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityEnableUser) WithPretty ¶ 

func (f SecurityEnableUser) WithPretty() func(*SecurityEnableUserRequest)

WithPretty makes the response body pretty-printed.

func (SecurityEnableUser) WithRefresh ¶ 

func (f SecurityEnableUser) WithRefresh(v string) func(*SecurityEnableUserRequest)

WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityEnableUserProfile ¶ added in v8.2.0 

type SecurityEnableUserProfile func(uid string, o ...func(*SecurityEnableUserProfileRequest)) (*Response, error)

SecurityEnableUserProfile - Enables a user profile so it's visible in user profile searches.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-enable-user-profile.html.

func (SecurityEnableUserProfile) WithContext ¶ added in v8.2.0 

func (f SecurityEnableUserProfile) WithContext(v context.Context) func(*SecurityEnableUserProfileRequest)

WithContext sets the request context.

func (SecurityEnableUserProfile) WithErrorTrace ¶ added in v8.2.0 

func (f SecurityEnableUserProfile) WithErrorTrace() func(*SecurityEnableUserProfileRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityEnableUserProfile) WithFilterPath ¶ added in v8.2.0 

func (f SecurityEnableUserProfile) WithFilterPath(v ...string) func(*SecurityEnableUserProfileRequest)

WithFilterPath filters the properties of the response body.

func (SecurityEnableUserProfile) WithHeader ¶ added in v8.2.0 

func (f SecurityEnableUserProfile) WithHeader(h map[string]string) func(*SecurityEnableUserProfileRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityEnableUserProfile) WithHuman ¶ added in v8.2.0 

func (f SecurityEnableUserProfile) WithHuman() func(*SecurityEnableUserProfileRequest)

WithHuman makes statistical values human-readable.

func (SecurityEnableUserProfile) WithOpaqueID ¶ added in v8.2.0 

func (f SecurityEnableUserProfile) WithOpaqueID(s string) func(*SecurityEnableUserProfileRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityEnableUserProfile) WithPretty ¶ added in v8.2.0 

func (f SecurityEnableUserProfile) WithPretty() func(*SecurityEnableUserProfileRequest)

WithPretty makes the response body pretty-printed.

func (SecurityEnableUserProfile) WithRefresh ¶ added in v8.2.0 

func (f SecurityEnableUserProfile) WithRefresh(v string) func(*SecurityEnableUserProfileRequest)

WithRefresh - if `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityEnableUserProfileRequest ¶ added in v8.2.0 

type SecurityEnableUserProfileRequest struct {
	UID string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityEnableUserProfileRequest configures the Security Enable User Profile API request.

func (SecurityEnableUserProfileRequest) Do ¶ added in v8.2.0 

func (r SecurityEnableUserProfileRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityEnableUserRequest ¶ 

type SecurityEnableUserRequest struct {
	Username string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityEnableUserRequest configures the Security Enable User API request.

func (SecurityEnableUserRequest) Do ¶ 

func (r SecurityEnableUserRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityEnrollKibana ¶ 

type SecurityEnrollKibana func(o ...func(*SecurityEnrollKibanaRequest)) (*Response, error)

SecurityEnrollKibana - Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-kibana-enrollment.html.

func (SecurityEnrollKibana) WithContext ¶ 

func (f SecurityEnrollKibana) WithContext(v context.Context) func(*SecurityEnrollKibanaRequest)

WithContext sets the request context.

func (SecurityEnrollKibana) WithErrorTrace ¶ 

func (f SecurityEnrollKibana) WithErrorTrace() func(*SecurityEnrollKibanaRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityEnrollKibana) WithFilterPath ¶ 

func (f SecurityEnrollKibana) WithFilterPath(v ...string) func(*SecurityEnrollKibanaRequest)

WithFilterPath filters the properties of the response body.

func (SecurityEnrollKibana) WithHeader ¶ 

func (f SecurityEnrollKibana) WithHeader(h map[string]string) func(*SecurityEnrollKibanaRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityEnrollKibana) WithHuman ¶ 

func (f SecurityEnrollKibana) WithHuman() func(*SecurityEnrollKibanaRequest)

WithHuman makes statistical values human-readable.

func (SecurityEnrollKibana) WithOpaqueID ¶ 

func (f SecurityEnrollKibana) WithOpaqueID(s string) func(*SecurityEnrollKibanaRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityEnrollKibana) WithPretty ¶ 

func (f SecurityEnrollKibana) WithPretty() func(*SecurityEnrollKibanaRequest)

WithPretty makes the response body pretty-printed.

type SecurityEnrollKibanaRequest ¶ 

type SecurityEnrollKibanaRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityEnrollKibanaRequest configures the Security Enroll Kibana API request.

func (SecurityEnrollKibanaRequest) Do ¶ 

func (r SecurityEnrollKibanaRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityEnrollNode ¶ 

type SecurityEnrollNode func(o ...func(*SecurityEnrollNodeRequest)) (*Response, error)

SecurityEnrollNode - Allows a new node to enroll to an existing cluster with security enabled.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-node-enrollment.html.

func (SecurityEnrollNode) WithContext ¶ 

func (f SecurityEnrollNode) WithContext(v context.Context) func(*SecurityEnrollNodeRequest)

WithContext sets the request context.

func (SecurityEnrollNode) WithErrorTrace ¶ 

func (f SecurityEnrollNode) WithErrorTrace() func(*SecurityEnrollNodeRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityEnrollNode) WithFilterPath ¶ 

func (f SecurityEnrollNode) WithFilterPath(v ...string) func(*SecurityEnrollNodeRequest)

WithFilterPath filters the properties of the response body.

func (SecurityEnrollNode) WithHeader ¶ 

func (f SecurityEnrollNode) WithHeader(h map[string]string) func(*SecurityEnrollNodeRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityEnrollNode) WithHuman ¶ 

func (f SecurityEnrollNode) WithHuman() func(*SecurityEnrollNodeRequest)

WithHuman makes statistical values human-readable.

func (SecurityEnrollNode) WithOpaqueID ¶ 

func (f SecurityEnrollNode) WithOpaqueID(s string) func(*SecurityEnrollNodeRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityEnrollNode) WithPretty ¶ 

func (f SecurityEnrollNode) WithPretty() func(*SecurityEnrollNodeRequest)

WithPretty makes the response body pretty-printed.

type SecurityEnrollNodeRequest ¶ 

type SecurityEnrollNodeRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityEnrollNodeRequest configures the Security Enroll Node API request.

func (SecurityEnrollNodeRequest) Do ¶ 

func (r SecurityEnrollNodeRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityGetAPIKey ¶ 

type SecurityGetAPIKey func(o ...func(*SecurityGetAPIKeyRequest)) (*Response, error)

SecurityGetAPIKey - Retrieves information for one or more API keys.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html.

func (SecurityGetAPIKey) WithActiveOnly ¶ added in v8.12.0 

func (f SecurityGetAPIKey) WithActiveOnly(v bool) func(*SecurityGetAPIKeyRequest)

WithActiveOnly - flag to limit response to only active (not invalidated or expired) api keys.

func (SecurityGetAPIKey) WithContext ¶ 

func (f SecurityGetAPIKey) WithContext(v context.Context) func(*SecurityGetAPIKeyRequest)

WithContext sets the request context.

func (SecurityGetAPIKey) WithErrorTrace ¶ 

func (f SecurityGetAPIKey) WithErrorTrace() func(*SecurityGetAPIKeyRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityGetAPIKey) WithFilterPath ¶ 

func (f SecurityGetAPIKey) WithFilterPath(v ...string) func(*SecurityGetAPIKeyRequest)

WithFilterPath filters the properties of the response body.

func (SecurityGetAPIKey) WithHeader ¶ 

func (f SecurityGetAPIKey) WithHeader(h map[string]string) func(*SecurityGetAPIKeyRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityGetAPIKey) WithHuman ¶ 

func (f SecurityGetAPIKey) WithHuman() func(*SecurityGetAPIKeyRequest)

WithHuman makes statistical values human-readable.

func (SecurityGetAPIKey) WithID ¶ 

func (f SecurityGetAPIKey) WithID(v string) func(*SecurityGetAPIKeyRequest)

WithID - api key ID of the api key to be retrieved.

func (SecurityGetAPIKey) WithName ¶ 

func (f SecurityGetAPIKey) WithName(v string) func(*SecurityGetAPIKeyRequest)

WithName - api key name of the api key to be retrieved.

func (SecurityGetAPIKey) WithOpaqueID ¶ 

func (f SecurityGetAPIKey) WithOpaqueID(s string) func(*SecurityGetAPIKeyRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityGetAPIKey) WithOwner ¶ 

func (f SecurityGetAPIKey) WithOwner(v bool) func(*SecurityGetAPIKeyRequest)

WithOwner - flag to query api keys owned by the currently authenticated user.

func (SecurityGetAPIKey) WithPretty ¶ 

func (f SecurityGetAPIKey) WithPretty() func(*SecurityGetAPIKeyRequest)

WithPretty makes the response body pretty-printed.

func (SecurityGetAPIKey) WithRealmName ¶ 

func (f SecurityGetAPIKey) WithRealmName(v string) func(*SecurityGetAPIKeyRequest)

WithRealmName - realm name of the user who created this api key to be retrieved.

func (SecurityGetAPIKey) WithUsername ¶ 

func (f SecurityGetAPIKey) WithUsername(v string) func(*SecurityGetAPIKeyRequest)

WithUsername - user name of the user who created this api key to be retrieved.

func (SecurityGetAPIKey) WithWithLimitedBy ¶ added in v8.5.0 

func (f SecurityGetAPIKey) WithWithLimitedBy(v bool) func(*SecurityGetAPIKeyRequest)

WithWithLimitedBy - flag to show the limited-by role descriptors of api keys.

func (SecurityGetAPIKey) WithWithProfileUID ¶ added in v8.14.0 

func (f SecurityGetAPIKey) WithWithProfileUID(v bool) func(*SecurityGetAPIKeyRequest)

WithWithProfileUID - flag to also retrieve the api key's owner profile uid, if it exists.

type SecurityGetAPIKeyRequest ¶ 

type SecurityGetAPIKeyRequest struct {
	ActiveOnly     *bool
	ID             string
	Name           string
	Owner          *bool
	RealmName      string
	Username       string
	WithLimitedBy  *bool
	WithProfileUID *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityGetAPIKeyRequest configures the Security GetAPI Key API request.

func (SecurityGetAPIKeyRequest) Do ¶ 

func (r SecurityGetAPIKeyRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityGetBuiltinPrivileges ¶ 

type SecurityGetBuiltinPrivileges func(o ...func(*SecurityGetBuiltinPrivilegesRequest)) (*Response, error)

SecurityGetBuiltinPrivileges - Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html.

func (SecurityGetBuiltinPrivileges) WithContext ¶ 

func (f SecurityGetBuiltinPrivileges) WithContext(v context.Context) func(*SecurityGetBuiltinPrivilegesRequest)

WithContext sets the request context.

func (SecurityGetBuiltinPrivileges) WithErrorTrace ¶ 

func (f SecurityGetBuiltinPrivileges) WithErrorTrace() func(*SecurityGetBuiltinPrivilegesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityGetBuiltinPrivileges) WithFilterPath ¶ 

func (f SecurityGetBuiltinPrivileges) WithFilterPath(v ...string) func(*SecurityGetBuiltinPrivilegesRequest)

WithFilterPath filters the properties of the response body.

func (SecurityGetBuiltinPrivileges) WithHeader ¶ 

func (f SecurityGetBuiltinPrivileges) WithHeader(h map[string]string) func(*SecurityGetBuiltinPrivilegesRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityGetBuiltinPrivileges) WithHuman ¶ 

func (f SecurityGetBuiltinPrivileges) WithHuman() func(*SecurityGetBuiltinPrivilegesRequest)

WithHuman makes statistical values human-readable.

func (SecurityGetBuiltinPrivileges) WithOpaqueID ¶ 

func (f SecurityGetBuiltinPrivileges) WithOpaqueID(s string) func(*SecurityGetBuiltinPrivilegesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityGetBuiltinPrivileges) WithPretty ¶ 

func (f SecurityGetBuiltinPrivileges) WithPretty() func(*SecurityGetBuiltinPrivilegesRequest)

WithPretty makes the response body pretty-printed.

type SecurityGetBuiltinPrivilegesRequest ¶ 

type SecurityGetBuiltinPrivilegesRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityGetBuiltinPrivilegesRequest configures the Security Get Builtin Privileges API request.

func (SecurityGetBuiltinPrivilegesRequest) Do ¶ 

func (r SecurityGetBuiltinPrivilegesRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityGetPrivileges ¶ 

type SecurityGetPrivileges func(o ...func(*SecurityGetPrivilegesRequest)) (*Response, error)

SecurityGetPrivileges - Retrieves application privileges.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html.

func (SecurityGetPrivileges) WithApplication ¶ 

func (f SecurityGetPrivileges) WithApplication(v string) func(*SecurityGetPrivilegesRequest)

WithApplication - application name.

func (SecurityGetPrivileges) WithContext ¶ 

func (f SecurityGetPrivileges) WithContext(v context.Context) func(*SecurityGetPrivilegesRequest)

WithContext sets the request context.

func (SecurityGetPrivileges) WithErrorTrace ¶ 

func (f SecurityGetPrivileges) WithErrorTrace() func(*SecurityGetPrivilegesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityGetPrivileges) WithFilterPath ¶ 

func (f SecurityGetPrivileges) WithFilterPath(v ...string) func(*SecurityGetPrivilegesRequest)

WithFilterPath filters the properties of the response body.

func (SecurityGetPrivileges) WithHeader ¶ 

func (f SecurityGetPrivileges) WithHeader(h map[string]string) func(*SecurityGetPrivilegesRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityGetPrivileges) WithHuman ¶ 

func (f SecurityGetPrivileges) WithHuman() func(*SecurityGetPrivilegesRequest)

WithHuman makes statistical values human-readable.

func (SecurityGetPrivileges) WithName ¶ 

func (f SecurityGetPrivileges) WithName(v string) func(*SecurityGetPrivilegesRequest)

WithName - privilege name.

func (SecurityGetPrivileges) WithOpaqueID ¶ 

func (f SecurityGetPrivileges) WithOpaqueID(s string) func(*SecurityGetPrivilegesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityGetPrivileges) WithPretty ¶ 

func (f SecurityGetPrivileges) WithPretty() func(*SecurityGetPrivilegesRequest)

WithPretty makes the response body pretty-printed.

type SecurityGetPrivilegesRequest ¶ 

type SecurityGetPrivilegesRequest struct {
	Application string
	Name        string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityGetPrivilegesRequest configures the Security Get Privileges API request.

func (SecurityGetPrivilegesRequest) Do ¶ 

func (r SecurityGetPrivilegesRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityGetRole ¶ 

type SecurityGetRole func(o ...func(*SecurityGetRoleRequest)) (*Response, error)

SecurityGetRole - Retrieves roles in the native realm.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html.

func (SecurityGetRole) WithContext ¶ 

func (f SecurityGetRole) WithContext(v context.Context) func(*SecurityGetRoleRequest)

WithContext sets the request context.

func (SecurityGetRole) WithErrorTrace ¶ 

func (f SecurityGetRole) WithErrorTrace() func(*SecurityGetRoleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityGetRole) WithFilterPath ¶ 

func (f SecurityGetRole) WithFilterPath(v ...string) func(*SecurityGetRoleRequest)

WithFilterPath filters the properties of the response body.

func (SecurityGetRole) WithHeader ¶ 

func (f SecurityGetRole) WithHeader(h map[string]string) func(*SecurityGetRoleRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityGetRole) WithHuman ¶ 

func (f SecurityGetRole) WithHuman() func(*SecurityGetRoleRequest)

WithHuman makes statistical values human-readable.

func (SecurityGetRole) WithName ¶ 

func (f SecurityGetRole) WithName(v ...string) func(*SecurityGetRoleRequest)

WithName - a list of role names.

func (SecurityGetRole) WithOpaqueID ¶ 

func (f SecurityGetRole) WithOpaqueID(s string) func(*SecurityGetRoleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityGetRole) WithPretty ¶ 

func (f SecurityGetRole) WithPretty() func(*SecurityGetRoleRequest)

WithPretty makes the response body pretty-printed.

type SecurityGetRoleMapping ¶ 

type SecurityGetRoleMapping func(o ...func(*SecurityGetRoleMappingRequest)) (*Response, error)

SecurityGetRoleMapping - Retrieves role mappings.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html.

func (SecurityGetRoleMapping) WithContext ¶ 

func (f SecurityGetRoleMapping) WithContext(v context.Context) func(*SecurityGetRoleMappingRequest)

WithContext sets the request context.

func (SecurityGetRoleMapping) WithErrorTrace ¶ 

func (f SecurityGetRoleMapping) WithErrorTrace() func(*SecurityGetRoleMappingRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityGetRoleMapping) WithFilterPath ¶ 

func (f SecurityGetRoleMapping) WithFilterPath(v ...string) func(*SecurityGetRoleMappingRequest)

WithFilterPath filters the properties of the response body.

func (SecurityGetRoleMapping) WithHeader ¶ 

func (f SecurityGetRoleMapping) WithHeader(h map[string]string) func(*SecurityGetRoleMappingRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityGetRoleMapping) WithHuman ¶ 

func (f SecurityGetRoleMapping) WithHuman() func(*SecurityGetRoleMappingRequest)

WithHuman makes statistical values human-readable.

func (SecurityGetRoleMapping) WithName ¶ 

func (f SecurityGetRoleMapping) WithName(v ...string) func(*SecurityGetRoleMappingRequest)

WithName - a list of role-mapping names.

func (SecurityGetRoleMapping) WithOpaqueID ¶ 

func (f SecurityGetRoleMapping) WithOpaqueID(s string) func(*SecurityGetRoleMappingRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityGetRoleMapping) WithPretty ¶ 

func (f SecurityGetRoleMapping) WithPretty() func(*SecurityGetRoleMappingRequest)

WithPretty makes the response body pretty-printed.

type SecurityGetRoleMappingRequest ¶ 

type SecurityGetRoleMappingRequest struct {
	Name []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityGetRoleMappingRequest configures the Security Get Role Mapping API request.

func (SecurityGetRoleMappingRequest) Do ¶ 

func (r SecurityGetRoleMappingRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityGetRoleRequest ¶ 

type SecurityGetRoleRequest struct {
	Name []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityGetRoleRequest configures the Security Get Role API request.

func (SecurityGetRoleRequest) Do ¶ 

func (r SecurityGetRoleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityGetServiceAccounts ¶ 

type SecurityGetServiceAccounts func(o ...func(*SecurityGetServiceAccountsRequest)) (*Response, error)

SecurityGetServiceAccounts - Retrieves information about service accounts.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html.

func (SecurityGetServiceAccounts) WithContext ¶ 

func (f SecurityGetServiceAccounts) WithContext(v context.Context) func(*SecurityGetServiceAccountsRequest)

WithContext sets the request context.

func (SecurityGetServiceAccounts) WithErrorTrace ¶ 

func (f SecurityGetServiceAccounts) WithErrorTrace() func(*SecurityGetServiceAccountsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityGetServiceAccounts) WithFilterPath ¶ 

func (f SecurityGetServiceAccounts) WithFilterPath(v ...string) func(*SecurityGetServiceAccountsRequest)

WithFilterPath filters the properties of the response body.

func (SecurityGetServiceAccounts) WithHeader ¶ 

func (f SecurityGetServiceAccounts) WithHeader(h map[string]string) func(*SecurityGetServiceAccountsRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityGetServiceAccounts) WithHuman ¶ 

func (f SecurityGetServiceAccounts) WithHuman() func(*SecurityGetServiceAccountsRequest)

WithHuman makes statistical values human-readable.

func (SecurityGetServiceAccounts) WithNamespace ¶ 

func (f SecurityGetServiceAccounts) WithNamespace(v string) func(*SecurityGetServiceAccountsRequest)

WithNamespace - an identifier for the namespace.

func (SecurityGetServiceAccounts) WithOpaqueID ¶ 

func (f SecurityGetServiceAccounts) WithOpaqueID(s string) func(*SecurityGetServiceAccountsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityGetServiceAccounts) WithPretty ¶ 

func (f SecurityGetServiceAccounts) WithPretty() func(*SecurityGetServiceAccountsRequest)

WithPretty makes the response body pretty-printed.

func (SecurityGetServiceAccounts) WithService ¶ 

func (f SecurityGetServiceAccounts) WithService(v string) func(*SecurityGetServiceAccountsRequest)

WithService - an identifier for the service name.

type SecurityGetServiceAccountsRequest ¶ 

type SecurityGetServiceAccountsRequest struct {
	Namespace string
	Service   string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityGetServiceAccountsRequest configures the Security Get Service Accounts API request.

func (SecurityGetServiceAccountsRequest) Do ¶ 

func (r SecurityGetServiceAccountsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityGetServiceCredentials ¶ 

type SecurityGetServiceCredentials func(namespace string, service string, o ...func(*SecurityGetServiceCredentialsRequest)) (*Response, error)

SecurityGetServiceCredentials - Retrieves information of all service credentials for a service account.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html.

func (SecurityGetServiceCredentials) WithContext ¶ 

func (f SecurityGetServiceCredentials) WithContext(v context.Context) func(*SecurityGetServiceCredentialsRequest)

WithContext sets the request context.

func (SecurityGetServiceCredentials) WithErrorTrace ¶ 

func (f SecurityGetServiceCredentials) WithErrorTrace() func(*SecurityGetServiceCredentialsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityGetServiceCredentials) WithFilterPath ¶ 

func (f SecurityGetServiceCredentials) WithFilterPath(v ...string) func(*SecurityGetServiceCredentialsRequest)

WithFilterPath filters the properties of the response body.

func (SecurityGetServiceCredentials) WithHeader ¶ 

func (f SecurityGetServiceCredentials) WithHeader(h map[string]string) func(*SecurityGetServiceCredentialsRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityGetServiceCredentials) WithHuman ¶ 

func (f SecurityGetServiceCredentials) WithHuman() func(*SecurityGetServiceCredentialsRequest)

WithHuman makes statistical values human-readable.

func (SecurityGetServiceCredentials) WithOpaqueID ¶ 

func (f SecurityGetServiceCredentials) WithOpaqueID(s string) func(*SecurityGetServiceCredentialsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityGetServiceCredentials) WithPretty ¶ 

func (f SecurityGetServiceCredentials) WithPretty() func(*SecurityGetServiceCredentialsRequest)

WithPretty makes the response body pretty-printed.

type SecurityGetServiceCredentialsRequest ¶ 

type SecurityGetServiceCredentialsRequest struct {
	Namespace string
	Service   string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityGetServiceCredentialsRequest configures the Security Get Service Credentials API request.

func (SecurityGetServiceCredentialsRequest) Do ¶ 

func (r SecurityGetServiceCredentialsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityGetSettings ¶ added in v8.10.0 

type SecurityGetSettings func(o ...func(*SecurityGetSettingsRequest)) (*Response, error)

SecurityGetSettings - Retrieve settings for the security system indices

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-settings.html.

func (SecurityGetSettings) WithContext ¶ added in v8.10.0 

func (f SecurityGetSettings) WithContext(v context.Context) func(*SecurityGetSettingsRequest)

WithContext sets the request context.

func (SecurityGetSettings) WithErrorTrace ¶ added in v8.10.0 

func (f SecurityGetSettings) WithErrorTrace() func(*SecurityGetSettingsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityGetSettings) WithFilterPath ¶ added in v8.10.0 

func (f SecurityGetSettings) WithFilterPath(v ...string) func(*SecurityGetSettingsRequest)

WithFilterPath filters the properties of the response body.

func (SecurityGetSettings) WithHeader ¶ added in v8.10.0 

func (f SecurityGetSettings) WithHeader(h map[string]string) func(*SecurityGetSettingsRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityGetSettings) WithHuman ¶ added in v8.10.0 

func (f SecurityGetSettings) WithHuman() func(*SecurityGetSettingsRequest)

WithHuman makes statistical values human-readable.

func (SecurityGetSettings) WithMasterTimeout ¶ added in v8.15.0 

func (f SecurityGetSettings) WithMasterTimeout(v time.Duration) func(*SecurityGetSettingsRequest)

WithMasterTimeout - timeout for connection to master.

func (SecurityGetSettings) WithOpaqueID ¶ added in v8.10.0 

func (f SecurityGetSettings) WithOpaqueID(s string) func(*SecurityGetSettingsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityGetSettings) WithPretty ¶ added in v8.10.0 

func (f SecurityGetSettings) WithPretty() func(*SecurityGetSettingsRequest)

WithPretty makes the response body pretty-printed.

type SecurityGetSettingsRequest ¶ added in v8.10.0 

type SecurityGetSettingsRequest struct {
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityGetSettingsRequest configures the Security Get Settings API request.

func (SecurityGetSettingsRequest) Do ¶ added in v8.10.0 

func (r SecurityGetSettingsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityGetToken ¶ 

type SecurityGetToken func(body io.Reader, o ...func(*SecurityGetTokenRequest)) (*Response, error)

SecurityGetToken - Creates a bearer token for access without requiring basic authentication.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html.

func (SecurityGetToken) WithContext ¶ 

func (f SecurityGetToken) WithContext(v context.Context) func(*SecurityGetTokenRequest)

WithContext sets the request context.

func (SecurityGetToken) WithErrorTrace ¶ 

func (f SecurityGetToken) WithErrorTrace() func(*SecurityGetTokenRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityGetToken) WithFilterPath ¶ 

func (f SecurityGetToken) WithFilterPath(v ...string) func(*SecurityGetTokenRequest)

WithFilterPath filters the properties of the response body.

func (SecurityGetToken) WithHeader ¶ 

func (f SecurityGetToken) WithHeader(h map[string]string) func(*SecurityGetTokenRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityGetToken) WithHuman ¶ 

func (f SecurityGetToken) WithHuman() func(*SecurityGetTokenRequest)

WithHuman makes statistical values human-readable.

func (SecurityGetToken) WithOpaqueID ¶ 

func (f SecurityGetToken) WithOpaqueID(s string) func(*SecurityGetTokenRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityGetToken) WithPretty ¶ 

func (f SecurityGetToken) WithPretty() func(*SecurityGetTokenRequest)

WithPretty makes the response body pretty-printed.

type SecurityGetTokenRequest ¶ 

type SecurityGetTokenRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityGetTokenRequest configures the Security Get Token API request.

func (SecurityGetTokenRequest) Do ¶ 

func (r SecurityGetTokenRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityGetUser ¶ 

type SecurityGetUser func(o ...func(*SecurityGetUserRequest)) (*Response, error)

SecurityGetUser - Retrieves information about users in the native realm and built-in users.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html.

func (SecurityGetUser) WithContext ¶ 

func (f SecurityGetUser) WithContext(v context.Context) func(*SecurityGetUserRequest)

WithContext sets the request context.

func (SecurityGetUser) WithErrorTrace ¶ 

func (f SecurityGetUser) WithErrorTrace() func(*SecurityGetUserRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityGetUser) WithFilterPath ¶ 

func (f SecurityGetUser) WithFilterPath(v ...string) func(*SecurityGetUserRequest)

WithFilterPath filters the properties of the response body.

func (SecurityGetUser) WithHeader ¶ 

func (f SecurityGetUser) WithHeader(h map[string]string) func(*SecurityGetUserRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityGetUser) WithHuman ¶ 

func (f SecurityGetUser) WithHuman() func(*SecurityGetUserRequest)

WithHuman makes statistical values human-readable.

func (SecurityGetUser) WithOpaqueID ¶ 

func (f SecurityGetUser) WithOpaqueID(s string) func(*SecurityGetUserRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityGetUser) WithPretty ¶ 

func (f SecurityGetUser) WithPretty() func(*SecurityGetUserRequest)

WithPretty makes the response body pretty-printed.

func (SecurityGetUser) WithUsername ¶ 

func (f SecurityGetUser) WithUsername(v ...string) func(*SecurityGetUserRequest)

WithUsername - a list of usernames.

func (SecurityGetUser) WithWithProfileUID ¶ added in v8.5.0 

func (f SecurityGetUser) WithWithProfileUID(v bool) func(*SecurityGetUserRequest)

WithWithProfileUID - flag to retrieve profile uid (if exists) associated to the user.

type SecurityGetUserPrivileges ¶ 

type SecurityGetUserPrivileges func(o ...func(*SecurityGetUserPrivilegesRequest)) (*Response, error)

SecurityGetUserPrivileges - Retrieves security privileges for the logged in user.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html.

func (SecurityGetUserPrivileges) WithContext ¶ 

func (f SecurityGetUserPrivileges) WithContext(v context.Context) func(*SecurityGetUserPrivilegesRequest)

WithContext sets the request context.

func (SecurityGetUserPrivileges) WithErrorTrace ¶ 

func (f SecurityGetUserPrivileges) WithErrorTrace() func(*SecurityGetUserPrivilegesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityGetUserPrivileges) WithFilterPath ¶ 

func (f SecurityGetUserPrivileges) WithFilterPath(v ...string) func(*SecurityGetUserPrivilegesRequest)

WithFilterPath filters the properties of the response body.

func (SecurityGetUserPrivileges) WithHeader ¶ 

func (f SecurityGetUserPrivileges) WithHeader(h map[string]string) func(*SecurityGetUserPrivilegesRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityGetUserPrivileges) WithHuman ¶ 

func (f SecurityGetUserPrivileges) WithHuman() func(*SecurityGetUserPrivilegesRequest)

WithHuman makes statistical values human-readable.

func (SecurityGetUserPrivileges) WithOpaqueID ¶ 

func (f SecurityGetUserPrivileges) WithOpaqueID(s string) func(*SecurityGetUserPrivilegesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityGetUserPrivileges) WithPretty ¶ 

func (f SecurityGetUserPrivileges) WithPretty() func(*SecurityGetUserPrivilegesRequest)

WithPretty makes the response body pretty-printed.

type SecurityGetUserPrivilegesRequest ¶ 

type SecurityGetUserPrivilegesRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityGetUserPrivilegesRequest configures the Security Get User Privileges API request.

func (SecurityGetUserPrivilegesRequest) Do ¶ 

func (r SecurityGetUserPrivilegesRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityGetUserProfile ¶ added in v8.2.0 

type SecurityGetUserProfile func(uid []string, o ...func(*SecurityGetUserProfileRequest)) (*Response, error)

SecurityGetUserProfile - Retrieves user profiles for the given unique ID(s).

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-profile.html.

func (SecurityGetUserProfile) WithContext ¶ added in v8.2.0 

func (f SecurityGetUserProfile) WithContext(v context.Context) func(*SecurityGetUserProfileRequest)

WithContext sets the request context.

func (SecurityGetUserProfile) WithData ¶ added in v8.2.0 

func (f SecurityGetUserProfile) WithData(v ...string) func(*SecurityGetUserProfileRequest)

WithData - a list of keys for which the corresponding application data are retrieved..

func (SecurityGetUserProfile) WithErrorTrace ¶ added in v8.2.0 

func (f SecurityGetUserProfile) WithErrorTrace() func(*SecurityGetUserProfileRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityGetUserProfile) WithFilterPath ¶ added in v8.2.0 

func (f SecurityGetUserProfile) WithFilterPath(v ...string) func(*SecurityGetUserProfileRequest)

WithFilterPath filters the properties of the response body.

func (SecurityGetUserProfile) WithHeader ¶ added in v8.2.0 

func (f SecurityGetUserProfile) WithHeader(h map[string]string) func(*SecurityGetUserProfileRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityGetUserProfile) WithHuman ¶ added in v8.2.0 

func (f SecurityGetUserProfile) WithHuman() func(*SecurityGetUserProfileRequest)

WithHuman makes statistical values human-readable.

func (SecurityGetUserProfile) WithOpaqueID ¶ added in v8.2.0 

func (f SecurityGetUserProfile) WithOpaqueID(s string) func(*SecurityGetUserProfileRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityGetUserProfile) WithPretty ¶ added in v8.2.0 

func (f SecurityGetUserProfile) WithPretty() func(*SecurityGetUserProfileRequest)

WithPretty makes the response body pretty-printed.

type SecurityGetUserProfileRequest ¶ added in v8.2.0 

type SecurityGetUserProfileRequest struct {
	UID []string

	Data []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityGetUserProfileRequest configures the Security Get User Profile API request.

func (SecurityGetUserProfileRequest) Do ¶ added in v8.2.0 

func (r SecurityGetUserProfileRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityGetUserRequest ¶ 

type SecurityGetUserRequest struct {
	Username []string

	WithProfileUID *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityGetUserRequest configures the Security Get User API request.

func (SecurityGetUserRequest) Do ¶ 

func (r SecurityGetUserRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityGrantAPIKey ¶ 

type SecurityGrantAPIKey func(body io.Reader, o ...func(*SecurityGrantAPIKeyRequest)) (*Response, error)

SecurityGrantAPIKey - Creates an API key on behalf of another user.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html.

func (SecurityGrantAPIKey) WithContext ¶ 

func (f SecurityGrantAPIKey) WithContext(v context.Context) func(*SecurityGrantAPIKeyRequest)

WithContext sets the request context.

func (SecurityGrantAPIKey) WithErrorTrace ¶ 

func (f SecurityGrantAPIKey) WithErrorTrace() func(*SecurityGrantAPIKeyRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityGrantAPIKey) WithFilterPath ¶ 

func (f SecurityGrantAPIKey) WithFilterPath(v ...string) func(*SecurityGrantAPIKeyRequest)

WithFilterPath filters the properties of the response body.

func (SecurityGrantAPIKey) WithHeader ¶ 

func (f SecurityGrantAPIKey) WithHeader(h map[string]string) func(*SecurityGrantAPIKeyRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityGrantAPIKey) WithHuman ¶ 

func (f SecurityGrantAPIKey) WithHuman() func(*SecurityGrantAPIKeyRequest)

WithHuman makes statistical values human-readable.

func (SecurityGrantAPIKey) WithOpaqueID ¶ 

func (f SecurityGrantAPIKey) WithOpaqueID(s string) func(*SecurityGrantAPIKeyRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityGrantAPIKey) WithPretty ¶ 

func (f SecurityGrantAPIKey) WithPretty() func(*SecurityGrantAPIKeyRequest)

WithPretty makes the response body pretty-printed.

func (SecurityGrantAPIKey) WithRefresh ¶ 

func (f SecurityGrantAPIKey) WithRefresh(v string) func(*SecurityGrantAPIKeyRequest)

WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityGrantAPIKeyRequest ¶ 

type SecurityGrantAPIKeyRequest struct {
	Body io.Reader

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityGrantAPIKeyRequest configures the Security GrantAPI Key API request.

func (SecurityGrantAPIKeyRequest) Do ¶ 

func (r SecurityGrantAPIKeyRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityHasPrivileges ¶ 

type SecurityHasPrivileges func(body io.Reader, o ...func(*SecurityHasPrivilegesRequest)) (*Response, error)

SecurityHasPrivileges - Determines whether the specified user has a specified list of privileges.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html.

func (SecurityHasPrivileges) WithContext ¶ 

func (f SecurityHasPrivileges) WithContext(v context.Context) func(*SecurityHasPrivilegesRequest)

WithContext sets the request context.

func (SecurityHasPrivileges) WithErrorTrace ¶ 

func (f SecurityHasPrivileges) WithErrorTrace() func(*SecurityHasPrivilegesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityHasPrivileges) WithFilterPath ¶ 

func (f SecurityHasPrivileges) WithFilterPath(v ...string) func(*SecurityHasPrivilegesRequest)

WithFilterPath filters the properties of the response body.

func (SecurityHasPrivileges) WithHeader ¶ 

func (f SecurityHasPrivileges) WithHeader(h map[string]string) func(*SecurityHasPrivilegesRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityHasPrivileges) WithHuman ¶ 

func (f SecurityHasPrivileges) WithHuman() func(*SecurityHasPrivilegesRequest)

WithHuman makes statistical values human-readable.

func (SecurityHasPrivileges) WithOpaqueID ¶ 

func (f SecurityHasPrivileges) WithOpaqueID(s string) func(*SecurityHasPrivilegesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityHasPrivileges) WithPretty ¶ 

func (f SecurityHasPrivileges) WithPretty() func(*SecurityHasPrivilegesRequest)

WithPretty makes the response body pretty-printed.

func (SecurityHasPrivileges) WithUser ¶ 

func (f SecurityHasPrivileges) WithUser(v string) func(*SecurityHasPrivilegesRequest)

WithUser - username.

type SecurityHasPrivilegesRequest ¶ 

type SecurityHasPrivilegesRequest struct {
	Body io.Reader

	User string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityHasPrivilegesRequest configures the Security Has Privileges API request.

func (SecurityHasPrivilegesRequest) Do ¶ 

func (r SecurityHasPrivilegesRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityHasPrivilegesUserProfile ¶ added in v8.3.0 

type SecurityHasPrivilegesUserProfile func(body io.Reader, o ...func(*SecurityHasPrivilegesUserProfileRequest)) (*Response, error)

SecurityHasPrivilegesUserProfile - Determines whether the users associated with the specified profile IDs have all the requested privileges.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges-user-profile.html.

func (SecurityHasPrivilegesUserProfile) WithContext ¶ added in v8.3.0 

func (f SecurityHasPrivilegesUserProfile) WithContext(v context.Context) func(*SecurityHasPrivilegesUserProfileRequest)

WithContext sets the request context.

func (SecurityHasPrivilegesUserProfile) WithErrorTrace ¶ added in v8.3.0 

func (f SecurityHasPrivilegesUserProfile) WithErrorTrace() func(*SecurityHasPrivilegesUserProfileRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityHasPrivilegesUserProfile) WithFilterPath ¶ added in v8.3.0 

func (f SecurityHasPrivilegesUserProfile) WithFilterPath(v ...string) func(*SecurityHasPrivilegesUserProfileRequest)

WithFilterPath filters the properties of the response body.

func (SecurityHasPrivilegesUserProfile) WithHeader ¶ added in v8.3.0 

func (f SecurityHasPrivilegesUserProfile) WithHeader(h map[string]string) func(*SecurityHasPrivilegesUserProfileRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityHasPrivilegesUserProfile) WithHuman ¶ added in v8.3.0 

func (f SecurityHasPrivilegesUserProfile) WithHuman() func(*SecurityHasPrivilegesUserProfileRequest)

WithHuman makes statistical values human-readable.

func (SecurityHasPrivilegesUserProfile) WithOpaqueID ¶ added in v8.3.0 

func (f SecurityHasPrivilegesUserProfile) WithOpaqueID(s string) func(*SecurityHasPrivilegesUserProfileRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityHasPrivilegesUserProfile) WithPretty ¶ added in v8.3.0 

func (f SecurityHasPrivilegesUserProfile) WithPretty() func(*SecurityHasPrivilegesUserProfileRequest)

WithPretty makes the response body pretty-printed.

type SecurityHasPrivilegesUserProfileRequest ¶ added in v8.3.0 

type SecurityHasPrivilegesUserProfileRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityHasPrivilegesUserProfileRequest configures the Security Has Privileges User Profile API request.

func (SecurityHasPrivilegesUserProfileRequest) Do ¶ added in v8.3.0 

func (r SecurityHasPrivilegesUserProfileRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityInvalidateAPIKey ¶ 

type SecurityInvalidateAPIKey func(body io.Reader, o ...func(*SecurityInvalidateAPIKeyRequest)) (*Response, error)

SecurityInvalidateAPIKey - Invalidates one or more API keys.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html.

func (SecurityInvalidateAPIKey) WithContext ¶ 

func (f SecurityInvalidateAPIKey) WithContext(v context.Context) func(*SecurityInvalidateAPIKeyRequest)

WithContext sets the request context.

func (SecurityInvalidateAPIKey) WithErrorTrace ¶ 

func (f SecurityInvalidateAPIKey) WithErrorTrace() func(*SecurityInvalidateAPIKeyRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityInvalidateAPIKey) WithFilterPath ¶ 

func (f SecurityInvalidateAPIKey) WithFilterPath(v ...string) func(*SecurityInvalidateAPIKeyRequest)

WithFilterPath filters the properties of the response body.

func (SecurityInvalidateAPIKey) WithHeader ¶ 

func (f SecurityInvalidateAPIKey) WithHeader(h map[string]string) func(*SecurityInvalidateAPIKeyRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityInvalidateAPIKey) WithHuman ¶ 

func (f SecurityInvalidateAPIKey) WithHuman() func(*SecurityInvalidateAPIKeyRequest)

WithHuman makes statistical values human-readable.

func (SecurityInvalidateAPIKey) WithOpaqueID ¶ 

func (f SecurityInvalidateAPIKey) WithOpaqueID(s string) func(*SecurityInvalidateAPIKeyRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityInvalidateAPIKey) WithPretty ¶ 

func (f SecurityInvalidateAPIKey) WithPretty() func(*SecurityInvalidateAPIKeyRequest)

WithPretty makes the response body pretty-printed.

type SecurityInvalidateAPIKeyRequest ¶ 

type SecurityInvalidateAPIKeyRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityInvalidateAPIKeyRequest configures the Security InvalidateAPI Key API request.

func (SecurityInvalidateAPIKeyRequest) Do ¶ 

func (r SecurityInvalidateAPIKeyRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityInvalidateToken ¶ 

type SecurityInvalidateToken func(body io.Reader, o ...func(*SecurityInvalidateTokenRequest)) (*Response, error)

SecurityInvalidateToken - Invalidates one or more access tokens or refresh tokens.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html.

func (SecurityInvalidateToken) WithContext ¶ 

func (f SecurityInvalidateToken) WithContext(v context.Context) func(*SecurityInvalidateTokenRequest)

WithContext sets the request context.

func (SecurityInvalidateToken) WithErrorTrace ¶ 

func (f SecurityInvalidateToken) WithErrorTrace() func(*SecurityInvalidateTokenRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityInvalidateToken) WithFilterPath ¶ 

func (f SecurityInvalidateToken) WithFilterPath(v ...string) func(*SecurityInvalidateTokenRequest)

WithFilterPath filters the properties of the response body.

func (SecurityInvalidateToken) WithHeader ¶ 

func (f SecurityInvalidateToken) WithHeader(h map[string]string) func(*SecurityInvalidateTokenRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityInvalidateToken) WithHuman ¶ 

func (f SecurityInvalidateToken) WithHuman() func(*SecurityInvalidateTokenRequest)

WithHuman makes statistical values human-readable.

func (SecurityInvalidateToken) WithOpaqueID ¶ 

func (f SecurityInvalidateToken) WithOpaqueID(s string) func(*SecurityInvalidateTokenRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityInvalidateToken) WithPretty ¶ 

func (f SecurityInvalidateToken) WithPretty() func(*SecurityInvalidateTokenRequest)

WithPretty makes the response body pretty-printed.

type SecurityInvalidateTokenRequest ¶ 

type SecurityInvalidateTokenRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityInvalidateTokenRequest configures the Security Invalidate Token API request.

func (SecurityInvalidateTokenRequest) Do ¶ 

func (r SecurityInvalidateTokenRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityOidcAuthenticate ¶ added in v8.1.0 

type SecurityOidcAuthenticate func(body io.Reader, o ...func(*SecurityOidcAuthenticateRequest)) (*Response, error)

SecurityOidcAuthenticate - Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-authenticate.html.

func (SecurityOidcAuthenticate) WithContext ¶ added in v8.1.0 

func (f SecurityOidcAuthenticate) WithContext(v context.Context) func(*SecurityOidcAuthenticateRequest)

WithContext sets the request context.

func (SecurityOidcAuthenticate) WithErrorTrace ¶ added in v8.1.0 

func (f SecurityOidcAuthenticate) WithErrorTrace() func(*SecurityOidcAuthenticateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityOidcAuthenticate) WithFilterPath ¶ added in v8.1.0 

func (f SecurityOidcAuthenticate) WithFilterPath(v ...string) func(*SecurityOidcAuthenticateRequest)

WithFilterPath filters the properties of the response body.

func (SecurityOidcAuthenticate) WithHeader ¶ added in v8.1.0 

func (f SecurityOidcAuthenticate) WithHeader(h map[string]string) func(*SecurityOidcAuthenticateRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityOidcAuthenticate) WithHuman ¶ added in v8.1.0 

func (f SecurityOidcAuthenticate) WithHuman() func(*SecurityOidcAuthenticateRequest)

WithHuman makes statistical values human-readable.

func (SecurityOidcAuthenticate) WithOpaqueID ¶ added in v8.1.0 

func (f SecurityOidcAuthenticate) WithOpaqueID(s string) func(*SecurityOidcAuthenticateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityOidcAuthenticate) WithPretty ¶ added in v8.1.0 

func (f SecurityOidcAuthenticate) WithPretty() func(*SecurityOidcAuthenticateRequest)

WithPretty makes the response body pretty-printed.

type SecurityOidcAuthenticateRequest ¶ added in v8.1.0 

type SecurityOidcAuthenticateRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityOidcAuthenticateRequest configures the Security Oidc Authenticate API request.

func (SecurityOidcAuthenticateRequest) Do ¶ added in v8.1.0 

func (r SecurityOidcAuthenticateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityOidcLogout ¶ added in v8.1.0 

type SecurityOidcLogout func(body io.Reader, o ...func(*SecurityOidcLogoutRequest)) (*Response, error)

SecurityOidcLogout - Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-logout.html.

func (SecurityOidcLogout) WithContext ¶ added in v8.1.0 

func (f SecurityOidcLogout) WithContext(v context.Context) func(*SecurityOidcLogoutRequest)

WithContext sets the request context.

func (SecurityOidcLogout) WithErrorTrace ¶ added in v8.1.0 

func (f SecurityOidcLogout) WithErrorTrace() func(*SecurityOidcLogoutRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityOidcLogout) WithFilterPath ¶ added in v8.1.0 

func (f SecurityOidcLogout) WithFilterPath(v ...string) func(*SecurityOidcLogoutRequest)

WithFilterPath filters the properties of the response body.

func (SecurityOidcLogout) WithHeader ¶ added in v8.1.0 

func (f SecurityOidcLogout) WithHeader(h map[string]string) func(*SecurityOidcLogoutRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityOidcLogout) WithHuman ¶ added in v8.1.0 

func (f SecurityOidcLogout) WithHuman() func(*SecurityOidcLogoutRequest)

WithHuman makes statistical values human-readable.

func (SecurityOidcLogout) WithOpaqueID ¶ added in v8.1.0 

func (f SecurityOidcLogout) WithOpaqueID(s string) func(*SecurityOidcLogoutRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityOidcLogout) WithPretty ¶ added in v8.1.0 

func (f SecurityOidcLogout) WithPretty() func(*SecurityOidcLogoutRequest)

WithPretty makes the response body pretty-printed.

type SecurityOidcLogoutRequest ¶ added in v8.1.0 

type SecurityOidcLogoutRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityOidcLogoutRequest configures the Security Oidc Logout API request.

func (SecurityOidcLogoutRequest) Do ¶ added in v8.1.0 

func (r SecurityOidcLogoutRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityOidcPrepareAuthentication ¶ added in v8.1.0 

type SecurityOidcPrepareAuthentication func(body io.Reader, o ...func(*SecurityOidcPrepareAuthenticationRequest)) (*Response, error)

SecurityOidcPrepareAuthentication - Creates an OAuth 2.0 authentication request as a URL string

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-prepare-authentication.html.

func (SecurityOidcPrepareAuthentication) WithContext ¶ added in v8.1.0 

func (f SecurityOidcPrepareAuthentication) WithContext(v context.Context) func(*SecurityOidcPrepareAuthenticationRequest)

WithContext sets the request context.

func (SecurityOidcPrepareAuthentication) WithErrorTrace ¶ added in v8.1.0 

func (f SecurityOidcPrepareAuthentication) WithErrorTrace() func(*SecurityOidcPrepareAuthenticationRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityOidcPrepareAuthentication) WithFilterPath ¶ added in v8.1.0 

func (f SecurityOidcPrepareAuthentication) WithFilterPath(v ...string) func(*SecurityOidcPrepareAuthenticationRequest)

WithFilterPath filters the properties of the response body.

func (SecurityOidcPrepareAuthentication) WithHeader ¶ added in v8.1.0 

func (f SecurityOidcPrepareAuthentication) WithHeader(h map[string]string) func(*SecurityOidcPrepareAuthenticationRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityOidcPrepareAuthentication) WithHuman ¶ added in v8.1.0 

func (f SecurityOidcPrepareAuthentication) WithHuman() func(*SecurityOidcPrepareAuthenticationRequest)

WithHuman makes statistical values human-readable.

func (SecurityOidcPrepareAuthentication) WithOpaqueID ¶ added in v8.1.0 

func (f SecurityOidcPrepareAuthentication) WithOpaqueID(s string) func(*SecurityOidcPrepareAuthenticationRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityOidcPrepareAuthentication) WithPretty ¶ added in v8.1.0 

func (f SecurityOidcPrepareAuthentication) WithPretty() func(*SecurityOidcPrepareAuthenticationRequest)

WithPretty makes the response body pretty-printed.

type SecurityOidcPrepareAuthenticationRequest ¶ added in v8.1.0 

type SecurityOidcPrepareAuthenticationRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityOidcPrepareAuthenticationRequest configures the Security Oidc Prepare Authentication API request.

func (SecurityOidcPrepareAuthenticationRequest) Do ¶ added in v8.1.0 

func (r SecurityOidcPrepareAuthenticationRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityPutPrivileges ¶ 

type SecurityPutPrivileges func(body io.Reader, o ...func(*SecurityPutPrivilegesRequest)) (*Response, error)

SecurityPutPrivileges - Adds or updates application privileges.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html.

func (SecurityPutPrivileges) WithContext ¶ 

func (f SecurityPutPrivileges) WithContext(v context.Context) func(*SecurityPutPrivilegesRequest)

WithContext sets the request context.

func (SecurityPutPrivileges) WithErrorTrace ¶ 

func (f SecurityPutPrivileges) WithErrorTrace() func(*SecurityPutPrivilegesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityPutPrivileges) WithFilterPath ¶ 

func (f SecurityPutPrivileges) WithFilterPath(v ...string) func(*SecurityPutPrivilegesRequest)

WithFilterPath filters the properties of the response body.

func (SecurityPutPrivileges) WithHeader ¶ 

func (f SecurityPutPrivileges) WithHeader(h map[string]string) func(*SecurityPutPrivilegesRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityPutPrivileges) WithHuman ¶ 

func (f SecurityPutPrivileges) WithHuman() func(*SecurityPutPrivilegesRequest)

WithHuman makes statistical values human-readable.

func (SecurityPutPrivileges) WithOpaqueID ¶ 

func (f SecurityPutPrivileges) WithOpaqueID(s string) func(*SecurityPutPrivilegesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityPutPrivileges) WithPretty ¶ 

func (f SecurityPutPrivileges) WithPretty() func(*SecurityPutPrivilegesRequest)

WithPretty makes the response body pretty-printed.

func (SecurityPutPrivileges) WithRefresh ¶ 

func (f SecurityPutPrivileges) WithRefresh(v string) func(*SecurityPutPrivilegesRequest)

WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityPutPrivilegesRequest ¶ 

type SecurityPutPrivilegesRequest struct {
	Body io.Reader

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityPutPrivilegesRequest configures the Security Put Privileges API request.

func (SecurityPutPrivilegesRequest) Do ¶ 

func (r SecurityPutPrivilegesRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityPutRole ¶ 

type SecurityPutRole func(name string, body io.Reader, o ...func(*SecurityPutRoleRequest)) (*Response, error)

SecurityPutRole - Adds and updates roles in the native realm.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html.

func (SecurityPutRole) WithContext ¶ 

func (f SecurityPutRole) WithContext(v context.Context) func(*SecurityPutRoleRequest)

WithContext sets the request context.

func (SecurityPutRole) WithErrorTrace ¶ 

func (f SecurityPutRole) WithErrorTrace() func(*SecurityPutRoleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityPutRole) WithFilterPath ¶ 

func (f SecurityPutRole) WithFilterPath(v ...string) func(*SecurityPutRoleRequest)

WithFilterPath filters the properties of the response body.

func (SecurityPutRole) WithHeader ¶ 

func (f SecurityPutRole) WithHeader(h map[string]string) func(*SecurityPutRoleRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityPutRole) WithHuman ¶ 

func (f SecurityPutRole) WithHuman() func(*SecurityPutRoleRequest)

WithHuman makes statistical values human-readable.

func (SecurityPutRole) WithOpaqueID ¶ 

func (f SecurityPutRole) WithOpaqueID(s string) func(*SecurityPutRoleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityPutRole) WithPretty ¶ 

func (f SecurityPutRole) WithPretty() func(*SecurityPutRoleRequest)

WithPretty makes the response body pretty-printed.

func (SecurityPutRole) WithRefresh ¶ 

func (f SecurityPutRole) WithRefresh(v string) func(*SecurityPutRoleRequest)

WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityPutRoleMapping ¶ 

type SecurityPutRoleMapping func(name string, body io.Reader, o ...func(*SecurityPutRoleMappingRequest)) (*Response, error)

SecurityPutRoleMapping - Creates and updates role mappings.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html.

func (SecurityPutRoleMapping) WithContext ¶ 

func (f SecurityPutRoleMapping) WithContext(v context.Context) func(*SecurityPutRoleMappingRequest)

WithContext sets the request context.

func (SecurityPutRoleMapping) WithErrorTrace ¶ 

func (f SecurityPutRoleMapping) WithErrorTrace() func(*SecurityPutRoleMappingRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityPutRoleMapping) WithFilterPath ¶ 

func (f SecurityPutRoleMapping) WithFilterPath(v ...string) func(*SecurityPutRoleMappingRequest)

WithFilterPath filters the properties of the response body.

func (SecurityPutRoleMapping) WithHeader ¶ 

func (f SecurityPutRoleMapping) WithHeader(h map[string]string) func(*SecurityPutRoleMappingRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityPutRoleMapping) WithHuman ¶ 

func (f SecurityPutRoleMapping) WithHuman() func(*SecurityPutRoleMappingRequest)

WithHuman makes statistical values human-readable.

func (SecurityPutRoleMapping) WithOpaqueID ¶ 

func (f SecurityPutRoleMapping) WithOpaqueID(s string) func(*SecurityPutRoleMappingRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityPutRoleMapping) WithPretty ¶ 

func (f SecurityPutRoleMapping) WithPretty() func(*SecurityPutRoleMappingRequest)

WithPretty makes the response body pretty-printed.

func (SecurityPutRoleMapping) WithRefresh ¶ 

func (f SecurityPutRoleMapping) WithRefresh(v string) func(*SecurityPutRoleMappingRequest)

WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityPutRoleMappingRequest ¶ 

type SecurityPutRoleMappingRequest struct {
	Body io.Reader

	Name string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityPutRoleMappingRequest configures the Security Put Role Mapping API request.

func (SecurityPutRoleMappingRequest) Do ¶ 

func (r SecurityPutRoleMappingRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityPutRoleRequest ¶ 

type SecurityPutRoleRequest struct {
	Body io.Reader

	Name string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityPutRoleRequest configures the Security Put Role API request.

func (SecurityPutRoleRequest) Do ¶ 

func (r SecurityPutRoleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityPutUser ¶ 

type SecurityPutUser func(username string, body io.Reader, o ...func(*SecurityPutUserRequest)) (*Response, error)

SecurityPutUser - Adds and updates users in the native realm. These users are commonly referred to as native users.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html.

func (SecurityPutUser) WithContext ¶ 

func (f SecurityPutUser) WithContext(v context.Context) func(*SecurityPutUserRequest)

WithContext sets the request context.

func (SecurityPutUser) WithErrorTrace ¶ 

func (f SecurityPutUser) WithErrorTrace() func(*SecurityPutUserRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityPutUser) WithFilterPath ¶ 

func (f SecurityPutUser) WithFilterPath(v ...string) func(*SecurityPutUserRequest)

WithFilterPath filters the properties of the response body.

func (SecurityPutUser) WithHeader ¶ 

func (f SecurityPutUser) WithHeader(h map[string]string) func(*SecurityPutUserRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityPutUser) WithHuman ¶ 

func (f SecurityPutUser) WithHuman() func(*SecurityPutUserRequest)

WithHuman makes statistical values human-readable.

func (SecurityPutUser) WithOpaqueID ¶ 

func (f SecurityPutUser) WithOpaqueID(s string) func(*SecurityPutUserRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityPutUser) WithPretty ¶ 

func (f SecurityPutUser) WithPretty() func(*SecurityPutUserRequest)

WithPretty makes the response body pretty-printed.

func (SecurityPutUser) WithRefresh ¶ 

func (f SecurityPutUser) WithRefresh(v string) func(*SecurityPutUserRequest)

WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityPutUserRequest ¶ 

type SecurityPutUserRequest struct {
	Body io.Reader

	Username string

	Refresh string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityPutUserRequest configures the Security Put User API request.

func (SecurityPutUserRequest) Do ¶ 

func (r SecurityPutUserRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityQueryAPIKeys ¶ 

type SecurityQueryAPIKeys func(o ...func(*SecurityQueryAPIKeysRequest)) (*Response, error)

SecurityQueryAPIKeys - Retrieves information for API keys using a subset of query DSL

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html.

func (SecurityQueryAPIKeys) WithBody ¶ 

func (f SecurityQueryAPIKeys) WithBody(v io.Reader) func(*SecurityQueryAPIKeysRequest)

WithBody - From, size, query, sort and search_after.

func (SecurityQueryAPIKeys) WithContext ¶ 

func (f SecurityQueryAPIKeys) WithContext(v context.Context) func(*SecurityQueryAPIKeysRequest)

WithContext sets the request context.

func (SecurityQueryAPIKeys) WithErrorTrace ¶ 

func (f SecurityQueryAPIKeys) WithErrorTrace() func(*SecurityQueryAPIKeysRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityQueryAPIKeys) WithFilterPath ¶ 

func (f SecurityQueryAPIKeys) WithFilterPath(v ...string) func(*SecurityQueryAPIKeysRequest)

WithFilterPath filters the properties of the response body.

func (SecurityQueryAPIKeys) WithHeader ¶ 

func (f SecurityQueryAPIKeys) WithHeader(h map[string]string) func(*SecurityQueryAPIKeysRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityQueryAPIKeys) WithHuman ¶ 

func (f SecurityQueryAPIKeys) WithHuman() func(*SecurityQueryAPIKeysRequest)

WithHuman makes statistical values human-readable.

func (SecurityQueryAPIKeys) WithOpaqueID ¶ 

func (f SecurityQueryAPIKeys) WithOpaqueID(s string) func(*SecurityQueryAPIKeysRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityQueryAPIKeys) WithPretty ¶ 

func (f SecurityQueryAPIKeys) WithPretty() func(*SecurityQueryAPIKeysRequest)

WithPretty makes the response body pretty-printed.

func (SecurityQueryAPIKeys) WithTypedKeys ¶ added in v8.14.0 

func (f SecurityQueryAPIKeys) WithTypedKeys(v bool) func(*SecurityQueryAPIKeysRequest)

WithTypedKeys - flag to prefix aggregation names by their respective types in the response.

func (SecurityQueryAPIKeys) WithWithLimitedBy ¶ added in v8.5.0 

func (f SecurityQueryAPIKeys) WithWithLimitedBy(v bool) func(*SecurityQueryAPIKeysRequest)

WithWithLimitedBy - flag to show the limited-by role descriptors of api keys.

func (SecurityQueryAPIKeys) WithWithProfileUID ¶ added in v8.14.0 

func (f SecurityQueryAPIKeys) WithWithProfileUID(v bool) func(*SecurityQueryAPIKeysRequest)

WithWithProfileUID - flag to also retrieve the api key's owner profile uid, if it exists.

type SecurityQueryAPIKeysRequest ¶ 

type SecurityQueryAPIKeysRequest struct {
	Body io.Reader

	TypedKeys      *bool
	WithLimitedBy  *bool
	WithProfileUID *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityQueryAPIKeysRequest configures the Security QueryAPI Keys API request.

func (SecurityQueryAPIKeysRequest) Do ¶ 

func (r SecurityQueryAPIKeysRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityQueryRole ¶ added in v8.15.0 

type SecurityQueryRole func(o ...func(*SecurityQueryRoleRequest)) (*Response, error)

SecurityQueryRole - Retrieves information for Roles using a subset of query DSL

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-role.html.

func (SecurityQueryRole) WithBody ¶ added in v8.15.0 

func (f SecurityQueryRole) WithBody(v io.Reader) func(*SecurityQueryRoleRequest)

WithBody - From, size, query, sort and search_after.

func (SecurityQueryRole) WithContext ¶ added in v8.15.0 

func (f SecurityQueryRole) WithContext(v context.Context) func(*SecurityQueryRoleRequest)

WithContext sets the request context.

func (SecurityQueryRole) WithErrorTrace ¶ added in v8.15.0 

func (f SecurityQueryRole) WithErrorTrace() func(*SecurityQueryRoleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityQueryRole) WithFilterPath ¶ added in v8.15.0 

func (f SecurityQueryRole) WithFilterPath(v ...string) func(*SecurityQueryRoleRequest)

WithFilterPath filters the properties of the response body.

func (SecurityQueryRole) WithHeader ¶ added in v8.15.0 

func (f SecurityQueryRole) WithHeader(h map[string]string) func(*SecurityQueryRoleRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityQueryRole) WithHuman ¶ added in v8.15.0 

func (f SecurityQueryRole) WithHuman() func(*SecurityQueryRoleRequest)

WithHuman makes statistical values human-readable.

func (SecurityQueryRole) WithOpaqueID ¶ added in v8.15.0 

func (f SecurityQueryRole) WithOpaqueID(s string) func(*SecurityQueryRoleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityQueryRole) WithPretty ¶ added in v8.15.0 

func (f SecurityQueryRole) WithPretty() func(*SecurityQueryRoleRequest)

WithPretty makes the response body pretty-printed.

type SecurityQueryRoleRequest ¶ added in v8.15.0 

type SecurityQueryRoleRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityQueryRoleRequest configures the Security Query Role API request.

func (SecurityQueryRoleRequest) Do ¶ added in v8.15.0 

func (r SecurityQueryRoleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityQueryUser ¶ added in v8.13.0 

type SecurityQueryUser func(o ...func(*SecurityQueryUserRequest)) (*Response, error)

SecurityQueryUser - Retrieves information for Users using a subset of query DSL

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-user.html.

func (SecurityQueryUser) WithBody ¶ added in v8.13.0 

func (f SecurityQueryUser) WithBody(v io.Reader) func(*SecurityQueryUserRequest)

WithBody - From, size, query, sort and search_after.

func (SecurityQueryUser) WithContext ¶ added in v8.13.0 

func (f SecurityQueryUser) WithContext(v context.Context) func(*SecurityQueryUserRequest)

WithContext sets the request context.

func (SecurityQueryUser) WithErrorTrace ¶ added in v8.13.0 

func (f SecurityQueryUser) WithErrorTrace() func(*SecurityQueryUserRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityQueryUser) WithFilterPath ¶ added in v8.13.0 

func (f SecurityQueryUser) WithFilterPath(v ...string) func(*SecurityQueryUserRequest)

WithFilterPath filters the properties of the response body.

func (SecurityQueryUser) WithHeader ¶ added in v8.13.0 

func (f SecurityQueryUser) WithHeader(h map[string]string) func(*SecurityQueryUserRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityQueryUser) WithHuman ¶ added in v8.13.0 

func (f SecurityQueryUser) WithHuman() func(*SecurityQueryUserRequest)

WithHuman makes statistical values human-readable.

func (SecurityQueryUser) WithOpaqueID ¶ added in v8.13.0 

func (f SecurityQueryUser) WithOpaqueID(s string) func(*SecurityQueryUserRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityQueryUser) WithPretty ¶ added in v8.13.0 

func (f SecurityQueryUser) WithPretty() func(*SecurityQueryUserRequest)

WithPretty makes the response body pretty-printed.

func (SecurityQueryUser) WithWithProfileUID ¶ added in v8.13.0 

func (f SecurityQueryUser) WithWithProfileUID(v bool) func(*SecurityQueryUserRequest)

WithWithProfileUID - flag to retrieve profile uid (if exists) associated with the user.

type SecurityQueryUserRequest ¶ added in v8.13.0 

type SecurityQueryUserRequest struct {
	Body io.Reader

	WithProfileUID *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityQueryUserRequest configures the Security Query User API request.

func (SecurityQueryUserRequest) Do ¶ added in v8.13.0 

func (r SecurityQueryUserRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecuritySamlAuthenticate ¶ 

type SecuritySamlAuthenticate func(body io.Reader, o ...func(*SecuritySamlAuthenticateRequest)) (*Response, error)

SecuritySamlAuthenticate - Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html.

func (SecuritySamlAuthenticate) WithContext ¶ 

func (f SecuritySamlAuthenticate) WithContext(v context.Context) func(*SecuritySamlAuthenticateRequest)

WithContext sets the request context.

func (SecuritySamlAuthenticate) WithErrorTrace ¶ 

func (f SecuritySamlAuthenticate) WithErrorTrace() func(*SecuritySamlAuthenticateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecuritySamlAuthenticate) WithFilterPath ¶ 

func (f SecuritySamlAuthenticate) WithFilterPath(v ...string) func(*SecuritySamlAuthenticateRequest)

WithFilterPath filters the properties of the response body.

func (SecuritySamlAuthenticate) WithHeader ¶ 

func (f SecuritySamlAuthenticate) WithHeader(h map[string]string) func(*SecuritySamlAuthenticateRequest)

WithHeader adds the headers to the HTTP request.

func (SecuritySamlAuthenticate) WithHuman ¶ 

func (f SecuritySamlAuthenticate) WithHuman() func(*SecuritySamlAuthenticateRequest)

WithHuman makes statistical values human-readable.

func (SecuritySamlAuthenticate) WithOpaqueID ¶ 

func (f SecuritySamlAuthenticate) WithOpaqueID(s string) func(*SecuritySamlAuthenticateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecuritySamlAuthenticate) WithPretty ¶ 

func (f SecuritySamlAuthenticate) WithPretty() func(*SecuritySamlAuthenticateRequest)

WithPretty makes the response body pretty-printed.

type SecuritySamlAuthenticateRequest ¶ 

type SecuritySamlAuthenticateRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecuritySamlAuthenticateRequest configures the Security Saml Authenticate API request.

func (SecuritySamlAuthenticateRequest) Do ¶ 

func (r SecuritySamlAuthenticateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecuritySamlCompleteLogout ¶ 

type SecuritySamlCompleteLogout func(body io.Reader, o ...func(*SecuritySamlCompleteLogoutRequest)) (*Response, error)

SecuritySamlCompleteLogout - Verifies the logout response sent from the SAML IdP

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-complete-logout.html.

func (SecuritySamlCompleteLogout) WithContext ¶ 

func (f SecuritySamlCompleteLogout) WithContext(v context.Context) func(*SecuritySamlCompleteLogoutRequest)

WithContext sets the request context.

func (SecuritySamlCompleteLogout) WithErrorTrace ¶ 

func (f SecuritySamlCompleteLogout) WithErrorTrace() func(*SecuritySamlCompleteLogoutRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecuritySamlCompleteLogout) WithFilterPath ¶ 

func (f SecuritySamlCompleteLogout) WithFilterPath(v ...string) func(*SecuritySamlCompleteLogoutRequest)

WithFilterPath filters the properties of the response body.

func (SecuritySamlCompleteLogout) WithHeader ¶ 

func (f SecuritySamlCompleteLogout) WithHeader(h map[string]string) func(*SecuritySamlCompleteLogoutRequest)

WithHeader adds the headers to the HTTP request.

func (SecuritySamlCompleteLogout) WithHuman ¶ 

func (f SecuritySamlCompleteLogout) WithHuman() func(*SecuritySamlCompleteLogoutRequest)

WithHuman makes statistical values human-readable.

func (SecuritySamlCompleteLogout) WithOpaqueID ¶ 

func (f SecuritySamlCompleteLogout) WithOpaqueID(s string) func(*SecuritySamlCompleteLogoutRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecuritySamlCompleteLogout) WithPretty ¶ 

func (f SecuritySamlCompleteLogout) WithPretty() func(*SecuritySamlCompleteLogoutRequest)

WithPretty makes the response body pretty-printed.

type SecuritySamlCompleteLogoutRequest ¶ 

type SecuritySamlCompleteLogoutRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecuritySamlCompleteLogoutRequest configures the Security Saml Complete Logout API request.

func (SecuritySamlCompleteLogoutRequest) Do ¶ 

func (r SecuritySamlCompleteLogoutRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecuritySamlInvalidate ¶ 

type SecuritySamlInvalidate func(body io.Reader, o ...func(*SecuritySamlInvalidateRequest)) (*Response, error)

SecuritySamlInvalidate - Consumes a SAML LogoutRequest

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html.

func (SecuritySamlInvalidate) WithContext ¶ 

func (f SecuritySamlInvalidate) WithContext(v context.Context) func(*SecuritySamlInvalidateRequest)

WithContext sets the request context.

func (SecuritySamlInvalidate) WithErrorTrace ¶ 

func (f SecuritySamlInvalidate) WithErrorTrace() func(*SecuritySamlInvalidateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecuritySamlInvalidate) WithFilterPath ¶ 

func (f SecuritySamlInvalidate) WithFilterPath(v ...string) func(*SecuritySamlInvalidateRequest)

WithFilterPath filters the properties of the response body.

func (SecuritySamlInvalidate) WithHeader ¶ 

func (f SecuritySamlInvalidate) WithHeader(h map[string]string) func(*SecuritySamlInvalidateRequest)

WithHeader adds the headers to the HTTP request.

func (SecuritySamlInvalidate) WithHuman ¶ 

func (f SecuritySamlInvalidate) WithHuman() func(*SecuritySamlInvalidateRequest)

WithHuman makes statistical values human-readable.

func (SecuritySamlInvalidate) WithOpaqueID ¶ 

func (f SecuritySamlInvalidate) WithOpaqueID(s string) func(*SecuritySamlInvalidateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecuritySamlInvalidate) WithPretty ¶ 

func (f SecuritySamlInvalidate) WithPretty() func(*SecuritySamlInvalidateRequest)

WithPretty makes the response body pretty-printed.

type SecuritySamlInvalidateRequest ¶ 

type SecuritySamlInvalidateRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecuritySamlInvalidateRequest configures the Security Saml Invalidate API request.

func (SecuritySamlInvalidateRequest) Do ¶ 

func (r SecuritySamlInvalidateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecuritySamlLogout ¶ 

type SecuritySamlLogout func(body io.Reader, o ...func(*SecuritySamlLogoutRequest)) (*Response, error)

SecuritySamlLogout - Invalidates an access token and a refresh token that were generated via the SAML Authenticate API

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html.

func (SecuritySamlLogout) WithContext ¶ 

func (f SecuritySamlLogout) WithContext(v context.Context) func(*SecuritySamlLogoutRequest)

WithContext sets the request context.

func (SecuritySamlLogout) WithErrorTrace ¶ 

func (f SecuritySamlLogout) WithErrorTrace() func(*SecuritySamlLogoutRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecuritySamlLogout) WithFilterPath ¶ 

func (f SecuritySamlLogout) WithFilterPath(v ...string) func(*SecuritySamlLogoutRequest)

WithFilterPath filters the properties of the response body.

func (SecuritySamlLogout) WithHeader ¶ 

func (f SecuritySamlLogout) WithHeader(h map[string]string) func(*SecuritySamlLogoutRequest)

WithHeader adds the headers to the HTTP request.

func (SecuritySamlLogout) WithHuman ¶ 

func (f SecuritySamlLogout) WithHuman() func(*SecuritySamlLogoutRequest)

WithHuman makes statistical values human-readable.

func (SecuritySamlLogout) WithOpaqueID ¶ 

func (f SecuritySamlLogout) WithOpaqueID(s string) func(*SecuritySamlLogoutRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecuritySamlLogout) WithPretty ¶ 

func (f SecuritySamlLogout) WithPretty() func(*SecuritySamlLogoutRequest)

WithPretty makes the response body pretty-printed.

type SecuritySamlLogoutRequest ¶ 

type SecuritySamlLogoutRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecuritySamlLogoutRequest configures the Security Saml Logout API request.

func (SecuritySamlLogoutRequest) Do ¶ 

func (r SecuritySamlLogoutRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecuritySamlPrepareAuthentication ¶ 

type SecuritySamlPrepareAuthentication func(body io.Reader, o ...func(*SecuritySamlPrepareAuthenticationRequest)) (*Response, error)

SecuritySamlPrepareAuthentication - Creates a SAML authentication request

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html.

func (SecuritySamlPrepareAuthentication) WithContext ¶ 

func (f SecuritySamlPrepareAuthentication) WithContext(v context.Context) func(*SecuritySamlPrepareAuthenticationRequest)

WithContext sets the request context.

func (SecuritySamlPrepareAuthentication) WithErrorTrace ¶ 

func (f SecuritySamlPrepareAuthentication) WithErrorTrace() func(*SecuritySamlPrepareAuthenticationRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecuritySamlPrepareAuthentication) WithFilterPath ¶ 

func (f SecuritySamlPrepareAuthentication) WithFilterPath(v ...string) func(*SecuritySamlPrepareAuthenticationRequest)

WithFilterPath filters the properties of the response body.

func (SecuritySamlPrepareAuthentication) WithHeader ¶ 

func (f SecuritySamlPrepareAuthentication) WithHeader(h map[string]string) func(*SecuritySamlPrepareAuthenticationRequest)

WithHeader adds the headers to the HTTP request.

func (SecuritySamlPrepareAuthentication) WithHuman ¶ 

func (f SecuritySamlPrepareAuthentication) WithHuman() func(*SecuritySamlPrepareAuthenticationRequest)

WithHuman makes statistical values human-readable.

func (SecuritySamlPrepareAuthentication) WithOpaqueID ¶ 

func (f SecuritySamlPrepareAuthentication) WithOpaqueID(s string) func(*SecuritySamlPrepareAuthenticationRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecuritySamlPrepareAuthentication) WithPretty ¶ 

func (f SecuritySamlPrepareAuthentication) WithPretty() func(*SecuritySamlPrepareAuthenticationRequest)

WithPretty makes the response body pretty-printed.

type SecuritySamlPrepareAuthenticationRequest ¶ 

type SecuritySamlPrepareAuthenticationRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecuritySamlPrepareAuthenticationRequest configures the Security Saml Prepare Authentication API request.

func (SecuritySamlPrepareAuthenticationRequest) Do ¶ 

func (r SecuritySamlPrepareAuthenticationRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecuritySamlServiceProviderMetadata ¶ 

type SecuritySamlServiceProviderMetadata func(realm_name string, o ...func(*SecuritySamlServiceProviderMetadataRequest)) (*Response, error)

SecuritySamlServiceProviderMetadata - Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html.

func (SecuritySamlServiceProviderMetadata) WithContext ¶ 

func (f SecuritySamlServiceProviderMetadata) WithContext(v context.Context) func(*SecuritySamlServiceProviderMetadataRequest)

WithContext sets the request context.

func (SecuritySamlServiceProviderMetadata) WithErrorTrace ¶ 

func (f SecuritySamlServiceProviderMetadata) WithErrorTrace() func(*SecuritySamlServiceProviderMetadataRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecuritySamlServiceProviderMetadata) WithFilterPath ¶ 

func (f SecuritySamlServiceProviderMetadata) WithFilterPath(v ...string) func(*SecuritySamlServiceProviderMetadataRequest)

WithFilterPath filters the properties of the response body.

func (SecuritySamlServiceProviderMetadata) WithHeader ¶ 

func (f SecuritySamlServiceProviderMetadata) WithHeader(h map[string]string) func(*SecuritySamlServiceProviderMetadataRequest)

WithHeader adds the headers to the HTTP request.

func (SecuritySamlServiceProviderMetadata) WithHuman ¶ 

func (f SecuritySamlServiceProviderMetadata) WithHuman() func(*SecuritySamlServiceProviderMetadataRequest)

WithHuman makes statistical values human-readable.

func (SecuritySamlServiceProviderMetadata) WithOpaqueID ¶ 

func (f SecuritySamlServiceProviderMetadata) WithOpaqueID(s string) func(*SecuritySamlServiceProviderMetadataRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecuritySamlServiceProviderMetadata) WithPretty ¶ 

func (f SecuritySamlServiceProviderMetadata) WithPretty() func(*SecuritySamlServiceProviderMetadataRequest)

WithPretty makes the response body pretty-printed.

type SecuritySamlServiceProviderMetadataRequest ¶ 

type SecuritySamlServiceProviderMetadataRequest struct {
	RealmName string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecuritySamlServiceProviderMetadataRequest configures the Security Saml Service Provider Metadata API request.

func (SecuritySamlServiceProviderMetadataRequest) Do ¶ 

func (r SecuritySamlServiceProviderMetadataRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecuritySuggestUserProfiles ¶ added in v8.2.0 

type SecuritySuggestUserProfiles func(o ...func(*SecuritySuggestUserProfilesRequest)) (*Response, error)

SecuritySuggestUserProfiles - Get suggestions for user profiles that match specified search criteria.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-suggest-user-profile.html.

func (SecuritySuggestUserProfiles) WithBody ¶ added in v8.2.0 

func (f SecuritySuggestUserProfiles) WithBody(v io.Reader) func(*SecuritySuggestUserProfilesRequest)

WithBody - The suggestion definition for user profiles.

func (SecuritySuggestUserProfiles) WithContext ¶ added in v8.2.0 

func (f SecuritySuggestUserProfiles) WithContext(v context.Context) func(*SecuritySuggestUserProfilesRequest)

WithContext sets the request context.

func (SecuritySuggestUserProfiles) WithData ¶ added in v8.2.0 

func (f SecuritySuggestUserProfiles) WithData(v ...string) func(*SecuritySuggestUserProfilesRequest)

WithData - a list of keys for which the corresponding application data are retrieved..

func (SecuritySuggestUserProfiles) WithErrorTrace ¶ added in v8.2.0 

func (f SecuritySuggestUserProfiles) WithErrorTrace() func(*SecuritySuggestUserProfilesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecuritySuggestUserProfiles) WithFilterPath ¶ added in v8.2.0 

func (f SecuritySuggestUserProfiles) WithFilterPath(v ...string) func(*SecuritySuggestUserProfilesRequest)

WithFilterPath filters the properties of the response body.

func (SecuritySuggestUserProfiles) WithHeader ¶ added in v8.2.0 

func (f SecuritySuggestUserProfiles) WithHeader(h map[string]string) func(*SecuritySuggestUserProfilesRequest)

WithHeader adds the headers to the HTTP request.

func (SecuritySuggestUserProfiles) WithHuman ¶ added in v8.2.0 

func (f SecuritySuggestUserProfiles) WithHuman() func(*SecuritySuggestUserProfilesRequest)

WithHuman makes statistical values human-readable.

func (SecuritySuggestUserProfiles) WithOpaqueID ¶ added in v8.2.0 

func (f SecuritySuggestUserProfiles) WithOpaqueID(s string) func(*SecuritySuggestUserProfilesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecuritySuggestUserProfiles) WithPretty ¶ added in v8.2.0 

func (f SecuritySuggestUserProfiles) WithPretty() func(*SecuritySuggestUserProfilesRequest)

WithPretty makes the response body pretty-printed.

type SecuritySuggestUserProfilesRequest ¶ added in v8.2.0 

type SecuritySuggestUserProfilesRequest struct {
	Body io.Reader

	Data []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecuritySuggestUserProfilesRequest configures the Security Suggest User Profiles API request.

func (SecuritySuggestUserProfilesRequest) Do ¶ added in v8.2.0 

func (r SecuritySuggestUserProfilesRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityUpdateAPIKey ¶ added in v8.4.0 

type SecurityUpdateAPIKey func(id string, o ...func(*SecurityUpdateAPIKeyRequest)) (*Response, error)

SecurityUpdateAPIKey - Updates attributes of an existing API key.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html.

func (SecurityUpdateAPIKey) WithBody ¶ added in v8.4.0 

func (f SecurityUpdateAPIKey) WithBody(v io.Reader) func(*SecurityUpdateAPIKeyRequest)

WithBody - The API key request to update attributes of an API key..

func (SecurityUpdateAPIKey) WithContext ¶ added in v8.4.0 

func (f SecurityUpdateAPIKey) WithContext(v context.Context) func(*SecurityUpdateAPIKeyRequest)

WithContext sets the request context.

func (SecurityUpdateAPIKey) WithErrorTrace ¶ added in v8.4.0 

func (f SecurityUpdateAPIKey) WithErrorTrace() func(*SecurityUpdateAPIKeyRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityUpdateAPIKey) WithFilterPath ¶ added in v8.4.0 

func (f SecurityUpdateAPIKey) WithFilterPath(v ...string) func(*SecurityUpdateAPIKeyRequest)

WithFilterPath filters the properties of the response body.

func (SecurityUpdateAPIKey) WithHeader ¶ added in v8.4.0 

func (f SecurityUpdateAPIKey) WithHeader(h map[string]string) func(*SecurityUpdateAPIKeyRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityUpdateAPIKey) WithHuman ¶ added in v8.4.0 

func (f SecurityUpdateAPIKey) WithHuman() func(*SecurityUpdateAPIKeyRequest)

WithHuman makes statistical values human-readable.

func (SecurityUpdateAPIKey) WithOpaqueID ¶ added in v8.4.0 

func (f SecurityUpdateAPIKey) WithOpaqueID(s string) func(*SecurityUpdateAPIKeyRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityUpdateAPIKey) WithPretty ¶ added in v8.4.0 

func (f SecurityUpdateAPIKey) WithPretty() func(*SecurityUpdateAPIKeyRequest)

WithPretty makes the response body pretty-printed.

type SecurityUpdateAPIKeyRequest ¶ added in v8.4.0 

type SecurityUpdateAPIKeyRequest struct {
	DocumentID string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityUpdateAPIKeyRequest configures the Security UpdateAPI Key API request.

func (SecurityUpdateAPIKeyRequest) Do ¶ added in v8.4.0 

func (r SecurityUpdateAPIKeyRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityUpdateCrossClusterAPIKey ¶ added in v8.9.0 

type SecurityUpdateCrossClusterAPIKey func(id string, body io.Reader, o ...func(*SecurityUpdateCrossClusterAPIKeyRequest)) (*Response, error)

SecurityUpdateCrossClusterAPIKey - Updates attributes of an existing cross-cluster API key.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-cross-cluster-api-key.html.

func (SecurityUpdateCrossClusterAPIKey) WithContext ¶ added in v8.9.0 

func (f SecurityUpdateCrossClusterAPIKey) WithContext(v context.Context) func(*SecurityUpdateCrossClusterAPIKeyRequest)

WithContext sets the request context.

func (SecurityUpdateCrossClusterAPIKey) WithErrorTrace ¶ added in v8.9.0 

func (f SecurityUpdateCrossClusterAPIKey) WithErrorTrace() func(*SecurityUpdateCrossClusterAPIKeyRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityUpdateCrossClusterAPIKey) WithFilterPath ¶ added in v8.9.0 

func (f SecurityUpdateCrossClusterAPIKey) WithFilterPath(v ...string) func(*SecurityUpdateCrossClusterAPIKeyRequest)

WithFilterPath filters the properties of the response body.

func (SecurityUpdateCrossClusterAPIKey) WithHeader ¶ added in v8.9.0 

func (f SecurityUpdateCrossClusterAPIKey) WithHeader(h map[string]string) func(*SecurityUpdateCrossClusterAPIKeyRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityUpdateCrossClusterAPIKey) WithHuman ¶ added in v8.9.0 

func (f SecurityUpdateCrossClusterAPIKey) WithHuman() func(*SecurityUpdateCrossClusterAPIKeyRequest)

WithHuman makes statistical values human-readable.

func (SecurityUpdateCrossClusterAPIKey) WithOpaqueID ¶ added in v8.9.0 

func (f SecurityUpdateCrossClusterAPIKey) WithOpaqueID(s string) func(*SecurityUpdateCrossClusterAPIKeyRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityUpdateCrossClusterAPIKey) WithPretty ¶ added in v8.9.0 

func (f SecurityUpdateCrossClusterAPIKey) WithPretty() func(*SecurityUpdateCrossClusterAPIKeyRequest)

WithPretty makes the response body pretty-printed.

type SecurityUpdateCrossClusterAPIKeyRequest ¶ added in v8.9.0 

type SecurityUpdateCrossClusterAPIKeyRequest struct {
	DocumentID string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityUpdateCrossClusterAPIKeyRequest configures the Security Update Cross ClusterAPI Key API request.

func (SecurityUpdateCrossClusterAPIKeyRequest) Do ¶ added in v8.9.0 

func (r SecurityUpdateCrossClusterAPIKeyRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityUpdateSettings ¶ added in v8.10.0 

type SecurityUpdateSettings func(body io.Reader, o ...func(*SecurityUpdateSettingsRequest)) (*Response, error)

SecurityUpdateSettings - Update settings for the security system index

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-settings.html.

func (SecurityUpdateSettings) WithContext ¶ added in v8.10.0 

func (f SecurityUpdateSettings) WithContext(v context.Context) func(*SecurityUpdateSettingsRequest)

WithContext sets the request context.

func (SecurityUpdateSettings) WithErrorTrace ¶ added in v8.10.0 

func (f SecurityUpdateSettings) WithErrorTrace() func(*SecurityUpdateSettingsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityUpdateSettings) WithFilterPath ¶ added in v8.10.0 

func (f SecurityUpdateSettings) WithFilterPath(v ...string) func(*SecurityUpdateSettingsRequest)

WithFilterPath filters the properties of the response body.

func (SecurityUpdateSettings) WithHeader ¶ added in v8.10.0 

func (f SecurityUpdateSettings) WithHeader(h map[string]string) func(*SecurityUpdateSettingsRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityUpdateSettings) WithHuman ¶ added in v8.10.0 

func (f SecurityUpdateSettings) WithHuman() func(*SecurityUpdateSettingsRequest)

WithHuman makes statistical values human-readable.

func (SecurityUpdateSettings) WithMasterTimeout ¶ added in v8.15.0 

func (f SecurityUpdateSettings) WithMasterTimeout(v time.Duration) func(*SecurityUpdateSettingsRequest)

WithMasterTimeout - timeout for connection to master.

func (SecurityUpdateSettings) WithOpaqueID ¶ added in v8.10.0 

func (f SecurityUpdateSettings) WithOpaqueID(s string) func(*SecurityUpdateSettingsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityUpdateSettings) WithPretty ¶ added in v8.10.0 

func (f SecurityUpdateSettings) WithPretty() func(*SecurityUpdateSettingsRequest)

WithPretty makes the response body pretty-printed.

func (SecurityUpdateSettings) WithTimeout ¶ added in v8.15.0 

func (f SecurityUpdateSettings) WithTimeout(v time.Duration) func(*SecurityUpdateSettingsRequest)

WithTimeout - timeout for acknowledgements from all nodes.

type SecurityUpdateSettingsRequest ¶ added in v8.10.0 

type SecurityUpdateSettingsRequest struct {
	Body io.Reader

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityUpdateSettingsRequest configures the Security Update Settings API request.

func (SecurityUpdateSettingsRequest) Do ¶ added in v8.10.0 

func (r SecurityUpdateSettingsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SecurityUpdateUserProfileData ¶ added in v8.2.0 

type SecurityUpdateUserProfileData func(body io.Reader, uid string, o ...func(*SecurityUpdateUserProfileDataRequest)) (*Response, error)

SecurityUpdateUserProfileData - Update application specific data for the user profile of the given unique ID.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-user-profile-data.html.

func (SecurityUpdateUserProfileData) WithContext ¶ added in v8.2.0 

func (f SecurityUpdateUserProfileData) WithContext(v context.Context) func(*SecurityUpdateUserProfileDataRequest)

WithContext sets the request context.

func (SecurityUpdateUserProfileData) WithErrorTrace ¶ added in v8.2.0 

func (f SecurityUpdateUserProfileData) WithErrorTrace() func(*SecurityUpdateUserProfileDataRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SecurityUpdateUserProfileData) WithFilterPath ¶ added in v8.2.0 

func (f SecurityUpdateUserProfileData) WithFilterPath(v ...string) func(*SecurityUpdateUserProfileDataRequest)

WithFilterPath filters the properties of the response body.

func (SecurityUpdateUserProfileData) WithHeader ¶ added in v8.2.0 

func (f SecurityUpdateUserProfileData) WithHeader(h map[string]string) func(*SecurityUpdateUserProfileDataRequest)

WithHeader adds the headers to the HTTP request.

func (SecurityUpdateUserProfileData) WithHuman ¶ added in v8.2.0 

func (f SecurityUpdateUserProfileData) WithHuman() func(*SecurityUpdateUserProfileDataRequest)

WithHuman makes statistical values human-readable.

func (SecurityUpdateUserProfileData) WithIfPrimaryTerm ¶ added in v8.2.0 

func (f SecurityUpdateUserProfileData) WithIfPrimaryTerm(v int) func(*SecurityUpdateUserProfileDataRequest)

WithIfPrimaryTerm - only perform the update operation if the last operation that has changed the document has the specified primary term.

func (SecurityUpdateUserProfileData) WithIfSeqNo ¶ added in v8.2.0 

func (f SecurityUpdateUserProfileData) WithIfSeqNo(v int) func(*SecurityUpdateUserProfileDataRequest)

WithIfSeqNo - only perform the update operation if the last operation that has changed the document has the specified sequence number.

func (SecurityUpdateUserProfileData) WithOpaqueID ¶ added in v8.2.0 

func (f SecurityUpdateUserProfileData) WithOpaqueID(s string) func(*SecurityUpdateUserProfileDataRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SecurityUpdateUserProfileData) WithPretty ¶ added in v8.2.0 

func (f SecurityUpdateUserProfileData) WithPretty() func(*SecurityUpdateUserProfileDataRequest)

WithPretty makes the response body pretty-printed.

func (SecurityUpdateUserProfileData) WithRefresh ¶ added in v8.2.0 

func (f SecurityUpdateUserProfileData) WithRefresh(v string) func(*SecurityUpdateUserProfileDataRequest)

WithRefresh - if `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes..

type SecurityUpdateUserProfileDataRequest ¶ added in v8.2.0 

type SecurityUpdateUserProfileDataRequest struct {
	Body io.Reader

	UID string

	IfPrimaryTerm *int
	IfSeqNo       *int
	Refresh       string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SecurityUpdateUserProfileDataRequest configures the Security Update User Profile Data API request.

func (SecurityUpdateUserProfileDataRequest) Do ¶ added in v8.2.0 

func (r SecurityUpdateUserProfileDataRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ShutdownDeleteNode ¶ 

type ShutdownDeleteNode func(node_id string, o ...func(*ShutdownDeleteNodeRequest)) (*Response, error)

ShutdownDeleteNode removes a node from the shutdown list. 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.

func (ShutdownDeleteNode) WithContext ¶ 

func (f ShutdownDeleteNode) WithContext(v context.Context) func(*ShutdownDeleteNodeRequest)

WithContext sets the request context.

func (ShutdownDeleteNode) WithErrorTrace ¶ 

func (f ShutdownDeleteNode) WithErrorTrace() func(*ShutdownDeleteNodeRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ShutdownDeleteNode) WithFilterPath ¶ 

func (f ShutdownDeleteNode) WithFilterPath(v ...string) func(*ShutdownDeleteNodeRequest)

WithFilterPath filters the properties of the response body.

func (ShutdownDeleteNode) WithHeader ¶ 

func (f ShutdownDeleteNode) WithHeader(h map[string]string) func(*ShutdownDeleteNodeRequest)

WithHeader adds the headers to the HTTP request.

func (ShutdownDeleteNode) WithHuman ¶ 

func (f ShutdownDeleteNode) WithHuman() func(*ShutdownDeleteNodeRequest)

WithHuman makes statistical values human-readable.

func (ShutdownDeleteNode) WithMasterTimeout ¶ added in v8.18.0 

func (f ShutdownDeleteNode) WithMasterTimeout(v time.Duration) func(*ShutdownDeleteNodeRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (ShutdownDeleteNode) WithOpaqueID ¶ 

func (f ShutdownDeleteNode) WithOpaqueID(s string) func(*ShutdownDeleteNodeRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ShutdownDeleteNode) WithPretty ¶ 

func (f ShutdownDeleteNode) WithPretty() func(*ShutdownDeleteNodeRequest)

WithPretty makes the response body pretty-printed.

func (ShutdownDeleteNode) WithTimeout ¶ added in v8.18.0 

func (f ShutdownDeleteNode) WithTimeout(v time.Duration) func(*ShutdownDeleteNodeRequest)

WithTimeout - explicit operation timeout.

type ShutdownDeleteNodeRequest ¶ 

type ShutdownDeleteNodeRequest struct {
	NodeID string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ShutdownDeleteNodeRequest configures the Shutdown Delete Node API request.

func (ShutdownDeleteNodeRequest) Do ¶ 

func (r ShutdownDeleteNodeRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ShutdownGetNode ¶ 

type ShutdownGetNode func(o ...func(*ShutdownGetNodeRequest)) (*Response, error)

ShutdownGetNode retrieve status of a node or nodes that are currently marked as shutting down. 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.

func (ShutdownGetNode) WithContext ¶ 

func (f ShutdownGetNode) WithContext(v context.Context) func(*ShutdownGetNodeRequest)

WithContext sets the request context.

func (ShutdownGetNode) WithErrorTrace ¶ 

func (f ShutdownGetNode) WithErrorTrace() func(*ShutdownGetNodeRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ShutdownGetNode) WithFilterPath ¶ 

func (f ShutdownGetNode) WithFilterPath(v ...string) func(*ShutdownGetNodeRequest)

WithFilterPath filters the properties of the response body.

func (ShutdownGetNode) WithHeader ¶ 

func (f ShutdownGetNode) WithHeader(h map[string]string) func(*ShutdownGetNodeRequest)

WithHeader adds the headers to the HTTP request.

func (ShutdownGetNode) WithHuman ¶ 

func (f ShutdownGetNode) WithHuman() func(*ShutdownGetNodeRequest)

WithHuman makes statistical values human-readable.

func (ShutdownGetNode) WithMasterTimeout ¶ added in v8.15.0 

func (f ShutdownGetNode) WithMasterTimeout(v time.Duration) func(*ShutdownGetNodeRequest)

WithMasterTimeout - timeout for processing on master node.

func (ShutdownGetNode) WithNodeID ¶ 

func (f ShutdownGetNode) WithNodeID(v string) func(*ShutdownGetNodeRequest)

WithNodeID - which node for which to retrieve the shutdown status.

func (ShutdownGetNode) WithOpaqueID ¶ 

func (f ShutdownGetNode) WithOpaqueID(s string) func(*ShutdownGetNodeRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ShutdownGetNode) WithPretty ¶ 

func (f ShutdownGetNode) WithPretty() func(*ShutdownGetNodeRequest)

WithPretty makes the response body pretty-printed.

type ShutdownGetNodeRequest ¶ 

type ShutdownGetNodeRequest struct {
	NodeID string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ShutdownGetNodeRequest configures the Shutdown Get Node API request.

func (ShutdownGetNodeRequest) Do ¶ 

func (r ShutdownGetNodeRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type ShutdownPutNode ¶ 

type ShutdownPutNode func(body io.Reader, node_id string, o ...func(*ShutdownPutNodeRequest)) (*Response, error)

ShutdownPutNode adds a node to be shut down. 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.

func (ShutdownPutNode) WithContext ¶ 

func (f ShutdownPutNode) WithContext(v context.Context) func(*ShutdownPutNodeRequest)

WithContext sets the request context.

func (ShutdownPutNode) WithErrorTrace ¶ 

func (f ShutdownPutNode) WithErrorTrace() func(*ShutdownPutNodeRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (ShutdownPutNode) WithFilterPath ¶ 

func (f ShutdownPutNode) WithFilterPath(v ...string) func(*ShutdownPutNodeRequest)

WithFilterPath filters the properties of the response body.

func (ShutdownPutNode) WithHeader ¶ 

func (f ShutdownPutNode) WithHeader(h map[string]string) func(*ShutdownPutNodeRequest)

WithHeader adds the headers to the HTTP request.

func (ShutdownPutNode) WithHuman ¶ 

func (f ShutdownPutNode) WithHuman() func(*ShutdownPutNodeRequest)

WithHuman makes statistical values human-readable.

func (ShutdownPutNode) WithMasterTimeout ¶ added in v8.18.0 

func (f ShutdownPutNode) WithMasterTimeout(v time.Duration) func(*ShutdownPutNodeRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (ShutdownPutNode) WithOpaqueID ¶ 

func (f ShutdownPutNode) WithOpaqueID(s string) func(*ShutdownPutNodeRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (ShutdownPutNode) WithPretty ¶ 

func (f ShutdownPutNode) WithPretty() func(*ShutdownPutNodeRequest)

WithPretty makes the response body pretty-printed.

func (ShutdownPutNode) WithTimeout ¶ added in v8.18.0 

func (f ShutdownPutNode) WithTimeout(v time.Duration) func(*ShutdownPutNodeRequest)

WithTimeout - explicit operation timeout.

type ShutdownPutNodeRequest ¶ 

type ShutdownPutNodeRequest struct {
	Body io.Reader

	NodeID string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

ShutdownPutNodeRequest configures the Shutdown Put Node API request.

func (ShutdownPutNodeRequest) Do ¶ 

func (r ShutdownPutNodeRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SimulateIngest ¶ added in v8.12.0 

type SimulateIngest func(body io.Reader, o ...func(*SimulateIngestRequest)) (*Response, error)

SimulateIngest simulates running ingest with example documents.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-ingest-api.html.

func (SimulateIngest) WithContext ¶ added in v8.12.0 

func (f SimulateIngest) WithContext(v context.Context) func(*SimulateIngestRequest)

WithContext sets the request context.

func (SimulateIngest) WithErrorTrace ¶ added in v8.12.0 

func (f SimulateIngest) WithErrorTrace() func(*SimulateIngestRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SimulateIngest) WithFilterPath ¶ added in v8.12.0 

func (f SimulateIngest) WithFilterPath(v ...string) func(*SimulateIngestRequest)

WithFilterPath filters the properties of the response body.

func (SimulateIngest) WithHeader ¶ added in v8.12.0 

func (f SimulateIngest) WithHeader(h map[string]string) func(*SimulateIngestRequest)

WithHeader adds the headers to the HTTP request.

func (SimulateIngest) WithHuman ¶ added in v8.12.0 

func (f SimulateIngest) WithHuman() func(*SimulateIngestRequest)

WithHuman makes statistical values human-readable.

func (SimulateIngest) WithIndex ¶ added in v8.12.0 

func (f SimulateIngest) WithIndex(v string) func(*SimulateIngestRequest)

WithIndex - default index for docs which don't provide one.

func (SimulateIngest) WithOpaqueID ¶ added in v8.12.0 

func (f SimulateIngest) WithOpaqueID(s string) func(*SimulateIngestRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SimulateIngest) WithPipeline ¶ added in v8.12.0 

func (f SimulateIngest) WithPipeline(v string) func(*SimulateIngestRequest)

WithPipeline - the pipeline ID to preprocess incoming documents with if no pipeline is given for a particular document.

func (SimulateIngest) WithPretty ¶ added in v8.12.0 

func (f SimulateIngest) WithPretty() func(*SimulateIngestRequest)

WithPretty makes the response body pretty-printed.

type SimulateIngestRequest ¶ added in v8.12.0 

type SimulateIngestRequest struct {
	Index string

	Body io.Reader

	Pipeline string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SimulateIngestRequest configures the Simulate Ingest API request.

func (SimulateIngestRequest) Do ¶ added in v8.12.0 

func (r SimulateIngestRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SlmDeleteLifecycle ¶ 

type SlmDeleteLifecycle func(policy_id string, o ...func(*SlmDeleteLifecycleRequest)) (*Response, error)

SlmDeleteLifecycle - Deletes an existing snapshot lifecycle policy.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html.

func (SlmDeleteLifecycle) WithContext ¶ 

func (f SlmDeleteLifecycle) WithContext(v context.Context) func(*SlmDeleteLifecycleRequest)

WithContext sets the request context.

func (SlmDeleteLifecycle) WithErrorTrace ¶ 

func (f SlmDeleteLifecycle) WithErrorTrace() func(*SlmDeleteLifecycleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SlmDeleteLifecycle) WithFilterPath ¶ 

func (f SlmDeleteLifecycle) WithFilterPath(v ...string) func(*SlmDeleteLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (SlmDeleteLifecycle) WithHeader ¶ 

func (f SlmDeleteLifecycle) WithHeader(h map[string]string) func(*SlmDeleteLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (SlmDeleteLifecycle) WithHuman ¶ 

func (f SlmDeleteLifecycle) WithHuman() func(*SlmDeleteLifecycleRequest)

WithHuman makes statistical values human-readable.

func (SlmDeleteLifecycle) WithMasterTimeout ¶ added in v8.18.0 

func (f SlmDeleteLifecycle) WithMasterTimeout(v time.Duration) func(*SlmDeleteLifecycleRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SlmDeleteLifecycle) WithOpaqueID ¶ 

func (f SlmDeleteLifecycle) WithOpaqueID(s string) func(*SlmDeleteLifecycleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SlmDeleteLifecycle) WithPretty ¶ 

func (f SlmDeleteLifecycle) WithPretty() func(*SlmDeleteLifecycleRequest)

WithPretty makes the response body pretty-printed.

func (SlmDeleteLifecycle) WithTimeout ¶ added in v8.18.0 

func (f SlmDeleteLifecycle) WithTimeout(v time.Duration) func(*SlmDeleteLifecycleRequest)

WithTimeout - explicit operation timeout.

type SlmDeleteLifecycleRequest ¶ 

type SlmDeleteLifecycleRequest struct {
	PolicyID string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SlmDeleteLifecycleRequest configures the Slm Delete Lifecycle API request.

func (SlmDeleteLifecycleRequest) Do ¶ 

func (r SlmDeleteLifecycleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SlmExecuteLifecycle ¶ 

type SlmExecuteLifecycle func(policy_id string, o ...func(*SlmExecuteLifecycleRequest)) (*Response, error)

SlmExecuteLifecycle - Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html.

func (SlmExecuteLifecycle) WithContext ¶ 

func (f SlmExecuteLifecycle) WithContext(v context.Context) func(*SlmExecuteLifecycleRequest)

WithContext sets the request context.

func (SlmExecuteLifecycle) WithErrorTrace ¶ 

func (f SlmExecuteLifecycle) WithErrorTrace() func(*SlmExecuteLifecycleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SlmExecuteLifecycle) WithFilterPath ¶ 

func (f SlmExecuteLifecycle) WithFilterPath(v ...string) func(*SlmExecuteLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (SlmExecuteLifecycle) WithHeader ¶ 

func (f SlmExecuteLifecycle) WithHeader(h map[string]string) func(*SlmExecuteLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (SlmExecuteLifecycle) WithHuman ¶ 

func (f SlmExecuteLifecycle) WithHuman() func(*SlmExecuteLifecycleRequest)

WithHuman makes statistical values human-readable.

func (SlmExecuteLifecycle) WithMasterTimeout ¶ added in v8.18.0 

func (f SlmExecuteLifecycle) WithMasterTimeout(v time.Duration) func(*SlmExecuteLifecycleRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SlmExecuteLifecycle) WithOpaqueID ¶ 

func (f SlmExecuteLifecycle) WithOpaqueID(s string) func(*SlmExecuteLifecycleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SlmExecuteLifecycle) WithPretty ¶ 

func (f SlmExecuteLifecycle) WithPretty() func(*SlmExecuteLifecycleRequest)

WithPretty makes the response body pretty-printed.

func (SlmExecuteLifecycle) WithTimeout ¶ added in v8.18.0 

func (f SlmExecuteLifecycle) WithTimeout(v time.Duration) func(*SlmExecuteLifecycleRequest)

WithTimeout - explicit operation timeout.

type SlmExecuteLifecycleRequest ¶ 

type SlmExecuteLifecycleRequest struct {
	PolicyID string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SlmExecuteLifecycleRequest configures the Slm Execute Lifecycle API request.

func (SlmExecuteLifecycleRequest) Do ¶ 

func (r SlmExecuteLifecycleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SlmExecuteRetention ¶ 

type SlmExecuteRetention func(o ...func(*SlmExecuteRetentionRequest)) (*Response, error)

SlmExecuteRetention - Deletes any snapshots that are expired according to the policy's retention rules.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html.

func (SlmExecuteRetention) WithContext ¶ 

func (f SlmExecuteRetention) WithContext(v context.Context) func(*SlmExecuteRetentionRequest)

WithContext sets the request context.

func (SlmExecuteRetention) WithErrorTrace ¶ 

func (f SlmExecuteRetention) WithErrorTrace() func(*SlmExecuteRetentionRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SlmExecuteRetention) WithFilterPath ¶ 

func (f SlmExecuteRetention) WithFilterPath(v ...string) func(*SlmExecuteRetentionRequest)

WithFilterPath filters the properties of the response body.

func (SlmExecuteRetention) WithHeader ¶ 

func (f SlmExecuteRetention) WithHeader(h map[string]string) func(*SlmExecuteRetentionRequest)

WithHeader adds the headers to the HTTP request.

func (SlmExecuteRetention) WithHuman ¶ 

func (f SlmExecuteRetention) WithHuman() func(*SlmExecuteRetentionRequest)

WithHuman makes statistical values human-readable.

func (SlmExecuteRetention) WithMasterTimeout ¶ added in v8.18.0 

func (f SlmExecuteRetention) WithMasterTimeout(v time.Duration) func(*SlmExecuteRetentionRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SlmExecuteRetention) WithOpaqueID ¶ 

func (f SlmExecuteRetention) WithOpaqueID(s string) func(*SlmExecuteRetentionRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SlmExecuteRetention) WithPretty ¶ 

func (f SlmExecuteRetention) WithPretty() func(*SlmExecuteRetentionRequest)

WithPretty makes the response body pretty-printed.

func (SlmExecuteRetention) WithTimeout ¶ added in v8.18.0 

func (f SlmExecuteRetention) WithTimeout(v time.Duration) func(*SlmExecuteRetentionRequest)

WithTimeout - explicit operation timeout.

type SlmExecuteRetentionRequest ¶ 

type SlmExecuteRetentionRequest struct {
	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SlmExecuteRetentionRequest configures the Slm Execute Retention API request.

func (SlmExecuteRetentionRequest) Do ¶ 

func (r SlmExecuteRetentionRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SlmGetLifecycle ¶ 

type SlmGetLifecycle func(o ...func(*SlmGetLifecycleRequest)) (*Response, error)

SlmGetLifecycle - Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html.

func (SlmGetLifecycle) WithContext ¶ 

func (f SlmGetLifecycle) WithContext(v context.Context) func(*SlmGetLifecycleRequest)

WithContext sets the request context.

func (SlmGetLifecycle) WithErrorTrace ¶ 

func (f SlmGetLifecycle) WithErrorTrace() func(*SlmGetLifecycleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SlmGetLifecycle) WithFilterPath ¶ 

func (f SlmGetLifecycle) WithFilterPath(v ...string) func(*SlmGetLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (SlmGetLifecycle) WithHeader ¶ 

func (f SlmGetLifecycle) WithHeader(h map[string]string) func(*SlmGetLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (SlmGetLifecycle) WithHuman ¶ 

func (f SlmGetLifecycle) WithHuman() func(*SlmGetLifecycleRequest)

WithHuman makes statistical values human-readable.

func (SlmGetLifecycle) WithMasterTimeout ¶ added in v8.18.0 

func (f SlmGetLifecycle) WithMasterTimeout(v time.Duration) func(*SlmGetLifecycleRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SlmGetLifecycle) WithOpaqueID ¶ 

func (f SlmGetLifecycle) WithOpaqueID(s string) func(*SlmGetLifecycleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SlmGetLifecycle) WithPolicyID ¶ 

func (f SlmGetLifecycle) WithPolicyID(v ...string) func(*SlmGetLifecycleRequest)

WithPolicyID - comma-separated list of snapshot lifecycle policies to retrieve.

func (SlmGetLifecycle) WithPretty ¶ 

func (f SlmGetLifecycle) WithPretty() func(*SlmGetLifecycleRequest)

WithPretty makes the response body pretty-printed.

func (SlmGetLifecycle) WithTimeout ¶ added in v8.18.0 

func (f SlmGetLifecycle) WithTimeout(v time.Duration) func(*SlmGetLifecycleRequest)

WithTimeout - explicit operation timeout.

type SlmGetLifecycleRequest ¶ 

type SlmGetLifecycleRequest struct {
	PolicyID []string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SlmGetLifecycleRequest configures the Slm Get Lifecycle API request.

func (SlmGetLifecycleRequest) Do ¶ 

func (r SlmGetLifecycleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SlmGetStats ¶ 

type SlmGetStats func(o ...func(*SlmGetStatsRequest)) (*Response, error)

SlmGetStats - Returns global and policy-level statistics about actions taken by snapshot lifecycle management.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-get-stats.html.

func (SlmGetStats) WithContext ¶ 

func (f SlmGetStats) WithContext(v context.Context) func(*SlmGetStatsRequest)

WithContext sets the request context.

func (SlmGetStats) WithErrorTrace ¶ 

func (f SlmGetStats) WithErrorTrace() func(*SlmGetStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SlmGetStats) WithFilterPath ¶ 

func (f SlmGetStats) WithFilterPath(v ...string) func(*SlmGetStatsRequest)

WithFilterPath filters the properties of the response body.

func (SlmGetStats) WithHeader ¶ 

func (f SlmGetStats) WithHeader(h map[string]string) func(*SlmGetStatsRequest)

WithHeader adds the headers to the HTTP request.

func (SlmGetStats) WithHuman ¶ 

func (f SlmGetStats) WithHuman() func(*SlmGetStatsRequest)

WithHuman makes statistical values human-readable.

func (SlmGetStats) WithMasterTimeout ¶ added in v8.18.0 

func (f SlmGetStats) WithMasterTimeout(v time.Duration) func(*SlmGetStatsRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SlmGetStats) WithOpaqueID ¶ 

func (f SlmGetStats) WithOpaqueID(s string) func(*SlmGetStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SlmGetStats) WithPretty ¶ 

func (f SlmGetStats) WithPretty() func(*SlmGetStatsRequest)

WithPretty makes the response body pretty-printed.

func (SlmGetStats) WithTimeout ¶ added in v8.18.0 

func (f SlmGetStats) WithTimeout(v time.Duration) func(*SlmGetStatsRequest)

WithTimeout - explicit operation timeout.

type SlmGetStatsRequest ¶ 

type SlmGetStatsRequest struct {
	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SlmGetStatsRequest configures the Slm Get Stats API request.

func (SlmGetStatsRequest) Do ¶ 

func (r SlmGetStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SlmGetStatus ¶ 

type SlmGetStatus func(o ...func(*SlmGetStatusRequest)) (*Response, error)

SlmGetStatus - Retrieves the status of snapshot lifecycle management (SLM).

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html.

func (SlmGetStatus) WithContext ¶ 

func (f SlmGetStatus) WithContext(v context.Context) func(*SlmGetStatusRequest)

WithContext sets the request context.

func (SlmGetStatus) WithErrorTrace ¶ 

func (f SlmGetStatus) WithErrorTrace() func(*SlmGetStatusRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SlmGetStatus) WithFilterPath ¶ 

func (f SlmGetStatus) WithFilterPath(v ...string) func(*SlmGetStatusRequest)

WithFilterPath filters the properties of the response body.

func (SlmGetStatus) WithHeader ¶ 

func (f SlmGetStatus) WithHeader(h map[string]string) func(*SlmGetStatusRequest)

WithHeader adds the headers to the HTTP request.

func (SlmGetStatus) WithHuman ¶ 

func (f SlmGetStatus) WithHuman() func(*SlmGetStatusRequest)

WithHuman makes statistical values human-readable.

func (SlmGetStatus) WithMasterTimeout ¶ added in v8.18.0 

func (f SlmGetStatus) WithMasterTimeout(v time.Duration) func(*SlmGetStatusRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SlmGetStatus) WithOpaqueID ¶ 

func (f SlmGetStatus) WithOpaqueID(s string) func(*SlmGetStatusRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SlmGetStatus) WithPretty ¶ 

func (f SlmGetStatus) WithPretty() func(*SlmGetStatusRequest)

WithPretty makes the response body pretty-printed.

func (SlmGetStatus) WithTimeout ¶ added in v8.18.0 

func (f SlmGetStatus) WithTimeout(v time.Duration) func(*SlmGetStatusRequest)

WithTimeout - explicit operation timeout.

type SlmGetStatusRequest ¶ 

type SlmGetStatusRequest struct {
	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SlmGetStatusRequest configures the Slm Get Status API request.

func (SlmGetStatusRequest) Do ¶ 

func (r SlmGetStatusRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SlmPutLifecycle ¶ 

type SlmPutLifecycle func(policy_id string, o ...func(*SlmPutLifecycleRequest)) (*Response, error)

SlmPutLifecycle - Creates or updates a snapshot lifecycle policy.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html.

func (SlmPutLifecycle) WithBody ¶ 

func (f SlmPutLifecycle) WithBody(v io.Reader) func(*SlmPutLifecycleRequest)

WithBody - The snapshot lifecycle policy definition to register.

func (SlmPutLifecycle) WithContext ¶ 

func (f SlmPutLifecycle) WithContext(v context.Context) func(*SlmPutLifecycleRequest)

WithContext sets the request context.

func (SlmPutLifecycle) WithErrorTrace ¶ 

func (f SlmPutLifecycle) WithErrorTrace() func(*SlmPutLifecycleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SlmPutLifecycle) WithFilterPath ¶ 

func (f SlmPutLifecycle) WithFilterPath(v ...string) func(*SlmPutLifecycleRequest)

WithFilterPath filters the properties of the response body.

func (SlmPutLifecycle) WithHeader ¶ 

func (f SlmPutLifecycle) WithHeader(h map[string]string) func(*SlmPutLifecycleRequest)

WithHeader adds the headers to the HTTP request.

func (SlmPutLifecycle) WithHuman ¶ 

func (f SlmPutLifecycle) WithHuman() func(*SlmPutLifecycleRequest)

WithHuman makes statistical values human-readable.

func (SlmPutLifecycle) WithMasterTimeout ¶ added in v8.18.0 

func (f SlmPutLifecycle) WithMasterTimeout(v time.Duration) func(*SlmPutLifecycleRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SlmPutLifecycle) WithOpaqueID ¶ 

func (f SlmPutLifecycle) WithOpaqueID(s string) func(*SlmPutLifecycleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SlmPutLifecycle) WithPretty ¶ 

func (f SlmPutLifecycle) WithPretty() func(*SlmPutLifecycleRequest)

WithPretty makes the response body pretty-printed.

func (SlmPutLifecycle) WithTimeout ¶ added in v8.18.0 

func (f SlmPutLifecycle) WithTimeout(v time.Duration) func(*SlmPutLifecycleRequest)

WithTimeout - explicit operation timeout.

type SlmPutLifecycleRequest ¶ 

type SlmPutLifecycleRequest struct {
	Body io.Reader

	PolicyID string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SlmPutLifecycleRequest configures the Slm Put Lifecycle API request.

func (SlmPutLifecycleRequest) Do ¶ 

func (r SlmPutLifecycleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SlmStart ¶ 

type SlmStart func(o ...func(*SlmStartRequest)) (*Response, error)

SlmStart - Turns on snapshot lifecycle management (SLM).

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html.

func (SlmStart) WithContext ¶ 

func (f SlmStart) WithContext(v context.Context) func(*SlmStartRequest)

WithContext sets the request context.

func (SlmStart) WithErrorTrace ¶ 

func (f SlmStart) WithErrorTrace() func(*SlmStartRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SlmStart) WithFilterPath ¶ 

func (f SlmStart) WithFilterPath(v ...string) func(*SlmStartRequest)

WithFilterPath filters the properties of the response body.

func (SlmStart) WithHeader ¶ 

func (f SlmStart) WithHeader(h map[string]string) func(*SlmStartRequest)

WithHeader adds the headers to the HTTP request.

func (SlmStart) WithHuman ¶ 

func (f SlmStart) WithHuman() func(*SlmStartRequest)

WithHuman makes statistical values human-readable.

func (SlmStart) WithMasterTimeout ¶ added in v8.15.0 

func (f SlmStart) WithMasterTimeout(v time.Duration) func(*SlmStartRequest)

WithMasterTimeout - timeout for processing on master node.

func (SlmStart) WithOpaqueID ¶ 

func (f SlmStart) WithOpaqueID(s string) func(*SlmStartRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SlmStart) WithPretty ¶ 

func (f SlmStart) WithPretty() func(*SlmStartRequest)

WithPretty makes the response body pretty-printed.

func (SlmStart) WithTimeout ¶ added in v8.15.0 

func (f SlmStart) WithTimeout(v time.Duration) func(*SlmStartRequest)

WithTimeout - timeout for acknowledgement of update from all nodes in cluster.

type SlmStartRequest ¶ 

type SlmStartRequest struct {
	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SlmStartRequest configures the Slm Start API request.

func (SlmStartRequest) Do ¶ 

func (r SlmStartRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SlmStop ¶ 

type SlmStop func(o ...func(*SlmStopRequest)) (*Response, error)

SlmStop - Turns off snapshot lifecycle management (SLM).

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html.

func (SlmStop) WithContext ¶ 

func (f SlmStop) WithContext(v context.Context) func(*SlmStopRequest)

WithContext sets the request context.

func (SlmStop) WithErrorTrace ¶ 

func (f SlmStop) WithErrorTrace() func(*SlmStopRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SlmStop) WithFilterPath ¶ 

func (f SlmStop) WithFilterPath(v ...string) func(*SlmStopRequest)

WithFilterPath filters the properties of the response body.

func (SlmStop) WithHeader ¶ 

func (f SlmStop) WithHeader(h map[string]string) func(*SlmStopRequest)

WithHeader adds the headers to the HTTP request.

func (SlmStop) WithHuman ¶ 

func (f SlmStop) WithHuman() func(*SlmStopRequest)

WithHuman makes statistical values human-readable.

func (SlmStop) WithMasterTimeout ¶ added in v8.15.0 

func (f SlmStop) WithMasterTimeout(v time.Duration) func(*SlmStopRequest)

WithMasterTimeout - timeout for processing on master node.

func (SlmStop) WithOpaqueID ¶ 

func (f SlmStop) WithOpaqueID(s string) func(*SlmStopRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SlmStop) WithPretty ¶ 

func (f SlmStop) WithPretty() func(*SlmStopRequest)

WithPretty makes the response body pretty-printed.

func (SlmStop) WithTimeout ¶ added in v8.15.0 

func (f SlmStop) WithTimeout(v time.Duration) func(*SlmStopRequest)

WithTimeout - timeout for acknowledgement of update from all nodes in cluster.

type SlmStopRequest ¶ 

type SlmStopRequest struct {
	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SlmStopRequest configures the Slm Stop API request.

func (SlmStopRequest) Do ¶ 

func (r SlmStopRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Snapshot ¶ 

type Snapshot struct {
	CleanupRepository         SnapshotCleanupRepository
	Clone                     SnapshotClone
	CreateRepository          SnapshotCreateRepository
	Create                    SnapshotCreate
	DeleteRepository          SnapshotDeleteRepository
	Delete                    SnapshotDelete
	GetRepository             SnapshotGetRepository
	Get                       SnapshotGet
	RepositoryAnalyze         SnapshotRepositoryAnalyze
	RepositoryVerifyIntegrity SnapshotRepositoryVerifyIntegrity
	Restore                   SnapshotRestore
	Status                    SnapshotStatus
	VerifyRepository          SnapshotVerifyRepository
}

Snapshot contains the Snapshot APIs

type SnapshotCleanupRepository ¶ 

type SnapshotCleanupRepository func(repository string, o ...func(*SnapshotCleanupRepositoryRequest)) (*Response, error)

SnapshotCleanupRepository removes stale data from repository.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/clean-up-snapshot-repo-api.html.

func (SnapshotCleanupRepository) WithContext ¶ 

func (f SnapshotCleanupRepository) WithContext(v context.Context) func(*SnapshotCleanupRepositoryRequest)

WithContext sets the request context.

func (SnapshotCleanupRepository) WithErrorTrace ¶ 

func (f SnapshotCleanupRepository) WithErrorTrace() func(*SnapshotCleanupRepositoryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotCleanupRepository) WithFilterPath ¶ 

func (f SnapshotCleanupRepository) WithFilterPath(v ...string) func(*SnapshotCleanupRepositoryRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotCleanupRepository) WithHeader ¶ 

func (f SnapshotCleanupRepository) WithHeader(h map[string]string) func(*SnapshotCleanupRepositoryRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotCleanupRepository) WithHuman ¶ 

func (f SnapshotCleanupRepository) WithHuman() func(*SnapshotCleanupRepositoryRequest)

WithHuman makes statistical values human-readable.

func (SnapshotCleanupRepository) WithMasterTimeout ¶ 

func (f SnapshotCleanupRepository) WithMasterTimeout(v time.Duration) func(*SnapshotCleanupRepositoryRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotCleanupRepository) WithOpaqueID ¶ 

func (f SnapshotCleanupRepository) WithOpaqueID(s string) func(*SnapshotCleanupRepositoryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotCleanupRepository) WithPretty ¶ 

func (f SnapshotCleanupRepository) WithPretty() func(*SnapshotCleanupRepositoryRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotCleanupRepository) WithTimeout ¶ 

func (f SnapshotCleanupRepository) WithTimeout(v time.Duration) func(*SnapshotCleanupRepositoryRequest)

WithTimeout - explicit operation timeout.

type SnapshotCleanupRepositoryRequest ¶ 

type SnapshotCleanupRepositoryRequest struct {
	Repository string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SnapshotCleanupRepositoryRequest configures the Snapshot Cleanup Repository API request.

func (SnapshotCleanupRepositoryRequest) Do ¶ 

func (r SnapshotCleanupRepositoryRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotClone ¶ 

type SnapshotClone func(repository string, snapshot string, body io.Reader, target_snapshot string, o ...func(*SnapshotCloneRequest)) (*Response, error)

SnapshotClone clones indices from one snapshot into another snapshot in the same repository.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotClone) WithContext ¶ 

func (f SnapshotClone) WithContext(v context.Context) func(*SnapshotCloneRequest)

WithContext sets the request context.

func (SnapshotClone) WithErrorTrace ¶ 

func (f SnapshotClone) WithErrorTrace() func(*SnapshotCloneRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotClone) WithFilterPath ¶ 

func (f SnapshotClone) WithFilterPath(v ...string) func(*SnapshotCloneRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotClone) WithHeader ¶ 

func (f SnapshotClone) WithHeader(h map[string]string) func(*SnapshotCloneRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotClone) WithHuman ¶ 

func (f SnapshotClone) WithHuman() func(*SnapshotCloneRequest)

WithHuman makes statistical values human-readable.

func (SnapshotClone) WithMasterTimeout ¶ 

func (f SnapshotClone) WithMasterTimeout(v time.Duration) func(*SnapshotCloneRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotClone) WithOpaqueID ¶ 

func (f SnapshotClone) WithOpaqueID(s string) func(*SnapshotCloneRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotClone) WithPretty ¶ 

func (f SnapshotClone) WithPretty() func(*SnapshotCloneRequest)

WithPretty makes the response body pretty-printed.

type SnapshotCloneRequest ¶ 

type SnapshotCloneRequest struct {
	Body io.Reader

	Repository     string
	Snapshot       string
	TargetSnapshot string

	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SnapshotCloneRequest configures the Snapshot Clone API request.

func (SnapshotCloneRequest) Do ¶ 

func (r SnapshotCloneRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotCreate ¶ 

type SnapshotCreate func(repository string, snapshot string, o ...func(*SnapshotCreateRequest)) (*Response, error)

SnapshotCreate creates a snapshot in a repository.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotCreate) WithBody ¶ 

func (f SnapshotCreate) WithBody(v io.Reader) func(*SnapshotCreateRequest)

WithBody - The snapshot definition.

func (SnapshotCreate) WithContext ¶ 

func (f SnapshotCreate) WithContext(v context.Context) func(*SnapshotCreateRequest)

WithContext sets the request context.

func (SnapshotCreate) WithErrorTrace ¶ 

func (f SnapshotCreate) WithErrorTrace() func(*SnapshotCreateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotCreate) WithFilterPath ¶ 

func (f SnapshotCreate) WithFilterPath(v ...string) func(*SnapshotCreateRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotCreate) WithHeader ¶ 

func (f SnapshotCreate) WithHeader(h map[string]string) func(*SnapshotCreateRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotCreate) WithHuman ¶ 

func (f SnapshotCreate) WithHuman() func(*SnapshotCreateRequest)

WithHuman makes statistical values human-readable.

func (SnapshotCreate) WithMasterTimeout ¶ 

func (f SnapshotCreate) WithMasterTimeout(v time.Duration) func(*SnapshotCreateRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotCreate) WithOpaqueID ¶ 

func (f SnapshotCreate) WithOpaqueID(s string) func(*SnapshotCreateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotCreate) WithPretty ¶ 

func (f SnapshotCreate) WithPretty() func(*SnapshotCreateRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotCreate) WithWaitForCompletion ¶ 

func (f SnapshotCreate) WithWaitForCompletion(v bool) func(*SnapshotCreateRequest)

WithWaitForCompletion - should this request wait until the operation has completed before returning.

type SnapshotCreateRepository ¶ 

type SnapshotCreateRepository func(repository string, body io.Reader, o ...func(*SnapshotCreateRepositoryRequest)) (*Response, error)

SnapshotCreateRepository creates a repository.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotCreateRepository) WithContext ¶ 

func (f SnapshotCreateRepository) WithContext(v context.Context) func(*SnapshotCreateRepositoryRequest)

WithContext sets the request context.

func (SnapshotCreateRepository) WithErrorTrace ¶ 

func (f SnapshotCreateRepository) WithErrorTrace() func(*SnapshotCreateRepositoryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotCreateRepository) WithFilterPath ¶ 

func (f SnapshotCreateRepository) WithFilterPath(v ...string) func(*SnapshotCreateRepositoryRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotCreateRepository) WithHeader ¶ 

func (f SnapshotCreateRepository) WithHeader(h map[string]string) func(*SnapshotCreateRepositoryRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotCreateRepository) WithHuman ¶ 

func (f SnapshotCreateRepository) WithHuman() func(*SnapshotCreateRepositoryRequest)

WithHuman makes statistical values human-readable.

func (SnapshotCreateRepository) WithMasterTimeout ¶ 

func (f SnapshotCreateRepository) WithMasterTimeout(v time.Duration) func(*SnapshotCreateRepositoryRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotCreateRepository) WithOpaqueID ¶ 

func (f SnapshotCreateRepository) WithOpaqueID(s string) func(*SnapshotCreateRepositoryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotCreateRepository) WithPretty ¶ 

func (f SnapshotCreateRepository) WithPretty() func(*SnapshotCreateRepositoryRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotCreateRepository) WithTimeout ¶ 

func (f SnapshotCreateRepository) WithTimeout(v time.Duration) func(*SnapshotCreateRepositoryRequest)

WithTimeout - explicit operation timeout.

func (SnapshotCreateRepository) WithVerify ¶ 

func (f SnapshotCreateRepository) WithVerify(v bool) func(*SnapshotCreateRepositoryRequest)

WithVerify - whether to verify the repository after creation.

type SnapshotCreateRepositoryRequest ¶ 

type SnapshotCreateRepositoryRequest struct {
	Body io.Reader

	Repository string

	MasterTimeout time.Duration
	Timeout       time.Duration
	Verify        *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SnapshotCreateRepositoryRequest configures the Snapshot Create Repository API request.

func (SnapshotCreateRepositoryRequest) Do ¶ 

func (r SnapshotCreateRepositoryRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotCreateRequest ¶ 

type SnapshotCreateRequest struct {
	Body io.Reader

	Repository string
	Snapshot   string

	MasterTimeout     time.Duration
	WaitForCompletion *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SnapshotCreateRequest configures the Snapshot Create API request.

func (SnapshotCreateRequest) Do ¶ 

func (r SnapshotCreateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotDelete ¶ 

type SnapshotDelete func(repository string, snapshot []string, o ...func(*SnapshotDeleteRequest)) (*Response, error)

SnapshotDelete deletes one or more snapshots.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotDelete) WithContext ¶ 

func (f SnapshotDelete) WithContext(v context.Context) func(*SnapshotDeleteRequest)

WithContext sets the request context.

func (SnapshotDelete) WithErrorTrace ¶ 

func (f SnapshotDelete) WithErrorTrace() func(*SnapshotDeleteRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotDelete) WithFilterPath ¶ 

func (f SnapshotDelete) WithFilterPath(v ...string) func(*SnapshotDeleteRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotDelete) WithHeader ¶ 

func (f SnapshotDelete) WithHeader(h map[string]string) func(*SnapshotDeleteRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotDelete) WithHuman ¶ 

func (f SnapshotDelete) WithHuman() func(*SnapshotDeleteRequest)

WithHuman makes statistical values human-readable.

func (SnapshotDelete) WithMasterTimeout ¶ 

func (f SnapshotDelete) WithMasterTimeout(v time.Duration) func(*SnapshotDeleteRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotDelete) WithOpaqueID ¶ 

func (f SnapshotDelete) WithOpaqueID(s string) func(*SnapshotDeleteRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotDelete) WithPretty ¶ 

func (f SnapshotDelete) WithPretty() func(*SnapshotDeleteRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotDelete) WithWaitForCompletion ¶ added in v8.15.0 

func (f SnapshotDelete) WithWaitForCompletion(v bool) func(*SnapshotDeleteRequest)

WithWaitForCompletion - should this request wait until the operation has completed before returning.

type SnapshotDeleteRepository ¶ 

type SnapshotDeleteRepository func(repository []string, o ...func(*SnapshotDeleteRepositoryRequest)) (*Response, error)

SnapshotDeleteRepository deletes a repository.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotDeleteRepository) WithContext ¶ 

func (f SnapshotDeleteRepository) WithContext(v context.Context) func(*SnapshotDeleteRepositoryRequest)

WithContext sets the request context.

func (SnapshotDeleteRepository) WithErrorTrace ¶ 

func (f SnapshotDeleteRepository) WithErrorTrace() func(*SnapshotDeleteRepositoryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotDeleteRepository) WithFilterPath ¶ 

func (f SnapshotDeleteRepository) WithFilterPath(v ...string) func(*SnapshotDeleteRepositoryRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotDeleteRepository) WithHeader ¶ 

func (f SnapshotDeleteRepository) WithHeader(h map[string]string) func(*SnapshotDeleteRepositoryRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotDeleteRepository) WithHuman ¶ 

func (f SnapshotDeleteRepository) WithHuman() func(*SnapshotDeleteRepositoryRequest)

WithHuman makes statistical values human-readable.

func (SnapshotDeleteRepository) WithMasterTimeout ¶ 

func (f SnapshotDeleteRepository) WithMasterTimeout(v time.Duration) func(*SnapshotDeleteRepositoryRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotDeleteRepository) WithOpaqueID ¶ 

func (f SnapshotDeleteRepository) WithOpaqueID(s string) func(*SnapshotDeleteRepositoryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotDeleteRepository) WithPretty ¶ 

func (f SnapshotDeleteRepository) WithPretty() func(*SnapshotDeleteRepositoryRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotDeleteRepository) WithTimeout ¶ 

func (f SnapshotDeleteRepository) WithTimeout(v time.Duration) func(*SnapshotDeleteRepositoryRequest)

WithTimeout - explicit operation timeout.

type SnapshotDeleteRepositoryRequest ¶ 

type SnapshotDeleteRepositoryRequest struct {
	Repository []string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SnapshotDeleteRepositoryRequest configures the Snapshot Delete Repository API request.

func (SnapshotDeleteRepositoryRequest) Do ¶ 

func (r SnapshotDeleteRepositoryRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotDeleteRequest ¶ 

type SnapshotDeleteRequest struct {
	Repository string
	Snapshot   []string

	MasterTimeout     time.Duration
	WaitForCompletion *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SnapshotDeleteRequest configures the Snapshot Delete API request.

func (SnapshotDeleteRequest) Do ¶ 

func (r SnapshotDeleteRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotGet ¶ 

type SnapshotGet func(repository string, snapshot []string, o ...func(*SnapshotGetRequest)) (*Response, error)

SnapshotGet returns information about a snapshot.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotGet) WithAfter ¶ added in v8.4.0 

func (f SnapshotGet) WithAfter(v string) func(*SnapshotGetRequest)

WithAfter - offset identifier to start pagination from as returned by the 'next' field in the response body..

func (SnapshotGet) WithContext ¶ 

func (f SnapshotGet) WithContext(v context.Context) func(*SnapshotGetRequest)

WithContext sets the request context.

func (SnapshotGet) WithErrorTrace ¶ 

func (f SnapshotGet) WithErrorTrace() func(*SnapshotGetRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotGet) WithFilterPath ¶ 

func (f SnapshotGet) WithFilterPath(v ...string) func(*SnapshotGetRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotGet) WithFromSortValue ¶ added in v8.4.0 

func (f SnapshotGet) WithFromSortValue(v string) func(*SnapshotGetRequest)

WithFromSortValue - value of the current sort column at which to start retrieval..

func (SnapshotGet) WithHeader ¶ 

func (f SnapshotGet) WithHeader(h map[string]string) func(*SnapshotGetRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotGet) WithHuman ¶ 

func (f SnapshotGet) WithHuman() func(*SnapshotGetRequest)

WithHuman makes statistical values human-readable.

func (SnapshotGet) WithIgnoreUnavailable ¶ 

func (f SnapshotGet) WithIgnoreUnavailable(v bool) func(*SnapshotGetRequest)

WithIgnoreUnavailable - whether to ignore unavailable snapshots, defaults to false which means a snapshotmissingexception is thrown.

func (SnapshotGet) WithIncludeRepository ¶ 

func (f SnapshotGet) WithIncludeRepository(v bool) func(*SnapshotGetRequest)

WithIncludeRepository - whether to include the repository name in the snapshot info. defaults to true..

func (SnapshotGet) WithIndexDetails ¶ 

func (f SnapshotGet) WithIndexDetails(v bool) func(*SnapshotGetRequest)

WithIndexDetails - whether to include details of each index in the snapshot, if those details are available. defaults to false..

func (SnapshotGet) WithIndexNames ¶ added in v8.3.0 

func (f SnapshotGet) WithIndexNames(v bool) func(*SnapshotGetRequest)

WithIndexNames - whether to include the name of each index in the snapshot. defaults to true..

func (SnapshotGet) WithMasterTimeout ¶ 

func (f SnapshotGet) WithMasterTimeout(v time.Duration) func(*SnapshotGetRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotGet) WithOffset ¶ added in v8.4.0 

func (f SnapshotGet) WithOffset(v int) func(*SnapshotGetRequest)

WithOffset - numeric offset to start pagination based on the snapshots matching the request. defaults to 0.

func (SnapshotGet) WithOpaqueID ¶ 

func (f SnapshotGet) WithOpaqueID(s string) func(*SnapshotGetRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotGet) WithOrder ¶ added in v8.4.0 

func (f SnapshotGet) WithOrder(v string) func(*SnapshotGetRequest)

WithOrder - sort order.

func (SnapshotGet) WithPretty ¶ 

func (f SnapshotGet) WithPretty() func(*SnapshotGetRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotGet) WithSize ¶ added in v8.4.0 

func (f SnapshotGet) WithSize(v int) func(*SnapshotGetRequest)

WithSize - maximum number of snapshots to return. defaults to 0 which means return all that match without limit..

func (SnapshotGet) WithSlmPolicyFilter ¶ added in v8.4.0 

func (f SnapshotGet) WithSlmPolicyFilter(v string) func(*SnapshotGetRequest)

WithSlmPolicyFilter - filter snapshots by a list of slm policy names that snapshots belong to. accepts wildcards. use the special pattern '_none' to match snapshots without an slm policy.

func (SnapshotGet) WithSort ¶ added in v8.4.0 

func (f SnapshotGet) WithSort(v string) func(*SnapshotGetRequest)

WithSort - allows setting a sort order for the result. defaults to start_time.

func (SnapshotGet) WithVerbose ¶ 

func (f SnapshotGet) WithVerbose(v bool) func(*SnapshotGetRequest)

WithVerbose - whether to show verbose snapshot info or only show the basic info found in the repository index blob.

type SnapshotGetRepository ¶ 

type SnapshotGetRepository func(o ...func(*SnapshotGetRepositoryRequest)) (*Response, error)

SnapshotGetRepository returns information about a repository.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotGetRepository) WithContext ¶ 

func (f SnapshotGetRepository) WithContext(v context.Context) func(*SnapshotGetRepositoryRequest)

WithContext sets the request context.

func (SnapshotGetRepository) WithErrorTrace ¶ 

func (f SnapshotGetRepository) WithErrorTrace() func(*SnapshotGetRepositoryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotGetRepository) WithFilterPath ¶ 

func (f SnapshotGetRepository) WithFilterPath(v ...string) func(*SnapshotGetRepositoryRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotGetRepository) WithHeader ¶ 

func (f SnapshotGetRepository) WithHeader(h map[string]string) func(*SnapshotGetRepositoryRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotGetRepository) WithHuman ¶ 

func (f SnapshotGetRepository) WithHuman() func(*SnapshotGetRepositoryRequest)

WithHuman makes statistical values human-readable.

func (SnapshotGetRepository) WithLocal ¶ 

func (f SnapshotGetRepository) WithLocal(v bool) func(*SnapshotGetRepositoryRequest)

WithLocal - return local information, do not retrieve the state from master node (default: false).

func (SnapshotGetRepository) WithMasterTimeout ¶ 

func (f SnapshotGetRepository) WithMasterTimeout(v time.Duration) func(*SnapshotGetRepositoryRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotGetRepository) WithOpaqueID ¶ 

func (f SnapshotGetRepository) WithOpaqueID(s string) func(*SnapshotGetRepositoryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotGetRepository) WithPretty ¶ 

func (f SnapshotGetRepository) WithPretty() func(*SnapshotGetRepositoryRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotGetRepository) WithRepository ¶ 

func (f SnapshotGetRepository) WithRepository(v ...string) func(*SnapshotGetRepositoryRequest)

WithRepository - a list of repository names.

type SnapshotGetRepositoryRequest ¶ 

type SnapshotGetRepositoryRequest struct {
	Repository []string

	Local         *bool
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SnapshotGetRepositoryRequest configures the Snapshot Get Repository API request.

func (SnapshotGetRepositoryRequest) Do ¶ 

func (r SnapshotGetRepositoryRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotGetRequest ¶ 

type SnapshotGetRequest struct {
	Repository string
	Snapshot   []string

	After             string
	FromSortValue     string
	IgnoreUnavailable *bool
	IncludeRepository *bool
	IndexDetails      *bool
	IndexNames        *bool
	MasterTimeout     time.Duration
	Offset            *int
	Order             string
	Size              *int
	SlmPolicyFilter   string
	Sort              string
	Verbose           *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SnapshotGetRequest configures the Snapshot Get API request.

func (SnapshotGetRequest) Do ¶ 

func (r SnapshotGetRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotRepositoryAnalyze ¶ 

type SnapshotRepositoryAnalyze func(repository string, o ...func(*SnapshotRepositoryAnalyzeRequest)) (*Response, error)

SnapshotRepositoryAnalyze analyzes a repository for correctness and performance

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotRepositoryAnalyze) WithBlobCount ¶ 

func (f SnapshotRepositoryAnalyze) WithBlobCount(v int) func(*SnapshotRepositoryAnalyzeRequest)

WithBlobCount - number of blobs to create during the test. defaults to 100..

func (SnapshotRepositoryAnalyze) WithConcurrency ¶ 

func (f SnapshotRepositoryAnalyze) WithConcurrency(v int) func(*SnapshotRepositoryAnalyzeRequest)

WithConcurrency - number of operations to run concurrently during the test. defaults to 10..

func (SnapshotRepositoryAnalyze) WithContext ¶ 

func (f SnapshotRepositoryAnalyze) WithContext(v context.Context) func(*SnapshotRepositoryAnalyzeRequest)

WithContext sets the request context.

func (SnapshotRepositoryAnalyze) WithDetailed ¶ 

func (f SnapshotRepositoryAnalyze) WithDetailed(v bool) func(*SnapshotRepositoryAnalyzeRequest)

WithDetailed - whether to return detailed results or a summary. defaults to 'false' so that only the summary is returned..

func (SnapshotRepositoryAnalyze) WithEarlyReadNodeCount ¶ 

func (f SnapshotRepositoryAnalyze) WithEarlyReadNodeCount(v int) func(*SnapshotRepositoryAnalyzeRequest)

WithEarlyReadNodeCount - number of nodes on which to perform an early read on a blob, i.e. before writing has completed. early reads are rare actions so the 'rare_action_probability' parameter is also relevant. defaults to 2..

func (SnapshotRepositoryAnalyze) WithErrorTrace ¶ 

func (f SnapshotRepositoryAnalyze) WithErrorTrace() func(*SnapshotRepositoryAnalyzeRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotRepositoryAnalyze) WithFilterPath ¶ 

func (f SnapshotRepositoryAnalyze) WithFilterPath(v ...string) func(*SnapshotRepositoryAnalyzeRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotRepositoryAnalyze) WithHeader ¶ 

func (f SnapshotRepositoryAnalyze) WithHeader(h map[string]string) func(*SnapshotRepositoryAnalyzeRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotRepositoryAnalyze) WithHuman ¶ 

func (f SnapshotRepositoryAnalyze) WithHuman() func(*SnapshotRepositoryAnalyzeRequest)

WithHuman makes statistical values human-readable.

func (SnapshotRepositoryAnalyze) WithMaxBlobSize ¶ 

func (f SnapshotRepositoryAnalyze) WithMaxBlobSize(v string) func(*SnapshotRepositoryAnalyzeRequest)

WithMaxBlobSize - maximum size of a blob to create during the test, e.g '1gb' or '100mb'. defaults to '10mb'..

func (SnapshotRepositoryAnalyze) WithMaxTotalDataSize ¶ 

func (f SnapshotRepositoryAnalyze) WithMaxTotalDataSize(v string) func(*SnapshotRepositoryAnalyzeRequest)

WithMaxTotalDataSize - maximum total size of all blobs to create during the test, e.g '1tb' or '100gb'. defaults to '1gb'..

func (SnapshotRepositoryAnalyze) WithOpaqueID ¶ 

func (f SnapshotRepositoryAnalyze) WithOpaqueID(s string) func(*SnapshotRepositoryAnalyzeRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotRepositoryAnalyze) WithPretty ¶ 

func (f SnapshotRepositoryAnalyze) WithPretty() func(*SnapshotRepositoryAnalyzeRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotRepositoryAnalyze) WithRareActionProbability ¶ 

func (f SnapshotRepositoryAnalyze) WithRareActionProbability(v int) func(*SnapshotRepositoryAnalyzeRequest)

WithRareActionProbability - probability of taking a rare action such as an early read or an overwrite. defaults to 0.02..

func (SnapshotRepositoryAnalyze) WithRarelyAbortWrites ¶ 

func (f SnapshotRepositoryAnalyze) WithRarelyAbortWrites(v bool) func(*SnapshotRepositoryAnalyzeRequest)

WithRarelyAbortWrites - whether to rarely abort writes before they complete. defaults to 'true'..

func (SnapshotRepositoryAnalyze) WithReadNodeCount ¶ 

func (f SnapshotRepositoryAnalyze) WithReadNodeCount(v int) func(*SnapshotRepositoryAnalyzeRequest)

WithReadNodeCount - number of nodes on which to read a blob after writing. defaults to 10..

func (SnapshotRepositoryAnalyze) WithSeed ¶ 

func (f SnapshotRepositoryAnalyze) WithSeed(v int) func(*SnapshotRepositoryAnalyzeRequest)

WithSeed - seed for the random number generator used to create the test workload. defaults to a random value..

func (SnapshotRepositoryAnalyze) WithTimeout ¶ 

func (f SnapshotRepositoryAnalyze) WithTimeout(v time.Duration) func(*SnapshotRepositoryAnalyzeRequest)

WithTimeout - explicit operation timeout. defaults to '30s'..

type SnapshotRepositoryAnalyzeRequest ¶ 

type SnapshotRepositoryAnalyzeRequest struct {
	Repository string

	BlobCount             *int
	Concurrency           *int
	Detailed              *bool
	EarlyReadNodeCount    *int
	MaxBlobSize           string
	MaxTotalDataSize      string
	RareActionProbability *int
	RarelyAbortWrites     *bool
	ReadNodeCount         *int
	Seed                  *int
	Timeout               time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SnapshotRepositoryAnalyzeRequest configures the Snapshot Repository Analyze API request.

func (SnapshotRepositoryAnalyzeRequest) Do ¶ 

func (r SnapshotRepositoryAnalyzeRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotRepositoryVerifyIntegrity ¶ added in v8.16.0 

type SnapshotRepositoryVerifyIntegrity func(repository string, o ...func(*SnapshotRepositoryVerifyIntegrityRequest)) (*Response, error)

SnapshotRepositoryVerifyIntegrity verifies the integrity of the contents of a snapshot repository

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotRepositoryVerifyIntegrity) WithBlobThreadPoolConcurrency ¶ added in v8.16.0 

func (f SnapshotRepositoryVerifyIntegrity) WithBlobThreadPoolConcurrency(v int) func(*SnapshotRepositoryVerifyIntegrityRequest)

WithBlobThreadPoolConcurrency - number of threads to use for reading blob contents.

func (SnapshotRepositoryVerifyIntegrity) WithContext ¶ added in v8.16.0 

func (f SnapshotRepositoryVerifyIntegrity) WithContext(v context.Context) func(*SnapshotRepositoryVerifyIntegrityRequest)

WithContext sets the request context.

func (SnapshotRepositoryVerifyIntegrity) WithErrorTrace ¶ added in v8.16.0 

func (f SnapshotRepositoryVerifyIntegrity) WithErrorTrace() func(*SnapshotRepositoryVerifyIntegrityRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotRepositoryVerifyIntegrity) WithFilterPath ¶ added in v8.16.0 

func (f SnapshotRepositoryVerifyIntegrity) WithFilterPath(v ...string) func(*SnapshotRepositoryVerifyIntegrityRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotRepositoryVerifyIntegrity) WithHeader ¶ added in v8.16.0 

func (f SnapshotRepositoryVerifyIntegrity) WithHeader(h map[string]string) func(*SnapshotRepositoryVerifyIntegrityRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotRepositoryVerifyIntegrity) WithHuman ¶ added in v8.16.0 

func (f SnapshotRepositoryVerifyIntegrity) WithHuman() func(*SnapshotRepositoryVerifyIntegrityRequest)

WithHuman makes statistical values human-readable.

func (SnapshotRepositoryVerifyIntegrity) WithIndexSnapshotVerificationConcurrency ¶ added in v8.16.0 

func (f SnapshotRepositoryVerifyIntegrity) WithIndexSnapshotVerificationConcurrency(v int) func(*SnapshotRepositoryVerifyIntegrityRequest)

WithIndexSnapshotVerificationConcurrency - number of snapshots to verify concurrently within each index.

func (SnapshotRepositoryVerifyIntegrity) WithIndexVerificationConcurrency ¶ added in v8.16.0 

func (f SnapshotRepositoryVerifyIntegrity) WithIndexVerificationConcurrency(v int) func(*SnapshotRepositoryVerifyIntegrityRequest)

WithIndexVerificationConcurrency - number of indices to verify concurrently.

func (SnapshotRepositoryVerifyIntegrity) WithMaxBytesPerSec ¶ added in v8.16.0 

func (f SnapshotRepositoryVerifyIntegrity) WithMaxBytesPerSec(v string) func(*SnapshotRepositoryVerifyIntegrityRequest)

WithMaxBytesPerSec - rate limit for individual blob verification.

func (SnapshotRepositoryVerifyIntegrity) WithMaxFailedShardSnapshots ¶ added in v8.16.0 

func (f SnapshotRepositoryVerifyIntegrity) WithMaxFailedShardSnapshots(v int) func(*SnapshotRepositoryVerifyIntegrityRequest)

WithMaxFailedShardSnapshots - maximum permitted number of failed shard snapshots.

func (SnapshotRepositoryVerifyIntegrity) WithMetaThreadPoolConcurrency ¶ added in v8.16.0 

func (f SnapshotRepositoryVerifyIntegrity) WithMetaThreadPoolConcurrency(v int) func(*SnapshotRepositoryVerifyIntegrityRequest)

WithMetaThreadPoolConcurrency - number of threads to use for reading metadata.

func (SnapshotRepositoryVerifyIntegrity) WithOpaqueID ¶ added in v8.16.0 

func (f SnapshotRepositoryVerifyIntegrity) WithOpaqueID(s string) func(*SnapshotRepositoryVerifyIntegrityRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotRepositoryVerifyIntegrity) WithPretty ¶ added in v8.16.0 

func (f SnapshotRepositoryVerifyIntegrity) WithPretty() func(*SnapshotRepositoryVerifyIntegrityRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotRepositoryVerifyIntegrity) WithSnapshotVerificationConcurrency ¶ added in v8.16.0 

func (f SnapshotRepositoryVerifyIntegrity) WithSnapshotVerificationConcurrency(v int) func(*SnapshotRepositoryVerifyIntegrityRequest)

WithSnapshotVerificationConcurrency - number of snapshots to verify concurrently.

func (SnapshotRepositoryVerifyIntegrity) WithVerifyBlobContents ¶ added in v8.16.0 

func (f SnapshotRepositoryVerifyIntegrity) WithVerifyBlobContents(v bool) func(*SnapshotRepositoryVerifyIntegrityRequest)

WithVerifyBlobContents - whether to verify the contents of individual blobs.

type SnapshotRepositoryVerifyIntegrityRequest ¶ added in v8.16.0 

type SnapshotRepositoryVerifyIntegrityRequest struct {
	Repository string

	BlobThreadPoolConcurrency            *int
	IndexSnapshotVerificationConcurrency *int
	IndexVerificationConcurrency         *int
	MaxBytesPerSec                       string
	MaxFailedShardSnapshots              *int
	MetaThreadPoolConcurrency            *int
	SnapshotVerificationConcurrency      *int
	VerifyBlobContents                   *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SnapshotRepositoryVerifyIntegrityRequest configures the Snapshot Repository Verify Integrity API request.

func (SnapshotRepositoryVerifyIntegrityRequest) Do ¶ added in v8.16.0 

func (r SnapshotRepositoryVerifyIntegrityRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotRestore ¶ 

type SnapshotRestore func(repository string, snapshot string, o ...func(*SnapshotRestoreRequest)) (*Response, error)

SnapshotRestore restores a snapshot.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotRestore) WithBody ¶ 

func (f SnapshotRestore) WithBody(v io.Reader) func(*SnapshotRestoreRequest)

WithBody - Details of what to restore.

func (SnapshotRestore) WithContext ¶ 

func (f SnapshotRestore) WithContext(v context.Context) func(*SnapshotRestoreRequest)

WithContext sets the request context.

func (SnapshotRestore) WithErrorTrace ¶ 

func (f SnapshotRestore) WithErrorTrace() func(*SnapshotRestoreRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotRestore) WithFilterPath ¶ 

func (f SnapshotRestore) WithFilterPath(v ...string) func(*SnapshotRestoreRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotRestore) WithHeader ¶ 

func (f SnapshotRestore) WithHeader(h map[string]string) func(*SnapshotRestoreRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotRestore) WithHuman ¶ 

func (f SnapshotRestore) WithHuman() func(*SnapshotRestoreRequest)

WithHuman makes statistical values human-readable.

func (SnapshotRestore) WithMasterTimeout ¶ 

func (f SnapshotRestore) WithMasterTimeout(v time.Duration) func(*SnapshotRestoreRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotRestore) WithOpaqueID ¶ 

func (f SnapshotRestore) WithOpaqueID(s string) func(*SnapshotRestoreRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotRestore) WithPretty ¶ 

func (f SnapshotRestore) WithPretty() func(*SnapshotRestoreRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotRestore) WithWaitForCompletion ¶ 

func (f SnapshotRestore) WithWaitForCompletion(v bool) func(*SnapshotRestoreRequest)

WithWaitForCompletion - should this request wait until the operation has completed before returning.

type SnapshotRestoreRequest ¶ 

type SnapshotRestoreRequest struct {
	Body io.Reader

	Repository string
	Snapshot   string

	MasterTimeout     time.Duration
	WaitForCompletion *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SnapshotRestoreRequest configures the Snapshot Restore API request.

func (SnapshotRestoreRequest) Do ¶ 

func (r SnapshotRestoreRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotStatus ¶ 

type SnapshotStatus func(o ...func(*SnapshotStatusRequest)) (*Response, error)

SnapshotStatus returns information about the status of a snapshot.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotStatus) WithContext ¶ 

func (f SnapshotStatus) WithContext(v context.Context) func(*SnapshotStatusRequest)

WithContext sets the request context.

func (SnapshotStatus) WithErrorTrace ¶ 

func (f SnapshotStatus) WithErrorTrace() func(*SnapshotStatusRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotStatus) WithFilterPath ¶ 

func (f SnapshotStatus) WithFilterPath(v ...string) func(*SnapshotStatusRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotStatus) WithHeader ¶ 

func (f SnapshotStatus) WithHeader(h map[string]string) func(*SnapshotStatusRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotStatus) WithHuman ¶ 

func (f SnapshotStatus) WithHuman() func(*SnapshotStatusRequest)

WithHuman makes statistical values human-readable.

func (SnapshotStatus) WithIgnoreUnavailable ¶ 

func (f SnapshotStatus) WithIgnoreUnavailable(v bool) func(*SnapshotStatusRequest)

WithIgnoreUnavailable - whether to ignore unavailable snapshots, defaults to false which means a snapshotmissingexception is thrown.

func (SnapshotStatus) WithMasterTimeout ¶ 

func (f SnapshotStatus) WithMasterTimeout(v time.Duration) func(*SnapshotStatusRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotStatus) WithOpaqueID ¶ 

func (f SnapshotStatus) WithOpaqueID(s string) func(*SnapshotStatusRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotStatus) WithPretty ¶ 

func (f SnapshotStatus) WithPretty() func(*SnapshotStatusRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotStatus) WithRepository ¶ 

func (f SnapshotStatus) WithRepository(v string) func(*SnapshotStatusRequest)

WithRepository - a repository name.

func (SnapshotStatus) WithSnapshot ¶ 

func (f SnapshotStatus) WithSnapshot(v ...string) func(*SnapshotStatusRequest)

WithSnapshot - a list of snapshot names.

type SnapshotStatusRequest ¶ 

type SnapshotStatusRequest struct {
	Repository string
	Snapshot   []string

	IgnoreUnavailable *bool
	MasterTimeout     time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SnapshotStatusRequest configures the Snapshot Status API request.

func (SnapshotStatusRequest) Do ¶ 

func (r SnapshotStatusRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SnapshotVerifyRepository ¶ 

type SnapshotVerifyRepository func(repository string, o ...func(*SnapshotVerifyRepositoryRequest)) (*Response, error)

SnapshotVerifyRepository verifies a repository.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.

func (SnapshotVerifyRepository) WithContext ¶ 

func (f SnapshotVerifyRepository) WithContext(v context.Context) func(*SnapshotVerifyRepositoryRequest)

WithContext sets the request context.

func (SnapshotVerifyRepository) WithErrorTrace ¶ 

func (f SnapshotVerifyRepository) WithErrorTrace() func(*SnapshotVerifyRepositoryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SnapshotVerifyRepository) WithFilterPath ¶ 

func (f SnapshotVerifyRepository) WithFilterPath(v ...string) func(*SnapshotVerifyRepositoryRequest)

WithFilterPath filters the properties of the response body.

func (SnapshotVerifyRepository) WithHeader ¶ 

func (f SnapshotVerifyRepository) WithHeader(h map[string]string) func(*SnapshotVerifyRepositoryRequest)

WithHeader adds the headers to the HTTP request.

func (SnapshotVerifyRepository) WithHuman ¶ 

func (f SnapshotVerifyRepository) WithHuman() func(*SnapshotVerifyRepositoryRequest)

WithHuman makes statistical values human-readable.

func (SnapshotVerifyRepository) WithMasterTimeout ¶ 

func (f SnapshotVerifyRepository) WithMasterTimeout(v time.Duration) func(*SnapshotVerifyRepositoryRequest)

WithMasterTimeout - explicit operation timeout for connection to master node.

func (SnapshotVerifyRepository) WithOpaqueID ¶ 

func (f SnapshotVerifyRepository) WithOpaqueID(s string) func(*SnapshotVerifyRepositoryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SnapshotVerifyRepository) WithPretty ¶ 

func (f SnapshotVerifyRepository) WithPretty() func(*SnapshotVerifyRepositoryRequest)

WithPretty makes the response body pretty-printed.

func (SnapshotVerifyRepository) WithTimeout ¶ 

func (f SnapshotVerifyRepository) WithTimeout(v time.Duration) func(*SnapshotVerifyRepositoryRequest)

WithTimeout - explicit operation timeout.

type SnapshotVerifyRepositoryRequest ¶ 

type SnapshotVerifyRepositoryRequest struct {
	Repository string

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SnapshotVerifyRepositoryRequest configures the Snapshot Verify Repository API request.

func (SnapshotVerifyRepositoryRequest) Do ¶ 

func (r SnapshotVerifyRepositoryRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SynonymsDeleteSynonym ¶ added in v8.10.0 

type SynonymsDeleteSynonym func(id string, o ...func(*SynonymsDeleteSynonymRequest)) (*Response, error)

SynonymsDeleteSynonym deletes a synonym set

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonyms-set.html.

func (SynonymsDeleteSynonym) WithContext ¶ added in v8.10.0 

func (f SynonymsDeleteSynonym) WithContext(v context.Context) func(*SynonymsDeleteSynonymRequest)

WithContext sets the request context.

func (SynonymsDeleteSynonym) WithErrorTrace ¶ added in v8.10.0 

func (f SynonymsDeleteSynonym) WithErrorTrace() func(*SynonymsDeleteSynonymRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SynonymsDeleteSynonym) WithFilterPath ¶ added in v8.10.0 

func (f SynonymsDeleteSynonym) WithFilterPath(v ...string) func(*SynonymsDeleteSynonymRequest)

WithFilterPath filters the properties of the response body.

func (SynonymsDeleteSynonym) WithHeader ¶ added in v8.10.0 

func (f SynonymsDeleteSynonym) WithHeader(h map[string]string) func(*SynonymsDeleteSynonymRequest)

WithHeader adds the headers to the HTTP request.

func (SynonymsDeleteSynonym) WithHuman ¶ added in v8.10.0 

func (f SynonymsDeleteSynonym) WithHuman() func(*SynonymsDeleteSynonymRequest)

WithHuman makes statistical values human-readable.

func (SynonymsDeleteSynonym) WithOpaqueID ¶ added in v8.10.0 

func (f SynonymsDeleteSynonym) WithOpaqueID(s string) func(*SynonymsDeleteSynonymRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SynonymsDeleteSynonym) WithPretty ¶ added in v8.10.0 

func (f SynonymsDeleteSynonym) WithPretty() func(*SynonymsDeleteSynonymRequest)

WithPretty makes the response body pretty-printed.

type SynonymsDeleteSynonymRequest ¶ added in v8.10.0 

type SynonymsDeleteSynonymRequest struct {
	DocumentID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SynonymsDeleteSynonymRequest configures the Synonyms Delete Synonym API request.

func (SynonymsDeleteSynonymRequest) Do ¶ added in v8.10.0 

func (r SynonymsDeleteSynonymRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SynonymsDeleteSynonymRule ¶ added in v8.10.0 

type SynonymsDeleteSynonymRule func(rule_id string, set_id string, o ...func(*SynonymsDeleteSynonymRuleRequest)) (*Response, error)

SynonymsDeleteSynonymRule deletes a synonym rule in a synonym set

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonym-rule.html.

func (SynonymsDeleteSynonymRule) WithContext ¶ added in v8.10.0 

func (f SynonymsDeleteSynonymRule) WithContext(v context.Context) func(*SynonymsDeleteSynonymRuleRequest)

WithContext sets the request context.

func (SynonymsDeleteSynonymRule) WithErrorTrace ¶ added in v8.10.0 

func (f SynonymsDeleteSynonymRule) WithErrorTrace() func(*SynonymsDeleteSynonymRuleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SynonymsDeleteSynonymRule) WithFilterPath ¶ added in v8.10.0 

func (f SynonymsDeleteSynonymRule) WithFilterPath(v ...string) func(*SynonymsDeleteSynonymRuleRequest)

WithFilterPath filters the properties of the response body.

func (SynonymsDeleteSynonymRule) WithHeader ¶ added in v8.10.0 

func (f SynonymsDeleteSynonymRule) WithHeader(h map[string]string) func(*SynonymsDeleteSynonymRuleRequest)

WithHeader adds the headers to the HTTP request.

func (SynonymsDeleteSynonymRule) WithHuman ¶ added in v8.10.0 

func (f SynonymsDeleteSynonymRule) WithHuman() func(*SynonymsDeleteSynonymRuleRequest)

WithHuman makes statistical values human-readable.

func (SynonymsDeleteSynonymRule) WithOpaqueID ¶ added in v8.10.0 

func (f SynonymsDeleteSynonymRule) WithOpaqueID(s string) func(*SynonymsDeleteSynonymRuleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SynonymsDeleteSynonymRule) WithPretty ¶ added in v8.10.0 

func (f SynonymsDeleteSynonymRule) WithPretty() func(*SynonymsDeleteSynonymRuleRequest)

WithPretty makes the response body pretty-printed.

type SynonymsDeleteSynonymRuleRequest ¶ added in v8.10.0 

type SynonymsDeleteSynonymRuleRequest struct {
	RuleID string
	SetID  string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SynonymsDeleteSynonymRuleRequest configures the Synonyms Delete Synonym Rule API request.

func (SynonymsDeleteSynonymRuleRequest) Do ¶ added in v8.10.0 

func (r SynonymsDeleteSynonymRuleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SynonymsGetSynonym ¶ added in v8.10.0 

type SynonymsGetSynonym func(id string, o ...func(*SynonymsGetSynonymRequest)) (*Response, error)

SynonymsGetSynonym retrieves a synonym set

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonyms-set.html.

func (SynonymsGetSynonym) WithContext ¶ added in v8.10.0 

func (f SynonymsGetSynonym) WithContext(v context.Context) func(*SynonymsGetSynonymRequest)

WithContext sets the request context.

func (SynonymsGetSynonym) WithErrorTrace ¶ added in v8.10.0 

func (f SynonymsGetSynonym) WithErrorTrace() func(*SynonymsGetSynonymRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SynonymsGetSynonym) WithFilterPath ¶ added in v8.10.0 

func (f SynonymsGetSynonym) WithFilterPath(v ...string) func(*SynonymsGetSynonymRequest)

WithFilterPath filters the properties of the response body.

func (SynonymsGetSynonym) WithFrom ¶ added in v8.10.0 

func (f SynonymsGetSynonym) WithFrom(v int) func(*SynonymsGetSynonymRequest)

WithFrom - starting offset.

func (SynonymsGetSynonym) WithHeader ¶ added in v8.10.0 

func (f SynonymsGetSynonym) WithHeader(h map[string]string) func(*SynonymsGetSynonymRequest)

WithHeader adds the headers to the HTTP request.

func (SynonymsGetSynonym) WithHuman ¶ added in v8.10.0 

func (f SynonymsGetSynonym) WithHuman() func(*SynonymsGetSynonymRequest)

WithHuman makes statistical values human-readable.

func (SynonymsGetSynonym) WithOpaqueID ¶ added in v8.10.0 

func (f SynonymsGetSynonym) WithOpaqueID(s string) func(*SynonymsGetSynonymRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SynonymsGetSynonym) WithPretty ¶ added in v8.10.0 

func (f SynonymsGetSynonym) WithPretty() func(*SynonymsGetSynonymRequest)

WithPretty makes the response body pretty-printed.

func (SynonymsGetSynonym) WithSize ¶ added in v8.10.0 

func (f SynonymsGetSynonym) WithSize(v int) func(*SynonymsGetSynonymRequest)

WithSize - specifies a max number of results to get.

type SynonymsGetSynonymRequest ¶ added in v8.10.0 

type SynonymsGetSynonymRequest struct {
	DocumentID string

	From *int
	Size *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SynonymsGetSynonymRequest configures the Synonyms Get Synonym API request.

func (SynonymsGetSynonymRequest) Do ¶ added in v8.10.0 

func (r SynonymsGetSynonymRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SynonymsGetSynonymRule ¶ added in v8.10.0 

type SynonymsGetSynonymRule func(rule_id string, set_id string, o ...func(*SynonymsGetSynonymRuleRequest)) (*Response, error)

SynonymsGetSynonymRule retrieves a synonym rule from a synonym set

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonym-rule.html.

func (SynonymsGetSynonymRule) WithContext ¶ added in v8.10.0 

func (f SynonymsGetSynonymRule) WithContext(v context.Context) func(*SynonymsGetSynonymRuleRequest)

WithContext sets the request context.

func (SynonymsGetSynonymRule) WithErrorTrace ¶ added in v8.10.0 

func (f SynonymsGetSynonymRule) WithErrorTrace() func(*SynonymsGetSynonymRuleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SynonymsGetSynonymRule) WithFilterPath ¶ added in v8.10.0 

func (f SynonymsGetSynonymRule) WithFilterPath(v ...string) func(*SynonymsGetSynonymRuleRequest)

WithFilterPath filters the properties of the response body.

func (SynonymsGetSynonymRule) WithHeader ¶ added in v8.10.0 

func (f SynonymsGetSynonymRule) WithHeader(h map[string]string) func(*SynonymsGetSynonymRuleRequest)

WithHeader adds the headers to the HTTP request.

func (SynonymsGetSynonymRule) WithHuman ¶ added in v8.10.0 

func (f SynonymsGetSynonymRule) WithHuman() func(*SynonymsGetSynonymRuleRequest)

WithHuman makes statistical values human-readable.

func (SynonymsGetSynonymRule) WithOpaqueID ¶ added in v8.10.0 

func (f SynonymsGetSynonymRule) WithOpaqueID(s string) func(*SynonymsGetSynonymRuleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SynonymsGetSynonymRule) WithPretty ¶ added in v8.10.0 

func (f SynonymsGetSynonymRule) WithPretty() func(*SynonymsGetSynonymRuleRequest)

WithPretty makes the response body pretty-printed.

type SynonymsGetSynonymRuleRequest ¶ added in v8.10.0 

type SynonymsGetSynonymRuleRequest struct {
	RuleID string
	SetID  string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SynonymsGetSynonymRuleRequest configures the Synonyms Get Synonym Rule API request.

func (SynonymsGetSynonymRuleRequest) Do ¶ added in v8.10.0 

func (r SynonymsGetSynonymRuleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SynonymsGetSynonymsSets ¶ added in v8.10.0 

type SynonymsGetSynonymsSets func(o ...func(*SynonymsGetSynonymsSetsRequest)) (*Response, error)

SynonymsGetSynonymsSets retrieves a summary of all defined synonym sets

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/list-synonyms-sets.html.

func (SynonymsGetSynonymsSets) WithContext ¶ added in v8.10.0 

func (f SynonymsGetSynonymsSets) WithContext(v context.Context) func(*SynonymsGetSynonymsSetsRequest)

WithContext sets the request context.

func (SynonymsGetSynonymsSets) WithErrorTrace ¶ added in v8.10.0 

func (f SynonymsGetSynonymsSets) WithErrorTrace() func(*SynonymsGetSynonymsSetsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SynonymsGetSynonymsSets) WithFilterPath ¶ added in v8.10.0 

func (f SynonymsGetSynonymsSets) WithFilterPath(v ...string) func(*SynonymsGetSynonymsSetsRequest)

WithFilterPath filters the properties of the response body.

func (SynonymsGetSynonymsSets) WithFrom ¶ added in v8.10.0 

func (f SynonymsGetSynonymsSets) WithFrom(v int) func(*SynonymsGetSynonymsSetsRequest)

WithFrom - starting offset.

func (SynonymsGetSynonymsSets) WithHeader ¶ added in v8.10.0 

func (f SynonymsGetSynonymsSets) WithHeader(h map[string]string) func(*SynonymsGetSynonymsSetsRequest)

WithHeader adds the headers to the HTTP request.

func (SynonymsGetSynonymsSets) WithHuman ¶ added in v8.10.0 

func (f SynonymsGetSynonymsSets) WithHuman() func(*SynonymsGetSynonymsSetsRequest)

WithHuman makes statistical values human-readable.

func (SynonymsGetSynonymsSets) WithOpaqueID ¶ added in v8.10.0 

func (f SynonymsGetSynonymsSets) WithOpaqueID(s string) func(*SynonymsGetSynonymsSetsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SynonymsGetSynonymsSets) WithPretty ¶ added in v8.10.0 

func (f SynonymsGetSynonymsSets) WithPretty() func(*SynonymsGetSynonymsSetsRequest)

WithPretty makes the response body pretty-printed.

func (SynonymsGetSynonymsSets) WithSize ¶ added in v8.10.0 

func (f SynonymsGetSynonymsSets) WithSize(v int) func(*SynonymsGetSynonymsSetsRequest)

WithSize - specifies a max number of results to get.

type SynonymsGetSynonymsSetsRequest ¶ added in v8.10.0 

type SynonymsGetSynonymsSetsRequest struct {
	From *int
	Size *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SynonymsGetSynonymsSetsRequest configures the Synonyms Get Synonyms Sets API request.

func (SynonymsGetSynonymsSetsRequest) Do ¶ added in v8.10.0 

func (r SynonymsGetSynonymsSetsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SynonymsPutSynonym ¶ added in v8.10.0 

type SynonymsPutSynonym func(id string, body io.Reader, o ...func(*SynonymsPutSynonymRequest)) (*Response, error)

SynonymsPutSynonym creates or updates a synonyms set

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonyms-set.html.

func (SynonymsPutSynonym) WithContext ¶ added in v8.10.0 

func (f SynonymsPutSynonym) WithContext(v context.Context) func(*SynonymsPutSynonymRequest)

WithContext sets the request context.

func (SynonymsPutSynonym) WithErrorTrace ¶ added in v8.10.0 

func (f SynonymsPutSynonym) WithErrorTrace() func(*SynonymsPutSynonymRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SynonymsPutSynonym) WithFilterPath ¶ added in v8.10.0 

func (f SynonymsPutSynonym) WithFilterPath(v ...string) func(*SynonymsPutSynonymRequest)

WithFilterPath filters the properties of the response body.

func (SynonymsPutSynonym) WithHeader ¶ added in v8.10.0 

func (f SynonymsPutSynonym) WithHeader(h map[string]string) func(*SynonymsPutSynonymRequest)

WithHeader adds the headers to the HTTP request.

func (SynonymsPutSynonym) WithHuman ¶ added in v8.10.0 

func (f SynonymsPutSynonym) WithHuman() func(*SynonymsPutSynonymRequest)

WithHuman makes statistical values human-readable.

func (SynonymsPutSynonym) WithOpaqueID ¶ added in v8.10.0 

func (f SynonymsPutSynonym) WithOpaqueID(s string) func(*SynonymsPutSynonymRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SynonymsPutSynonym) WithPretty ¶ added in v8.10.0 

func (f SynonymsPutSynonym) WithPretty() func(*SynonymsPutSynonymRequest)

WithPretty makes the response body pretty-printed.

type SynonymsPutSynonymRequest ¶ added in v8.10.0 

type SynonymsPutSynonymRequest struct {
	DocumentID string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SynonymsPutSynonymRequest configures the Synonyms Put Synonym API request.

func (SynonymsPutSynonymRequest) Do ¶ added in v8.10.0 

func (r SynonymsPutSynonymRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type SynonymsPutSynonymRule ¶ added in v8.10.0 

type SynonymsPutSynonymRule func(body io.Reader, rule_id string, set_id string, o ...func(*SynonymsPutSynonymRuleRequest)) (*Response, error)

SynonymsPutSynonymRule creates or updates a synonym rule in a synonym set

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonym-rule.html.

func (SynonymsPutSynonymRule) WithContext ¶ added in v8.10.0 

func (f SynonymsPutSynonymRule) WithContext(v context.Context) func(*SynonymsPutSynonymRuleRequest)

WithContext sets the request context.

func (SynonymsPutSynonymRule) WithErrorTrace ¶ added in v8.10.0 

func (f SynonymsPutSynonymRule) WithErrorTrace() func(*SynonymsPutSynonymRuleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (SynonymsPutSynonymRule) WithFilterPath ¶ added in v8.10.0 

func (f SynonymsPutSynonymRule) WithFilterPath(v ...string) func(*SynonymsPutSynonymRuleRequest)

WithFilterPath filters the properties of the response body.

func (SynonymsPutSynonymRule) WithHeader ¶ added in v8.10.0 

func (f SynonymsPutSynonymRule) WithHeader(h map[string]string) func(*SynonymsPutSynonymRuleRequest)

WithHeader adds the headers to the HTTP request.

func (SynonymsPutSynonymRule) WithHuman ¶ added in v8.10.0 

func (f SynonymsPutSynonymRule) WithHuman() func(*SynonymsPutSynonymRuleRequest)

WithHuman makes statistical values human-readable.

func (SynonymsPutSynonymRule) WithOpaqueID ¶ added in v8.10.0 

func (f SynonymsPutSynonymRule) WithOpaqueID(s string) func(*SynonymsPutSynonymRuleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (SynonymsPutSynonymRule) WithPretty ¶ added in v8.10.0 

func (f SynonymsPutSynonymRule) WithPretty() func(*SynonymsPutSynonymRuleRequest)

WithPretty makes the response body pretty-printed.

type SynonymsPutSynonymRuleRequest ¶ added in v8.10.0 

type SynonymsPutSynonymRuleRequest struct {
	Body io.Reader

	RuleID string
	SetID  string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

SynonymsPutSynonymRuleRequest configures the Synonyms Put Synonym Rule API request.

func (SynonymsPutSynonymRuleRequest) Do ¶ added in v8.10.0 

func (r SynonymsPutSynonymRuleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Tasks ¶ 

type Tasks struct {
	Cancel TasksCancel
	Get    TasksGet
	List   TasksList
}

Tasks contains the Tasks APIs

type TasksCancel ¶ 

type TasksCancel func(o ...func(*TasksCancelRequest)) (*Response, error)

TasksCancel cancels a task, if it can be cancelled through an API.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html.

func (TasksCancel) WithActions ¶ 

func (f TasksCancel) WithActions(v ...string) func(*TasksCancelRequest)

WithActions - a list of actions that should be cancelled. leave empty to cancel all..

func (TasksCancel) WithContext ¶ 

func (f TasksCancel) WithContext(v context.Context) func(*TasksCancelRequest)

WithContext sets the request context.

func (TasksCancel) WithErrorTrace ¶ 

func (f TasksCancel) WithErrorTrace() func(*TasksCancelRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TasksCancel) WithFilterPath ¶ 

func (f TasksCancel) WithFilterPath(v ...string) func(*TasksCancelRequest)

WithFilterPath filters the properties of the response body.

func (TasksCancel) WithHeader ¶ 

func (f TasksCancel) WithHeader(h map[string]string) func(*TasksCancelRequest)

WithHeader adds the headers to the HTTP request.

func (TasksCancel) WithHuman ¶ 

func (f TasksCancel) WithHuman() func(*TasksCancelRequest)

WithHuman makes statistical values human-readable.

func (TasksCancel) WithNodes ¶ 

func (f TasksCancel) WithNodes(v ...string) func(*TasksCancelRequest)

WithNodes - a list of node ids or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.

func (TasksCancel) WithOpaqueID ¶ 

func (f TasksCancel) WithOpaqueID(s string) func(*TasksCancelRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TasksCancel) WithParentTaskID ¶ 

func (f TasksCancel) WithParentTaskID(v string) func(*TasksCancelRequest)

WithParentTaskID - cancel tasks with specified parent task ID (node_id:task_number). set to -1 to cancel all..

func (TasksCancel) WithPretty ¶ 

func (f TasksCancel) WithPretty() func(*TasksCancelRequest)

WithPretty makes the response body pretty-printed.

func (TasksCancel) WithTaskID ¶ 

func (f TasksCancel) WithTaskID(v string) func(*TasksCancelRequest)

WithTaskID - cancel the task with specified task ID (node_id:task_number).

func (TasksCancel) WithWaitForCompletion ¶ 

func (f TasksCancel) WithWaitForCompletion(v bool) func(*TasksCancelRequest)

WithWaitForCompletion - should the request block until the cancellation of the task and its descendant tasks is completed. defaults to false.

type TasksCancelRequest ¶ 

type TasksCancelRequest struct {
	TaskID string

	Actions           []string
	Nodes             []string
	ParentTaskID      string
	WaitForCompletion *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TasksCancelRequest configures the Tasks Cancel API request.

func (TasksCancelRequest) Do ¶ 

func (r TasksCancelRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TasksGet ¶ 

type TasksGet func(task_id string, o ...func(*TasksGetRequest)) (*Response, error)

TasksGet returns information about a task.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html.

func (TasksGet) WithContext ¶ 

func (f TasksGet) WithContext(v context.Context) func(*TasksGetRequest)

WithContext sets the request context.

func (TasksGet) WithErrorTrace ¶ 

func (f TasksGet) WithErrorTrace() func(*TasksGetRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TasksGet) WithFilterPath ¶ 

func (f TasksGet) WithFilterPath(v ...string) func(*TasksGetRequest)

WithFilterPath filters the properties of the response body.

func (TasksGet) WithHeader ¶ 

func (f TasksGet) WithHeader(h map[string]string) func(*TasksGetRequest)

WithHeader adds the headers to the HTTP request.

func (TasksGet) WithHuman ¶ 

func (f TasksGet) WithHuman() func(*TasksGetRequest)

WithHuman makes statistical values human-readable.

func (TasksGet) WithOpaqueID ¶ 

func (f TasksGet) WithOpaqueID(s string) func(*TasksGetRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TasksGet) WithPretty ¶ 

func (f TasksGet) WithPretty() func(*TasksGetRequest)

WithPretty makes the response body pretty-printed.

func (TasksGet) WithTimeout ¶ 

func (f TasksGet) WithTimeout(v time.Duration) func(*TasksGetRequest)

WithTimeout - explicit operation timeout.

func (TasksGet) WithWaitForCompletion ¶ 

func (f TasksGet) WithWaitForCompletion(v bool) func(*TasksGetRequest)

WithWaitForCompletion - wait for the matching tasks to complete (default: false).

type TasksGetRequest ¶ 

type TasksGetRequest struct {
	TaskID string

	Timeout           time.Duration
	WaitForCompletion *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TasksGetRequest configures the Tasks Get API request.

func (TasksGetRequest) Do ¶ 

func (r TasksGetRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TasksList ¶ 

type TasksList func(o ...func(*TasksListRequest)) (*Response, error)

TasksList returns a list of tasks.

This API is experimental.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html.

func (TasksList) WithActions ¶ 

func (f TasksList) WithActions(v ...string) func(*TasksListRequest)

WithActions - a list of actions that should be returned. leave empty to return all..

func (TasksList) WithContext ¶ 

func (f TasksList) WithContext(v context.Context) func(*TasksListRequest)

WithContext sets the request context.

func (TasksList) WithDetailed ¶ 

func (f TasksList) WithDetailed(v bool) func(*TasksListRequest)

WithDetailed - return detailed task information (default: false).

func (TasksList) WithErrorTrace ¶ 

func (f TasksList) WithErrorTrace() func(*TasksListRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TasksList) WithFilterPath ¶ 

func (f TasksList) WithFilterPath(v ...string) func(*TasksListRequest)

WithFilterPath filters the properties of the response body.

func (TasksList) WithGroupBy ¶ 

func (f TasksList) WithGroupBy(v string) func(*TasksListRequest)

WithGroupBy - group tasks by nodes or parent/child relationships.

func (TasksList) WithHeader ¶ 

func (f TasksList) WithHeader(h map[string]string) func(*TasksListRequest)

WithHeader adds the headers to the HTTP request.

func (TasksList) WithHuman ¶ 

func (f TasksList) WithHuman() func(*TasksListRequest)

WithHuman makes statistical values human-readable.

func (TasksList) WithNodes ¶ 

func (f TasksList) WithNodes(v ...string) func(*TasksListRequest)

WithNodes - a list of node ids or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.

func (TasksList) WithOpaqueID ¶ 

func (f TasksList) WithOpaqueID(s string) func(*TasksListRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TasksList) WithParentTaskID ¶ 

func (f TasksList) WithParentTaskID(v string) func(*TasksListRequest)

WithParentTaskID - return tasks with specified parent task ID (node_id:task_number). set to -1 to return all..

func (TasksList) WithPretty ¶ 

func (f TasksList) WithPretty() func(*TasksListRequest)

WithPretty makes the response body pretty-printed.

func (TasksList) WithTimeout ¶ 

func (f TasksList) WithTimeout(v time.Duration) func(*TasksListRequest)

WithTimeout - explicit operation timeout.

func (TasksList) WithWaitForCompletion ¶ 

func (f TasksList) WithWaitForCompletion(v bool) func(*TasksListRequest)

WithWaitForCompletion - wait for the matching tasks to complete (default: false).

type TasksListRequest ¶ 

type TasksListRequest struct {
	Actions           []string
	Detailed          *bool
	GroupBy           string
	Nodes             []string
	ParentTaskID      string
	Timeout           time.Duration
	WaitForCompletion *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TasksListRequest configures the Tasks List API request.

func (TasksListRequest) Do ¶ 

func (r TasksListRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TermsEnum ¶ 

type TermsEnum func(index []string, o ...func(*TermsEnumRequest)) (*Response, error)

TermsEnum the terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html.

func (TermsEnum) WithBody ¶ 

func (f TermsEnum) WithBody(v io.Reader) func(*TermsEnumRequest)

WithBody - field name, string which is the prefix expected in matching terms, timeout and size for max number of results.

func (TermsEnum) WithContext ¶ 

func (f TermsEnum) WithContext(v context.Context) func(*TermsEnumRequest)

WithContext sets the request context.

func (TermsEnum) WithErrorTrace ¶ 

func (f TermsEnum) WithErrorTrace() func(*TermsEnumRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TermsEnum) WithFilterPath ¶ 

func (f TermsEnum) WithFilterPath(v ...string) func(*TermsEnumRequest)

WithFilterPath filters the properties of the response body.

func (TermsEnum) WithHeader ¶ 

func (f TermsEnum) WithHeader(h map[string]string) func(*TermsEnumRequest)

WithHeader adds the headers to the HTTP request.

func (TermsEnum) WithHuman ¶ 

func (f TermsEnum) WithHuman() func(*TermsEnumRequest)

WithHuman makes statistical values human-readable.

func (TermsEnum) WithOpaqueID ¶ 

func (f TermsEnum) WithOpaqueID(s string) func(*TermsEnumRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TermsEnum) WithPretty ¶ 

func (f TermsEnum) WithPretty() func(*TermsEnumRequest)

WithPretty makes the response body pretty-printed.

type TermsEnumRequest ¶ 

type TermsEnumRequest struct {
	Index []string

	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TermsEnumRequest configures the Terms Enum API request.

func (TermsEnumRequest) Do ¶ 

func (r TermsEnumRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Termvectors ¶ 

type Termvectors func(index string, o ...func(*TermvectorsRequest)) (*Response, error)

Termvectors returns information and statistics about terms in the fields of a particular document.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html.

func (Termvectors) WithBody ¶ 

func (f Termvectors) WithBody(v io.Reader) func(*TermvectorsRequest)

WithBody - Define parameters and or supply a document to get termvectors for. See documentation..

func (Termvectors) WithContext ¶ 

func (f Termvectors) WithContext(v context.Context) func(*TermvectorsRequest)

WithContext sets the request context.

func (Termvectors) WithDocumentID ¶ 

func (f Termvectors) WithDocumentID(v string) func(*TermvectorsRequest)

WithDocumentID - the ID of the document, when not specified a doc param should be supplied..

func (Termvectors) WithErrorTrace ¶ 

func (f Termvectors) WithErrorTrace() func(*TermvectorsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Termvectors) WithFieldStatistics ¶ 

func (f Termvectors) WithFieldStatistics(v bool) func(*TermvectorsRequest)

WithFieldStatistics - specifies if document count, sum of document frequencies and sum of total term frequencies should be returned..

func (Termvectors) WithFields ¶ 

func (f Termvectors) WithFields(v ...string) func(*TermvectorsRequest)

WithFields - a list of fields to return..

func (Termvectors) WithFilterPath ¶ 

func (f Termvectors) WithFilterPath(v ...string) func(*TermvectorsRequest)

WithFilterPath filters the properties of the response body.

func (Termvectors) WithHeader ¶ 

func (f Termvectors) WithHeader(h map[string]string) func(*TermvectorsRequest)

WithHeader adds the headers to the HTTP request.

func (Termvectors) WithHuman ¶ 

func (f Termvectors) WithHuman() func(*TermvectorsRequest)

WithHuman makes statistical values human-readable.

func (Termvectors) WithOffsets ¶ 

func (f Termvectors) WithOffsets(v bool) func(*TermvectorsRequest)

WithOffsets - specifies if term offsets should be returned..

func (Termvectors) WithOpaqueID ¶ 

func (f Termvectors) WithOpaqueID(s string) func(*TermvectorsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Termvectors) WithPayloads ¶ 

func (f Termvectors) WithPayloads(v bool) func(*TermvectorsRequest)

WithPayloads - specifies if term payloads should be returned..

func (Termvectors) WithPositions ¶ 

func (f Termvectors) WithPositions(v bool) func(*TermvectorsRequest)

WithPositions - specifies if term positions should be returned..

func (Termvectors) WithPreference ¶ 

func (f Termvectors) WithPreference(v string) func(*TermvectorsRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random)..

func (Termvectors) WithPretty ¶ 

func (f Termvectors) WithPretty() func(*TermvectorsRequest)

WithPretty makes the response body pretty-printed.

func (Termvectors) WithRealtime ¶ 

func (f Termvectors) WithRealtime(v bool) func(*TermvectorsRequest)

WithRealtime - specifies if request is real-time as opposed to near-real-time (default: true)..

func (Termvectors) WithRouting ¶ 

func (f Termvectors) WithRouting(v string) func(*TermvectorsRequest)

WithRouting - specific routing value..

func (Termvectors) WithTermStatistics ¶ 

func (f Termvectors) WithTermStatistics(v bool) func(*TermvectorsRequest)

WithTermStatistics - specifies if total term frequency and document frequency should be returned..

func (Termvectors) WithVersion ¶ 

func (f Termvectors) WithVersion(v int) func(*TermvectorsRequest)

WithVersion - explicit version number for concurrency control.

func (Termvectors) WithVersionType ¶ 

func (f Termvectors) WithVersionType(v string) func(*TermvectorsRequest)

WithVersionType - specific version type.

type TermvectorsRequest ¶ 

type TermvectorsRequest struct {
	Index      string
	DocumentID string

	Body io.Reader

	Fields          []string
	FieldStatistics *bool
	Offsets         *bool
	Payloads        *bool
	Positions       *bool
	Preference      string
	Realtime        *bool
	Routing         string
	TermStatistics  *bool
	Version         *int
	VersionType     string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TermvectorsRequest configures the Termvectors API request.

func (TermvectorsRequest) Do ¶ 

func (r TermvectorsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TextStructureFindFieldStructure ¶ added in v8.14.0 

type TextStructureFindFieldStructure func(index string, field string, o ...func(*TextStructureFindFieldStructureRequest)) (*Response, error)

TextStructureFindFieldStructure - Finds the structure of a text field in an index.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/find-field-structure.html.

func (TextStructureFindFieldStructure) WithColumnNames ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithColumnNames(v ...string) func(*TextStructureFindFieldStructureRequest)

WithColumnNames - optional parameter containing a comma separated list of the column names for a delimited file.

func (TextStructureFindFieldStructure) WithContext ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithContext(v context.Context) func(*TextStructureFindFieldStructureRequest)

WithContext sets the request context.

func (TextStructureFindFieldStructure) WithDelimiter ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithDelimiter(v string) func(*TextStructureFindFieldStructureRequest)

WithDelimiter - optional parameter to specify the delimiter character for a delimited file - must be a single character.

func (TextStructureFindFieldStructure) WithDocumentsToSample ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithDocumentsToSample(v int) func(*TextStructureFindFieldStructureRequest)

WithDocumentsToSample - how many documents should be included in the analysis.

func (TextStructureFindFieldStructure) WithEcsCompatibility ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithEcsCompatibility(v string) func(*TextStructureFindFieldStructureRequest)

WithEcsCompatibility - optional parameter to specify the compatibility mode with ecs grok patterns - may be either 'v1' or 'disabled'.

func (TextStructureFindFieldStructure) WithErrorTrace ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithErrorTrace() func(*TextStructureFindFieldStructureRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TextStructureFindFieldStructure) WithExplain ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithExplain(v bool) func(*TextStructureFindFieldStructureRequest)

WithExplain - whether to include a commentary on how the structure was derived.

func (TextStructureFindFieldStructure) WithField ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithField(v string) func(*TextStructureFindFieldStructureRequest)

WithField - the field that should be analyzed.

func (TextStructureFindFieldStructure) WithFilterPath ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithFilterPath(v ...string) func(*TextStructureFindFieldStructureRequest)

WithFilterPath filters the properties of the response body.

func (TextStructureFindFieldStructure) WithFormat ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithFormat(v string) func(*TextStructureFindFieldStructureRequest)

WithFormat - optional parameter to specify the high level file format.

func (TextStructureFindFieldStructure) WithGrokPattern ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithGrokPattern(v string) func(*TextStructureFindFieldStructureRequest)

WithGrokPattern - optional parameter to specify the grok pattern that should be used to extract fields from messages in a semi-structured text file.

func (TextStructureFindFieldStructure) WithHeader ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithHeader(h map[string]string) func(*TextStructureFindFieldStructureRequest)

WithHeader adds the headers to the HTTP request.

func (TextStructureFindFieldStructure) WithHuman ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithHuman() func(*TextStructureFindFieldStructureRequest)

WithHuman makes statistical values human-readable.

func (TextStructureFindFieldStructure) WithIndex ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithIndex(v string) func(*TextStructureFindFieldStructureRequest)

WithIndex - the index containing the analyzed field.

func (TextStructureFindFieldStructure) WithOpaqueID ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithOpaqueID(s string) func(*TextStructureFindFieldStructureRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TextStructureFindFieldStructure) WithPretty ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithPretty() func(*TextStructureFindFieldStructureRequest)

WithPretty makes the response body pretty-printed.

func (TextStructureFindFieldStructure) WithQuote ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithQuote(v string) func(*TextStructureFindFieldStructureRequest)

WithQuote - optional parameter to specify the quote character for a delimited file - must be a single character.

func (TextStructureFindFieldStructure) WithShouldTrimFields ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithShouldTrimFields(v bool) func(*TextStructureFindFieldStructureRequest)

WithShouldTrimFields - optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them.

func (TextStructureFindFieldStructure) WithTimeout ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithTimeout(v time.Duration) func(*TextStructureFindFieldStructureRequest)

WithTimeout - timeout after which the analysis will be aborted.

func (TextStructureFindFieldStructure) WithTimestampField ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithTimestampField(v string) func(*TextStructureFindFieldStructureRequest)

WithTimestampField - optional parameter to specify the timestamp field in the file.

func (TextStructureFindFieldStructure) WithTimestampFormat ¶ added in v8.14.0 

func (f TextStructureFindFieldStructure) WithTimestampFormat(v string) func(*TextStructureFindFieldStructureRequest)

WithTimestampFormat - optional parameter to specify the timestamp format in the file - may be either a joda or java time format.

type TextStructureFindFieldStructureRequest ¶ added in v8.14.0 

type TextStructureFindFieldStructureRequest struct {
	ColumnNames       []string
	Delimiter         string
	DocumentsToSample *int
	EcsCompatibility  string
	Explain           *bool
	Field             string
	Format            string
	GrokPattern       string
	Index             string
	Quote             string
	ShouldTrimFields  *bool
	Timeout           time.Duration
	TimestampField    string
	TimestampFormat   string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TextStructureFindFieldStructureRequest configures the Text Structure Find Field Structure API request.

func (TextStructureFindFieldStructureRequest) Do ¶ added in v8.14.0 

func (r TextStructureFindFieldStructureRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TextStructureFindMessageStructure ¶ added in v8.14.0 

type TextStructureFindMessageStructure func(body io.Reader, o ...func(*TextStructureFindMessageStructureRequest)) (*Response, error)

TextStructureFindMessageStructure - Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/find-message-structure.html.

func (TextStructureFindMessageStructure) WithColumnNames ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithColumnNames(v ...string) func(*TextStructureFindMessageStructureRequest)

WithColumnNames - optional parameter containing a comma separated list of the column names for a delimited file.

func (TextStructureFindMessageStructure) WithContext ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithContext(v context.Context) func(*TextStructureFindMessageStructureRequest)

WithContext sets the request context.

func (TextStructureFindMessageStructure) WithDelimiter ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithDelimiter(v string) func(*TextStructureFindMessageStructureRequest)

WithDelimiter - optional parameter to specify the delimiter character for a delimited file - must be a single character.

func (TextStructureFindMessageStructure) WithEcsCompatibility ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithEcsCompatibility(v string) func(*TextStructureFindMessageStructureRequest)

WithEcsCompatibility - optional parameter to specify the compatibility mode with ecs grok patterns - may be either 'v1' or 'disabled'.

func (TextStructureFindMessageStructure) WithErrorTrace ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithErrorTrace() func(*TextStructureFindMessageStructureRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TextStructureFindMessageStructure) WithExplain ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithExplain(v bool) func(*TextStructureFindMessageStructureRequest)

WithExplain - whether to include a commentary on how the structure was derived.

func (TextStructureFindMessageStructure) WithFilterPath ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithFilterPath(v ...string) func(*TextStructureFindMessageStructureRequest)

WithFilterPath filters the properties of the response body.

func (TextStructureFindMessageStructure) WithFormat ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithFormat(v string) func(*TextStructureFindMessageStructureRequest)

WithFormat - optional parameter to specify the high level file format.

func (TextStructureFindMessageStructure) WithGrokPattern ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithGrokPattern(v string) func(*TextStructureFindMessageStructureRequest)

WithGrokPattern - optional parameter to specify the grok pattern that should be used to extract fields from messages in a semi-structured text file.

func (TextStructureFindMessageStructure) WithHeader ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithHeader(h map[string]string) func(*TextStructureFindMessageStructureRequest)

WithHeader adds the headers to the HTTP request.

func (TextStructureFindMessageStructure) WithHuman ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithHuman() func(*TextStructureFindMessageStructureRequest)

WithHuman makes statistical values human-readable.

func (TextStructureFindMessageStructure) WithOpaqueID ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithOpaqueID(s string) func(*TextStructureFindMessageStructureRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TextStructureFindMessageStructure) WithPretty ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithPretty() func(*TextStructureFindMessageStructureRequest)

WithPretty makes the response body pretty-printed.

func (TextStructureFindMessageStructure) WithQuote ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithQuote(v string) func(*TextStructureFindMessageStructureRequest)

WithQuote - optional parameter to specify the quote character for a delimited file - must be a single character.

func (TextStructureFindMessageStructure) WithShouldTrimFields ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithShouldTrimFields(v bool) func(*TextStructureFindMessageStructureRequest)

WithShouldTrimFields - optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them.

func (TextStructureFindMessageStructure) WithTimeout ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithTimeout(v time.Duration) func(*TextStructureFindMessageStructureRequest)

WithTimeout - timeout after which the analysis will be aborted.

func (TextStructureFindMessageStructure) WithTimestampField ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithTimestampField(v string) func(*TextStructureFindMessageStructureRequest)

WithTimestampField - optional parameter to specify the timestamp field in the file.

func (TextStructureFindMessageStructure) WithTimestampFormat ¶ added in v8.14.0 

func (f TextStructureFindMessageStructure) WithTimestampFormat(v string) func(*TextStructureFindMessageStructureRequest)

WithTimestampFormat - optional parameter to specify the timestamp format in the file - may be either a joda or java time format.

type TextStructureFindMessageStructureRequest ¶ added in v8.14.0 

type TextStructureFindMessageStructureRequest struct {
	Body io.Reader

	ColumnNames      []string
	Delimiter        string
	EcsCompatibility string
	Explain          *bool
	Format           string
	GrokPattern      string
	Quote            string
	ShouldTrimFields *bool
	Timeout          time.Duration
	TimestampField   string
	TimestampFormat  string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TextStructureFindMessageStructureRequest configures the Text Structure Find Message Structure API request.

func (TextStructureFindMessageStructureRequest) Do ¶ added in v8.14.0 

func (r TextStructureFindMessageStructureRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TextStructureFindStructure ¶ 

type TextStructureFindStructure func(body io.Reader, o ...func(*TextStructureFindStructureRequest)) (*Response, error)

TextStructureFindStructure - Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html.

func (TextStructureFindStructure) WithCharset ¶ 

func (f TextStructureFindStructure) WithCharset(v string) func(*TextStructureFindStructureRequest)

WithCharset - optional parameter to specify the character set of the file.

func (TextStructureFindStructure) WithColumnNames ¶ 

func (f TextStructureFindStructure) WithColumnNames(v ...string) func(*TextStructureFindStructureRequest)

WithColumnNames - optional parameter containing a comma separated list of the column names for a delimited file.

func (TextStructureFindStructure) WithContext ¶ 

func (f TextStructureFindStructure) WithContext(v context.Context) func(*TextStructureFindStructureRequest)

WithContext sets the request context.

func (TextStructureFindStructure) WithDelimiter ¶ 

func (f TextStructureFindStructure) WithDelimiter(v string) func(*TextStructureFindStructureRequest)

WithDelimiter - optional parameter to specify the delimiter character for a delimited file - must be a single character.

func (TextStructureFindStructure) WithEcsCompatibility ¶ added in v8.5.0 

func (f TextStructureFindStructure) WithEcsCompatibility(v string) func(*TextStructureFindStructureRequest)

WithEcsCompatibility - optional parameter to specify the compatibility mode with ecs grok patterns - may be either 'v1' or 'disabled'.

func (TextStructureFindStructure) WithErrorTrace ¶ 

func (f TextStructureFindStructure) WithErrorTrace() func(*TextStructureFindStructureRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TextStructureFindStructure) WithExplain ¶ 

func (f TextStructureFindStructure) WithExplain(v bool) func(*TextStructureFindStructureRequest)

WithExplain - whether to include a commentary on how the structure was derived.

func (TextStructureFindStructure) WithFilterPath ¶ 

func (f TextStructureFindStructure) WithFilterPath(v ...string) func(*TextStructureFindStructureRequest)

WithFilterPath filters the properties of the response body.

func (TextStructureFindStructure) WithFormat ¶ 

func (f TextStructureFindStructure) WithFormat(v string) func(*TextStructureFindStructureRequest)

WithFormat - optional parameter to specify the high level file format.

func (TextStructureFindStructure) WithGrokPattern ¶ 

func (f TextStructureFindStructure) WithGrokPattern(v string) func(*TextStructureFindStructureRequest)

WithGrokPattern - optional parameter to specify the grok pattern that should be used to extract fields from messages in a semi-structured text file.

func (TextStructureFindStructure) WithHasHeaderRow ¶ 

func (f TextStructureFindStructure) WithHasHeaderRow(v bool) func(*TextStructureFindStructureRequest)

WithHasHeaderRow - optional parameter to specify whether a delimited file includes the column names in its first row.

func (TextStructureFindStructure) WithHeader ¶ 

func (f TextStructureFindStructure) WithHeader(h map[string]string) func(*TextStructureFindStructureRequest)

WithHeader adds the headers to the HTTP request.

func (TextStructureFindStructure) WithHuman ¶ 

func (f TextStructureFindStructure) WithHuman() func(*TextStructureFindStructureRequest)

WithHuman makes statistical values human-readable.

func (TextStructureFindStructure) WithLineMergeSizeLimit ¶ 

func (f TextStructureFindStructure) WithLineMergeSizeLimit(v int) func(*TextStructureFindStructureRequest)

WithLineMergeSizeLimit - maximum number of characters permitted in a single message when lines are merged to create messages..

func (TextStructureFindStructure) WithLinesToSample ¶ 

func (f TextStructureFindStructure) WithLinesToSample(v int) func(*TextStructureFindStructureRequest)

WithLinesToSample - how many lines of the file should be included in the analysis.

func (TextStructureFindStructure) WithOpaqueID ¶ 

func (f TextStructureFindStructure) WithOpaqueID(s string) func(*TextStructureFindStructureRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TextStructureFindStructure) WithPretty ¶ 

func (f TextStructureFindStructure) WithPretty() func(*TextStructureFindStructureRequest)

WithPretty makes the response body pretty-printed.

func (TextStructureFindStructure) WithQuote ¶ 

func (f TextStructureFindStructure) WithQuote(v string) func(*TextStructureFindStructureRequest)

WithQuote - optional parameter to specify the quote character for a delimited file - must be a single character.

func (TextStructureFindStructure) WithShouldTrimFields ¶ 

func (f TextStructureFindStructure) WithShouldTrimFields(v bool) func(*TextStructureFindStructureRequest)

WithShouldTrimFields - optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them.

func (TextStructureFindStructure) WithTimeout ¶ 

func (f TextStructureFindStructure) WithTimeout(v time.Duration) func(*TextStructureFindStructureRequest)

WithTimeout - timeout after which the analysis will be aborted.

func (TextStructureFindStructure) WithTimestampField ¶ 

func (f TextStructureFindStructure) WithTimestampField(v string) func(*TextStructureFindStructureRequest)

WithTimestampField - optional parameter to specify the timestamp field in the file.

func (TextStructureFindStructure) WithTimestampFormat ¶ 

func (f TextStructureFindStructure) WithTimestampFormat(v string) func(*TextStructureFindStructureRequest)

WithTimestampFormat - optional parameter to specify the timestamp format in the file - may be either a joda or java time format.

type TextStructureFindStructureRequest ¶ 

type TextStructureFindStructureRequest struct {
	Body io.Reader

	Charset            string
	ColumnNames        []string
	Delimiter          string
	EcsCompatibility   string
	Explain            *bool
	Format             string
	GrokPattern        string
	HasHeaderRow       *bool
	LineMergeSizeLimit *int
	LinesToSample      *int
	Quote              string
	ShouldTrimFields   *bool
	Timeout            time.Duration
	TimestampField     string
	TimestampFormat    string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TextStructureFindStructureRequest configures the Text Structure Find Structure API request.

func (TextStructureFindStructureRequest) Do ¶ 

func (r TextStructureFindStructureRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TextStructureTestGrokPattern ¶ added in v8.13.0 

type TextStructureTestGrokPattern func(body io.Reader, o ...func(*TextStructureTestGrokPatternRequest)) (*Response, error)

TextStructureTestGrokPattern - Tests a Grok pattern on some text.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/test-grok-pattern.html.

func (TextStructureTestGrokPattern) WithContext ¶ added in v8.13.0 

func (f TextStructureTestGrokPattern) WithContext(v context.Context) func(*TextStructureTestGrokPatternRequest)

WithContext sets the request context.

func (TextStructureTestGrokPattern) WithEcsCompatibility ¶ added in v8.13.0 

func (f TextStructureTestGrokPattern) WithEcsCompatibility(v string) func(*TextStructureTestGrokPatternRequest)

WithEcsCompatibility - optional parameter to specify the compatibility mode with ecs grok patterns - may be either 'v1' or 'disabled'.

func (TextStructureTestGrokPattern) WithErrorTrace ¶ added in v8.13.0 

func (f TextStructureTestGrokPattern) WithErrorTrace() func(*TextStructureTestGrokPatternRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TextStructureTestGrokPattern) WithFilterPath ¶ added in v8.13.0 

func (f TextStructureTestGrokPattern) WithFilterPath(v ...string) func(*TextStructureTestGrokPatternRequest)

WithFilterPath filters the properties of the response body.

func (TextStructureTestGrokPattern) WithHeader ¶ added in v8.13.0 

func (f TextStructureTestGrokPattern) WithHeader(h map[string]string) func(*TextStructureTestGrokPatternRequest)

WithHeader adds the headers to the HTTP request.

func (TextStructureTestGrokPattern) WithHuman ¶ added in v8.13.0 

func (f TextStructureTestGrokPattern) WithHuman() func(*TextStructureTestGrokPatternRequest)

WithHuman makes statistical values human-readable.

func (TextStructureTestGrokPattern) WithOpaqueID ¶ added in v8.13.0 

func (f TextStructureTestGrokPattern) WithOpaqueID(s string) func(*TextStructureTestGrokPatternRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TextStructureTestGrokPattern) WithPretty ¶ added in v8.13.0 

func (f TextStructureTestGrokPattern) WithPretty() func(*TextStructureTestGrokPatternRequest)

WithPretty makes the response body pretty-printed.

type TextStructureTestGrokPatternRequest ¶ added in v8.13.0 

type TextStructureTestGrokPatternRequest struct {
	Body io.Reader

	EcsCompatibility string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TextStructureTestGrokPatternRequest configures the Text Structure Test Grok Pattern API request.

func (TextStructureTestGrokPatternRequest) Do ¶ added in v8.13.0 

func (r TextStructureTestGrokPatternRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TransformDeleteTransform ¶ 

type TransformDeleteTransform func(transform_id string, o ...func(*TransformDeleteTransformRequest)) (*Response, error)

TransformDeleteTransform - Deletes an existing transform.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html.

func (TransformDeleteTransform) WithContext ¶ 

func (f TransformDeleteTransform) WithContext(v context.Context) func(*TransformDeleteTransformRequest)

WithContext sets the request context.

func (TransformDeleteTransform) WithDeleteDestIndex ¶ added in v8.8.0 

func (f TransformDeleteTransform) WithDeleteDestIndex(v bool) func(*TransformDeleteTransformRequest)

WithDeleteDestIndex - when `true`, the destination index is deleted together with the transform. the default value is `false`, meaning that the destination index will not be deleted..

func (TransformDeleteTransform) WithErrorTrace ¶ 

func (f TransformDeleteTransform) WithErrorTrace() func(*TransformDeleteTransformRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TransformDeleteTransform) WithFilterPath ¶ 

func (f TransformDeleteTransform) WithFilterPath(v ...string) func(*TransformDeleteTransformRequest)

WithFilterPath filters the properties of the response body.

func (TransformDeleteTransform) WithForce ¶ 

func (f TransformDeleteTransform) WithForce(v bool) func(*TransformDeleteTransformRequest)

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 (TransformDeleteTransform) WithHeader ¶ 

func (f TransformDeleteTransform) WithHeader(h map[string]string) func(*TransformDeleteTransformRequest)

WithHeader adds the headers to the HTTP request.

func (TransformDeleteTransform) WithHuman ¶ 

func (f TransformDeleteTransform) WithHuman() func(*TransformDeleteTransformRequest)

WithHuman makes statistical values human-readable.

func (TransformDeleteTransform) WithOpaqueID ¶ 

func (f TransformDeleteTransform) WithOpaqueID(s string) func(*TransformDeleteTransformRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TransformDeleteTransform) WithPretty ¶ 

func (f TransformDeleteTransform) WithPretty() func(*TransformDeleteTransformRequest)

WithPretty makes the response body pretty-printed.

func (TransformDeleteTransform) WithTimeout ¶ 

func (f TransformDeleteTransform) WithTimeout(v time.Duration) func(*TransformDeleteTransformRequest)

WithTimeout - controls the time to wait for the transform deletion.

type TransformDeleteTransformRequest ¶ 

type TransformDeleteTransformRequest struct {
	TransformID string

	DeleteDestIndex *bool
	Force           *bool
	Timeout         time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TransformDeleteTransformRequest configures the Transform Delete Transform API request.

func (TransformDeleteTransformRequest) Do ¶ 

func (r TransformDeleteTransformRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TransformGetNodeStats ¶ added in v8.15.0 

type TransformGetNodeStats func(o ...func(*TransformGetNodeStatsRequest)) (*Response, error)

TransformGetNodeStats - Retrieves transform usage information for transform nodes.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-node-stats.html.

func (TransformGetNodeStats) WithContext ¶ added in v8.15.0 

func (f TransformGetNodeStats) WithContext(v context.Context) func(*TransformGetNodeStatsRequest)

WithContext sets the request context.

func (TransformGetNodeStats) WithErrorTrace ¶ added in v8.15.0 

func (f TransformGetNodeStats) WithErrorTrace() func(*TransformGetNodeStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TransformGetNodeStats) WithFilterPath ¶ added in v8.15.0 

func (f TransformGetNodeStats) WithFilterPath(v ...string) func(*TransformGetNodeStatsRequest)

WithFilterPath filters the properties of the response body.

func (TransformGetNodeStats) WithHeader ¶ added in v8.15.0 

func (f TransformGetNodeStats) WithHeader(h map[string]string) func(*TransformGetNodeStatsRequest)

WithHeader adds the headers to the HTTP request.

func (TransformGetNodeStats) WithHuman ¶ added in v8.15.0 

func (f TransformGetNodeStats) WithHuman() func(*TransformGetNodeStatsRequest)

WithHuman makes statistical values human-readable.

func (TransformGetNodeStats) WithOpaqueID ¶ added in v8.15.0 

func (f TransformGetNodeStats) WithOpaqueID(s string) func(*TransformGetNodeStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TransformGetNodeStats) WithPretty ¶ added in v8.15.0 

func (f TransformGetNodeStats) WithPretty() func(*TransformGetNodeStatsRequest)

WithPretty makes the response body pretty-printed.

type TransformGetNodeStatsRequest ¶ added in v8.15.0 

type TransformGetNodeStatsRequest struct {
	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TransformGetNodeStatsRequest configures the Transform Get Node Stats API request.

func (TransformGetNodeStatsRequest) Do ¶ added in v8.15.0 

func (r TransformGetNodeStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TransformGetTransform ¶ 

type TransformGetTransform func(o ...func(*TransformGetTransformRequest)) (*Response, error)

TransformGetTransform - Retrieves configuration information for transforms.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html.

func (TransformGetTransform) WithAllowNoMatch ¶ 

func (f TransformGetTransform) WithAllowNoMatch(v bool) func(*TransformGetTransformRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no transforms. (this includes `_all` string or when no transforms have been specified).

func (TransformGetTransform) WithContext ¶ 

func (f TransformGetTransform) WithContext(v context.Context) func(*TransformGetTransformRequest)

WithContext sets the request context.

func (TransformGetTransform) WithErrorTrace ¶ 

func (f TransformGetTransform) WithErrorTrace() func(*TransformGetTransformRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TransformGetTransform) WithExcludeGenerated ¶ 

func (f TransformGetTransform) WithExcludeGenerated(v bool) func(*TransformGetTransformRequest)

WithExcludeGenerated - omits fields that are illegal to set on transform put.

func (TransformGetTransform) WithFilterPath ¶ 

func (f TransformGetTransform) WithFilterPath(v ...string) func(*TransformGetTransformRequest)

WithFilterPath filters the properties of the response body.

func (TransformGetTransform) WithFrom ¶ 

func (f TransformGetTransform) WithFrom(v int) func(*TransformGetTransformRequest)

WithFrom - skips a number of transform configs, defaults to 0.

func (TransformGetTransform) WithHeader ¶ 

func (f TransformGetTransform) WithHeader(h map[string]string) func(*TransformGetTransformRequest)

WithHeader adds the headers to the HTTP request.

func (TransformGetTransform) WithHuman ¶ 

func (f TransformGetTransform) WithHuman() func(*TransformGetTransformRequest)

WithHuman makes statistical values human-readable.

func (TransformGetTransform) WithOpaqueID ¶ 

func (f TransformGetTransform) WithOpaqueID(s string) func(*TransformGetTransformRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TransformGetTransform) WithPretty ¶ 

func (f TransformGetTransform) WithPretty() func(*TransformGetTransformRequest)

WithPretty makes the response body pretty-printed.

func (TransformGetTransform) WithSize ¶ 

func (f TransformGetTransform) WithSize(v int) func(*TransformGetTransformRequest)

WithSize - specifies a max number of transforms to get, defaults to 100.

func (TransformGetTransform) WithTransformID ¶ 

func (f TransformGetTransform) WithTransformID(v string) func(*TransformGetTransformRequest)

WithTransformID - the ID or comma delimited list of ID expressions of the transforms to get, '_all' or '*' implies get all transforms.

type TransformGetTransformRequest ¶ 

type TransformGetTransformRequest struct {
	TransformID string

	AllowNoMatch     *bool
	ExcludeGenerated *bool
	From             *int
	Size             *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TransformGetTransformRequest configures the Transform Get Transform API request.

func (TransformGetTransformRequest) Do ¶ 

func (r TransformGetTransformRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TransformGetTransformStats ¶ 

type TransformGetTransformStats func(transform_id string, o ...func(*TransformGetTransformStatsRequest)) (*Response, error)

TransformGetTransformStats - Retrieves usage information for transforms.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html.

func (TransformGetTransformStats) WithAllowNoMatch ¶ 

func (f TransformGetTransformStats) WithAllowNoMatch(v bool) func(*TransformGetTransformStatsRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no transforms. (this includes `_all` string or when no transforms have been specified).

func (TransformGetTransformStats) WithContext ¶ 

func (f TransformGetTransformStats) WithContext(v context.Context) func(*TransformGetTransformStatsRequest)

WithContext sets the request context.

func (TransformGetTransformStats) WithErrorTrace ¶ 

func (f TransformGetTransformStats) WithErrorTrace() func(*TransformGetTransformStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TransformGetTransformStats) WithFilterPath ¶ 

func (f TransformGetTransformStats) WithFilterPath(v ...string) func(*TransformGetTransformStatsRequest)

WithFilterPath filters the properties of the response body.

func (TransformGetTransformStats) WithFrom ¶ 

func (f TransformGetTransformStats) WithFrom(v int) func(*TransformGetTransformStatsRequest)

WithFrom - skips a number of transform stats, defaults to 0.

func (TransformGetTransformStats) WithHeader ¶ 

func (f TransformGetTransformStats) WithHeader(h map[string]string) func(*TransformGetTransformStatsRequest)

WithHeader adds the headers to the HTTP request.

func (TransformGetTransformStats) WithHuman ¶ 

func (f TransformGetTransformStats) WithHuman() func(*TransformGetTransformStatsRequest)

WithHuman makes statistical values human-readable.

func (TransformGetTransformStats) WithOpaqueID ¶ 

func (f TransformGetTransformStats) WithOpaqueID(s string) func(*TransformGetTransformStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TransformGetTransformStats) WithPretty ¶ 

func (f TransformGetTransformStats) WithPretty() func(*TransformGetTransformStatsRequest)

WithPretty makes the response body pretty-printed.

func (TransformGetTransformStats) WithSize ¶ 

func (f TransformGetTransformStats) WithSize(v int) func(*TransformGetTransformStatsRequest)

WithSize - specifies a max number of transform stats to get, defaults to 100.

func (TransformGetTransformStats) WithTimeout ¶ added in v8.7.0 

func (f TransformGetTransformStats) WithTimeout(v time.Duration) func(*TransformGetTransformStatsRequest)

WithTimeout - controls the time to wait for the stats.

type TransformGetTransformStatsRequest ¶ 

type TransformGetTransformStatsRequest struct {
	TransformID string

	AllowNoMatch *bool
	From         *int
	Size         *int
	Timeout      time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TransformGetTransformStatsRequest configures the Transform Get Transform Stats API request.

func (TransformGetTransformStatsRequest) Do ¶ 

func (r TransformGetTransformStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TransformPreviewTransform ¶ 

type TransformPreviewTransform func(o ...func(*TransformPreviewTransformRequest)) (*Response, error)

TransformPreviewTransform - Previews a transform.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html.

func (TransformPreviewTransform) WithBody ¶ 

func (f TransformPreviewTransform) WithBody(v io.Reader) func(*TransformPreviewTransformRequest)

WithBody - The definition for the transform to preview.

func (TransformPreviewTransform) WithContext ¶ 

func (f TransformPreviewTransform) WithContext(v context.Context) func(*TransformPreviewTransformRequest)

WithContext sets the request context.

func (TransformPreviewTransform) WithErrorTrace ¶ 

func (f TransformPreviewTransform) WithErrorTrace() func(*TransformPreviewTransformRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TransformPreviewTransform) WithFilterPath ¶ 

func (f TransformPreviewTransform) WithFilterPath(v ...string) func(*TransformPreviewTransformRequest)

WithFilterPath filters the properties of the response body.

func (TransformPreviewTransform) WithHeader ¶ 

func (f TransformPreviewTransform) WithHeader(h map[string]string) func(*TransformPreviewTransformRequest)

WithHeader adds the headers to the HTTP request.

func (TransformPreviewTransform) WithHuman ¶ 

func (f TransformPreviewTransform) WithHuman() func(*TransformPreviewTransformRequest)

WithHuman makes statistical values human-readable.

func (TransformPreviewTransform) WithOpaqueID ¶ 

func (f TransformPreviewTransform) WithOpaqueID(s string) func(*TransformPreviewTransformRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TransformPreviewTransform) WithPretty ¶ 

func (f TransformPreviewTransform) WithPretty() func(*TransformPreviewTransformRequest)

WithPretty makes the response body pretty-printed.

func (TransformPreviewTransform) WithTimeout ¶ 

func (f TransformPreviewTransform) WithTimeout(v time.Duration) func(*TransformPreviewTransformRequest)

WithTimeout - controls the time to wait for the preview.

func (TransformPreviewTransform) WithTransformID ¶ 

func (f TransformPreviewTransform) WithTransformID(v string) func(*TransformPreviewTransformRequest)

WithTransformID - the ID of the transform to preview..

type TransformPreviewTransformRequest ¶ 

type TransformPreviewTransformRequest struct {
	Body io.Reader

	TransformID string

	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TransformPreviewTransformRequest configures the Transform Preview Transform API request.

func (TransformPreviewTransformRequest) Do ¶ 

func (r TransformPreviewTransformRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TransformPutTransform ¶ 

type TransformPutTransform func(body io.Reader, transform_id string, o ...func(*TransformPutTransformRequest)) (*Response, error)

TransformPutTransform - Instantiates a transform.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html.

func (TransformPutTransform) WithContext ¶ 

func (f TransformPutTransform) WithContext(v context.Context) func(*TransformPutTransformRequest)

WithContext sets the request context.

func (TransformPutTransform) WithDeferValidation ¶ 

func (f TransformPutTransform) WithDeferValidation(v bool) func(*TransformPutTransformRequest)

WithDeferValidation - if validations should be deferred until transform starts, defaults to false..

func (TransformPutTransform) WithErrorTrace ¶ 

func (f TransformPutTransform) WithErrorTrace() func(*TransformPutTransformRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TransformPutTransform) WithFilterPath ¶ 

func (f TransformPutTransform) WithFilterPath(v ...string) func(*TransformPutTransformRequest)

WithFilterPath filters the properties of the response body.

func (TransformPutTransform) WithHeader ¶ 

func (f TransformPutTransform) WithHeader(h map[string]string) func(*TransformPutTransformRequest)

WithHeader adds the headers to the HTTP request.

func (TransformPutTransform) WithHuman ¶ 

func (f TransformPutTransform) WithHuman() func(*TransformPutTransformRequest)

WithHuman makes statistical values human-readable.

func (TransformPutTransform) WithOpaqueID ¶ 

func (f TransformPutTransform) WithOpaqueID(s string) func(*TransformPutTransformRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TransformPutTransform) WithPretty ¶ 

func (f TransformPutTransform) WithPretty() func(*TransformPutTransformRequest)

WithPretty makes the response body pretty-printed.

func (TransformPutTransform) WithTimeout ¶ 

func (f TransformPutTransform) WithTimeout(v time.Duration) func(*TransformPutTransformRequest)

WithTimeout - controls the time to wait for the transform to start.

type TransformPutTransformRequest ¶ 

type TransformPutTransformRequest struct {
	Body io.Reader

	TransformID string

	DeferValidation *bool
	Timeout         time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TransformPutTransformRequest configures the Transform Put Transform API request.

func (TransformPutTransformRequest) Do ¶ 

func (r TransformPutTransformRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TransformResetTransform ¶ added in v8.1.0 

type TransformResetTransform func(transform_id string, o ...func(*TransformResetTransformRequest)) (*Response, error)

TransformResetTransform - Resets an existing transform.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html.

func (TransformResetTransform) WithContext ¶ added in v8.1.0 

func (f TransformResetTransform) WithContext(v context.Context) func(*TransformResetTransformRequest)

WithContext sets the request context.

func (TransformResetTransform) WithErrorTrace ¶ added in v8.1.0 

func (f TransformResetTransform) WithErrorTrace() func(*TransformResetTransformRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TransformResetTransform) WithFilterPath ¶ added in v8.1.0 

func (f TransformResetTransform) WithFilterPath(v ...string) func(*TransformResetTransformRequest)

WithFilterPath filters the properties of the response body.

func (TransformResetTransform) WithForce ¶ added in v8.1.0 

func (f TransformResetTransform) WithForce(v bool) func(*TransformResetTransformRequest)

WithForce - when `true`, the transform is reset regardless of its current state. the default value is `false`, meaning that the transform must be `stopped` before it can be reset..

func (TransformResetTransform) WithHeader ¶ added in v8.1.0 

func (f TransformResetTransform) WithHeader(h map[string]string) func(*TransformResetTransformRequest)

WithHeader adds the headers to the HTTP request.

func (TransformResetTransform) WithHuman ¶ added in v8.1.0 

func (f TransformResetTransform) WithHuman() func(*TransformResetTransformRequest)

WithHuman makes statistical values human-readable.

func (TransformResetTransform) WithOpaqueID ¶ added in v8.1.0 

func (f TransformResetTransform) WithOpaqueID(s string) func(*TransformResetTransformRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TransformResetTransform) WithPretty ¶ added in v8.1.0 

func (f TransformResetTransform) WithPretty() func(*TransformResetTransformRequest)

WithPretty makes the response body pretty-printed.

func (TransformResetTransform) WithTimeout ¶ added in v8.1.0 

func (f TransformResetTransform) WithTimeout(v time.Duration) func(*TransformResetTransformRequest)

WithTimeout - controls the time to wait for the transform to reset.

type TransformResetTransformRequest ¶ added in v8.1.0 

type TransformResetTransformRequest struct {
	TransformID string

	Force   *bool
	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TransformResetTransformRequest configures the Transform Reset Transform API request.

func (TransformResetTransformRequest) Do ¶ added in v8.1.0 

func (r TransformResetTransformRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TransformScheduleNowTransform ¶ added in v8.7.0 

type TransformScheduleNowTransform func(transform_id string, o ...func(*TransformScheduleNowTransformRequest)) (*Response, error)

TransformScheduleNowTransform - Schedules now a transform.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html.

func (TransformScheduleNowTransform) WithContext ¶ added in v8.7.0 

func (f TransformScheduleNowTransform) WithContext(v context.Context) func(*TransformScheduleNowTransformRequest)

WithContext sets the request context.

func (TransformScheduleNowTransform) WithErrorTrace ¶ added in v8.7.0 

func (f TransformScheduleNowTransform) WithErrorTrace() func(*TransformScheduleNowTransformRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TransformScheduleNowTransform) WithFilterPath ¶ added in v8.7.0 

func (f TransformScheduleNowTransform) WithFilterPath(v ...string) func(*TransformScheduleNowTransformRequest)

WithFilterPath filters the properties of the response body.

func (TransformScheduleNowTransform) WithHeader ¶ added in v8.7.0 

func (f TransformScheduleNowTransform) WithHeader(h map[string]string) func(*TransformScheduleNowTransformRequest)

WithHeader adds the headers to the HTTP request.

func (TransformScheduleNowTransform) WithHuman ¶ added in v8.7.0 

func (f TransformScheduleNowTransform) WithHuman() func(*TransformScheduleNowTransformRequest)

WithHuman makes statistical values human-readable.

func (TransformScheduleNowTransform) WithOpaqueID ¶ added in v8.7.0 

func (f TransformScheduleNowTransform) WithOpaqueID(s string) func(*TransformScheduleNowTransformRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TransformScheduleNowTransform) WithPretty ¶ added in v8.7.0 

func (f TransformScheduleNowTransform) WithPretty() func(*TransformScheduleNowTransformRequest)

WithPretty makes the response body pretty-printed.

func (TransformScheduleNowTransform) WithTimeout ¶ added in v8.7.0 

func (f TransformScheduleNowTransform) WithTimeout(v time.Duration) func(*TransformScheduleNowTransformRequest)

WithTimeout - controls the time to wait for the scheduling to take place.

type TransformScheduleNowTransformRequest ¶ added in v8.7.0 

type TransformScheduleNowTransformRequest struct {
	TransformID string

	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TransformScheduleNowTransformRequest configures the Transform Schedule Now Transform API request.

func (TransformScheduleNowTransformRequest) Do ¶ added in v8.7.0 

func (r TransformScheduleNowTransformRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TransformStartTransform ¶ 

type TransformStartTransform func(transform_id string, o ...func(*TransformStartTransformRequest)) (*Response, error)

TransformStartTransform - Starts one or more transforms.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html.

func (TransformStartTransform) WithContext ¶ 

func (f TransformStartTransform) WithContext(v context.Context) func(*TransformStartTransformRequest)

WithContext sets the request context.

func (TransformStartTransform) WithErrorTrace ¶ 

func (f TransformStartTransform) WithErrorTrace() func(*TransformStartTransformRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TransformStartTransform) WithFilterPath ¶ 

func (f TransformStartTransform) WithFilterPath(v ...string) func(*TransformStartTransformRequest)

WithFilterPath filters the properties of the response body.

func (TransformStartTransform) WithFrom ¶ added in v8.7.0 

func (f TransformStartTransform) WithFrom(v string) func(*TransformStartTransformRequest)

WithFrom - restricts the set of transformed entities to those changed after this time.

func (TransformStartTransform) WithHeader ¶ 

func (f TransformStartTransform) WithHeader(h map[string]string) func(*TransformStartTransformRequest)

WithHeader adds the headers to the HTTP request.

func (TransformStartTransform) WithHuman ¶ 

func (f TransformStartTransform) WithHuman() func(*TransformStartTransformRequest)

WithHuman makes statistical values human-readable.

func (TransformStartTransform) WithOpaqueID ¶ 

func (f TransformStartTransform) WithOpaqueID(s string) func(*TransformStartTransformRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TransformStartTransform) WithPretty ¶ 

func (f TransformStartTransform) WithPretty() func(*TransformStartTransformRequest)

WithPretty makes the response body pretty-printed.

func (TransformStartTransform) WithTimeout ¶ 

func (f TransformStartTransform) WithTimeout(v time.Duration) func(*TransformStartTransformRequest)

WithTimeout - controls the time to wait for the transform to start.

type TransformStartTransformRequest ¶ 

type TransformStartTransformRequest struct {
	TransformID string

	From    string
	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TransformStartTransformRequest configures the Transform Start Transform API request.

func (TransformStartTransformRequest) Do ¶ 

func (r TransformStartTransformRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TransformStopTransform ¶ 

type TransformStopTransform func(transform_id string, o ...func(*TransformStopTransformRequest)) (*Response, error)

TransformStopTransform - Stops one or more transforms.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html.

func (TransformStopTransform) WithAllowNoMatch ¶ 

func (f TransformStopTransform) WithAllowNoMatch(v bool) func(*TransformStopTransformRequest)

WithAllowNoMatch - whether to ignore if a wildcard expression matches no transforms. (this includes `_all` string or when no transforms have been specified).

func (TransformStopTransform) WithContext ¶ 

func (f TransformStopTransform) WithContext(v context.Context) func(*TransformStopTransformRequest)

WithContext sets the request context.

func (TransformStopTransform) WithErrorTrace ¶ 

func (f TransformStopTransform) WithErrorTrace() func(*TransformStopTransformRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TransformStopTransform) WithFilterPath ¶ 

func (f TransformStopTransform) WithFilterPath(v ...string) func(*TransformStopTransformRequest)

WithFilterPath filters the properties of the response body.

func (TransformStopTransform) WithForce ¶ 

func (f TransformStopTransform) WithForce(v bool) func(*TransformStopTransformRequest)

WithForce - whether to force stop a failed transform or not. default to false.

func (TransformStopTransform) WithHeader ¶ 

func (f TransformStopTransform) WithHeader(h map[string]string) func(*TransformStopTransformRequest)

WithHeader adds the headers to the HTTP request.

func (TransformStopTransform) WithHuman ¶ 

func (f TransformStopTransform) WithHuman() func(*TransformStopTransformRequest)

WithHuman makes statistical values human-readable.

func (TransformStopTransform) WithOpaqueID ¶ 

func (f TransformStopTransform) WithOpaqueID(s string) func(*TransformStopTransformRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TransformStopTransform) WithPretty ¶ 

func (f TransformStopTransform) WithPretty() func(*TransformStopTransformRequest)

WithPretty makes the response body pretty-printed.

func (TransformStopTransform) WithTimeout ¶ 

func (f TransformStopTransform) WithTimeout(v time.Duration) func(*TransformStopTransformRequest)

WithTimeout - controls the time to wait until the transform has stopped. default to 30 seconds.

func (TransformStopTransform) WithWaitForCheckpoint ¶ 

func (f TransformStopTransform) WithWaitForCheckpoint(v bool) func(*TransformStopTransformRequest)

WithWaitForCheckpoint - whether to wait for the transform to reach a checkpoint before stopping. default to false.

func (TransformStopTransform) WithWaitForCompletion ¶ 

func (f TransformStopTransform) WithWaitForCompletion(v bool) func(*TransformStopTransformRequest)

WithWaitForCompletion - whether to wait for the transform to fully stop before returning or not. default to false.

type TransformStopTransformRequest ¶ 

type TransformStopTransformRequest struct {
	TransformID string

	AllowNoMatch      *bool
	Force             *bool
	Timeout           time.Duration
	WaitForCheckpoint *bool
	WaitForCompletion *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TransformStopTransformRequest configures the Transform Stop Transform API request.

func (TransformStopTransformRequest) Do ¶ 

func (r TransformStopTransformRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TransformUpdateTransform ¶ 

type TransformUpdateTransform func(body io.Reader, transform_id string, o ...func(*TransformUpdateTransformRequest)) (*Response, error)

TransformUpdateTransform - Updates certain properties of a transform.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html.

func (TransformUpdateTransform) WithContext ¶ 

func (f TransformUpdateTransform) WithContext(v context.Context) func(*TransformUpdateTransformRequest)

WithContext sets the request context.

func (TransformUpdateTransform) WithDeferValidation ¶ 

func (f TransformUpdateTransform) WithDeferValidation(v bool) func(*TransformUpdateTransformRequest)

WithDeferValidation - if validations should be deferred until transform starts, defaults to false..

func (TransformUpdateTransform) WithErrorTrace ¶ 

func (f TransformUpdateTransform) WithErrorTrace() func(*TransformUpdateTransformRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TransformUpdateTransform) WithFilterPath ¶ 

func (f TransformUpdateTransform) WithFilterPath(v ...string) func(*TransformUpdateTransformRequest)

WithFilterPath filters the properties of the response body.

func (TransformUpdateTransform) WithHeader ¶ 

func (f TransformUpdateTransform) WithHeader(h map[string]string) func(*TransformUpdateTransformRequest)

WithHeader adds the headers to the HTTP request.

func (TransformUpdateTransform) WithHuman ¶ 

func (f TransformUpdateTransform) WithHuman() func(*TransformUpdateTransformRequest)

WithHuman makes statistical values human-readable.

func (TransformUpdateTransform) WithOpaqueID ¶ 

func (f TransformUpdateTransform) WithOpaqueID(s string) func(*TransformUpdateTransformRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TransformUpdateTransform) WithPretty ¶ 

func (f TransformUpdateTransform) WithPretty() func(*TransformUpdateTransformRequest)

WithPretty makes the response body pretty-printed.

func (TransformUpdateTransform) WithTimeout ¶ 

func (f TransformUpdateTransform) WithTimeout(v time.Duration) func(*TransformUpdateTransformRequest)

WithTimeout - controls the time to wait for the update.

type TransformUpdateTransformRequest ¶ 

type TransformUpdateTransformRequest struct {
	Body io.Reader

	TransformID string

	DeferValidation *bool
	Timeout         time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TransformUpdateTransformRequest configures the Transform Update Transform API request.

func (TransformUpdateTransformRequest) Do ¶ 

func (r TransformUpdateTransformRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type TransformUpgradeTransforms ¶ 

type TransformUpgradeTransforms func(o ...func(*TransformUpgradeTransformsRequest)) (*Response, error)

TransformUpgradeTransforms - Upgrades all transforms.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html.

func (TransformUpgradeTransforms) WithContext ¶ 

func (f TransformUpgradeTransforms) WithContext(v context.Context) func(*TransformUpgradeTransformsRequest)

WithContext sets the request context.

func (TransformUpgradeTransforms) WithDryRun ¶ 

func (f TransformUpgradeTransforms) WithDryRun(v bool) func(*TransformUpgradeTransformsRequest)

WithDryRun - whether to only check for updates but don't execute.

func (TransformUpgradeTransforms) WithErrorTrace ¶ 

func (f TransformUpgradeTransforms) WithErrorTrace() func(*TransformUpgradeTransformsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (TransformUpgradeTransforms) WithFilterPath ¶ 

func (f TransformUpgradeTransforms) WithFilterPath(v ...string) func(*TransformUpgradeTransformsRequest)

WithFilterPath filters the properties of the response body.

func (TransformUpgradeTransforms) WithHeader ¶ 

func (f TransformUpgradeTransforms) WithHeader(h map[string]string) func(*TransformUpgradeTransformsRequest)

WithHeader adds the headers to the HTTP request.

func (TransformUpgradeTransforms) WithHuman ¶ 

func (f TransformUpgradeTransforms) WithHuman() func(*TransformUpgradeTransformsRequest)

WithHuman makes statistical values human-readable.

func (TransformUpgradeTransforms) WithOpaqueID ¶ 

func (f TransformUpgradeTransforms) WithOpaqueID(s string) func(*TransformUpgradeTransformsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (TransformUpgradeTransforms) WithPretty ¶ 

func (f TransformUpgradeTransforms) WithPretty() func(*TransformUpgradeTransformsRequest)

WithPretty makes the response body pretty-printed.

func (TransformUpgradeTransforms) WithTimeout ¶ 

func (f TransformUpgradeTransforms) WithTimeout(v time.Duration) func(*TransformUpgradeTransformsRequest)

WithTimeout - controls the time to wait for the upgrade.

type TransformUpgradeTransformsRequest ¶ 

type TransformUpgradeTransformsRequest struct {
	DryRun  *bool
	Timeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

TransformUpgradeTransformsRequest configures the Transform Upgrade Transforms API request.

func (TransformUpgradeTransformsRequest) Do ¶ 

func (r TransformUpgradeTransformsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Transport ¶ 

type Transport interface {
	Perform(*http.Request) (*http.Response, error)
}

Transport defines the interface for an API client.

type Update ¶ 

type Update func(index string, id string, body io.Reader, o ...func(*UpdateRequest)) (*Response, error)

Update updates a document with a script or partial document.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html.

func (Update) WithContext ¶ 

func (f Update) WithContext(v context.Context) func(*UpdateRequest)

WithContext sets the request context.

func (Update) WithErrorTrace ¶ 

func (f Update) WithErrorTrace() func(*UpdateRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (Update) WithFilterPath ¶ 

func (f Update) WithFilterPath(v ...string) func(*UpdateRequest)

WithFilterPath filters the properties of the response body.

func (Update) WithHeader ¶ 

func (f Update) WithHeader(h map[string]string) func(*UpdateRequest)

WithHeader adds the headers to the HTTP request.

func (Update) WithHuman ¶ 

func (f Update) WithHuman() func(*UpdateRequest)

WithHuman makes statistical values human-readable.

func (Update) WithIfPrimaryTerm ¶ 

func (f Update) WithIfPrimaryTerm(v int) func(*UpdateRequest)

WithIfPrimaryTerm - only perform the update operation if the last operation that has changed the document has the specified primary term.

func (Update) WithIfSeqNo ¶ 

func (f Update) WithIfSeqNo(v int) func(*UpdateRequest)

WithIfSeqNo - only perform the update operation if the last operation that has changed the document has the specified sequence number.

func (Update) WithIncludeSourceOnError ¶ added in v8.18.0 

func (f Update) WithIncludeSourceOnError(v bool) func(*UpdateRequest)

WithIncludeSourceOnError - true or false if to include the document source in the error message in case of parsing errors. defaults to true..

func (Update) WithLang ¶ 

func (f Update) WithLang(v string) func(*UpdateRequest)

WithLang - the script language (default: painless).

func (Update) WithOpaqueID ¶ 

func (f Update) WithOpaqueID(s string) func(*UpdateRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (Update) WithPretty ¶ 

func (f Update) WithPretty() func(*UpdateRequest)

WithPretty makes the response body pretty-printed.

func (Update) WithRefresh ¶ 

func (f Update) WithRefresh(v string) func(*UpdateRequest)

WithRefresh - if `true` then refresh the 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 (Update) WithRequireAlias ¶ 

func (f Update) WithRequireAlias(v bool) func(*UpdateRequest)

WithRequireAlias - when true, requires destination is an alias. default is false.

func (Update) WithRetryOnConflict ¶ 

func (f Update) WithRetryOnConflict(v int) func(*UpdateRequest)

WithRetryOnConflict - specify how many times should the operation be retried when a conflict occurs (default: 0).

func (Update) WithRouting ¶ 

func (f Update) WithRouting(v string) func(*UpdateRequest)

WithRouting - specific routing value.

func (Update) WithSource ¶ 

func (f Update) WithSource(v ...string) func(*UpdateRequest)

WithSource - true or false to return the _source field or not, or a list of fields to return.

func (Update) WithSourceExcludes ¶ 

func (f Update) WithSourceExcludes(v ...string) func(*UpdateRequest)

WithSourceExcludes - a list of fields to exclude from the returned _source field.

func (Update) WithSourceIncludes ¶ 

func (f Update) WithSourceIncludes(v ...string) func(*UpdateRequest)

WithSourceIncludes - a list of fields to extract and return from the _source field.

func (Update) WithTimeout ¶ 

func (f Update) WithTimeout(v time.Duration) func(*UpdateRequest)

WithTimeout - explicit operation timeout.

func (Update) WithWaitForActiveShards ¶ 

func (f Update) WithWaitForActiveShards(v string) func(*UpdateRequest)

WithWaitForActiveShards - sets the number of shard copies that must be active before proceeding with the update operation. defaults to 1, meaning the primary shard only. set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).

type UpdateByQuery ¶ 

type UpdateByQuery func(index []string, o ...func(*UpdateByQueryRequest)) (*Response, error)

UpdateByQuery performs an update on every document in the index without changing the source, for example to pick up a mapping change.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html.

func (UpdateByQuery) WithAllowNoIndices ¶ 

func (f UpdateByQuery) WithAllowNoIndices(v bool) func(*UpdateByQueryRequest)

WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).

func (UpdateByQuery) WithAnalyzeWildcard ¶ 

func (f UpdateByQuery) WithAnalyzeWildcard(v bool) func(*UpdateByQueryRequest)

WithAnalyzeWildcard - specify whether wildcard and prefix queries should be analyzed (default: false).

func (UpdateByQuery) WithAnalyzer ¶ 

func (f UpdateByQuery) WithAnalyzer(v string) func(*UpdateByQueryRequest)

WithAnalyzer - the analyzer to use for the query string.

func (UpdateByQuery) WithBody ¶ 

func (f UpdateByQuery) WithBody(v io.Reader) func(*UpdateByQueryRequest)

WithBody - The search definition using the Query DSL.

func (UpdateByQuery) WithConflicts ¶ 

func (f UpdateByQuery) WithConflicts(v string) func(*UpdateByQueryRequest)

WithConflicts - what to do when the update by query hits version conflicts?.

func (UpdateByQuery) WithContext ¶ 

func (f UpdateByQuery) WithContext(v context.Context) func(*UpdateByQueryRequest)

WithContext sets the request context.

func (UpdateByQuery) WithDefaultOperator ¶ 

func (f UpdateByQuery) WithDefaultOperator(v string) func(*UpdateByQueryRequest)

WithDefaultOperator - the default operator for query string query (and or or).

func (UpdateByQuery) WithDf ¶ 

func (f UpdateByQuery) WithDf(v string) func(*UpdateByQueryRequest)

WithDf - the field to use as default where no field prefix is given in the query string.

func (UpdateByQuery) WithErrorTrace ¶ 

func (f UpdateByQuery) WithErrorTrace() func(*UpdateByQueryRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (UpdateByQuery) WithExpandWildcards ¶ 

func (f UpdateByQuery) WithExpandWildcards(v string) func(*UpdateByQueryRequest)

WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..

func (UpdateByQuery) WithFilterPath ¶ 

func (f UpdateByQuery) WithFilterPath(v ...string) func(*UpdateByQueryRequest)

WithFilterPath filters the properties of the response body.

func (UpdateByQuery) WithFrom ¶ 

func (f UpdateByQuery) WithFrom(v int) func(*UpdateByQueryRequest)

WithFrom - starting offset (default: 0).

func (UpdateByQuery) WithHeader ¶ 

func (f UpdateByQuery) WithHeader(h map[string]string) func(*UpdateByQueryRequest)

WithHeader adds the headers to the HTTP request.

func (UpdateByQuery) WithHuman ¶ 

func (f UpdateByQuery) WithHuman() func(*UpdateByQueryRequest)

WithHuman makes statistical values human-readable.

func (UpdateByQuery) WithIgnoreUnavailable ¶ 

func (f UpdateByQuery) WithIgnoreUnavailable(v bool) func(*UpdateByQueryRequest)

WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).

func (UpdateByQuery) WithLenient ¶ 

func (f UpdateByQuery) WithLenient(v bool) func(*UpdateByQueryRequest)

WithLenient - specify whether format-based query failures (such as providing text to a numeric field) should be ignored.

func (UpdateByQuery) WithMaxDocs ¶ 

func (f UpdateByQuery) WithMaxDocs(v int) func(*UpdateByQueryRequest)

WithMaxDocs - maximum number of documents to process (default: all documents).

func (UpdateByQuery) WithOpaqueID ¶ 

func (f UpdateByQuery) WithOpaqueID(s string) func(*UpdateByQueryRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (UpdateByQuery) WithPipeline ¶ 

func (f UpdateByQuery) WithPipeline(v string) func(*UpdateByQueryRequest)

WithPipeline - ingest pipeline to set on index requests made by this action. (default: none).

func (UpdateByQuery) WithPreference ¶ 

func (f UpdateByQuery) WithPreference(v string) func(*UpdateByQueryRequest)

WithPreference - specify the node or shard the operation should be performed on (default: random).

func (UpdateByQuery) WithPretty ¶ 

func (f UpdateByQuery) WithPretty() func(*UpdateByQueryRequest)

WithPretty makes the response body pretty-printed.

func (UpdateByQuery) WithQuery ¶ 

func (f UpdateByQuery) WithQuery(v string) func(*UpdateByQueryRequest)

WithQuery - query in the lucene query string syntax.

func (UpdateByQuery) WithRefresh ¶ 

func (f UpdateByQuery) WithRefresh(v bool) func(*UpdateByQueryRequest)

WithRefresh - should the affected indexes be refreshed?.

func (UpdateByQuery) WithRequestCache ¶ 

func (f UpdateByQuery) WithRequestCache(v bool) func(*UpdateByQueryRequest)

WithRequestCache - specify if request cache should be used for this request or not, defaults to index level setting.

func (UpdateByQuery) WithRequestsPerSecond ¶ 

func (f UpdateByQuery) WithRequestsPerSecond(v int) func(*UpdateByQueryRequest)

WithRequestsPerSecond - the throttle to set on this request in sub-requests per second. -1 means no throttle..

func (UpdateByQuery) WithRouting ¶ 

func (f UpdateByQuery) WithRouting(v ...string) func(*UpdateByQueryRequest)

WithRouting - a list of specific routing values.

func (UpdateByQuery) WithScroll ¶ 

func (f UpdateByQuery) WithScroll(v time.Duration) func(*UpdateByQueryRequest)

WithScroll - specify how long a consistent view of the index should be maintained for scrolled search.

func (UpdateByQuery) WithScrollSize ¶ 

func (f UpdateByQuery) WithScrollSize(v int) func(*UpdateByQueryRequest)

WithScrollSize - size on the scroll request powering the update by query.

func (UpdateByQuery) WithSearchTimeout ¶ 

func (f UpdateByQuery) WithSearchTimeout(v time.Duration) func(*UpdateByQueryRequest)

WithSearchTimeout - explicit timeout for each search request. defaults to no timeout..

func (UpdateByQuery) WithSearchType ¶ 

func (f UpdateByQuery) WithSearchType(v string) func(*UpdateByQueryRequest)

WithSearchType - search operation type.

func (UpdateByQuery) WithSlices ¶ 

func (f UpdateByQuery) WithSlices(v interface{}) func(*UpdateByQueryRequest)

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 (UpdateByQuery) WithSort ¶ 

func (f UpdateByQuery) WithSort(v ...string) func(*UpdateByQueryRequest)

WithSort - a list of <field>:<direction> pairs.

func (UpdateByQuery) WithStats ¶ 

func (f UpdateByQuery) WithStats(v ...string) func(*UpdateByQueryRequest)

WithStats - specific 'tag' of the request for logging and statistical purposes.

func (UpdateByQuery) WithTerminateAfter ¶ 

func (f UpdateByQuery) WithTerminateAfter(v int) func(*UpdateByQueryRequest)

WithTerminateAfter - the maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early..

func (UpdateByQuery) WithTimeout ¶ 

func (f UpdateByQuery) WithTimeout(v time.Duration) func(*UpdateByQueryRequest)

WithTimeout - time each individual bulk request should wait for shards that are unavailable..

func (UpdateByQuery) WithVersion ¶ 

func (f UpdateByQuery) WithVersion(v bool) func(*UpdateByQueryRequest)

WithVersion - specify whether to return document version as part of a hit.

func (UpdateByQuery) WithVersionType ¶ 

func (f UpdateByQuery) WithVersionType(v bool) func(*UpdateByQueryRequest)

WithVersionType - should the document increment the version number (internal) on hit or not (reindex).

func (UpdateByQuery) WithWaitForActiveShards ¶ 

func (f UpdateByQuery) WithWaitForActiveShards(v string) func(*UpdateByQueryRequest)

WithWaitForActiveShards - sets the number of shard copies that must be active before proceeding with the update by query operation. defaults to 1, meaning the primary shard only. set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).

func (UpdateByQuery) WithWaitForCompletion ¶ 

func (f UpdateByQuery) WithWaitForCompletion(v bool) func(*UpdateByQueryRequest)

WithWaitForCompletion - should the request should block until the update by query operation is complete..

type UpdateByQueryRequest ¶ 

type UpdateByQueryRequest struct {
	Index []string

	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
	Pipeline            string
	Preference          string
	Query               string
	Refresh             *bool
	RequestCache        *bool
	RequestsPerSecond   *int
	Routing             []string
	Scroll              time.Duration
	ScrollSize          *int
	SearchTimeout       time.Duration
	SearchType          string
	Slices              interface{}
	Sort                []string
	Stats               []string
	TerminateAfter      *int
	Timeout             time.Duration
	Version             *bool
	VersionType         *bool
	WaitForActiveShards string
	WaitForCompletion   *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

UpdateByQueryRequest configures the Update By Query API request.

func (UpdateByQueryRequest) Do ¶ 

func (r UpdateByQueryRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type UpdateByQueryRethrottle ¶ 

type UpdateByQueryRethrottle func(task_id string, requests_per_second *int, o ...func(*UpdateByQueryRethrottleRequest)) (*Response, error)

UpdateByQueryRethrottle changes the number of requests per second for a particular Update By Query operation.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html.

func (UpdateByQueryRethrottle) WithContext ¶ 

func (f UpdateByQueryRethrottle) WithContext(v context.Context) func(*UpdateByQueryRethrottleRequest)

WithContext sets the request context.

func (UpdateByQueryRethrottle) WithErrorTrace ¶ 

func (f UpdateByQueryRethrottle) WithErrorTrace() func(*UpdateByQueryRethrottleRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (UpdateByQueryRethrottle) WithFilterPath ¶ 

func (f UpdateByQueryRethrottle) WithFilterPath(v ...string) func(*UpdateByQueryRethrottleRequest)

WithFilterPath filters the properties of the response body.

func (UpdateByQueryRethrottle) WithHeader ¶ 

func (f UpdateByQueryRethrottle) WithHeader(h map[string]string) func(*UpdateByQueryRethrottleRequest)

WithHeader adds the headers to the HTTP request.

func (UpdateByQueryRethrottle) WithHuman ¶ 

func (f UpdateByQueryRethrottle) WithHuman() func(*UpdateByQueryRethrottleRequest)

WithHuman makes statistical values human-readable.

func (UpdateByQueryRethrottle) WithOpaqueID ¶ 

func (f UpdateByQueryRethrottle) WithOpaqueID(s string) func(*UpdateByQueryRethrottleRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (UpdateByQueryRethrottle) WithPretty ¶ 

func (f UpdateByQueryRethrottle) WithPretty() func(*UpdateByQueryRethrottleRequest)

WithPretty makes the response body pretty-printed.

func (UpdateByQueryRethrottle) WithRequestsPerSecond ¶ 

func (f UpdateByQueryRethrottle) WithRequestsPerSecond(v int) func(*UpdateByQueryRethrottleRequest)

WithRequestsPerSecond - the throttle to set on this request in floating sub-requests per second. -1 means set no throttle..

type UpdateByQueryRethrottleRequest ¶ 

type UpdateByQueryRethrottleRequest struct {
	TaskID string

	RequestsPerSecond *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

UpdateByQueryRethrottleRequest configures the Update By Query Rethrottle API request.

func (UpdateByQueryRethrottleRequest) Do ¶ 

func (r UpdateByQueryRethrottleRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type UpdateRequest ¶ 

type UpdateRequest struct {
	Index      string
	DocumentID string

	Body io.Reader

	IfPrimaryTerm        *int
	IfSeqNo              *int
	IncludeSourceOnError *bool
	Lang                 string
	Refresh              string
	RequireAlias         *bool
	RetryOnConflict      *int
	Routing              string
	Source               []string
	SourceExcludes       []string
	SourceIncludes       []string
	Timeout              time.Duration
	WaitForActiveShards  string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

UpdateRequest configures the Update API request.

func (UpdateRequest) Do ¶ 

func (r UpdateRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type Watcher ¶ 

type Watcher struct {
	AckWatch        WatcherAckWatch
	ActivateWatch   WatcherActivateWatch
	DeactivateWatch WatcherDeactivateWatch
	DeleteWatch     WatcherDeleteWatch
	ExecuteWatch    WatcherExecuteWatch
	GetSettings     WatcherGetSettings
	GetWatch        WatcherGetWatch
	PutWatch        WatcherPutWatch
	QueryWatches    WatcherQueryWatches
	Start           WatcherStart
	Stats           WatcherStats
	Stop            WatcherStop
	UpdateSettings  WatcherUpdateSettings
}

Watcher contains the Watcher APIs

type WatcherAckWatch ¶ 

type WatcherAckWatch func(watch_id string, o ...func(*WatcherAckWatchRequest)) (*Response, error)

WatcherAckWatch - Acknowledges a watch, manually throttling the execution of the watch's actions.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html.

func (WatcherAckWatch) WithActionID ¶ 

func (f WatcherAckWatch) WithActionID(v ...string) func(*WatcherAckWatchRequest)

WithActionID - a list of the action ids to be acked.

func (WatcherAckWatch) WithContext ¶ 

func (f WatcherAckWatch) WithContext(v context.Context) func(*WatcherAckWatchRequest)

WithContext sets the request context.

func (WatcherAckWatch) WithErrorTrace ¶ 

func (f WatcherAckWatch) WithErrorTrace() func(*WatcherAckWatchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (WatcherAckWatch) WithFilterPath ¶ 

func (f WatcherAckWatch) WithFilterPath(v ...string) func(*WatcherAckWatchRequest)

WithFilterPath filters the properties of the response body.

func (WatcherAckWatch) WithHeader ¶ 

func (f WatcherAckWatch) WithHeader(h map[string]string) func(*WatcherAckWatchRequest)

WithHeader adds the headers to the HTTP request.

func (WatcherAckWatch) WithHuman ¶ 

func (f WatcherAckWatch) WithHuman() func(*WatcherAckWatchRequest)

WithHuman makes statistical values human-readable.

func (WatcherAckWatch) WithOpaqueID ¶ 

func (f WatcherAckWatch) WithOpaqueID(s string) func(*WatcherAckWatchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (WatcherAckWatch) WithPretty ¶ 

func (f WatcherAckWatch) WithPretty() func(*WatcherAckWatchRequest)

WithPretty makes the response body pretty-printed.

type WatcherAckWatchRequest ¶ 

type WatcherAckWatchRequest struct {
	ActionID []string
	WatchID  string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

WatcherAckWatchRequest configures the Watcher Ack Watch API request.

func (WatcherAckWatchRequest) Do ¶ 

func (r WatcherAckWatchRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type WatcherActivateWatch ¶ 

type WatcherActivateWatch func(watch_id string, o ...func(*WatcherActivateWatchRequest)) (*Response, error)

WatcherActivateWatch - Activates a currently inactive watch.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html.

func (WatcherActivateWatch) WithContext ¶ 

func (f WatcherActivateWatch) WithContext(v context.Context) func(*WatcherActivateWatchRequest)

WithContext sets the request context.

func (WatcherActivateWatch) WithErrorTrace ¶ 

func (f WatcherActivateWatch) WithErrorTrace() func(*WatcherActivateWatchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (WatcherActivateWatch) WithFilterPath ¶ 

func (f WatcherActivateWatch) WithFilterPath(v ...string) func(*WatcherActivateWatchRequest)

WithFilterPath filters the properties of the response body.

func (WatcherActivateWatch) WithHeader ¶ 

func (f WatcherActivateWatch) WithHeader(h map[string]string) func(*WatcherActivateWatchRequest)

WithHeader adds the headers to the HTTP request.

func (WatcherActivateWatch) WithHuman ¶ 

func (f WatcherActivateWatch) WithHuman() func(*WatcherActivateWatchRequest)

WithHuman makes statistical values human-readable.

func (WatcherActivateWatch) WithOpaqueID ¶ 

func (f WatcherActivateWatch) WithOpaqueID(s string) func(*WatcherActivateWatchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (WatcherActivateWatch) WithPretty ¶ 

func (f WatcherActivateWatch) WithPretty() func(*WatcherActivateWatchRequest)

WithPretty makes the response body pretty-printed.

type WatcherActivateWatchRequest ¶ 

type WatcherActivateWatchRequest struct {
	WatchID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

WatcherActivateWatchRequest configures the Watcher Activate Watch API request.

func (WatcherActivateWatchRequest) Do ¶ 

func (r WatcherActivateWatchRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type WatcherDeactivateWatch ¶ 

type WatcherDeactivateWatch func(watch_id string, o ...func(*WatcherDeactivateWatchRequest)) (*Response, error)

WatcherDeactivateWatch - Deactivates a currently active watch.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html.

func (WatcherDeactivateWatch) WithContext ¶ 

func (f WatcherDeactivateWatch) WithContext(v context.Context) func(*WatcherDeactivateWatchRequest)

WithContext sets the request context.

func (WatcherDeactivateWatch) WithErrorTrace ¶ 

func (f WatcherDeactivateWatch) WithErrorTrace() func(*WatcherDeactivateWatchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (WatcherDeactivateWatch) WithFilterPath ¶ 

func (f WatcherDeactivateWatch) WithFilterPath(v ...string) func(*WatcherDeactivateWatchRequest)

WithFilterPath filters the properties of the response body.

func (WatcherDeactivateWatch) WithHeader ¶ 

func (f WatcherDeactivateWatch) WithHeader(h map[string]string) func(*WatcherDeactivateWatchRequest)

WithHeader adds the headers to the HTTP request.

func (WatcherDeactivateWatch) WithHuman ¶ 

func (f WatcherDeactivateWatch) WithHuman() func(*WatcherDeactivateWatchRequest)

WithHuman makes statistical values human-readable.

func (WatcherDeactivateWatch) WithOpaqueID ¶ 

func (f WatcherDeactivateWatch) WithOpaqueID(s string) func(*WatcherDeactivateWatchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (WatcherDeactivateWatch) WithPretty ¶ 

func (f WatcherDeactivateWatch) WithPretty() func(*WatcherDeactivateWatchRequest)

WithPretty makes the response body pretty-printed.

type WatcherDeactivateWatchRequest ¶ 

type WatcherDeactivateWatchRequest struct {
	WatchID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

WatcherDeactivateWatchRequest configures the Watcher Deactivate Watch API request.

func (WatcherDeactivateWatchRequest) Do ¶ 

func (r WatcherDeactivateWatchRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type WatcherDeleteWatch ¶ 

type WatcherDeleteWatch func(id string, o ...func(*WatcherDeleteWatchRequest)) (*Response, error)

WatcherDeleteWatch - Removes a watch from Watcher.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html.

func (WatcherDeleteWatch) WithContext ¶ 

func (f WatcherDeleteWatch) WithContext(v context.Context) func(*WatcherDeleteWatchRequest)

WithContext sets the request context.

func (WatcherDeleteWatch) WithErrorTrace ¶ 

func (f WatcherDeleteWatch) WithErrorTrace() func(*WatcherDeleteWatchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (WatcherDeleteWatch) WithFilterPath ¶ 

func (f WatcherDeleteWatch) WithFilterPath(v ...string) func(*WatcherDeleteWatchRequest)

WithFilterPath filters the properties of the response body.

func (WatcherDeleteWatch) WithHeader ¶ 

func (f WatcherDeleteWatch) WithHeader(h map[string]string) func(*WatcherDeleteWatchRequest)

WithHeader adds the headers to the HTTP request.

func (WatcherDeleteWatch) WithHuman ¶ 

func (f WatcherDeleteWatch) WithHuman() func(*WatcherDeleteWatchRequest)

WithHuman makes statistical values human-readable.

func (WatcherDeleteWatch) WithOpaqueID ¶ 

func (f WatcherDeleteWatch) WithOpaqueID(s string) func(*WatcherDeleteWatchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (WatcherDeleteWatch) WithPretty ¶ 

func (f WatcherDeleteWatch) WithPretty() func(*WatcherDeleteWatchRequest)

WithPretty makes the response body pretty-printed.

type WatcherDeleteWatchRequest ¶ 

type WatcherDeleteWatchRequest struct {
	WatchID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

WatcherDeleteWatchRequest configures the Watcher Delete Watch API request.

func (WatcherDeleteWatchRequest) Do ¶ 

func (r WatcherDeleteWatchRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type WatcherExecuteWatch ¶ 

type WatcherExecuteWatch func(o ...func(*WatcherExecuteWatchRequest)) (*Response, error)

WatcherExecuteWatch - Forces the execution of a stored watch.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html.

func (WatcherExecuteWatch) WithBody ¶ 

func (f WatcherExecuteWatch) WithBody(v io.Reader) func(*WatcherExecuteWatchRequest)

WithBody - Execution control.

func (WatcherExecuteWatch) WithContext ¶ 

func (f WatcherExecuteWatch) WithContext(v context.Context) func(*WatcherExecuteWatchRequest)

WithContext sets the request context.

func (WatcherExecuteWatch) WithDebug ¶ 

func (f WatcherExecuteWatch) WithDebug(v bool) func(*WatcherExecuteWatchRequest)

WithDebug - indicates whether the watch should execute in debug mode.

func (WatcherExecuteWatch) WithErrorTrace ¶ 

func (f WatcherExecuteWatch) WithErrorTrace() func(*WatcherExecuteWatchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (WatcherExecuteWatch) WithFilterPath ¶ 

func (f WatcherExecuteWatch) WithFilterPath(v ...string) func(*WatcherExecuteWatchRequest)

WithFilterPath filters the properties of the response body.

func (WatcherExecuteWatch) WithHeader ¶ 

func (f WatcherExecuteWatch) WithHeader(h map[string]string) func(*WatcherExecuteWatchRequest)

WithHeader adds the headers to the HTTP request.

func (WatcherExecuteWatch) WithHuman ¶ 

func (f WatcherExecuteWatch) WithHuman() func(*WatcherExecuteWatchRequest)

WithHuman makes statistical values human-readable.

func (WatcherExecuteWatch) WithOpaqueID ¶ 

func (f WatcherExecuteWatch) WithOpaqueID(s string) func(*WatcherExecuteWatchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (WatcherExecuteWatch) WithPretty ¶ 

func (f WatcherExecuteWatch) WithPretty() func(*WatcherExecuteWatchRequest)

WithPretty makes the response body pretty-printed.

func (WatcherExecuteWatch) WithWatchID ¶ 

func (f WatcherExecuteWatch) WithWatchID(v string) func(*WatcherExecuteWatchRequest)

WithWatchID - watch ID.

type WatcherExecuteWatchRequest ¶ 

type WatcherExecuteWatchRequest struct {
	WatchID string

	Body io.Reader

	Debug *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

WatcherExecuteWatchRequest configures the Watcher Execute Watch API request.

func (WatcherExecuteWatchRequest) Do ¶ 

func (r WatcherExecuteWatchRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type WatcherGetSettings ¶ added in v8.8.0 

type WatcherGetSettings func(o ...func(*WatcherGetSettingsRequest)) (*Response, error)

WatcherGetSettings - Retrieve settings for the watcher system index

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-settings.html.

func (WatcherGetSettings) WithContext ¶ added in v8.8.0 

func (f WatcherGetSettings) WithContext(v context.Context) func(*WatcherGetSettingsRequest)

WithContext sets the request context.

func (WatcherGetSettings) WithErrorTrace ¶ added in v8.8.0 

func (f WatcherGetSettings) WithErrorTrace() func(*WatcherGetSettingsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (WatcherGetSettings) WithFilterPath ¶ added in v8.8.0 

func (f WatcherGetSettings) WithFilterPath(v ...string) func(*WatcherGetSettingsRequest)

WithFilterPath filters the properties of the response body.

func (WatcherGetSettings) WithHeader ¶ added in v8.8.0 

func (f WatcherGetSettings) WithHeader(h map[string]string) func(*WatcherGetSettingsRequest)

WithHeader adds the headers to the HTTP request.

func (WatcherGetSettings) WithHuman ¶ added in v8.8.0 

func (f WatcherGetSettings) WithHuman() func(*WatcherGetSettingsRequest)

WithHuman makes statistical values human-readable.

func (WatcherGetSettings) WithMasterTimeout ¶ added in v8.15.0 

func (f WatcherGetSettings) WithMasterTimeout(v time.Duration) func(*WatcherGetSettingsRequest)

WithMasterTimeout - specify timeout for connection to master.

func (WatcherGetSettings) WithOpaqueID ¶ added in v8.8.0 

func (f WatcherGetSettings) WithOpaqueID(s string) func(*WatcherGetSettingsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (WatcherGetSettings) WithPretty ¶ added in v8.8.0 

func (f WatcherGetSettings) WithPretty() func(*WatcherGetSettingsRequest)

WithPretty makes the response body pretty-printed.

type WatcherGetSettingsRequest ¶ added in v8.8.0 

type WatcherGetSettingsRequest struct {
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

WatcherGetSettingsRequest configures the Watcher Get Settings API request.

func (WatcherGetSettingsRequest) Do ¶ added in v8.8.0 

func (r WatcherGetSettingsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type WatcherGetWatch ¶ 

type WatcherGetWatch func(id string, o ...func(*WatcherGetWatchRequest)) (*Response, error)

WatcherGetWatch - Retrieves a watch by its ID.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html.

func (WatcherGetWatch) WithContext ¶ 

func (f WatcherGetWatch) WithContext(v context.Context) func(*WatcherGetWatchRequest)

WithContext sets the request context.

func (WatcherGetWatch) WithErrorTrace ¶ 

func (f WatcherGetWatch) WithErrorTrace() func(*WatcherGetWatchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (WatcherGetWatch) WithFilterPath ¶ 

func (f WatcherGetWatch) WithFilterPath(v ...string) func(*WatcherGetWatchRequest)

WithFilterPath filters the properties of the response body.

func (WatcherGetWatch) WithHeader ¶ 

func (f WatcherGetWatch) WithHeader(h map[string]string) func(*WatcherGetWatchRequest)

WithHeader adds the headers to the HTTP request.

func (WatcherGetWatch) WithHuman ¶ 

func (f WatcherGetWatch) WithHuman() func(*WatcherGetWatchRequest)

WithHuman makes statistical values human-readable.

func (WatcherGetWatch) WithOpaqueID ¶ 

func (f WatcherGetWatch) WithOpaqueID(s string) func(*WatcherGetWatchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (WatcherGetWatch) WithPretty ¶ 

func (f WatcherGetWatch) WithPretty() func(*WatcherGetWatchRequest)

WithPretty makes the response body pretty-printed.

type WatcherGetWatchRequest ¶ 

type WatcherGetWatchRequest struct {
	WatchID string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

WatcherGetWatchRequest configures the Watcher Get Watch API request.

func (WatcherGetWatchRequest) Do ¶ 

func (r WatcherGetWatchRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type WatcherPutWatch ¶ 

type WatcherPutWatch func(id string, o ...func(*WatcherPutWatchRequest)) (*Response, error)

WatcherPutWatch - Creates a new watch, or updates an existing one.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html.

func (WatcherPutWatch) WithActive ¶ 

func (f WatcherPutWatch) WithActive(v bool) func(*WatcherPutWatchRequest)

WithActive - specify whether the watch is in/active by default.

func (WatcherPutWatch) WithBody ¶ 

func (f WatcherPutWatch) WithBody(v io.Reader) func(*WatcherPutWatchRequest)

WithBody - The watch.

func (WatcherPutWatch) WithContext ¶ 

func (f WatcherPutWatch) WithContext(v context.Context) func(*WatcherPutWatchRequest)

WithContext sets the request context.

func (WatcherPutWatch) WithErrorTrace ¶ 

func (f WatcherPutWatch) WithErrorTrace() func(*WatcherPutWatchRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (WatcherPutWatch) WithFilterPath ¶ 

func (f WatcherPutWatch) WithFilterPath(v ...string) func(*WatcherPutWatchRequest)

WithFilterPath filters the properties of the response body.

func (WatcherPutWatch) WithHeader ¶ 

func (f WatcherPutWatch) WithHeader(h map[string]string) func(*WatcherPutWatchRequest)

WithHeader adds the headers to the HTTP request.

func (WatcherPutWatch) WithHuman ¶ 

func (f WatcherPutWatch) WithHuman() func(*WatcherPutWatchRequest)

WithHuman makes statistical values human-readable.

func (WatcherPutWatch) WithIfPrimaryTerm ¶ 

func (f WatcherPutWatch) WithIfPrimaryTerm(v int) func(*WatcherPutWatchRequest)

WithIfPrimaryTerm - only update the watch if the last operation that has changed the watch has the specified primary term.

func (WatcherPutWatch) WithIfSeqNo ¶ 

func (f WatcherPutWatch) WithIfSeqNo(v int) func(*WatcherPutWatchRequest)

WithIfSeqNo - only update the watch if the last operation that has changed the watch has the specified sequence number.

func (WatcherPutWatch) WithOpaqueID ¶ 

func (f WatcherPutWatch) WithOpaqueID(s string) func(*WatcherPutWatchRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (WatcherPutWatch) WithPretty ¶ 

func (f WatcherPutWatch) WithPretty() func(*WatcherPutWatchRequest)

WithPretty makes the response body pretty-printed.

func (WatcherPutWatch) WithVersion ¶ 

func (f WatcherPutWatch) WithVersion(v int) func(*WatcherPutWatchRequest)

WithVersion - explicit version number for concurrency control.

type WatcherPutWatchRequest ¶ 

type WatcherPutWatchRequest struct {
	WatchID string

	Body io.Reader

	Active        *bool
	IfPrimaryTerm *int
	IfSeqNo       *int
	Version       *int

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

WatcherPutWatchRequest configures the Watcher Put Watch API request.

func (WatcherPutWatchRequest) Do ¶ 

func (r WatcherPutWatchRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type WatcherQueryWatches ¶ 

type WatcherQueryWatches func(o ...func(*WatcherQueryWatchesRequest)) (*Response, error)

WatcherQueryWatches - Retrieves stored watches.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-query-watches.html.

func (WatcherQueryWatches) WithBody ¶ 

func (f WatcherQueryWatches) WithBody(v io.Reader) func(*WatcherQueryWatchesRequest)

WithBody - From, size, query, sort and search_after.

func (WatcherQueryWatches) WithContext ¶ 

func (f WatcherQueryWatches) WithContext(v context.Context) func(*WatcherQueryWatchesRequest)

WithContext sets the request context.

func (WatcherQueryWatches) WithErrorTrace ¶ 

func (f WatcherQueryWatches) WithErrorTrace() func(*WatcherQueryWatchesRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (WatcherQueryWatches) WithFilterPath ¶ 

func (f WatcherQueryWatches) WithFilterPath(v ...string) func(*WatcherQueryWatchesRequest)

WithFilterPath filters the properties of the response body.

func (WatcherQueryWatches) WithHeader ¶ 

func (f WatcherQueryWatches) WithHeader(h map[string]string) func(*WatcherQueryWatchesRequest)

WithHeader adds the headers to the HTTP request.

func (WatcherQueryWatches) WithHuman ¶ 

func (f WatcherQueryWatches) WithHuman() func(*WatcherQueryWatchesRequest)

WithHuman makes statistical values human-readable.

func (WatcherQueryWatches) WithOpaqueID ¶ 

func (f WatcherQueryWatches) WithOpaqueID(s string) func(*WatcherQueryWatchesRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (WatcherQueryWatches) WithPretty ¶ 

func (f WatcherQueryWatches) WithPretty() func(*WatcherQueryWatchesRequest)

WithPretty makes the response body pretty-printed.

type WatcherQueryWatchesRequest ¶ 

type WatcherQueryWatchesRequest struct {
	Body io.Reader

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

WatcherQueryWatchesRequest configures the Watcher Query Watches API request.

func (WatcherQueryWatchesRequest) Do ¶ 

func (r WatcherQueryWatchesRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type WatcherStart ¶ 

type WatcherStart func(o ...func(*WatcherStartRequest)) (*Response, error)

WatcherStart - Starts Watcher if it is not already running.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html.

func (WatcherStart) WithContext ¶ 

func (f WatcherStart) WithContext(v context.Context) func(*WatcherStartRequest)

WithContext sets the request context.

func (WatcherStart) WithErrorTrace ¶ 

func (f WatcherStart) WithErrorTrace() func(*WatcherStartRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (WatcherStart) WithFilterPath ¶ 

func (f WatcherStart) WithFilterPath(v ...string) func(*WatcherStartRequest)

WithFilterPath filters the properties of the response body.

func (WatcherStart) WithHeader ¶ 

func (f WatcherStart) WithHeader(h map[string]string) func(*WatcherStartRequest)

WithHeader adds the headers to the HTTP request.

func (WatcherStart) WithHuman ¶ 

func (f WatcherStart) WithHuman() func(*WatcherStartRequest)

WithHuman makes statistical values human-readable.

func (WatcherStart) WithMasterTimeout ¶ added in v8.15.0 

func (f WatcherStart) WithMasterTimeout(v time.Duration) func(*WatcherStartRequest)

WithMasterTimeout - specify timeout for connection to master.

func (WatcherStart) WithOpaqueID ¶ 

func (f WatcherStart) WithOpaqueID(s string) func(*WatcherStartRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (WatcherStart) WithPretty ¶ 

func (f WatcherStart) WithPretty() func(*WatcherStartRequest)

WithPretty makes the response body pretty-printed.

type WatcherStartRequest ¶ 

type WatcherStartRequest struct {
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

WatcherStartRequest configures the Watcher Start API request.

func (WatcherStartRequest) Do ¶ 

func (r WatcherStartRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type WatcherStats ¶ 

type WatcherStats func(o ...func(*WatcherStatsRequest)) (*Response, error)

WatcherStats - Retrieves the current Watcher metrics.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html.

func (WatcherStats) WithContext ¶ 

func (f WatcherStats) WithContext(v context.Context) func(*WatcherStatsRequest)

WithContext sets the request context.

func (WatcherStats) WithEmitStacktraces ¶ 

func (f WatcherStats) WithEmitStacktraces(v bool) func(*WatcherStatsRequest)

WithEmitStacktraces - emits stack traces of currently running watches.

func (WatcherStats) WithErrorTrace ¶ 

func (f WatcherStats) WithErrorTrace() func(*WatcherStatsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (WatcherStats) WithFilterPath ¶ 

func (f WatcherStats) WithFilterPath(v ...string) func(*WatcherStatsRequest)

WithFilterPath filters the properties of the response body.

func (WatcherStats) WithHeader ¶ 

func (f WatcherStats) WithHeader(h map[string]string) func(*WatcherStatsRequest)

WithHeader adds the headers to the HTTP request.

func (WatcherStats) WithHuman ¶ 

func (f WatcherStats) WithHuman() func(*WatcherStatsRequest)

WithHuman makes statistical values human-readable.

func (WatcherStats) WithMetric ¶ 

func (f WatcherStats) WithMetric(v ...string) func(*WatcherStatsRequest)

WithMetric - controls what additional stat metrics should be include in the response.

func (WatcherStats) WithOpaqueID ¶ 

func (f WatcherStats) WithOpaqueID(s string) func(*WatcherStatsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (WatcherStats) WithPretty ¶ 

func (f WatcherStats) WithPretty() func(*WatcherStatsRequest)

WithPretty makes the response body pretty-printed.

type WatcherStatsRequest ¶ 

type WatcherStatsRequest struct {
	Metric []string

	EmitStacktraces *bool

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

WatcherStatsRequest configures the Watcher Stats API request.

func (WatcherStatsRequest) Do ¶ 

func (r WatcherStatsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type WatcherStop ¶ 

type WatcherStop func(o ...func(*WatcherStopRequest)) (*Response, error)

WatcherStop - Stops Watcher if it is running.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html.

func (WatcherStop) WithContext ¶ 

func (f WatcherStop) WithContext(v context.Context) func(*WatcherStopRequest)

WithContext sets the request context.

func (WatcherStop) WithErrorTrace ¶ 

func (f WatcherStop) WithErrorTrace() func(*WatcherStopRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (WatcherStop) WithFilterPath ¶ 

func (f WatcherStop) WithFilterPath(v ...string) func(*WatcherStopRequest)

WithFilterPath filters the properties of the response body.

func (WatcherStop) WithHeader ¶ 

func (f WatcherStop) WithHeader(h map[string]string) func(*WatcherStopRequest)

WithHeader adds the headers to the HTTP request.

func (WatcherStop) WithHuman ¶ 

func (f WatcherStop) WithHuman() func(*WatcherStopRequest)

WithHuman makes statistical values human-readable.

func (WatcherStop) WithMasterTimeout ¶ added in v8.15.0 

func (f WatcherStop) WithMasterTimeout(v time.Duration) func(*WatcherStopRequest)

WithMasterTimeout - specify timeout for connection to master.

func (WatcherStop) WithOpaqueID ¶ 

func (f WatcherStop) WithOpaqueID(s string) func(*WatcherStopRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (WatcherStop) WithPretty ¶ 

func (f WatcherStop) WithPretty() func(*WatcherStopRequest)

WithPretty makes the response body pretty-printed.

type WatcherStopRequest ¶ 

type WatcherStopRequest struct {
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

WatcherStopRequest configures the Watcher Stop API request.

func (WatcherStopRequest) Do ¶ 

func (r WatcherStopRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type WatcherUpdateSettings ¶ added in v8.8.0 

type WatcherUpdateSettings func(body io.Reader, o ...func(*WatcherUpdateSettingsRequest)) (*Response, error)

WatcherUpdateSettings - Update settings for the watcher system index

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-update-settings.html.

func (WatcherUpdateSettings) WithContext ¶ added in v8.8.0 

func (f WatcherUpdateSettings) WithContext(v context.Context) func(*WatcherUpdateSettingsRequest)

WithContext sets the request context.

func (WatcherUpdateSettings) WithErrorTrace ¶ added in v8.8.0 

func (f WatcherUpdateSettings) WithErrorTrace() func(*WatcherUpdateSettingsRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (WatcherUpdateSettings) WithFilterPath ¶ added in v8.8.0 

func (f WatcherUpdateSettings) WithFilterPath(v ...string) func(*WatcherUpdateSettingsRequest)

WithFilterPath filters the properties of the response body.

func (WatcherUpdateSettings) WithHeader ¶ added in v8.8.0 

func (f WatcherUpdateSettings) WithHeader(h map[string]string) func(*WatcherUpdateSettingsRequest)

WithHeader adds the headers to the HTTP request.

func (WatcherUpdateSettings) WithHuman ¶ added in v8.8.0 

func (f WatcherUpdateSettings) WithHuman() func(*WatcherUpdateSettingsRequest)

WithHuman makes statistical values human-readable.

func (WatcherUpdateSettings) WithMasterTimeout ¶ added in v8.15.0 

func (f WatcherUpdateSettings) WithMasterTimeout(v time.Duration) func(*WatcherUpdateSettingsRequest)

WithMasterTimeout - specify timeout for connection to master.

func (WatcherUpdateSettings) WithOpaqueID ¶ added in v8.8.0 

func (f WatcherUpdateSettings) WithOpaqueID(s string) func(*WatcherUpdateSettingsRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (WatcherUpdateSettings) WithPretty ¶ added in v8.8.0 

func (f WatcherUpdateSettings) WithPretty() func(*WatcherUpdateSettingsRequest)

WithPretty makes the response body pretty-printed.

func (WatcherUpdateSettings) WithTimeout ¶ added in v8.15.0 

func (f WatcherUpdateSettings) WithTimeout(v time.Duration) func(*WatcherUpdateSettingsRequest)

WithTimeout - specify timeout for waiting for acknowledgement from all nodes.

type WatcherUpdateSettingsRequest ¶ added in v8.8.0 

type WatcherUpdateSettingsRequest struct {
	Body io.Reader

	MasterTimeout time.Duration
	Timeout       time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

WatcherUpdateSettingsRequest configures the Watcher Update Settings API request.

func (WatcherUpdateSettingsRequest) Do ¶ added in v8.8.0 

func (r WatcherUpdateSettingsRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPack ¶ 

type XPack struct {
	Info  XPackInfo
	Usage XPackUsage
}

XPack contains the XPack APIs

type XPackInfo ¶ 

type XPackInfo func(o ...func(*XPackInfoRequest)) (*Response, error)

XPackInfo - Retrieves information about the installed X-Pack features.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html.

func (XPackInfo) WithAcceptEnterprise ¶ 

func (f XPackInfo) WithAcceptEnterprise(v bool) func(*XPackInfoRequest)

WithAcceptEnterprise - if this param is used it must be set to true.

func (XPackInfo) WithCategories ¶ 

func (f XPackInfo) WithCategories(v ...string) func(*XPackInfoRequest)

WithCategories - comma-separated list of info categories. can be any of: build, license, features.

func (XPackInfo) WithContext ¶ 

func (f XPackInfo) WithContext(v context.Context) func(*XPackInfoRequest)

WithContext sets the request context.

func (XPackInfo) WithErrorTrace ¶ 

func (f XPackInfo) WithErrorTrace() func(*XPackInfoRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackInfo) WithFilterPath ¶ 

func (f XPackInfo) WithFilterPath(v ...string) func(*XPackInfoRequest)

WithFilterPath filters the properties of the response body.

func (XPackInfo) WithHeader ¶ 

func (f XPackInfo) WithHeader(h map[string]string) func(*XPackInfoRequest)

WithHeader adds the headers to the HTTP request.

func (XPackInfo) WithHuman ¶ 

func (f XPackInfo) WithHuman() func(*XPackInfoRequest)

WithHuman makes statistical values human-readable.

func (XPackInfo) WithOpaqueID ¶ 

func (f XPackInfo) WithOpaqueID(s string) func(*XPackInfoRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackInfo) WithPretty ¶ 

func (f XPackInfo) WithPretty() func(*XPackInfoRequest)

WithPretty makes the response body pretty-printed.

type XPackInfoRequest ¶ 

type XPackInfoRequest struct {
	AcceptEnterprise *bool
	Categories       []string

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

XPackInfoRequest configures the X Pack Info API request.

func (XPackInfoRequest) Do ¶ 

func (r XPackInfoRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

type XPackUsage ¶ 

type XPackUsage func(o ...func(*XPackUsageRequest)) (*Response, error)

XPackUsage - Retrieves usage information about the installed X-Pack features.

See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html.

func (XPackUsage) WithContext ¶ 

func (f XPackUsage) WithContext(v context.Context) func(*XPackUsageRequest)

WithContext sets the request context.

func (XPackUsage) WithErrorTrace ¶ 

func (f XPackUsage) WithErrorTrace() func(*XPackUsageRequest)

WithErrorTrace includes the stack trace for errors in the response body.

func (XPackUsage) WithFilterPath ¶ 

func (f XPackUsage) WithFilterPath(v ...string) func(*XPackUsageRequest)

WithFilterPath filters the properties of the response body.

func (XPackUsage) WithHeader ¶ 

func (f XPackUsage) WithHeader(h map[string]string) func(*XPackUsageRequest)

WithHeader adds the headers to the HTTP request.

func (XPackUsage) WithHuman ¶ 

func (f XPackUsage) WithHuman() func(*XPackUsageRequest)

WithHuman makes statistical values human-readable.

func (XPackUsage) WithMasterTimeout ¶ 

func (f XPackUsage) WithMasterTimeout(v time.Duration) func(*XPackUsageRequest)

WithMasterTimeout - specify timeout for watch write operation.

func (XPackUsage) WithOpaqueID ¶ 

func (f XPackUsage) WithOpaqueID(s string) func(*XPackUsageRequest)

WithOpaqueID adds the X-Opaque-Id header to the HTTP request.

func (XPackUsage) WithPretty ¶ 

func (f XPackUsage) WithPretty() func(*XPackUsageRequest)

WithPretty makes the response body pretty-printed.

type XPackUsageRequest ¶ 

type XPackUsageRequest struct {
	MasterTimeout time.Duration

	Pretty     bool
	Human      bool
	ErrorTrace bool
	FilterPath []string

	Header http.Header

	Instrument Instrumentation
	// contains filtered or unexported fields
}

XPackUsageRequest configures the X Pack Usage API request.

func (XPackUsageRequest) Do ¶ 

func (r XPackUsageRequest) Do(providedCtx context.Context, transport Transport) (*Response, error)

Do executes the request and returns response or error.

Source Files ¶

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.